简体中文
简体中文
English
联系我们
注册
登录
layout空间导航

基础接口

更新时间:2022-08-04 07:37:34下载pdf

本文介绍综合 SDK 的基础接口。

结构体定义

TY_IOT_APP_CBS_S

typedef struct {
    GW_APP_LOG_PATH_CB gw_app_log_path_cb;
}TY_IOT_APP_CBS_S;

功能说明

应用回调结构体,如远程拉取网关本地日志回调。

成员说明

成员名称 说明
gw_app_log_path_cb 详见 gw_app_log_path_cb

GW_PROD_INFO_S

typedef struct {
    CHAR_T *uuid; 
    CHAR_T *auth_key;
} GW_PROD_INFO_S;

功能说明

网关授权信息结构体,适用于无线 SDK

成员说明

成员名称 说明
uuid UUID 字符串。一定不能为 NULL
auth_key auth_key 字符串。一定不能为 NULL

WF_GW_PROD_INFO_S

typedef struct {
    CHAR_T *uuid; 
    CHAR_T *auth_key;
    CHAR_T *ap_ssid;
    CHAR_T *ap_passwd;
} WF_GW_PROD_INFO_S;

功能说明

网关授权信息结构体,适用于有线 SDK

成员说明

成员名称 说明
uuid UUID 字符串。一定不能为 NULL。长度小于或等于 16 字节
auth_key auth_key 字符串。一定不能为 NULL。长度小于或等于 32 字节
ap_ssid SSID 前缀。长度小于或等于 16 字节。如果设置为 NULL 时,则 ssid 前缀默认是 “SmartLife-XXXX”,其中 XXXX 为 MAC 地址
ap_passwd 长度小于或等于 16 字节。默认为 NULL

GW_ATTACH_ATTR_T

typedef struct {
    /** attach ota channel */
    GW_PERMIT_DEV_TP_T tp;
    /** attach version, format xx.xx.xx */
    CHAR_T ver[SW_VER_LEN+1];
}GW_ATTACH_ATTR_T;

功能说明

连接网关的模组的版本信息结构体。

成员说明

成员名称 说明
tp 升级通道号,要求跟 IoT 开发平台上产品自定义固件选择的升级通道号一致
ver 版本号

TY_GW_INFRA_CBS_S

typedef struct {
    VOID (*gw_reset_cb)(GW_RESET_TYPE_E type);
    VOID (*gw_reboot_cb)(VOID);
    VOID (*gw_upgrade_cb)(CONST FW_UG_S *fw);
    VOID (*gw_active_stat_cb)(GW_STATUS_E stat);
    VOID (*gw_active_url_cb)(CHAR_T *url);
} TY_GW_INFRA_CBS_S;

功能说明

网关基础回调结构体,如网关升级、重置、重启、激活通知等。

成员说明

成员名称 说明
gw_reset_cb 详见 gw_reset_cb
gw_reboot_cb 详见 gw_reboot_cb
gw_upgrade_cb 详见 gw_upgrade_cb
gw_active_stat_cb 详见 gw_active_stat_cb
gw_active_url_cb 详见 gw_active_url_cb

TY_GW_NCP_DETECT_S

typedef struct {
    GW_PERMIT_DEV_TP_T type;
    TIME_T timeout;
    GW_GET_NCP_VER_CB get_ver_cb;
} TY_GW_NCP_DETECT_S;

功能说明

获取连接网关的模组的版本信息结构体。

成员说明

成员名称 说明
type 模组类型,类型值对应升级通道
timeout 超时时间,单位是秒。在超时时间内,没有返回版本号则不上报该模组的信息
get_ver_cb 读取版本回调,详见 GW_GET_NCP_VER_CB

FW_UG_S

typedef struct {
    DEV_TYPE_T tp;
    UPGRADE_TYPE_T type;
    CHAR_T fw_url[FW_URL_LEN+1];
    CHAR_T sw_ver[SW_VER_LEN+1];
    UINT_T file_size;
    CHAR_T fw_hmac[FW_HMAC_LEN+1];
} FW_UG_S;

