Tuya.com
简体中文
English
注册
登录开发者平台
简体中文
English
注册
登录开发者平台
TuyaOS
search
根据文档目录筛选

安防接口

更新时间：2024-11-20 08:51:29下载pdf

本文介绍了综合 SDK 的安防接口。

结构体定义

TY_HOME_SECURITY_OPS_CB_S

typedef struct {
    VOID (*alarm_cb)(INT_T volume, UINT_T time);
    VOID (*alarm_mute_cb)(INT_T mute_on);
    VOID (*alarm_cancel_cb)(VOID);
    VOID (*disarmed_cb)(INT_T volume);
    VOID (*away_and_armed_cb)(INT_T volume);
    VOID (*home_and_armed_cb)(INT_T volume);
    VOID (*arm_ignore_cb)(INT_T volume);
    VOID (*arm_countdown_cb)(INT_T volume, UINT_T countdown_time);
    VOID (*alarm_countdown_cb)(INT_T volume, UINT_T countdown_time);
    VOID (*alarm_door_cb)(INT_T volume);
    VOID (*alarm_devname_cb)(INT_T volume, CHAR_T *name);
} TY_HOME_SECURITY_OPS_CB_S;

功能说明(Summary)

安防操作回调结构体。

成员说明

成员名称 说明
alarm_cb 报警发生回调接口，详见 alarm_cb
alarm_mute_cb 报警消音回调接口，详见 alarm_mute_cb
alarm_cancel_cb 报警取消回调接口，详见 alarm_cancel_cb
disarmed_cb 撤防完成回调接口，详见 disarmed_cb
away_and_armed_cb 离家布防完成回调接口，详见 away_and_armed_cb
home_and_armed_cb 在家布防完成回调接口，详见 home_and_armed_cb
arm_ignore_cb 报警忽略回调接口（正在布防时），详见 arm_ignore_cb
arm_countdown_cb 布防倒计时开始回调接口，详见 arm_countdown_cb
alarm_countdown_cb 报警倒计时开始回调接口，详见 alarm_countdown_cb
alarm_door_cb 门磁设备打开回调接口，详见 alarm_door_cb
alarm_devname_cb 报警下发设备名称回调接口，详见 alarm_devname_cb

TY_GW_HOME_SECURITY_APP_CBS_S

typedef struct {
    GW_OFFLINE_DP_SAVE gw_offline_dp_save_cb;
    GW_HOME_SECURITY_IF_CB gw_home_security_if_cb;
    GW_HOME_SECURITY_ALARM_DEV_CB gw_home_security_alarm_dev_cb;
    GW_HOME_SECURITY_ALARM_DEV_CB gw_home_security_alarm_env_dev_cb;
    GW_HOME_SECURITY_ALARM_DELAY_STATUS_CB gw_home_security_alarm_delay_status_cb;
    GW_HOME_SECURITY_EVENT_CB gw_home_security_event_cb;
    GW_HOME_SECURITY_CANCEL_ALARM_CB gw_home_security_cancel_alarm;
    GW_HOME_SECURITY_ALARM_DEV_NEW_CB gw_home_security_alarm_dev_new_cb;
	GW_HOME_SECURITY_ENTER_ALARM_CB gw_home_security_enter_alarm_cb;
} TY_GW_HOME_SECURITY_APP_CBS_S;

功能说明(Summary)

安防业务回调结构体。

成员说明

成员名称 说明
gw_offline_dp_save_cb 离线保存 DP 信息回调接口，详见 gw_offline_dp_save_cb
gw_home_security_if_cb 安防模式变化通知回调接口，详见 gw_home_security_if_cb
gw_home_security_alarm_dev_cb 已废弃，代替接口 gw_home_security_alarm_dev_new_cb
gw_home_security_alarm_env_dev_cb 已废弃，代替接口 gw_home_security_alarm_dev_new_cb
gw_home_security_alarm_delay_status_cb 报警延时状态通知回调接口，详见 gw_home_security_alarm_delay_status_cb
gw_home_security_event_cb 安防事件通知回调接口，详见 gw_home_security_event_cb
gw_home_security_cancel_alarm 取消报警回调接口，详见 gw_home_security_cancel_alarm
gw_home_security_alarm_dev_new_cb 安防报警设备功能点信息处理回调接口，详见 gw_home_security_alarm_dev_new_cb
gw_home_security_enter_alarm_cb 进入报警状态通知回调接口，详见 gw_home_security_enter_alarm_cb

