tkl_zll_commissioning.h 文件参考

Common process - zll commissioning network 更多...

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

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

浏览源代码.

结构体
struct	TKL_ZLL_DEV_LIST_T

类型定义
typedef VOID_T(*	TKL_ZLL_INITIATOR_CMP_CB) (TKL_ZLL_SCAN_RESULT_E, TKL_ZLL_DEV_LIST_T *)
typedef VOID_T(*	TKL_ZLL_TARGET_CMP_CB) (TKL_ZLL_TARGET_STATUS_E)

枚举
enum	TKL_ZLL_SCAN_RESULT_E { TKL_ZLL_SCAN_RESULT_SUCESS = 0 , TKL_ZLL_SCAN_RESULT_NO_FOUND = 1 }
enum	TKL_ZLL_SCAN_STATUS_E { TKL_ZLL_SCAN_OK = 0 , TKL_ZLL_SCAN_BUSY = 1 }
enum	TKL_ZLL_SCAN_TYPE_E { TKL_ZLL_SCANE_FOR_JOIN = 0 , TKL_ZLL_SCAN_FOR_LEAVE = 1 , TKL_ZLL_SCAN_FOR_INDENTIFY = 2 }
enum	TKL_ZLL_TARGET_STATUS_E { TKL_ZLL_TARGET_IDLE = 0 , TKL_ZLL_TARGET_LEAVE , TKL_ZLL_TARGET_JOINED }

函数
VOID_T	tkl_zll_commissioning_3_0_test_enable (VOID_T)
	zll commissioning 3.0 test enable 更多...
BOOL_T	tkl_zll_commissioning_in_process (VOID_T)
	check zll commissioning is in progress to avoid some process conflicts 更多...
OPERATE_RET	tkl_zll_initiator_register_complete_cb (TKL_ZLL_INITIATOR_CMP_CB cb)
	zll initiator register complete callback 更多...
TKL_ZLL_SCAN_STATUS_E	tkl_zll_initiator_scan_start (TKL_ZLL_SCAN_TYPE_E type)
	zll initiator scan start 更多...
VOID_T	tkl_zll_initiator_scan_stop (VOID_T)
	zll initiator scan stop 更多...
OPERATE_RET	tkl_zll_initiator_touchlink_init (VOID_T)
	zll initiator touchlink init 更多...
INT8_T	tkl_zll_initiator_tx_power_get (VOID_T)
	zll initiator get tx power 更多...
VOID_T	tkl_zll_initiator_tx_power_set (INT8_T tx_db)
	zll initiator set tx power 更多...
BOOL_T	tkl_zll_target_no_reset_for_non_factory_new (VOID_T)
	zll target no touchlink for non-factory new device this function will cause an nfn device to refuse network start/join/update requests and thus to forbid commissioning by touchlinking. this can be useful to restrict touchlink stealing. 更多...
BOOL_T	tkl_zll_target_no_touchlink_for_non_factory_new (VOID_T)
	no reset for non-factory new device this function will cause an NFN device on a centralized security network to a touchlink reset-to-factory-new request from a remote device. 更多...
OPERATE_RET	tkl_zll_target_register_complete_cb (TKL_ZLL_TARGET_CMP_CB cb)
	zll target register complete callback 更多...
INT8_T	tkl_zll_target_rssi_threshold_get (VOID_T)
	zll target get rssi threshold 更多...
VOID_T	tkl_zll_target_rssi_threshold_set (INT8_T rx_rssi)
	zll target set rssi threshold 更多...
BOOL_T	tkl_zll_target_touchlink_enable (BOOL_T en)
	zll target touchlink enable 更多...
OPERATE_RET	tkl_zll_target_touchlink_init (VOID_T)
	zll target touchlink init 更多...
BOOL_T	tkl_zll_target_touchlink_is_enable (VOID_T)
	zll target touchlink disable 更多...

详细描述

Common process - zll commissioning network

版本

1.0.0

日期

2021-11-16

版权所有

Copyright 2021-2022 Tuya Inc. All Rights Reserved.

枚举类型说明

TKL_ZLL_SCAN_RESULT_E

enum TKL_ZLL_SCAN_RESULT_E

枚举值
TKL_ZLL_SCAN_RESULT_SUCESS	zll scan OK, found device
TKL_ZLL_SCAN_RESULT_NO_FOUND	zll scan OK, no found device

TKL_ZLL_SCAN_STATUS_E

enum TKL_ZLL_SCAN_STATUS_E

枚举值
TKL_ZLL_SCAN_OK	zll scan start OK.
TKL_ZLL_SCAN_BUSY	zll scan start failed because of busy-bdb.