功能说明

升级的固件信息。

成员说明

成员名称 说明
tp 固件类型,对应升级通道
type 升级类型,定义如下:
UPGRADE_TYPE_NORMAL :普通升级
UPGRADE_TYPE_SILENT : 静默升级
fw_url 固件下载 URL 地址
sw_ver 固件版本号
file_size 固件大小
fw_hmac 固件 HMAC 校验码

接口说明

tuya_os_intf_init

int tuya_os_intf_init(void)

功能说明

涂鸦 SDK OS 层初始化接口,必须最先调用

参数说明

参数名称 说明
VOID /

返回值

返回值 说明
错误码 错误码定义参考头文件 tuya_error_code.h

tuya_iot_init

OPERATE_RET tuya_iot_init(IN CONST CHAR_T *fs_storge_path)

功能说明

涂鸦 SDK IoT 层初始化接口,必须在 tuya_os_intf_init 接口之后,其他接口之前调用

参数说明

参数名称 说明
fs_storge_path 存储路径,必须要有可读写权限,路径长度不能大于 110 个字节

返回值

返回值 说明
错误码 错误码定义参考头文件 tuya_error_code.h

tuya_iot_sdk_pre_init

OPERATE_RET tuya_iot_sdk_pre_init(BOOL_T is_gw)

功能说明

涂鸦 SDK 业务层预初始化接口。

参数说明

参数名称 说明
is_gw tuya_iot_wf_sdk_init是否为网关产品。TRUE:网关,FALSE:单品设备

返回值

返回值 说明
错误码 错误码定义参考头文件 tuya_error_code.h

tuya_iot_sdk_init

OPERATE_RET tuya_iot_sdk_init(IN CONST CHAR_T *product_key,
                              IN CONST CHAR_T *sw_ver,
							  IN CONST GW_ATTACH_ATTR_T *attr,
                              IN CONST UINT_T attr_num)

功能说明

涂鸦 SDK 业务层初始化接口,该接口适用于有线 SDK

参数说明

参数名称 说明
product_key 在涂鸦 IoT 平台创建产品对应的产品 ID
sw_ver 网关固件版本号
attr 网关可 OTA 模组配置列表,详见 GW_ATTACH_ATTR_T
attr_num 网关可 OTA 模组配置列表个数

返回值

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

tuya_iot_wf_sdk_init

OPERATE_RET tuya_iot_wf_sdk_init(IN CONST GW_WF_CFG_MTHD_SEL cfg, 
                                 IN CONST GW_WF_START_MODE start_mode,
                                 IN CONST CHAR_T *product_key,IN CONST CHAR_T *sw_ver,
                                 IN CONST GW_ATTACH_ATTR_T *attr,
                                 IN CONST UINT_T attr_num)

功能说明

涂鸦 SDK 业务层初始化接口,该接口适用于有线 SDK

参数说明

参数名称 说明
cfg Wi-Fi 工作模式
start_mode Wi-Fi 配网模式
product_key 在涂鸦 IoT 平台创建产品对应的产品 ID
wf_sw_ver 固件版本号
attr 网关可 OTA 模组配置列表,详见 GW_ATTACH_ATTR_T
attr_num 网关可 OTA 模组配置列表个数

返回值

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

tuya_iot_wired_wf_sdk_init

OPERATE_RET tuya_iot_wired_wf_sdk_init(IN CONST IOT_GW_NET_TYPE_T net_mode,
                                       IN CONST GW_WF_CFG_MTHD_SEL cfg, 
                                       IN CONST GW_WF_START_MODE start_mode,
                                       IN CONST CHAR_T *product_key,
                                       IN CONST CHAR_T *sw_ver,
                                       IN CONST GW_ATTACH_ATTR_T *attr,
                                       IN CONST UINT_T attr_num)

功能说明

涂鸦 SDK 业务层初始化接口,该接口适用于有线+无线 SDK

参数说明

