tkl_network_manager.h

浏览该文件的文档.

 
#ifndef __TKL_NETWORK_MANAGER_H__
#define __TKL_NETWORK_MANAGER_H__
 
 
#ifdef __cplusplus
    extern "C" {
#endif
 
#include "tuya_zigbee_stack.h"
#include "tuya_cloud_types.h"
 
/*
 * zigbee secret key type
*/
#define CENTRALIZED_GLOBAL_TC_LINK_KEY              0x00
#define DISTRIBUTED_SECURITY_GLOBAL_LINK_KEY        0x01
#define CENTRALIZED_INSTALL_CODE_DERIVED_LINK_KEY   0x02
#define DISTRIBUTED_TOUCHLINK_PRECFG_LINK_KEY       0x03
 
/*
 * zigbee network rejoin type
*/
typedef enum {
    // rejoin on current channel
    TKL_REJOIN_ON_CURRENT_CH = 0,
    // rejoin on all 802.25.4 channel(11~26)
    TKL_REJOIN_ON_ALL_ZG_CH,
} TKL_REJOIN_TYPE_E;
 
/*
 * zigbee secret key information structure
*/
typedef struct {
    UINT8_T nwk_key[16];         
    UINT8_T sec_tc_link_key[16]; 
} TKL_SECRET_KEY_T;
 
/*
 * zigbee install code structure
*/
typedef struct {
    UINT8_T code[16];           
} TKL_INSTALL_CODE_T;
 
/*
 * zigbee key status
*/
typedef enum {
    TKL_KEY_STATUS_NONE                 = 0x00,  
    TKL_TCLINK_KEY_ESTABLISHED          = 0x02,  
    TKL_TCLINK_KEY_ESTABLISHED_FAILED   = 0x03,  
    TKL_TCLINK_KEY_VERIFY_SUCCESS       = 0x04,  
    TKL_TCLINK_KEY_VERIFY_FAILED        = 0x05,  
} TKL_KEY_STATUS_E;
 
typedef VOID_T (*TKL_TCLINK_KEY_CB)(TKL_KEY_STATUS_E status);
 
/*
 * zigbee network basic state
*/
typedef enum {
    // the node is not associated with a network in any way
    TKL_NODE_NO_NETWORK = 0,
    // the node is currently attempting to join a network
    TKL_NODE_JOINING_NETWORK,
    // the node is joined to a network
    TKL_NODE_JOINED_NETWORK,
    // the node is an end device joined to a network but its parent is not responding
    TKL_NODE_NO_PARENT,
    // the node is in the process of leaving its current network
    TKL_NODE_LEAVING_NETWORK
} TKL_NWK_BASIC_STATE_E;
 
typedef VOID_T (*TKL_ZGAL_NWK_CHANGE_CB)(TKL_NWK_BASIC_STATE_E state);
 
/*
 * zigbee scan type
*/
typedef enum {
    TKL_SCAN_FOR_JOIN = 0, 
    TKL_SCAN_FOR_REJOIN    
} TKL_SCAN_TYPE_E;
 
/*
 * zigbee scan result
*/
typedef enum {
    TKL_SCAN_SUCESS = 0,    
    TKL_SCAN_NO_BEACONS,    
    TKL_SCAN_NO_LINK_KEY,   
    TKL_SCAN_DECRYPT_FAIL,  
    TKL_SCAN_NOT_PERMITTED, 
    TKL_SCAN_UNKNOWN_FAIL,  
} TKL_SCAN_STATUS_E;
 
/*
 * zigbee basic information structure
*/
typedef struct {
    INT8_T   radio_power;   
    UINT8_T  radio_channel; 
    UINT16_T nwk_addr;      
    UINT16_T panid;         
    UINT8_T  mac_addr[8];   
    UINT8_T  ext_panid[8];  
} TKL_NWK_BASIC_INFO_T;
 
/*
 * zigbee scan result structure
*/
typedef struct {
    UINT8_T channel;            
    TKL_SCAN_TYPE_E type;       
    TKL_SCAN_STATUS_E result;   
} TKL_SCAN_RESULT_T;
 
/* 
 * zigbee join and rejoin complete callback
*/
typedef VOID_T (*TKL_NWK_SCAN_CB)(TKL_SCAN_RESULT_T *result);
 
/*
 * zigbee scan policy structure
*/
typedef struct {
    TKL_REJOIN_TYPE_E type;             
    TKL_NWK_SCAN_CB  scan_complete_cb;  
} TKL_REJOIN_CFG_T;
 
/*
 * zigbee scan policy structure
*/
typedef struct {
    ZG_SCAN_DURATION_E  duration;           
    UINT8_T             link_key_mask;      
    UINT32_T            channel_mask;       
    TKL_NWK_SCAN_CB     scan_complete_cb;   
} TKL_JOIN_CFG_T;
 
/*
 * zigbee scan policy structure
*/
typedef struct {
    union {
        TKL_JOIN_CFG_T   join;
        TKL_REJOIN_CFG_T rejoin;
    } scan;
} TKL_SCAN_POLICY_T;
 
TKL_NWK_BASIC_STATE_E tkl_zg_nwk_base_status_get(VOID_T);
 
OPERATE_RET tkl_zg_nwk_state_change_register(TKL_ZGAL_NWK_CHANGE_CB nwk_change_cb);
 
VOID_T tkl_zg_scan_policy_set(TKL_SCAN_TYPE_E type, TKL_SCAN_POLICY_T *policy);
 
OPERATE_RET tkl_zg_start_scan(TKL_SCAN_TYPE_E type);
 
OPERATE_RET tkl_zg_stop_scan(TKL_SCAN_TYPE_E type);
 
OPERATE_RET tkl_zg_start_leave(VOID_T);
 
VOID_T tkl_zg_install_code_set(TKL_INSTALL_CODE_T *insall_code);
 
VOID_T tkl_zg_install_code_get(TKL_INSTALL_CODE_T *insall_code);
 
BOOL_T tkl_zg_nwk_secret_key_info_get(TKL_SECRET_KEY_T *key_info);
 
OPERATE_RET tkl_zg_register_key_establish_cb(TKL_TCLINK_KEY_CB key_cb);
 
VOID_T tkl_zg_nwk_base_info_get(TKL_NWK_BASIC_INFO_T *nwk_info);
 
UINT8_T tkl_zg_radio_channel_get(VOID_T);
 
VOID_T tkl_zg_radio_channel_set(UINT8_T channel);
 
INT8_T tkl_zg_radio_power_get(VOID_T);
 
VOID_T tkl_zg_radio_power_set(INT8_T tx_power);
 
VOID_T tkl_zg_mac_address_get(UINT8_T *mac);
 
UINT16_T tkl_zg_nwk_address_get(VOID_T);
 
UINT16_T tkl_zg_nwk_panid_get(VOID_T);
 
VOID_T tkl_zg_nwk_extend_panid_get(UINT8_T *extpanid);
 
ZG_NWK_TYPE_E tkl_zg_nwk_type_get(VOID_T);
 
ZG_NODE_TYPE_E tkl_zg_node_type_get(VOID_T);
 
VOID_T tkl_zg_node_type_set(ZG_NODE_TYPE_E type);
 
 
#ifdef __cplusplus
}
#endif
 
#endif