工程接口

本文介绍了综合 SDK 的工程接口。

结构体定义

TY_ENGR_GW_INFRA_CBS_S

typedef struct {
    TY_ENGR_GW_GET_LOG_CB engineer_get_log;
    TY_ENGR_GW_SYNC_CONFIG_CB engineer_sync_config;
    TY_ENGR_GW_FIN_CB engineer_finish;
    TY_ENGR_GW_RESET_CB engineer_reset;
} TY_ENGR_GW_INFRA_CBS_S;

功能说明(Summary)

工程模式基本操作的回调函数结构体。

成员说明

成员名称	说明
engineer_get_log	工程模式，获取网关设备日志的回调函数。详见 TY_ENGR_GW_GET_LOG_CB
engineer_sync_config	工程模式，同步施工配置至普通模式的回调函数。详见 TY_ENGR_GW_SYNC_CONFIG_CB
engineer_finish	工程模式，施工完成的回调函数。详见 TY_ENGR_GW_FIN_CB
engineer_reset	工程模式，重置工程配置的回调函数。详见 TY_ENGR_GW_RESET_CB

TY_ENGR_GW_ZIG_CBS_S

typedef struct {
    TY_ENGR_GW_UG_LAN_INFORM_CB gw_lan_ug_cb;
    TY_ENGR_DEV_UG_LAN_INFORM_CB dev_lan_ug_cb;
    TY_ENGR_GW_SET_CHANNEL_CB gw_set_channel_cb;
    TY_ENGR_GW_GET_CHANNEL_CB gw_get_channel_cb;
    TY_ENGR_GW_SCE_PANEL_BIND_CB gw_sce_panel_cb;
}TY_ENGR_GW_ZIG_CBS_S;

功能说明(Summary)

工程模式zigbee功能相关的回调函数结构体。

成员说明

成员名称	说明
gw_lan_ug_cb	工程模式，网关升级的回调函数。详见 TY_ENGR_GW_UG_LAN_INFORM_CB
dev_lan_ug_cb	工程模式，子设备升级的回调函数。详见 TY_ENGR_DEV_UG_LAN_INFORM_CB
gw_set_channel_cb	工程模式，设置 Zigbee 信道的回调函数。详见 TY_ENGR_GW_SET_CHANNEL_CB
gw_get_channel_cb	工程模式，获取 Zigbee 信道的回调函数。详见 TY_ENGR_GW_GET_CHANNEL_CB
gw_sce_panel_cb	工程模式，设置场景面板的 Zigbee 标准场景的回调函数。详见 TY_ENGR_GW_SCE_PANEL_BIND_CB

TY_SCE_PANEL_S

typedef struct {
    INT_T btn;
    CHAR_T *grp;
    CHAR_T *sce;
    CHAR_T *sce_name;
}TY_SCE_PANEL_S;

功能说明(Summary)

工程模式 Zigbee 标准场景配置信息。

成员说明

成员名称	说明
btn	工程模式 Zigbee 标准场景 button id
grp	工程模式 Zigbee 标准场景 groupId
sce	工程模式 Zigbee 标准场景 sceneId
sce_name	工程模式 Zigbee 标准场景名称

接口说明

tuya_engineer_sdk_init

OPERATE_RET tuya_engineer_sdk_init(IN CONST CHAR_T *product_key, IN TY_ENGR_GW_INFRA_CBS_S *eng_infra_cbs, IN TY_ENGR_GW_ZIG_CBS_S* eng_zig_cbs);

功能说明

工程模式功能初始化接口，该接口要在 SDK 初始化接口（tuya_iot_wired_wf_sdk_init / tuya_iot_wf_sdk_init / tuya_iot_sdk_init）之前调用。

参数 eng_zig_cbs 表示 Zigbee 相关的回调函数。使用函数启用涂鸦 Zigbee 功能时，该参数输入无效。

参数说明