参数名称 说明
net_mode 网络类型,支持三种类型:
IOT_GW_NET_WIRED:有线
IOT_GW_NET_WIFI:无线
IOT_GW_NET_WIRED_WIFI:有线和无线共存
cfg Wi-Fi 工作模式,支持以下类型:
GWCM_OLD:非低功耗模式
GWCM_LOW_POWER:低功耗模式
GWCM_OLD_PROD:低功耗+产测模式
start_mode Wi-Fi 配网模式,支持以下类型:
WF_START_AP_ONLY:仅支持 AP 配网
WF_START_SMART_ONLY:仅支持 EZ 配网
WF_START_AP_FIRST:支持 AP+EZ 配网,AP 配网优先
WF_START_SMART_FIRST:支持 AP+EZ 配网,EZ 配网优先
WF_START_SMART_AP_CONCURRENT:AP 和 EZ 共存模式
product_key 在涂鸦 IoT 平台创建产品对应的产品 ID
wf_sw_ver 固件版本号
attr 网关可 OTA 模组配置列表,详见 GW_ATTACH_ATTR_T
attr_num 网关可 OTA 模组配置列表个数

返回值

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

tuya_iot_app_cbs_init

VOID tuya_iot_app_cbs_init(IN CONST TY_IOT_APP_CBS_S *app_cbs)

功能说明

注册应用回调接口,如远程拉取网关本地日志。

参数说明

参数名称 说明
app_cbs 应用回调结构体。详见 TY_IOT_APP_CBS_S

返回值

返回值 说明
VOID /

tuya_iot_get_sdk_info

CHAR_T *tuya_iot_get_sdk_info(VOID)

功能说明

获取涂鸦 SDK 信息。

参数说明

VOID

返回值

返回值 说明
SDK 信息字符串 包含 SDK 的编译时间,平台,以及版本号,使能的功能等

tuya_iot_set_gw_prod_info

OPERATE_RET tuya_iot_set_gw_prod_info(IN CONST GW_PROD_INFO_S *prod_info)

功能说明

设置有线网关授权信息接口,授权信息需通过涂鸦获取,否则设备无法正常使用。该接口 适用于有线SDK

参数说明

参数名称 说明
prod_info 网关授权信息,详见 GW_PROD_INFO_S

返回值

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

tuya_iot_set_wf_gw_prod_info

OPERATE_RET tuya_iot_set_wf_gw_prod_info(IN CONST WF_GW_PROD_INFO_S *wf_prod_info)

功能说明

设置无线网关授权信息接口,授权信息需通过涂鸦获取,否则设备无法正常使用。该接口适用于无线 SDK

参数说明

参数名称 说明
wf_prod_info 网关授权信息,见 WF_GW_PROD_INFO_S 说明

返回值

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

tuya_iot_gw_unactive

OPERATE_RET tuya_iot_gw_unactive(VOID);

功能说明

本地解绑(不清除数据)接口,该接口适用于有线 SDK

参数说明

参数名称 说明
VOID /

返回值

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

tuya_iot_wf_gw_unactive

OPERATE_RET tuya_iot_wf_gw_unactive(VOID);

功能说明

本地解绑(不清除数据)接口,该接口适用于无线 SDK

参数说明

参数名称 说明
VOID /

返回值

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

tuya_iot_wired_wifi_gw_unactive

OPERATE_RET tuya_iot_wired_wifi_gw_unactive(VOID);

功能说明

本地解绑(不清除数据)接口,该接口适用于有线+无线 SDK

参数说明

参数名称 说明
VOID

返回值

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

tuya_iot_gw_reset

OPERATE_RET tuya_iot_gw_reset(VOID);

功能说明

本地解绑并清除数据接口,该接口 适用于有线 SDK

参数说明

参数名称 说明
VOID

返回值

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

tuya_iot_wf_gw_reset

OPERATE_RET tuya_iot_wf_gw_reset(VOID);

功能说明

本地解绑并清除数据接口,该接口适用于无线 SDK

参数说明

参数名称 说明
VOID /

返回值

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

tuya_iot_wired_wifi_gw_reset

OPERATE_RET tuya_iot_wired_wifi_gw_reset(VOID);

功能说明

