oc_knx.h

Go to the documentation of this file.

/*
// Copyright (c) 2021 Cascoda Ltd
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
*/
#ifndef OC_KNX_INTERNAL_H
#define OC_KNX_INTERNAL_H
 
#include <stddef.h>
#include "oc_api.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct oc_pase_t
{
  oc_string_t id;   
  uint8_t salt[32]; 
  uint8_t pa[65];   
  uint8_t pb[65];   
  uint8_t ca[32];   
  uint8_t cb[32];   
  uint8_t rnd[32];  
  int it;
} oc_pase_t;
 
typedef struct oc_group_object_notification_t
{
  oc_string_t value; 
  uint32_t sia;      
  oc_string_t st;    
  uint32_t ga;       
} oc_group_object_notification_t;
 
typedef enum oc_lsm_state {
  LSM_S_UNLOADED = 0,      
  LSM_S_LOADED = 1,        
  LSM_S_LOADING = 2,       
  LSM_S_UNLOADING = 4,     
  LSM_S_LOADCOMPLETING = 5 
} oc_lsm_state_t;
 
typedef enum {
  LSM_E_NOP = 0, 
  LSM_E_STARTLOADING =
    1, 
  LSM_E_LOADCOMPLETE = 2, 
  LSM_E_UNLOAD = 4        
} oc_lsm_event_t;
 
oc_lsm_state_t oc_a_lsm_state(size_t device_index);
 
int oc_a_lsm_set_state(size_t device_index, oc_lsm_event_t new_state);
 
const char *oc_core_get_lsm_event_as_string(oc_lsm_event_t lsm_e);
 
const char *oc_core_get_lsm_state_as_string(oc_lsm_state_t lsm_s);
 
typedef void (*oc_lsm_change_cb_t)(size_t device, oc_lsm_state_t lsm_state,
                                   void *data);
 
void oc_set_lsm_change_cb(oc_lsm_change_cb_t cb, void *data);
 
bool oc_s_mode_notification_to_json(
  char *buffer, size_t buffer_size,
  oc_group_object_notification_t notification);
 
bool oc_is_device_in_runtime(size_t device_index);
 
void oc_knx_set_idevid(const char *idevid, int length);
 
void oc_knx_set_ldevid(char *ldevid, int len);
 
void oc_knx_set_fingerprint(uint64_t fingerprint);
 
void oc_knx_increase_fingerprint();
 
void oc_knx_load_fingerprint();
 
void oc_knx_dump_fingerprint();
 
void oc_knx_load_state(size_t device_index);
 
int oc_reset_device(size_t device_index, int reset_value);
 
void oc_create_knx_resources(size_t device);
 
int oc_knx_knx_ignore_smessage_from_self(bool ignore);
 
#ifdef OC_SPAKE
void oc_initialise_spake_data(void);
#endif
 
#ifdef __cplusplus
}
#endif
 
#endif /* OC_KNX_INTERNAL_H */