Common process - network manager 更多...

#include "tuya_zigbee_stack.h"
#include "tuya_cloud_types.h"

tkl_network_manager.h 的引用(Include)关系图:

结构体
struct	TKL_SCAN_POLICY_T

宏定义
#define	CENTRALIZED_GLOBAL_TC_LINK_KEY 0x00

#define	CENTRALIZED_INSTALL_CODE_DERIVED_LINK_KEY 0x02

#define	DISTRIBUTED_SECURITY_GLOBAL_LINK_KEY 0x01

#define	DISTRIBUTED_TOUCHLINK_PRECFG_LINK_KEY 0x03

类型定义
typedef VOID_T(*	TKL_NWK_SCAN_CB) (TKL_SCAN_RESULT_T *result)

typedef VOID_T(*	TKL_TCLINK_KEY_CB) (TKL_KEY_STATUS_E status)

typedef VOID_T(*	TKL_ZGAL_NWK_CHANGE_CB) (TKL_NWK_BASIC_STATE_E state)

枚举
enum	TKL_KEY_STATUS_E { 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 }

enum	TKL_NWK_BASIC_STATE_E { TKL_NODE_NO_NETWORK = 0 , TKL_NODE_JOINING_NETWORK , TKL_NODE_JOINED_NETWORK , TKL_NODE_NO_PARENT , TKL_NODE_LEAVING_NETWORK }

enum	TKL_REJOIN_TYPE_E { TKL_REJOIN_ON_CURRENT_CH = 0 , TKL_REJOIN_ON_ALL_ZG_CH }

enum	TKL_SCAN_STATUS_E { 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 }

enum	TKL_SCAN_TYPE_E { TKL_SCAN_FOR_JOIN = 0 , TKL_SCAN_FOR_REJOIN }

函数
VOID_T	tkl_zg_install_code_get (TKL_INSTALL_CODE_T *insall_code)
	get zigbee install code 更多...

VOID_T	tkl_zg_install_code_set (TKL_INSTALL_CODE_T *insall_code)
	set zigbee install code 更多...

VOID_T	tkl_zg_mac_address_get (UINT8_T *mac)
	get zigbee mac address 更多...

ZG_NODE_TYPE_E	tkl_zg_node_type_get (VOID_T)
	zigbee node type get 更多...

VOID_T	tkl_zg_node_type_set (ZG_NODE_TYPE_E type)
	zigbee node type set 更多...

UINT16_T	tkl_zg_nwk_address_get (VOID_T)
	get zigbee network short address 更多...

VOID_T	tkl_zg_nwk_base_info_get (TKL_NWK_BASIC_INFO_T *nwk_info)
	get zigbee network basic information 更多...

TKL_NWK_BASIC_STATE_E	tkl_zg_nwk_base_status_get (VOID_T)
	get zigbee basic network information 更多...

VOID_T	tkl_zg_nwk_extend_panid_get (UINT8_T *extpanid)
	get zigbee network extend panid 更多...

UINT16_T	tkl_zg_nwk_panid_get (VOID_T)
	get zigbee network panid 更多...

BOOL_T	tkl_zg_nwk_secret_key_info_get (TKL_SECRET_KEY_T *key_info)
	get zigbee network secret key struct 更多...

OPERATE_RET	tkl_zg_nwk_state_change_register (TKL_ZGAL_NWK_CHANGE_CB nwk_change_cb)
	register network state change callback 更多...

ZG_NWK_TYPE_E	tkl_zg_nwk_type_get (VOID_T)
	zigbee network type get 更多...

UINT8_T	tkl_zg_radio_channel_get (VOID_T)
	get zigbee radio channel 更多...

VOID_T	tkl_zg_radio_channel_set (UINT8_T channel)
	set zigbee radio channel 更多...

INT8_T	tkl_zg_radio_power_get (VOID_T)
	get zigbee radio power 更多...

VOID_T	tkl_zg_radio_power_set (INT8_T tx_power)
	set zigbee radio power 更多...

OPERATE_RET	tkl_zg_register_key_establish_cb (TKL_TCLINK_KEY_CB key_cb)
	register key status callback 更多...