本地解绑并清除数据接口,该接口适用于有线+无线 SDK

参数说明

参数名称 说明
VOID /

返回值

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

tuya_iot_sdk_reg_netstat_cb

OPERATE_RET tuya_iot_sdk_reg_netstat_cb(IN CONST SDK_GET_NW_STAT_CB nw_stat_cb, 
                                        IN CONST SDK_WIRED_NW_STAT_CB wr_nw_stat_cb, 
                                        IN CONST SDK_WIFI_NW_STAT_CB wf_nw_stat_cb)

功能说明

注册网络状态管理回调接口。

参数说明

参数名称 说明
nw_stat_cb 联网状态变化回调,详见 SDK_GET_NW_STAT_CB
wr_nw_stat_cb 有线状态变化回调,详见 SDK_WIRED_NW_STAT_CB
wf_nw_stat_cb 无线状态变化回调,详见 SDK_WIFI_NW_STAT_CB

tuya_iot_set_prod_ability

VOID tuya_iot_set_prod_ability(GW_ABI abi)

功能说明

设置网关产品能力接口。必须在 tuya_iot_sdk_init 接口之前调用

参数说明

参数名称 说明
abi 网关产品能力,支持以下类型:
GW_VIRTUAL:没有子设备接入能力,如 SOC 或 MCU
GW_ENTITY_ATTH_DEV:有子设备接入能力,并且支持自身 DP 处理
GW_ENTITY:仅有子设备接入能力,不支持自身 DP 处理

返回值

返回值 说明
VOID /

tuya_iot_get_gw_stat

OPERATE_RET tuya_iot_get_gw_stat(TY_GW_STAT_T *stat)

功能说明

获取网关激活状态接口。

参数说明

参数名称 说明
stat 激活状态定义如下:
GW_UNREGISTERED:未注册
GW_REGISTERED:已注册,激活中
GW_ACTIVATED:已激活
GW_BLE_ACTIVING:激活中(蓝牙配网)
GW_BLE_ACTIVATED:已激活(蓝牙配网)

返回值

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

tuya_iot_httpc_common_post

OPEROPERATE_RET tuya_iot_httpc_common_post(IN CONST CHAR_T *api_name, 
                                           IN CONST CHAR_T *api_ver, 
                                           IN CHAR_T *post_data, 
                                           OUT ty_cJSON **pp_result)

功能说明

涂鸦云 HTTP POST 请求接口,该接口必须在网关激活后使用

参数说明

参数名称 说明
api_name API 接口名称
api_ver API 版本号
post_data 数据内容
pp_result 涂鸦云返回的结果,JSON 数据格式

返回值

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

tuya_iot_httpc_download_file

OPERATE_RET tuya_iot_httpc_download_file(IN CONST CHAR_T *url,
                                         IN CONST UINT_T mlk_buf_len,
                                         IN CONST GW_GET_FILE_DATA_CB cb, 
                                         IN PVOID_T priv_data,
                                         IN CONST UINT_T total_len, 
                                         INOUT BYTE_T file_hmac[32])

功能说明

从涂鸦云拉文件接口,该接口必须在网关激活后使用

参数说明

参数名称 说明
url URL 链接
mlk_buf_len 大文件分段下载,指定块大小
cb 数据接收回调
priv_data 私有数据,作为回调的参数
total_len 文件总大小
file_hmac 文件 HMAC 校验值

返回值

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

tuya_iot_enable_blemesh_compatible

VOID tuya_iot_enable_blemesh_compatible(VOID)

功能说明

使能网关蓝牙 sigmesh 能力接口,网关产品需要蓝牙 sigmesh 功能,但在涂鸦 IoT 平台创建产品时未选择 sigmesh 协议,则需要调用该接口来使能,该接口必须在网关激活后使用

参数说明

参数名称 说明
VOID /

返回值

返回值 说明
VOID /

tuya_iot_dev_join_permit

OPERATE_RET tuya_iot_dev_join_permit(GW_PERMIT_DEV_TP_T tp, 
                                     BOOL_T permit, 
                                     UINT_T timeout);

