RM红码信息相关特殊接口
[TOC]
RM产品简介
RM产品的基本功能是将接收到的红外码/遥控码通过红外发送出去，其本身因为存储空间的限制不具备保存红外码功能。所以，目前的RM产品都是将红外码保存在APP或者云端。
RM使用和控制机制
用户通过APP首先查询RM支持的品类，比如空调，电视，机顶盒，灯，风扇等，然后选择品类下的 品牌列表，比如格力，Aux，TCL，这时候APP会获取到一个红外码型号列表，用户通过UI界面和自己 要控制的设备进行匹配，一旦测试验证通过，APP就将对应的红外码保存下来。控制时，将红外码发送给RM即可。
BroadLink经过多年的积累，已经构建了目前全球最大的各品类的红外码库，涵盖全球所有知名品牌。 同时每个品类的功能都已经标准化，方便UI的交互设计。
对接流程介绍
获取品类列表
通过云端接口获取当前支持的品类列表，也可以固化部分品类，比如空调，电视
获取品类下的品牌列表
通过云端接口获取品类下的当前支持的品牌列表
获取品牌下的型号列表
获取品牌下的红码列表，该列表是有优先级的，排在前面的适配的产品更多
获取红外码编号，和对应的面板类型
通过SDK发送红外码
将红码按要求的格式通过SDK发送给RM后，用户可以观察自己的设备是否有响应，进而判断匹配是否成功， 若成功，则返回生成的面板信息。
云端注册与控制
通过调用云端的XX接口
SDK具体接口参考
- 发送红外码接口
public String deviceControl(String action, String params)
action: RM_Panel_Test
params:
{
"devicePairedInfo": devicePairedInfo // 配置成功上的设备信息
"data" : { // 云端返回信息
"pid":"", // 设备类型
"ircodeid":"", // 红外码ID
"timestamp":1514736000000, // 云端返回测试时间戳
"ircode": {
"function":"on", //本条红外码功能
"name":"空调打开"， //功能名称
"desc":"xxx", //本条红外码描述信息
"code":"2600121343241325243521342342141" //红外码值
}
}
"version": 1 // 配对版本
}
return:
{
"status":0,
"msg": "success",
"devicePairedInfo": devicePairedInfo // 新返回创建的设备信息
}
云端具体接口参考
- 获取品类列表
URL: https://xxxbizopenplatform.ibroadlink.com/openproxy/v2/ircode/info
header:
body:
{
"directive": {
"header": {
"namespace": "DNA.IrcodeInfo",
"name": "getdevtype",
"messageId": "1bd5d003-31b9-476f-ad03-71d471922820",
"interfaceVersion": "2"
},
"payload": {
}
}
}
return:
{
"context": {
},
"event": {
"header": {
"namespace": "DNA.IrcodeInfo",
"name": "Response",
"interfaceVersion": "2",
"messageId": "5f8a426e-01e4-4cc9-8b79-65f8bd0fd8a4",
},
"payload": {
"devtype": [{"devtypeid":int,"devtypename":string}]
}
}
}
- 获取品牌列表
URL: https://xxxbizopenplatform.ibroadlink.com/openproxy/v2/ircode/info
header:
body:
{
"directive": {
"header": {
"namespace": "DNA.IrcodeInfo",
"name": "getbrand",
"messageId": "1bd5d003-31b9-476f-ad03-71d471922820",
"interfaceVersion": "2"
},
"payload": {
"devtypeid":0
}
}
}
return:
{
"context": {
},
"event": {
"header": {
"namespace": "DNA.IrcodeInfo",
"name": "Response",
"interfaceVersion": "2",
"messageId": "5f8a426e-01e4-4cc9-8b79-65f8bd0fd8a4",
},
"payload": {
"brand": [{"brandid":int,"brand":string,"enbrand":string,"famousstatus":int}]
}
}
}
- 获取型号列表（目前只有云电机有型号）
URL: https://xxxbizopenplatform.ibroadlink.com/openproxy/v2/ircode/info
header:
body:
{
"directive": {
"header": {
"namespace": "DNA.IrcodeInfo",
"name": "getversion",
"messageId": "1bd5d003-31b9-476f-ad03-71d471922820",
"interfaceVersion": "2"
},
"payload": {
"devtypeid":0，
"brandid":1
}
}
}
return:
{
"context": {
},
"event": {
"header": {
"namespace": "DNA.IrcodeInfo",
"name": "Response",
"interfaceVersion": "2",
"messageId": "5f8a426e-01e4-4cc9-8b79-65f8bd0fd8a4",
},
"payload": {
"version": [{"versionid":0,"version":"","devtypeid":0,brandid:0}]
}
}
}
- 获取地区列表
URL: https://xxxbizopenplatform.ibroadlink.com/openproxy/v2/ircode/info
body:
{
"directive": {
"header": {
"namespace": "DNA.IrcodeInfo",
"name": "getlocate",
"messageId": "1bd5d003-31b9-476f-ad03-71d471922820",
"interfaceVersion": "2"
},
"payload": {
"locateid": 0 //父地区id，最高为0
}
}
}
return：
{
"context": {
},
"event": {
"header": {
"namespace": "DNA.IrcodeInfo",
"name": "Response",
"interfaceVersion": "2",
"messageId": "5f8a426e-01e4-4cc9-8b79-65f8bd0fd8a4",
},
"payload": {
"subareainfo": [
{
"locateid": 2405,
"levelid": 3,
"name": "朝阳市",
"isleaf": 1,
"status": "正常",
"initials": "C"
},
{
"locateid": 150,
"levelid": 3,
"name": "本溪市",
"isleaf": 1,
"status": "正常",
"initials": "B"
} ]
}
}
}
- 获取运营商列表
URL: https://xxxbizopenplatform.ibroadlink.com/openproxy/v2/ircode/info
body:
{
"directive": {
"header": {
"namespace": "DNA.IrcodeInfo",
"name": "getprovider",
"messageId": "1bd5d003-31b9-476f-ad03-71d471922820",
"interfaceVersion": "2"
},
"payload": {
"locateid": 51
}
}
}
return：
{
"context": {
},
"event": {
"header": {
"namespace": "DNA.IrcodeInfo",
"name": "Response",
"interfaceVersion": "2",
"messageId": "5f8a426e-01e4-4cc9-8b79-65f8bd0fd8a4",
},
"payload": {
"providerinfo": [
{
"providerid": 72,
"providername": "通用",
"providernameen": "",
"initials": "T"
},
{
"providerid": 179,
"providername": "大连广电",
"providernameen": "",
"initials": "D"
}
]
}
}
}
- 获取红码列表
URL: https://xxxbizopenplatform.ibroadlink.com/openproxy/v2/ircode/info
header:
body:
{
"directive": {
"header": {
"namespace": "DNA.IrcodeInfo",
"name": "getircode",
"messageId": "1bd5d003-31b9-476f-ad03-71d471922820",
"interfaceVersion": "2"
}
"payload": {
"devtypeid":0，
"brandid":1,//(电视、空调)
"versionid":0//(可选)
"providerid":1//(可选)
}
}
}
return:
{
"context":{},
"event":{
"header":{
"namespace":"DNA.IrcodeInfo",
"name":"Response",
"interfaceVersion":"2",
"messageId":"5f8a426e-01e4-4cc9-8b79-65f8bd0fd8a4"
},
"payload":{
"ircode":[
{
"pid":"",
"ircodeid":"",
"timestamp":1514736000000,
"ircode":[
{
"function":"on",
"name":"空调打开",
"desc":"空调打开，模式制热,23摄氏度，自动风",
"code":"2600121343241325243521342342141"
}
]
}
]
}
}
}
- rm空调红码一键匹配
body:
{
"directive": {
"header": {
"namespace": "DNA.IrcodeInfo",
"name": "matchircode",
"messageId": "1bd5d003-31b9-476f-ad03-71d471922820",
"interfaceVersion": "2"
},
"payload": {
"dnacode":"xxxxx"
}
}
}
return:
{
"context":{},
"event":{
"header":{
"namespace":"DNA.IrcodeInfo",
"name":"Response",
"interfaceVersion":"2",
"messageId":"5f8a426e-01e4-4cc9-8b79-65f8bd0fd8a4"
},
"payload":{
"retdata":[
{
"irid":int,
"name":"xxxx"
}
]
}
}
}
8.获取频道列表
URL: https://xxxbizopenplatform.ibroadlink.com/openproxy/v2/ircode/info
header:
body:
{
"directive": {
"header": {
"namespace": "DNA.IrcodeInfo",
"name": "getchannel",
"messageId": "1bd5d003-31b9-476f-ad03-71d471922820",
"interfaceVersion": "2"
},
"payload": {
"locateid":0,
"providerid":1,
}
}
}
return:
{
"context":{},
"event":{
"header":{
"namespace":"DNA.IrcodeInfo",
"name":"Response",
"interfaceVersion":"2",
"messageId":"5f8a426e-01e4-4cc9-8b79-65f8bd0fd8a4"
},
"payload":{
"tvchannel":[
{
"name":"xxx",
"famousstatus":0,
"channelid":11,
"serialnum":123
}
]
}
}
}
9.红码透传接口（测试红码匹配时使用）
POST https://(OpenproxyURL)/openproxy/v3/opencontrol?license=(license)
请求：
{
"directive": {
"header": {
"namespace": "DNA.FreeControl",
"name": "DnaCodeControl",
"interfaceVersion": "2",
"messageId": "1bd5d003-31b9-476f-ad03-71d471922820"
},
"endpoint": {
"endpointId": "Some-Device-ID",
"cookie": {}
},
"payload": {
"dnaCode":"b445sdfafad112224sdf"
}
}
}
响应：
{
"context": {//控制参数
"properties": [ {
"namespace": "DNA.FreeControl",
"name": "DnaCodeControl",
"value": "b445sdfafad112224sdf",//控制指令
"timeOfSample": "2017-02-03T16:20:50.52Z",
} ]
},
"event": {
"header": {
"namespace": "DNA.FreeControl",
"name": "Response",//成功返回标识
"interfaceVersion": "2",
"messageId": "5f8a426e-01e4-4cc9-8b79-65f8bd0fd8a4",
},
"endpoint": {
"endpointId": "appliance-001"//控制设备
cookie:{}
},
"payload": {
}
}
}
10.RM进入学习状态接口
POST https://(OpenproxyURL)/openproxy/v3/opencontrol?license=(license)
请求：
{
"directive": {
"header": {
"namespace": "DNA.RMControl",
"name": "StudyIrCode",
"interfaceVersion": "2",
"messageId": "1bd5d003-31b9-476f-ad03-71d471922820"
},
"endpoint": {
"endpointId": "Some-Device-ID",
"cookie": {}
},
"payload": {
}
}
}
响应：
{
"context": {
},
"event": {
"header": {
"namespace": "DNA.RMControl",
"name": "Response",//成功返回标识
"interfaceVersion": "2",
"messageId": "5f8a426e-01e4-4cc9-8b79-65f8bd0fd8a4",
},
"endpoint": {
"endpointId": "appliance-001"//控制设备
},
"payload": {
}
}
}
11.RM查询红码学习结果
POST https://(OpenproxyURL)/openproxy/v3/opencontrol?license=(license)
请求：
{
"directive": {
"header": {
"namespace": "DNA.RMControl",
"name": "GetIrCode",
"interfaceVersion": "2",
"messageId": "1bd5d003-31b9-476f-ad03-71d471922820"
},
"endpoint": {
"endpointId": "Some-Device-ID",
"cookie": {}
},
"payload": {
}
}
}
响应：
{
"context":{
},
"event":{
"header":{
"namespace":"DNA.RMControl",
"messageId":"30d2cd1a-ce4f-4542-aa5e-04bd0a6492d5",//新生成
"name":"GetIrCode",
"interfaceVersion":"2"
},
"endpoint":{
"endpointId":"appliance-001"
},
"payload":{
"code":"2600ac000700059e0001158911121211"
}
}
}
12获取红码匹配树
URL: https://xxxbizopenplatform.ibroadlink.com/openproxy/v2/ircode/info
header:
body:
{
"directive": {
"header": {
"namespace": "DNA.IrcodeInfo",
"name": "getircodetree",
"messageId": "1bd5d003-31b9-476f-ad03-71d471922820",
"interfaceVersion": "2"
}
"payload": {
"countrycode":"1",//可选 1 中国， 其他表示国外，不填默认为中国
"devtypeid":0，
"brandid":1,//(电视、空调)
"versionid":0//(可选)
"providerid":1//(机顶盒)
}
}
}
return:
{
"context":{},
"event":{
"header":{
"namespace":"DNA.IrcodeInfo",
"name":"Response",
"interfaceVersion":"2",
"messageId":"5f8a426e-01e4-4cc9-8b79-65f8bd0fd8a4"
},
"payload":{
"hotircode": {
"ircodeid": ["1234","343"],
"ircode":{
"1234":[{"key":"","codestr":"xxxxxxxxx"}],
"343":[{"key":"","codestr":"xxxxxxxxx"}]
}
},
"matchtree": {
"key": "power",
"codeList": [{
"codestr":"xxxxxxxxx",
"ircodeid": "",
"chirdren": {
"key": "volume_down",
"codeList": [{
"codestr":"xxxxxxxxx",
"ircodeid": "1179"
}]
}
},
{
"codestr":"xxxxxxxxx",
"ircodeid": "",
"chirdren": {
"key": "volume_down",
"codeList": [{
"codestr":"xxxxxxxxx",
"ircodeid": "1180"
}]
}
},
{
"codestr":"xxxxxxxxx",
"ircodeid": "",
"chirdren": {
"key": "volume_down",
"codeList": [{
"codestr":"xxxxxxxxx",
"ircodeid": "1175"
}]
}
},
{
"codestr":"xxxxxxxxx",
"ircodeid": "",
"chirdren": {
"key": "tv_av",
"codeList": [{
"codestr":"xxxxxxxxx",
"ircodeid": "",
"chirdren": {
"key": "menu",
"codeList": [{
"codestr":"xxxxxxxxx",
"ircodeid": "",
"chirdren": {
"key": "volume_down",
"codeList": [{
"code": [20,38],
"ircodeid": "1198"
},
{
"code": [20,38],
"ircodeid": "15582"
}
]
}
},
{
"codestr":"xxxxxxxxx",
"ircodeid": "",
"chirdren": {
"key": "volume_down",
"codeList": [{
"codestr":"xxxxxxxxx",
"ircodeid": "1212"
}]
}
}
]
}
}]
}
},
{
"codestr":"xxxxxxxxx",
"ircodeid": "",
"chirdren": {
"key": "volume_down",
"codeList": [{
"codestr":"xxxxxxxxx",
"ircodeid": "TV_0264"
}]
}
},
{
"codestr":"xxxxxxxxx",
"ircodeid": "",
"chirdren": {
"key": "tv_av",
"codeList": [{
"codestr":"xxxxxxxxx",
"ircodeid": "",
"chirdren": {
"key": "volume_down",
"codeList": [{
"codestr":"xxxxxxxxx",
"ircodeid": "971"
}]
}
},
{
"codestr":"xxxxxxxxx",
"ircodeid": "",
"chirdren": {
"key": "volume_down",
"codeList": [{
"codestr":"xxxxxxxxx",
"ircodeid": "TV_0178"
}]
}
}
]
}
}
]
}
}
}
}
13 获取红码支持范围
```
POST https://(OpenproxyURL)/openproxy/v2/ircode/info?license=(license)
body:
{
"directive": {
"header": {
"namespace": "DNA.IrcodeInfo",
"name": "getircodesupport",
"messageId": "1bd5d003-31b9-476f-ad03-71d471922820",
"interfaceVersion": "2"
}
"payload": {
"devtypeid":1，
"ircodeid":"123"
}
}
}
response:
{
"context" : {},
"event" : {
"header" : {
"interfaceVersion" : "2",
"messageId" : "efe037e3-fbf5-4cc9-a8a5-285fed620f70",
"name" : "Response",
"namespace" : "DNA.IrcodeInfo"
},
"payload" : {
"ircode" : [
{
"allfunction" : [
"0",
"power"
]
"ircodeid" : "123",
"timestamp" : 1563416029
}
]
}
}
}
```
14 根据品牌获取红码空调gz文件,需要由SDK来处理该文件进行空调红码控制
```
POST https://(OpenproxyURL)/openproxy/v2/ircode/info?license=(license)
body:
{
"directive": {
"header": {
"namespace": "DNA.IrcodeInfo",
"name": "getirfile",
"messageId": "1bd5d003-31b9-476f-ad03-71d471922820",
"interfaceVersion": "2"
}
"payload": {
"devtypeid":3，//int 固定值
"brandid":123,//int 品牌id
"versionid":0//(可选)
}
}
}
response:
{
"context": {},
"event": {
"header": {
"namespace": "DNA.IrcodeInfo",
"name": "Response",
"interfaceVersion": "2",
"messageId": "5f8a426e-01e4-4cc9-8b79-65f8bd0fd8a4",
},
"payload": {
"irfiles":[
{
"data":"1236",//string 红码文件数据，使用标准base64编码,需要base64解码后，保存为ircodeid.gz文件,供SDK调用
"ircodeid":"111" //string 红码id
}
]
}
}
}
```
15 根据红码ID获取红码空调gz文件,需要由SDK来处理该文件进行空调红码控制
```
POST https://(OpenproxyURL)/openproxy/v2/ircode/info?license=(license)
body:
{
"directive": {
"header": {
"namespace": "DNA.IrcodeInfo",
"name": "getirfilebyircodeid",
"messageId": "1bd5d003-31b9-476f-ad03-71d471922820",
"interfaceVersion": "2"
}
"payload": {
"devtypeid":3，//固定值
"ircodeid": "17407"
}
}
}
response:
{
"context": {},
"event": {
"header": {
"namespace": "DNA.IrcodeInfo",
"name": "Response",
"interfaceVersion": "2",
"messageId": "5f8a426e-01e4-4cc9-8b79-65f8bd0fd8a4",
},
"payload": {
"irfiles":[
{
"data":"1236",//红码文件数据，使用标准base64编码,需要base64解码后，保存为ircodeid.gz文件,供SDK调用
"ircodeid":"xxxxxx"//红码id
}
]
}
}
}
```
目前支持的面板品类
- 空调
- 电视
- 机顶盒
- 风扇
- 灯