VOID_T	tkl_zg_scan_policy_set (TKL_SCAN_TYPE_E type, TKL_SCAN_POLICY_T *policy)
	set zigbee scan policy 更多...

OPERATE_RET	tkl_zg_start_leave (VOID_T)
	zigbee start leave 更多...

OPERATE_RET	tkl_zg_start_scan (TKL_SCAN_TYPE_E type)
	zigbee start scan 更多...

OPERATE_RET	tkl_zg_stop_scan (TKL_SCAN_TYPE_E type)
	zigbee stop scan 更多...

详细描述

Common process - network manager

版本: 1.0.0

日期: 2021-05-01

版权所有: Copyright 2021-2022 Tuya Inc. All Rights Reserved.

枚举类型说明

◆ TKL_KEY_STATUS_E

enum TKL_KEY_STATUS_E

枚举值
TKL_KEY_STATUS_NONE	status none
TKL_TCLINK_KEY_ESTABLISHED	receive TcLink key
TKL_TCLINK_KEY_ESTABLISHED_FAILED	receive TcLink failed
TKL_TCLINK_KEY_VERIFY_SUCCESS	verify TcLink key success
TKL_TCLINK_KEY_VERIFY_FAILED	verify TcLink key failed

◆ TKL_SCAN_STATUS_E

enum TKL_SCAN_STATUS_E

枚举值
TKL_SCAN_SUCESS	scan success
TKL_SCAN_NO_BEACONS	scan failed because no beacon received
TKL_SCAN_NO_LINK_KEY	scan failed because no link key
TKL_SCAN_DECRYPT_FAIL	scan failed because decrypt fail
TKL_SCAN_NOT_PERMITTED	scan failed because remote not permitted
TKL_SCAN_UNKNOWN_FAIL	scan failed because other reasons

◆ TKL_SCAN_TYPE_E

enum TKL_SCAN_TYPE_E

枚举值
TKL_SCAN_FOR_JOIN	scan for joining a network
TKL_SCAN_FOR_REJOIN	scan for re-joining a network

函数说明

◆ tkl_zg_install_code_get()

VOID_T tkl_zg_install_code_get ( TKL_INSTALL_CODE_T * insall_code )

get zigbee install code

参数

[in] insall_code point to the data structure of install code

返回: none

◆ tkl_zg_install_code_set()

VOID_T tkl_zg_install_code_set ( TKL_INSTALL_CODE_T * insall_code )

set zigbee install code

参数

[in] insall_code point to the data structure of install code

返回: none

◆ tkl_zg_mac_address_get()

VOID_T tkl_zg_mac_address_get ( UINT8_T * mac )

get zigbee mac address

参数

[out] mac mac address

返回: none

◆ tkl_zg_node_type_get()

ZG_NODE_TYPE_E tkl_zg_node_type_get ( VOID_T )

zigbee node type get

参数

[in] none

返回: 0: success Other: fail

◆ tkl_zg_node_type_set()

VOID_T tkl_zg_node_type_set ( ZG_NODE_TYPE_E type )

zigbee node type set

参数

[in] none

返回: 0: success Other: fail

◆ tkl_zg_nwk_address_get()

UINT16_T tkl_zg_nwk_address_get ( VOID_T )

get zigbee network short address

参数

[in] none

返回: network address

◆ tkl_zg_nwk_base_info_get()

VOID_T tkl_zg_nwk_base_info_get ( TKL_NWK_BASIC_INFO_T * nwk_info )

get zigbee network basic information

参数

[in] nwk_info point to the data structure of network basic information

返回: none

◆ tkl_zg_nwk_base_status_get()

TKL_NWK_BASIC_STATE_E tkl_zg_nwk_base_status_get ( VOID_T )

get zigbee basic network information

参数

[in] none

返回: NULL: fail Other: success

◆ tkl_zg_nwk_extend_panid_get()

VOID_T tkl_zg_nwk_extend_panid_get ( UINT8_T * extpanid )

get zigbee network extend panid

参数

[out] extpanid extend panid

返回: none

◆ tkl_zg_nwk_panid_get()

UINT16_T tkl_zg_nwk_panid_get ( VOID_T )

get zigbee network panid

参数

[in] none

返回: network panid

◆ tkl_zg_nwk_secret_key_info_get()