参数名称	说明
product_key	网关产品 ID
eng_infra_cbs	工程模式基本操作回调。详见 TY_ENGR_GW_INFRA_CBS_S
eng_zig_cbs	工程模式 Zigbee 功能相关的回调，使能涂鸦 Zigbee 功能时该参数无效。详见 TY_ENGR_GW_ZIG_CBS_S

返回值

返回值	说明
OPRT_OK	操作成功
错误码	错误码定义参考头文件 tuya_error_code.h

tuya_set_engineer_mode

VOID tuya_set_engineer_mode(VOID);

功能说明

设置当前运行模式为工程模式。

参数说明

参数名称	说明
VOID	/

返回值

返回值	说明
VOID	/

tuya_engineer_extra_lan_data_report

OPERATE_RET tuya_engineer_extra_lan_data_report(IN CHAR_T *data);

功能说明

网关工程模式，局域网扩展协议上报的接口，网关会透传 data 数据至施工 App。

参数说明

参数名称	说明
data	局域网扩展协议上报的数据。网关会透传 data 数据至施工 app#TY_IR_CODE_S)

返回值

返回值	说明
OPRT_OK	操作成功
错误码	错误码定义参考头文件 tuya_error_code.h

tuya_engineer_is_need_sync

OPERATE_RET tuya_engineer_is_need_sync(BOOL_T *status);

功能说明

获取当前工程施工状态，是否是施工完成但未同步到普通模式的状态。

参数说明

参数名称	说明
status	返回 TRUE，表示当前工程施工状态是施工完成但未同步到普通模式的状态。

返回值

返回值	说明
OPRT_OK	操作成功
错误码	错误码定义参考头文件 tuya_error_code.h

tuya_engineer_set_tuya_zigbee_enable

OPERATE_RET tuya_engineer_set_tuya_zigbee_enable(VOID);

功能说明

网关工程模式启用涂鸦zigbee功能。

参数说明

参数名称	说明
VOID

返回值

返回值	说明
OPRT_OK	操作成功
错误码	错误码定义参考头文件 tuya_error_code.h

tuya_iot_engineer_process_register

OPERATE_RET tuya_iot_engineer_process_register(IN GW_ENGR_PROCESS_CB cb);

功能说明

网关工程模式注册获取网关配网状态上报的接口。

参数说明

参数名称	说明
cb	工程模式网关配网状态上报的回调。详见 GW_ENGR_PROCESS_CB

返回值

返回值	说明
OPRT_OK	操作成功
错误码	错误码定义参考头文件 tuya_error_code.h

回调接口

TY_ENGR_GW_GET_LOG_CB

typedef OPERATE_RET (*TY_ENGR_GW_GET_LOG_CB)(OUT CHAR_T *path, IN CONST INT_T len);

功能说明

工程模式网关获取设备日志的回调函数类型。

参数说明

参数名称	说明
path	设备日志所在路径
len	设备日志文件绝对路径的最大字节数（默认最大值为 64 字节）

返回值

返回值	说明
OPRT_OK	操作成功
错误码	错误码定义参考头文件 tuya_error_code.h

TY_ENGR_GW_SYNC_CONFIG_CB

typedef OPERATE_RET (*TY_ENGR_GW_SYNC_CONFIG_CB)(VOID);

功能说明

工程模式网关，施工完成后同步施工配置至普通模式的回调函数类型。

参数说明

参数名称	说明
VOID

返回值

返回值	说明
OPRT_OK	操作成功
错误码	错误码定义参考头文件 tuya_error_code.h

TY_ENGR_GW_FIN_CB

typedef OPERATE_RET (*TY_ENGR_GW_FIN_CB)(VOID);

功能说明

工程模式网关，施工完成时的回调函数类型。

参数说明

参数名称	说明
VOID	/

返回值

返回值	说明
OPRT_OK	操作成功
错误码	错误码定义参考头文件 tuya_error_code.h

TY_ENGR_GW_RESET_CB

