更新时间:2024-06-05 03:15:12下载pdf
```mermaid %%{init: { "sequence": { "wrap": true} } }%% sequenceDiagram title: 红外学习 Actor 用户 as 用户 participant 小程序 as 小程序 participant 云端 as 云端 participant 万能红外遥控器 as 万能红外遥控器 participant 红外设备 as 红外设备 用户->>小程序: 请求开启学习状态 小程序->>云端: infrared.learningState 云端->>万能红外遥控器: -->>云端: -->>小程序: 开启学习状态成功 用户->>万能红外遥控器: -->>云端: 上报红外码 小程序->>云端: -->>小程序: 返回红外码 用户->>小程序: 关闭学习状态 小程序->>云端: -->>万能红外遥控器: -->>云端: -->>小程序: 关闭学习状态成功 opt [可选动作] 用户->>小程序: 保存学习到的红外码 小程序->>云端: -->>小程序: 返回学习设备对应的虚拟遥控器 remote_id 用户->>小程序: 更新学习到的红外码 小程序->>云端: -->>小程序: 返回学习设备对应的虚拟遥控器 remote_id(与传入的相同) 用户->>小程序: 删除学习到的红外码 小程序->>云端: -->>小程序: 返回删除结果(是否删除成功) 用户->>小程序: 获取保存的学习红外码 小程序->>云端: -->>小程序: 返回保存的学习红外码 用户->>小程序: 下发学习到的红外码 小程序->>云端: infrared.learningCodeSend 云端->>万能红外遥控器: 下发红外码 万能红外遥控器->>红外设备: 发送红外码 end ```
action | 说明 |
---|---|
infrared.learningState | 更新学习状态 |
infrared.learningCode | 查询学习到的红外码 |
infrared.learningCodeSave | 保存学习到的红外码 |
infrared.learningCodeUpdate | 修改学习到的红外码 |
infrared.learningCodeInfos | 获取保存的学习到的红外码 |
infrared.learningCodeDelete | 删除学习到的红外码 |
infrared.learningCodeSend | 下发学习到的红外码 |
接口说明
使红外网关进入学习状态。
接⼝地址
action: infrared.learningState
请求参数
参数名 | 类型 | 说明 | 是否必填 |
---|---|---|---|
infrared_id | String | 红外设备 ID | 是 |
state | String | 是否进入学习模式:true :是false :否 |
是 |
请求示例
{
"action": "infrared.learningState",
"params": {
"infrared_id": "vdevo157924607038167",
"state": "true"
}
}
响应参数
参数名 | 类型 | 说明 |
---|---|---|
code | Integer | 响应码 |
success | Boolean | 是否成功:true :成功false :失败 |
msg | String | 请求失败的信息,成功时为空 |
result | Boolean | 切换成功,返回 true |
t | Long | 进⼊入学习模式的时间 |
响应示例
{
"success": true,
"t": 1545135036437,
"result": true
}
接口说明
获取红外网关在学习状态下学习到的红外码。
接⼝地址
action: infrared.learningCode
请求参数
参数名 | 类型 | 说明 | 是否必填 |
---|---|---|---|
infrared_id | String | 红外设备 ID | 是 |
learning_time | String | 进⼊入学习模式的时间 | 是 |
请求示例
{
"action": "infrared.learningCode",
"params": {
"infrared_id": "vdevo157924607038167",
"learning_time": "1545135036437"
}
}
响应参数
参数名 | 类型 | 说明 |
---|---|---|
code | Integer | 响应码 |
success | Boolean | 是否成功:true :成功false :失败 |
msg | String | 请求失败的信息,成功时为空 |
result | Object | 返回结果 |
result 参数说明
参数名 | 类型 | 说明 |
---|---|---|
success | Boolean | 是否学习到红外码 |
code | String | 学习到的红外码(当 success 为 false 时,值为空) |
响应示例
{
"result": {
"code": "xxxxxxx",
"success": true
},
"success": true,
"t": 1584019201214
}
接口说明
同时保存学习到的一个或多个红外码,生成并返回遥控器 ID。
接⼝地址
action: infrared.learningCodeSave
请求参数
参数名 | 类型 | 说明 | 是否必填 |
---|---|---|---|
infrared_id | String | 红外设备 ID | 是 |
codes | List | 保存的红外信息 | 是 |
codes 参数
参数名 | 类型 | 说明 |
---|---|---|
name | String | 学习到的红外码的名称 |
key_name | String | 学习到的红外码按键名称 |
code | String | 学习到的红外码 |
请求示例
{
"action": "infrared.learningCodeSave",
"params": {
"infrared_id": "vdevo157924607038167",
"codes": [
{
"name": "1584019201214",
"key_name": "电源",
"code": "xxxxxx"
},
{
"name": "15840193485764",
"key_name": "音量+",
"code": "xxxxxxx"
}
]
}
}
响应参数
参数名 | 类型 | 说明 |
---|---|---|
code | Integer | 响应码 |
success | Boolean | 是否成功:true :成功false :失败 |
msg | String | 请求失败的信息,成功时为空 |
result | Object | 返回结果 |
result 参数说明
参数名 | 类型 | 说明 |
---|---|---|
remote_id | String | 遥控器 ID |
响应示例
{
"success": true,
"t": 1545135036437,
"result": {
"remote_id":"xxxx"
}
}
接口说明
更新修改学习到的遥控器。
接⼝地址
action: infrared.learningCodeUpdate
请求参数
参数名 | 类型 | 说明 | 是否必填 |
---|---|---|---|
infrared_id | String | 红外设备 ID | 是 |
codes | List | 保存的红外信息 | 是 |
codes 参数
参数名 | 类型 | 说明 |
---|---|---|
name | String | 学习到的红外码的名称 |
key_name | String | 学习到的红外码按键名称 |
code | String | 学习到的红外码 |
请求示例
{
"action": "infrared.learningCodeUpdate",
"params": {
"infrared_id": "vdevo157924607038167",
"codes": [
{
"name": "1584019201214",
"key_name": "电源",
"code": "yyyyy"
}
]
}
}
响应参数
参数名 | 类型 | 说明 |
---|---|---|
code | Integer | 响应码 |
success | Boolean | 是否成功:true :成功 false :失败 |
msg | String | 请求失败的信息,成功时为空 |
result | Object | 返回结果 |
result 参数说明
参数名 | 类型 | 说明 |
---|---|---|
remote_id | String | 遥控器 ID |
响应示例
{
"success": true,
"t": 1545135036437,
"result": {
"remote_id":"xxxx"
}
}
接口说明
获取保存的学习到的红外码的遥控器。
接⼝地址
action: infrared.learningCodeInfos
请求参数
参数名 | 类型 | 说明 | 是否必填 |
---|---|---|---|
infrared_id | String | 红外设备 ID | 是 |
remote_id | String | 遥控器 ID | 是 |
请求示例
{
"action": "infrared.learningCodeInfos",
"params": {
"infrared_id": "vdevo157924607038167",
"remote_id": "xxxxxx"
}
}
响应参数
参数名 | 类型 | 说明 |
---|---|---|
code | Integer | 响应码 |
success | Boolean | 是否成功:true :成功false :失败 |
msg | String | 请求失败的信息,成功时为空 |
result | Object | 返回结果 |
result 参数说明
参数名 | 类型 | 说明 |
---|---|---|
code | String | 学习到的红外码 |
name | String | 红外码的名称 |
key_name | String | 学习到的红外码按键 |
id | Long | 学习到的红外码的 ID |
remote_id | String | 遥控器 ID |
响应示例
{
"result": [
{
"code": "xxxxx",
"id": 1294005,
"key_name": "电源",
"name": "1584011048645",
"remote_id": "xxxxx"
},
{
"code": "yyyyy",
"id": 1294008,
"key_name": "音量+",
"name": "1584011186158",
"remote_id": "xxxxx"
}
],
"success": true,
"t": 1584019606407
}
接口说明
删除学习到的红外码。
接⼝地址
action: infrared.learningCodeDelete
请求参数
参数名 | 类型 | 说明 | 是否必填 |
---|---|---|---|
infrared_id | String | 红外设备 ID | 是 |
id | String | 学习到的红外码的 ID | 是 |
请求示例
{
"action": "infrared.learningCodeDelete",
"params": {
"infrared_id": "vdevo157924607038167",
"id": "1294009"
}
}
响应参数
参数名 | 类型 | 说明 |
---|---|---|
code | Integer | 响应码 |
success | Boolean | 是否成功:true :成功false :失败 |
msg | String | 请求失败的信息,成功时为空 |
result | Object | 删除是否成功 |
响应示例
{
"success": true,
"t": 1545135036437,
"result": true
}
接口说明
删除学习到的红外码。
接⼝地址
action: infrared.learningCodeSend
请求参数
参数名 | 类型 | 说明 | 是否必填 |
---|---|---|---|
infrared_id | String | 红外设备 ID | 是 |
remote_id | String | 遥控器 ID(如果没有,则填 TUYA ) |
是 |
code | String | 学习到的红外码 | 是 |
请求示例
{
"action": "infrared.learningCodeSend",
"params": {
"infrared_id": "vdevo157924607038167",
"remote_id": "xxxxxx",
"code": "xxxxxx"
}
}
响应参数
参数名 | 类型 | 说明 |
---|---|---|
code | Integer | 响应码 |
success | Boolean | 是否成功:true :成功false :失败 |
msg | String | 请求失败的信息,成功时为空 |
result | Boolean | 删除是否成功 |
响应示例
{
"success": true,
"t": 1545135036437,
"result": true
}
该内容对您有帮助吗?
是意见反馈该内容对您有帮助吗?
是意见反馈