接口说明

tuya_iot_gw_home_security_reg_ops_cb

OPERATE_RET tuya_iot_gw_home_security_reg_ops_cb(TY_HOME_SECURITY_OPS_CB_S *cbs)

功能说明

注册安防功能操作回调接口。

参数说明

参数名称 说明
cbs 操作回调结构体，详见 TY_HOME_SECURITY_OPS_CB_S

返回值

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

tuya_iot_gw_home_security_start

OPERATE_RET tuya_iot_gw_home_security_start(TY_GW_HOME_SECURITY_APP_CBS_S *iot_alarm_cbs);

功能说明

安防服务初始化接口。

参数说明

参数名称 说明
cbs 安防业务回调结构体，详见 TY_GW_HOME_SECURITY_APP_CBS_S
  • cbs == NULL，表示 SDK 内部处理
  • cbs != NULL，表示开发者自行处理

返回值

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

回调接口

alarm_cb

VOID (*alarm_cb)(INT_T volume, 
                 UINT_T time)

功能说明

报警发生回调接口。

参数说明

参数名称 说明
volume 报警音量
time 延迟报警时长

返回值

返回值 说明
VOID /

alarm_mute_cb

VOID (*alarm_mute_cb)(INT_T mute_on)

功能说明

报警消音回调接口。

参数说明

参数名称 说明
mute_on 0：恢复音量，非 0：消音

返回值

返回值 说明
VOID /

alarm_cancel_cb

VOID (*alarm_cancel_cb)(VOID)

功能说明

报警取消回调接口。

参数说明

参数名称 说明
VOID /

返回值

返回值 说明
VOID /

disarmed_cb

VOID (*disarmed_cb)(INT_T volume)

功能说明

撤防完成回调接口。

参数说明

参数名称 说明
volume 语音播放音量

返回值

返回值 说明
VOID /

away_and_armed_cb

VOID (*away_and_armed_cb)(INT_T volume)

功能说明

离家布防完成回调接口。

参数说明

参数名称 说明
volume 语音播放音量

返回值

返回值 说明
VOID /

home_and_armed_cb

VOID (*home_and_armed_cb)(INT_T volume)

功能说明

在家布防完成回调接口。

参数说明

参数名称 说明
volume 语音播放音量

返回值

返回值 说明
VOID /

arm_ignore_cb

VOID (*arm_ignore_cb)(INT_T volume)

功能说明

报警忽略回调接口，正在布防时触发的报警会进入该回调接口。

参数说明

参数名称 说明
volume 语音播放音量

返回值

返回值 说明
VOID /

arm_countdown_cb

VOID (*arm_countdown_cb)(INT_T volume, 
                         UINT_T countdown_time)

功能说明

布防倒计时开始回调接口。

参数说明

参数名称 说明
volume 语音播放音量
countdown_time 倒计时时间，单位秒

返回值

返回值 说明
VOID /

alarm_countdown_cb

VOID (*alarm_countdown_cb)(INT_T volume, 
                           UINT_T countdown_time)

功能说明

报警倒计时开始回调接口。

参数说明

参数名称 说明
volume 语音播放音量
countdown_time 倒计时时间，单位秒

返回值

返回值 说明
VOID /

alarm_door_cb

VOID (*alarm_door_cb)(INT_T volume)

功能说明

门磁设备打开回调接口。

参数说明

参数名称 说明
volume 语音播放音量

返回值

返回值 说明
VOID /

alarm_devname_cb

VOID (*alarm_devname_cb)(INT_T volume, 
                         CHAR_T *name)

功能说明

报警下发设备名称回调接口，要求产品支持 DP103。

参数说明

参数名称 说明
volume 语音播放音量
name 设备名称字符串

返回值

返回值 说明
VOID /

gw_offline_dp_save_cb

typedef OPERATE_RET (*GW_OFFLINE_DP_SAVE)(IN CONST CHAR_T *dev_id,
                                          IN CONST TY_OBJ_DP_S *dp_data,
                                          IN CONST UINT_T cnt)

功能说明

离线保存 DP 信息回调接口。网关离线时，触发该回调，开发者在回调中保存 DP 信息，等网关恢复上线后上报。

参数说明