typedef OPERATE_RET (*TY_ENGR_GW_RESET_CB)(VOID);

功能说明

工程模式网关，网关配置重置的回调接口函数。

参数说明

参数名称	说明
VOID	/

返回值

返回值	说明
OPRT_OK	操作成功
错误码	错误码定义参考头文件 tuya_error_code.h

TY_ENGR_GW_SCE_PANEL_BIND_CB

typedef OPERATE_RET (*TY_ENGR_GW_SCE_PANEL_BIND_CB)(IN CONST CHAR_T *dev_id,IN CONST TY_SCE_PANEL_S *sce_panel, IN CONST INT_T btn_num);

功能说明

工程模式网关，Zigbee 标准场景绑定的回调函数类型。

参数说明

参数名称	说明
dev_id	场景面板的设备 ID
sce_panel	工程模式 Zigbee 标准场景配置信息。详见 TY_SCE_PANEL_S
btn_num	场景面板的场景数量

返回值

返回值	说明
OPRT_OK	操作成功
错误码	错误码定义参考头文件 tuya_error_code.h

TY_ENGR_GW_UG_LAN_INFORM_CB

typedef OPERATE_RET (*TY_ENGR_GW_UG_LAN_INFORM_CB)(IN CONST FW_UG_S *fw);

功能说明

工程模式网关升级的回调函数类型。

参数说明

参数名称	说明
fw	工程模式下，网关升级的版本信息

返回值

返回值	说明
OPRT_OK	操作成功
错误码	错误码定义参考头文件 tuya_error_code.h

TY_ENGR_DEV_UG_LAN_INFORM_CB

typedef OPERATE_RET (*TY_ENGR_DEV_UG_LAN_INFORM_CB)(IN CONST CHAR_T *dev_id,IN CONST FW_UG_S *fw);

功能说明

工程模式子设备升级的回调函数类型。

参数说明

参数名称	说明
dev_id	工程模式下，升级的子设备设备 ID
fw	工程模式下，子设备升级的版本信息

返回值

返回值	说明
OPRT_OK	操作成功
错误码	错误码定义参考头文件 tuya_error_code.h

TY_ENGR_GW_SET_CHANNEL_CB

typedef OPERATE_RET (*TY_ENGR_GW_SET_CHANNEL_CB)(IN INT_T channel);

功能说明

工程模式网关设置 Zigbee 信道的回调函数类型。

参数说明

参数名称	说明
channel	Zigbee 信道号

返回值

返回值	说明
OPRT_OK	操作成功
错误码	错误码定义参考头文件 tuya_error_code.h

TY_ENGR_GW_GET_CHANNEL_CB

typedef OPERATE_RET (*TY_ENGR_GW_GET_CHANNEL_CB)(OUT INT_T *channel);

功能说明

工程模式网关获取 Zigbee 信道的回调函数类型。

参数说明

参数名称	说明
channel	Zigbee 信道号

返回值

返回值	说明
OPRT_OK	操作成功
错误码	错误码定义参考头文件 tuya_error_code.h

GW_ENGR_PROCESS_CB

typedef OPERATE_RET (*GW_ENGR_PROCESS_CB)(GW_ENGR_PROCESS_T process);

功能说明

工程模式网关配网流程的状态上报的回调函数类型。

参数说明

参数名称	说明
process	工程模式网关配网流程的状态，参考 GW_ENGR_PROCESS_T

返回值

返回值	说明
OPRT_OK	操作成功
错误码	错误码定义参考头文件 tuya_error_code.h

typedef OPERATE_RET (*GW_ENGR_PROCESS_CB)(GW_ENGR_PROCESS_T process);

功能说明

工程模式网关配网流程的状态上报的回调函数类型。

参数说明

参数名称	说明
process	工程模式网关配网流程的状态，参考GW_ENGR_PROCESS_T

返回值

返回值	说明
OPRT_OK	操作成功
错误码	错误码定义参考头文件 tuya_error_code.h