tkl_zcl_scene.h 文件参考

Common process - scene 更多...

#include "tuya_cloud_types.h"

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

浏览源代码.

结构体
struct	TKL_SCENE_CB_T

宏定义
#define	SCENES_MAX_SCENE_DATA_LEN   64

类型定义
typedef OPERATE_RET(*	TKL_RECALL_SCENE_CB) (UINT8_T ep_id, UINT8_T scene_id, UINT16_T group_id, UINT16_T time100ms)
typedef OPERATE_RET(*	TKL_REMOVE_ALL_SCENE_CB) (UINT8_T ep_id, UINT16_T group_id)
typedef OPERATE_RET(*	TKL_REMOVE_SCENE_CB) (UINT8_T ep_id, UINT8_T scene_id, UINT16_T group_id)
typedef OPERATE_RET(*	TKL_SAVE_SCENE_CB) (TKL_SCENE_T *entry)
typedef OPERATE_RET(*	TKL_SAVE_SCENE_PRE_CB) (UINT8_T ep_id, UINT8_T scene_id, UINT16_T group_id)
typedef OPERATE_RET(*	TKL_VIEW_SCENE_CB) (TKL_SCENE_T *entry)

枚举
enum	TKL_SCENE_TYPE_T { TKL_SCENE_DATA_TYPE_EXT_SERVER = 0 , TKL_SCENE_DATA_TYPE_YOURSELF = 1 , TKL_SCENE_DATA_TYPE_ZIGBEE = 2 }

函数
VOID_T	tkl_zg_clear_all_scene (VOID_T)
	clear all scenes 更多...
BOOL_T	tkl_zg_find_scene (UINT8_T ep_id, UINT8_T scene_id, UINT16_T group_id)
	find scenes on endpoint 更多...
OPERATE_RET	tkl_zg_scene_cb_register (TKL_SCENE_CB_T *scene_cb)
	scenes callback register 更多...
OPERATE_RET	tkl_zg_scene_recovery (TKL_MINI_SCENE_T *scene_list, UINT8_T sums)
	tuya scene table recovery to native SDK scene table 更多...
UINT8_T	tkl_zg_scene_size_get (VOID_T)
	get scenes table size 更多...

详细描述

Common process - scene

版本

1.0.0

日期

2021-05-13

版权所有

Copyright 2021-2022 Tuya Inc. All Rights Reserved.

枚举类型说明

TKL_SCENE_TYPE_T

enum TKL_SCENE_TYPE_T

枚举值
TKL_SCENE_DATA_TYPE_EXT_SERVER	scene data with extension field, save scene data in sdk
TKL_SCENE_DATA_TYPE_YOURSELF	scene data without extension field, save scene data not in sdk
TKL_SCENE_DATA_TYPE_ZIGBEE	not used

函数说明

tkl_zg_clear_all_scene()

VOID_T tkl_zg_clear_all_scene

(

VOID_T

)

clear all scenes

参数

[in]

none

返回

none

tkl_zg_find_scene()

BOOL_T tkl_zg_find_scene	(	UINT8_T	ep_id,
		UINT8_T	scene_id,
		UINT16_T	group_id
	)

find scenes on endpoint

参数

[in]	ep_id	endpoint
[in]	scene_id	scene id
[in]	group_id	group id

返回

TRUE/ FALSE

tkl_zg_scene_cb_register()

OPERATE_RET tkl_zg_scene_cb_register

(

TKL_SCENE_CB_T *

scene_cb

)

scenes callback register

参数

[in]

scene_cb

scene callback collection

返回

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

tkl_zg_scene_recovery()

OPERATE_RET tkl_zg_scene_recovery	(	TKL_MINI_SCENE_T *	scene_list,
		UINT8_T	sums
	)

tuya scene table recovery to native SDK scene table

参数

[in]	scene_list	tuya scenes table
[in]	sums	tuya scenes table number

返回

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

tkl_zg_scene_size_get()

UINT8_T tkl_zg_scene_size_get

(

VOID_T

)

get scenes table size

参数

[in]

none

返回

scene table size