TKL_ZLL_SCAN_TYPE_E

enum TKL_ZLL_SCAN_TYPE_E

枚举值
TKL_ZLL_SCANE_FOR_JOIN	zll scan because of touchlink.
TKL_ZLL_SCAN_FOR_LEAVE	zll scan because of "reset to factory new".
TKL_ZLL_SCAN_FOR_INDENTIFY	zll scan because of identify.

TKL_ZLL_TARGET_STATUS_E

enum TKL_ZLL_TARGET_STATUS_E

枚举值
TKL_ZLL_TARGET_IDLE	zll target idle
TKL_ZLL_TARGET_LEAVE	zll target leave by initiator
TKL_ZLL_TARGET_JOINED	zll target joined to a zll network

函数说明

tkl_zll_commissioning_3_0_test_enable()

VOID_T tkl_zll_commissioning_3_0_test_enable

(

VOID_T

)

zll commissioning 3.0 test enable

参数

[in]

none

返回

none

tkl_zll_commissioning_in_process()

BOOL_T tkl_zll_commissioning_in_process

(

VOID_T

)

check zll commissioning is in progress to avoid some process conflicts

参数

[in]

none

返回

TRUE:in process

tkl_zll_initiator_register_complete_cb()

OPERATE_RET tkl_zll_initiator_register_complete_cb

(

TKL_ZLL_INITIATOR_CMP_CB

cb

)

zll initiator register complete callback

参数

[in]

cb

pointe to callback

返回

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

tkl_zll_initiator_scan_start()

TKL_ZLL_SCAN_STATUS_E tkl_zll_initiator_scan_start

(

TKL_ZLL_SCAN_TYPE_E

type

)

zll initiator scan start

参数

[in]

type

scan type

返回

scan status

tkl_zll_initiator_scan_stop()

VOID_T tkl_zll_initiator_scan_stop

(

VOID_T

)

zll initiator scan stop

参数

[in]

none

返回

none

tkl_zll_initiator_touchlink_init()

OPERATE_RET tkl_zll_initiator_touchlink_init

(

VOID_T

)

zll initiator touchlink init

参数

[in]

none

返回

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

tkl_zll_initiator_tx_power_get()

INT8_T tkl_zll_initiator_tx_power_get

(

VOID_T

)

zll initiator get tx power

参数

[in]

tx_db

radio tx power

返回

none

tkl_zll_initiator_tx_power_set()

VOID_T tkl_zll_initiator_tx_power_set

(

INT8_T

tx_db

)

zll initiator set tx power

参数

[in]

tx_db

radio tx power

返回

none

tkl_zll_target_no_reset_for_non_factory_new()

BOOL_T tkl_zll_target_no_reset_for_non_factory_new

(

VOID_T

)

zll target no touchlink for non-factory new device this function will cause an nfn device to refuse network start/join/update requests and thus to forbid commissioning by touchlinking. this can be useful to restrict touchlink stealing.

参数

[in]

none

返回

none

tkl_zll_target_no_touchlink_for_non_factory_new()

BOOL_T tkl_zll_target_no_touchlink_for_non_factory_new

(

VOID_T

)

no reset for non-factory new device this function will cause an NFN device on a centralized security network to a touchlink reset-to-factory-new request from a remote device.

参数

[in]

none

返回

none

tkl_zll_target_register_complete_cb()

OPERATE_RET tkl_zll_target_register_complete_cb

(

TKL_ZLL_TARGET_CMP_CB

cb

)

zll target register complete callback

参数

[in]

cb

pointe to callback

返回

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

tkl_zll_target_rssi_threshold_get()

INT8_T tkl_zll_target_rssi_threshold_get

(

VOID_T

)

zll target get rssi threshold

参数

[in]

none

返回

rssi value

tkl_zll_target_rssi_threshold_set()

VOID_T tkl_zll_target_rssi_threshold_set

(

INT8_T

rx_rssi

)

zll target set rssi threshold

参数

[in]

rx_rssi

rssi value

返回

none

tkl_zll_target_touchlink_enable()

BOOL_T tkl_zll_target_touchlink_enable

(

BOOL_T

en

)

zll target touchlink enable

参数

[in]

en

TRUE: enable, FALSE: disable

返回

TRUE: enabel success

tkl_zll_target_touchlink_init()

OPERATE_RET tkl_zll_target_touchlink_init

(

VOID_T

)

zll target touchlink init

参数

[in]

none

返回

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

tkl_zll_target_touchlink_is_enable()

BOOL_T tkl_zll_target_touchlink_is_enable

(

VOID_T

)

zll target touchlink disable

参数

[in]

none

返回

TRUE: enabel success