功能说明

本地使能或禁止子设备入网接口。

参数说明

参数名称 说明
tp 设备类型
permit 使能或禁止入网
timeout 超时时间,单位:秒

返回值

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

tuya_user_svc_init

OPERATE_RET tuya_user_svc_init(CONST GW_INFRA_CBS_S *cbs)

功能说明

用户服务初始化接口。

参数说明

参数名称 说明
cb 用户回调结构体,参考 TY_GW_INFRA_CBS_S

返回值

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

tuya_user_svc_start

OPERATE_RET tuya_user_svc_start(CONST VOID *cbs)

功能说明

用户服务启动接口。

参数说明

参数名称 说明
cbs 目前为保留,可为 NULL

返回值

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

tuya_user_ncp_ver_upload_reg

OPERATE_RET tuya_user_ncp_ver_upload_reg(TY_GW_NCP_DETECT_S *ncp)

功能说明

上报连接网关的模组的版本信息接口,用于在初始化之后异步上报。与 tuya_iot_sdk_init 接口 attr 参数的功能相同。使用该接口时,tuya_iot_sdk_init 接口 attr 参数要求为 NULL,attr_num 参数为 0。

参数说明

参数名称 说明
ncp 目前为保留,可为 NULL

返回值

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

tuya_user_iot_get_gw_nw_stat

OPERATE_RET tuya_user_iot_get_gw_nw_stat(GW_NW_STAT_T *stat)

功能说明

获取网关联网状态接口。

参数说明

参数名称 说明
stat 状态定义如下:
GNS_UNVALID:网口没有 IP 地址
GNS_LAN_VALID:网口有 IP 地址,但是没有外网
GNS_WAN_VALID:外网正常

返回值

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

tuya_user_iot_set_gw_ext_stat

VOID tuya_user_iot_set_gw_ext_stat(IN CONST GW_EXT_STAT_T ext_stat)

功能说明

设置网关扩展状态接口。

参数说明

参数名称 说明
ext_stat 扩展状态定义如下:
EXT_UNAUTH:未认证
EXT_PROD_TEST:产测
EXT_NORMAL_S:正常
EXT_GW_UPGRD:网关升级
EXT_DEV_UPGRD:子设备升级
EXT_DEV_ADD:添加子设备
EXT_REG_FAIL:注册失败
EXT_NET_FAIL:网络异常
EXT_CONFIG_BACK_UP:故障替换备份
EXT_CONFIG_RESTORE:故障替换恢复

返回值

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

tuya_user_iot_wd_common_write

OPERATE_RET tuya_user_iot_wd_common_write(IN CONST CHAR_T *key, 
                                          IN CONST BYTE_T *value, 
                                          IN CONST UINT_T len)

功能说明

写入数据库键值对接口。

参数说明

参数名称 说明
key 唯一的 ID
value 二进制数据
len 数据的长度

返回值

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

tuya_user_iot_wd_common_read

OPERATE_RET tuya_user_iot_wd_common_read(IN CONST CHAR_T *key, 
                                         OUT BYTE_T **value, 
                                         OUT UINT_T *p_len)

功能说明

读取数据库键值对接口。

参数说明

参数名称 说明
key 唯一的 ID
value 二进制数据,需要释放内存
len 数据的长度

返回值

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

tuya_user_iot_wd_common_delete

OPERATE_RET tuya_user_iot_wd_common_delete(IN CONST CHAR_T *key)

功能说明

删除数据库键值对接口。

参数说明

参数名称 说明
key 唯一的 ID

返回值

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

tuya_user_iot_set_country_code

OPERATE_RET tuya_user_iot_set_country_code(CHAR_T *country_code)

功能说明

设置国家码接口。

参数说明

参数名称 说明
country_code ISO 3166-1 格式的国家码,如 “US”/“CN”

返回值

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

回调接口

SDK_GET_NW_STAT_CB

typedef VOID (*SDK_GET_NW_STAT_CB)(IN CONST SDK_NW_STAT_T stat)

功能说明

联网状态变化回调接口。

参数说明

