红外接口

本文介绍了综合 SDK 的红外接口。

结构体定义

TY_IR_CONTROL_CBS_S

typedef struct
{
    TY_IR_STUDY_CTL_CB  study_ctl_cb;
    TY_IR_SEND_CB       send_cb;
}TY_IR_CONTROL_CBS_S;

功能说明(Summary)

红外回调注册。

成员说明

成员名称	说明
study_ctl_cb	详见 TY_IR_STUDY_CTL_CB
send_cb	详见 TY_IR_SEND_CB

TY_IR_CODE_S

typedef struct
{
    USHORT_T    *code;
    USHORT_T    code_len;
    BYTE_T      send_count;     //repeat send count, don't need delay
    UINT_T      feq;
    USHORT_T    delay;          //ms
}TY_IR_CODE_S;

功能说明(Summary)

红外码结构数组。

成员说明

成员名称	说明
code	红外码
code_len	码的数量
send_count	发送完一轮后，再次重复的次数。重复过程中间不会产生 delay。
feq	发送红外码的频率
delay	此红外码发送完后延迟的毫秒数

TY_RF_CONTROL_CBS_S

typedef struct
{
    TY_RF_STUDY_STATE_CB    rf_study_state_cb;    //A callback is sent in the RF learning state
    TY_RF_SEND_CB           rf_lib_send_cb;       //A callback is sent in the RF data
} TY_RF_CONTROL_CBS_S;

功能说明(Summary)

射频回调接口。

成员说明

成员名称	说明
rf_study_state_cb	详见 TY_RF_STUDY_STATE_CB
rf_lib_send_cb	详见 TY_RF_SEND_CB

接口说明

uya_ir_control_register

OPERATE_RET tuya_ir_control_register(IN CONST TY_IR_CONTROL_CBS_S *p_ir_cbs);

功能说明

开启红外服务，注册回调函数组。

参数说明

参数名称	说明
p_ir_cbs	红外控制回调函数组，详见 TY_IR_CONTROL_CBS_S

返回值

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

tuya_ir_study_code_report

OPERATE_RET tuya_ir_study_code_report(IN CONST USHORT_T *p_code, IN CONST UINT_T code_len);

功能说明

红外学习码上报。

参数说明

参数名称	说明
p_code	学习码数据
code_len	学习码数据长度

返回值

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

tuya_ir_code_free

OPERATE_RET tuya_ir_code_free(IN TY_IR_CODE_S *ir_code, IN UCHAR_T code_num);

功能说明

接收红外发送后，发送完，使用此函数进行释放资源。

参数说明

参数名称	说明
ir_code	红外码结构数组，详见 TY_IR_CODE_S
code_num	发送的红外按键个数

返回值

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

tuya_ir_study_stat_report

OPERATE_RET tuya_ir_study_stat_report(IN TY_IR_STUDY_CTL_E mode);

功能说明

学习码上报状态。

参数说明

参数名称	说明
mode	当前学习状态，定义如下。 TY_IR_STUDY_START：开始学习 TY_IR_STUDY_EXIT：退出学习

返回值

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

tuya_rf_control_register

OPERATE_RET tuya_rf_control_register(IN CONST TY_RF_CONTROL_CBS_S *p_ir_cbs);

功能说明

射频服务启动，注册回调函数组。

参数说明

参数名称	说明
p_ir_cbs	回调函数组，详见 TY_RF_CONTROL_CBS_S

返回值

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

tuya_rf_study_code_report

OPERATE_RET tuya_rf_study_code_report(IN CONST UCHAR_T *p_code,IN CONST UINT_T code_len,IN CONST UINT_T max_len);

功能说明

射频学习码上报。

参数说明

参数名称	说明
p_code	学习码数据
code_len	学习码数据长度
max_len	学习码最大长度。学习码长度不能最大长度

返回值

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

tuya_rf_study_stat_report

OPERATE_RET tuya_rf_study_stat_report(IN TY_RF_STUDY_CTL_E mode);

功能说明

射频学习状态上报。

参数说明

参数名称	说明
mode	当前学习状态，定义如下。 TY_IR_STUDY_START：开始学习 TY_IR_STUDY_EXIT：退出学习

返回值

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

回调接口

TY_IR_STUDY_CTL_CB

VOID (*TY_IR_STUDY_CTL_CB)(TY_IR_STUDY_CTL_E mode);

功能说明

报警发生回调接口。

参数说明

参数名称	说明
mode	当前学习状态，定义如下： TY_IR_STUDY_START：开始学习 TY_IR_STUDY_EXIT：退出学习

返回值

返回值	说明
VOID	/

TY_IR_SEND_CB

VOID (*TY_IR_SEND_CB)(TY_IR_CODE_S *ir_code, UCHAR_T code_num_type);

功能说明

报警消音回调接口。

参数说明

参数名称	说明
ir_code	红外码结构数组，详见 TY_IR_CODE_S
code_num_type	红外码结构数组个数

返回值

返回值	说明
VOID	/

TY_RF_STUDY_STATE_CB

VOID (*TY_RF_STUDY_STATE_CB)(TY_RF_STUDY_CTL_E mode);

功能说明

报警取消回调接口。

参数说明

参数名称	说明
mode	当前学习状态，定义如下。 TY_IR_STUDY_START：开始学习 TY_IR_STUDY_EXIT：退出学习

返回值

返回值	说明
VOID	/

TY_RF_SEND_CB

VOID (*TY_RF_SEND_CB)(UCHAR_T *rf_data,UCHAR_T rf_data_len,TY_RF_SEND_CTL_E type);

功能说明

撤防完成回调接口。

参数说明

参数名称	说明
rf_data	发送数据
rf_data_len	发送数据长度
type	数据类型定义如下： TY_RF_SEND_CONFIG_PKG ：发送配置包 TY_RF_SEND_PAIR_PKG：发送 PAIR 包 TY_RF_SEND_CMD_PKG：发送命令包 TY_RF_SEND_STUDYCODE_PKG ：发送 STUDYCODE 包

返回值

返回值	说明
VOID	/