BOOL_T tkl_zg_nwk_secret_key_info_get ( TKL_SECRET_KEY_T * key_info )

get zigbee network secret key struct

参数

[in] key_info point to the data structure of install code

返回: TRUE: success Other: fail

◆ tkl_zg_nwk_state_change_register()

OPERATE_RET tkl_zg_nwk_state_change_register ( TKL_ZGAL_NWK_CHANGE_CB nwk_change_cb )

register network state change callback

参数

[in] change callback: network change to notify app user

返回: OPRT_OK on success. Others on error, please refer to tuya_error_code.h

◆ tkl_zg_nwk_type_get()

ZG_NWK_TYPE_E tkl_zg_nwk_type_get ( VOID_T )

zigbee network type get

参数

[in] none

返回: 0: success Other: fail

◆ tkl_zg_radio_channel_get()

UINT8_T tkl_zg_radio_channel_get ( VOID_T )

get zigbee radio channel

参数

[in] none

返回: radio channel

◆ tkl_zg_radio_channel_set()

VOID_T tkl_zg_radio_channel_set ( UINT8_T channel )

set zigbee radio channel

参数

[in] channel radio channel

返回: none

◆ tkl_zg_radio_power_get()

INT8_T tkl_zg_radio_power_get ( VOID_T )

get zigbee radio power

参数

[in] none

返回: radio power

◆ tkl_zg_radio_power_set()

VOID_T tkl_zg_radio_power_set ( INT8_T tx_power )

set zigbee radio power

参数

[in] tx_power radio power

返回: none

◆ tkl_zg_register_key_establish_cb()

OPERATE_RET tkl_zg_register_key_establish_cb ( TKL_TCLINK_KEY_CB key_cb )

register key status callback

参数

[in] key_cb key callback

返回: OPRT_OK on success. Others on error, please refer to tuya_error_code.h

◆ tkl_zg_scan_policy_set()

VOID_T tkl_zg_scan_policy_set	(	TKL_SCAN_TYPE_E	type,
		TKL_SCAN_POLICY_T *	policy
	)

set zigbee scan policy

参数

[in]	type	scan type
[in]	policy	point to the data structure of the set scan policy

返回: none

◆ tkl_zg_start_leave()

OPERATE_RET tkl_zg_start_leave ( VOID_T )

zigbee start leave

参数

[in] none

返回: OPRT_OK on success. Others on error, please refer to tuya_error_code.h

◆ tkl_zg_start_scan()

OPERATE_RET tkl_zg_start_scan ( TKL_SCAN_TYPE_E type )

zigbee start scan

参数

[in] type scan type

返回: OPRT_OK on success. Others on error, please refer to tuya_error_code.h

◆ tkl_zg_stop_scan()

OPERATE_RET tkl_zg_stop_scan ( TKL_SCAN_TYPE_E type )

zigbee stop scan

参数

[in] type scan type

返回: OPRT_OK on success. Others on error, please refer to tuya_error_code.h

结构体

宏定义

类型定义

枚举

函数

详细描述

枚举类型说明

◆ TKL_KEY_STATUS_E

◆ TKL_SCAN_STATUS_E

◆ TKL_SCAN_TYPE_E

函数说明

◆ tkl_zg_install_code_get()

◆ tkl_zg_install_code_set()

◆ tkl_zg_mac_address_get()

◆ tkl_zg_node_type_get()

◆ tkl_zg_node_type_set()

◆ tkl_zg_nwk_address_get()

◆ tkl_zg_nwk_base_info_get()

◆ tkl_zg_nwk_base_status_get()

◆ tkl_zg_nwk_extend_panid_get()

◆ tkl_zg_nwk_panid_get()

◆ tkl_zg_nwk_secret_key_info_get()

◆ tkl_zg_nwk_state_change_register()

◆ tkl_zg_nwk_type_get()

◆ tkl_zg_radio_channel_get()

◆ tkl_zg_radio_channel_set()

◆ tkl_zg_radio_power_get()

◆ tkl_zg_radio_power_set()

◆ tkl_zg_register_key_establish_cb()

◆ tkl_zg_scan_policy_set()

◆ tkl_zg_start_leave()

◆ tkl_zg_start_scan()

◆ tkl_zg_stop_scan()