参数名称 说明
stat 联网状态,状态定义如下:
SDK_NWK_OFFLINE:离线
SDK_NWK_ONLINE:上线

返回值

返回值 说明
VOID /

SDK_WIRED_NW_STAT_CB

typedef VOID (*SDK_WIRED_NW_STAT_CB)(IN CONST SDK_WIRED_NW_STAT_T stat)

功能说明

有线状态变化回调接口。

参数说明

参数名称 说明
stat 有线状态,状态定义如下:
SDK_STAT_LAN_UNCONN:已连接网线
SDK_STAT_LAN_CONN:未连接网线

返回值

返回值 说明
VOID /

SDK_WIFI_NW_STAT_CB

typedef VOID (*SDK_WIFI_NW_STAT_CB)(IN CONST SDK_WIFI_NW_STAT_T stat)

功能说明

无线状态变化回调接口。

参数说明

参数名称 说明
stat 无线状态,状态定义如下:
SDK_STAT_LOW_POWER:初始状态
SDK_STAT_UNPROVISION:处于 AP 或 EZ 配网状态
SDK_STAT_AP_STA_UNCFG:未配置无线网络
SDK_STAT_AP_STA_DISC:已配置无线网络,但未连接(AP 和 Station 共存)
SDK_STAT_AP_STA_CONN:已配置无线网络,且已连接(AP 和 Station 共存)
SDK_STAT_STA_DISC:未连接无线网络
SDK_STAT_STA_CONN:已连接无线网络

返回值

返回值 说明
VOID /

GW_GET_NCP_VER_CB

typedef OPERATE_RET (*GW_GET_NCP_VER_CB)(OUT CHAR_T *ver)

功能说明

获取模组版本号回调接口。

参数说明

参数名称 说明
ver 固件版本号

返回值

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

gw_reset_cb

VOID gw_reset_cb(GW_RESET_TYPE_E type)

功能说明

移除网关回调接口。

参数说明

参数名称 说明
type 重置类型,定义如下:
GW_LOCAL_RESET_FACTORY:本地移除并清除数据
GW_REMOTE_UNACTIVE:APP 移除
GW_LOCAL_UNACTIVE:本地移除
GW_REMOTE_RESET_FACTORY:APP 移除并清除数据
GW_RESET_DATA_FACTORY:激活时需要清除数据

返回值

返回值 说明
VOID /

gw_reboot_cb

VOID (*gw_reboot_cb)(VOID)

功能说明

重启应用回调接口,要求开发者在回调中实现重启应用功能。

参数说明

参数名称 说明
VOID /

返回值

返回值 说明
VOID /

gw_upgrade_cb

VOID (*gw_upgrade_cb)(CONST FW_UG_S *fw)

功能说明

升级通知回调接口,要求开发者在回调中实现升级功能。

参数说明

参数名称 说明
fw 固件信息,详见 FW_UG_S

返回值

返回值 说明
VOID /

gw_active_stat_cb

VOID (*gw_active_stat_cb)(GW_STATUS_E stat)

功能说明

状态变化通知回调接口。

参数说明

参数名称 说明
stat 状态定义如下:
GW_RESET:已重置
GW_ACTIVED:已激活
GW_FIRST_START:第一次启动
GW_NORMAL:已激活时,正常启动通知
GW_BLE_ACTIVED:已激活(蓝牙配网)

返回值

返回值 说明
VOID /

gw_active_url_cb

VOID (*gw_active_url_cb)(CHAR_T *url)

功能说明

获取到二维码 URL 通知回调接口。

参数说明

参数名称 说明
url 激活 URL,用于生成配网二维码

返回值

返回值 说明
VOID /

app_log_path_cb

VOID app_log_path_cb(OUT CHAR_T *path, IN CONST INT_T len)

功能说明

远程拉取本地日志回调接口,要求开发者在该回调中把要上传的日志文件路径赋值给 path 变量。

参数说明

参数名称 说明
path 路径 buf,把日志文件路径赋值给该变量
len 路径 buf 大小

返回值

返回值 说明
VOID /