参数名称 说明
dev_id 设备 ID
dp_data OBJ 类型功能点数组
cnt OBJ 类型功能点数组长度

返回值

返回值 说明
VOID

gw_home_security_if_cb

typedef VOID (*GW_HOME_SECURITY_IF_CB)(IN CONST CHAR_T *mode_str, 
                                       IN CONST UINT_T time, 
                                       BOOL_T is_sound)

功能说明

安防模式变化通知回调接口。

参数说明

参数名称 说明
mode_str 模式定义如下：
0：撤防
1：在家布防
2：离家布防
time 倒计时时间，单位秒
is_sound TURE：开启语音，FALSE：关闭语音

返回值

返回值 说明
VOID /

gw_home_security_alarm_delay_status_cb

typedef VOID (*GW_HOME_SECURITY_ALARM_DELAY_STATUS_CB)(IN ALARM_DELAY_STATE alarm_status)

功能说明

报警延时状态通知回调接口。

参数说明

参数名称 说明
alarm_status 延时状态，定义如下：
ALARM_DELAY_DONOT_CREATE：报警延时未创建
ALARM_DELAY_COUNTDOWN：报警延时进行中
ALARM_DELAY_END：报警延时结束

返回值

返回值 说明
VOID /

gw_home_security_event_cb

typedef VOID (*GW_HOME_SECURITY_EVENT_CB)(IN SECURITY_EVENT_E security_event_status, 
                                          PVOID_T data);

功能说明

安防事件通知回调接口。

参数说明

参数名称 说明
security_event_status DISARMED_EVENT：非报警状态
ARMED_EVENT：进入布防（在家布防或离家布防）
BYPASS_EVNET：报警忽略
WARING_COUNTDOWN：报警倒计时
data security_event_status == WARING_COUNTDOWN 时，data 的数据类型为 UINT_T，表示倒计时时间；
security_event_status != WARING_COUNTDOWN 时，data 为 NULL

返回值

返回值 说明
VOID /

gw_home_security_cancel_alarm

typedef VOID (*GW_HOME_SECURITY_CANCEL_ALARM_CB)(VOID);

功能说明

取消报警回调接口。

参数说明

参数名称 说明
VOID /

返回值

返回值 说明
VOID /

gw_home_security_alarm_dev_new_cb

typedef VOID (*GW_HOME_SECURITY_ALARM_DEV_NEW_CB)(IN CONST CHAR_T *cid,  
                                                  IN ty_cJSON *dp_inf, 
                                                  SECURITY_DEV_TYPE_E dev_type);

功能说明

安防报警设备功能点信息处理回调接口。

参数说明

参数名称 说明
cid 设备 ID
dp_inf 设备功能点信息，JSON 格式数据，dp_inf->string 表示 dp id，dp value 根据 type 不同而不同，规则如下：
  • dp_inf->type <= cJSON_True，值为 dp_inf->type
  • dp_inf->type == cJSON_Number，值为 dp_inf->valueint
  • dp_inf->type == cJSON_String，值为 dp_inf->valuestring
dev_type 设备类型，定义如下：
  • NO_ENV_DEV：非环境设备，如门磁，PIR 等设备
  • ENV_DEV：环境设备，如燃气报警器，烟雾报警器等设备

返回值

返回值 说明
VOID /

gw_home_security_enter_alarm_cb

typedef VOID (*GW_HOME_SECURITY_ENTER_ALARM_CB)(IN BOOL_T alarm_status, 
                                                IN CHAR_T *alarm_info);

功能说明

进入报警状态通知回调接口。

参数说明

参数名称 说明
alarm_status 报警状态
alarm_info 报警信息字符串

返回值

返回值 说明
VOID /
语言
简体中文
简体中文
English
400-881-8611
7×24小时服务热线
市场合作
marketing@tuya.com
业务合作
service@tuya.com
媒体联络
pr@tuya.com
关注“涂鸦智能”
涂鸦服务尽在掌握
关注“全球智能商业”
第一时间获取物联网资讯
联系我们加入我们TuyaExpoApp 商城TuyaGoTuyaGo服务商查询
法律声明隐私协议加州隐私权利声明服务条款廉正合规安全应急响应中心
©2014-2025 杭州涂鸦信息技术有限公司 版权
浙ICP备14011795号
浙B2-20210233号
浙公网安备33010602004238号
简体中文
简体中文
English