【涂鸦物联网足迹】涂鸦云平台接口列表—万能红外遥控器

前序系列文章>>>

【涂鸦物联网足迹】涂鸦云平台接口列表

我们系列文章，都会围绕如何完成一款智能“隔空接吻机”的开发。希望能帮到各异地恋 or 异国恋的情侣们！

本文我们会大概讲解 API 接口列表中的垂直品类之一的万能红外遥控器~

目前涂鸦云开发平台除了提供了共 12 个基础的接口列表（见上一篇文章）， 还提供 5 个垂直品类的接口。所谓的“垂直品类”，就是基于场景化的接口啦~我们接下来一一介绍一下吧~

一、万能红外整体介绍：

万能红外：万能红外遥控器，也称万能红外网关，可替代国内外 99% 主流品牌红外遥控器，支持 DIY 学习功能。可以让家里的传统家电快速接入互联网，支持手机端控制，场景联动等各种丰富的功能。有关产品介绍和相关参数，请访问 万能红外遥控器。

其中场景类型包括：普通遥控器控制、机顶盒遥控器控制、空调遥控器，另外还有通用接口、红外码学习、红外码智能匹配、红外定时任务等等。

二、场景类接口列表：

普通遥控器控制

用于控制电视和风扇的遥控器类型。此场景只是推荐的红外流程，可以根据各自不同的需要，基于已开放的接口开发并丰富各自的业务流程场景。

       操作流程如下：

•    首先可以获取当前云云对接支持的红外设备类型；当前支持电视、机顶盒、空调和风扇类型；API(1)：API文档——获取红外支持的设备类型
  

• 根据想要控制的设备类型，选择一个类型获取支持的设备类型的品牌；API(2)：API文档——获取指定类型品牌列表
  

• 选择指定的品牌获取云云对接中预设的公版遥控器红外码库索引；API(3)：API文档——获取品牌支持遥控器索引列表
  

• 一个品牌可能会有多个不同的遥控器红外码库索引，这时需要试用是否合适需要控制的红外设备，一般建议至少测试三个按键有效后再确认添加遥控器；API(4)：API文档——控制遥控器：测试场景按键（基于通用标准按键）
  

• 确认可用的遥控器红外码库索引后，使用此索引绑定普通遥控器到万能红外遥控器设备上；API(7)：API文档——添加普通遥控器
  

• 使用普通遥控器，基于标准红外指令控制设备，标准指令参考；API(8)：API文档——控制遥控器：已添加遥控器（基于通用标准按键）
  

API 列表：

• 获取红外支持的设备类型：获取红外设备支持的设备类型，目前支持电视，机顶盒，空调，风扇等。

• 获取指定类型品牌列表：按遥控器类型获取品牌列表,支持电视和空调。

• 获取品牌支持遥控器索引列表：根据品牌 id 获取指定品牌下所有型号的遥控器索引列表。

• 添加普通遥控器：添加一款指定型号的遥控器，形成一个实例化的虚拟遥控器。

机顶盒遥控器控制

机顶盒设备支持 IPTV 和非 IPTV 。此场景只是推荐的红外流程，可以根据各自不同的需要，基于已开放的接口开发并丰富各自的业务流程场景。

操作流程：

• 首先获取支持的红外设备类型；API(1)：API文档——获取红外支持的设备类型
  

• 选择相应的地址；

API(2)：API文档——获取省份列表

API(3)：API文档——获取城市列表

API(4)：API文档——获取区域列表

• 根据所在的区域，获取指定区域支持的运营商信息列表；API(5)：API文档——获取运营商列表：根据区域
  

• 根据选择的运营商，获取支持的设备品牌；API(6)：API文档——获取品牌列表：根据运营商
  

• 选择指定的品牌获取云云对接中预设的公版遥控器红外码库索引；

API(7)：API文档——获取遥控器索引列表：根据品牌

API(8)：API文档——获取遥控器索引列表：根据区域

• 一个品牌可能会有多个不同的遥控器红外码库索引，这时需要试用是否合适需要控制的红外设备，一般建议至少测试三个按键有效后再确认添加遥控器；API(9)：API文档——控制遥控器：测试场景按键（基于通用标准按键）
  

• 确认可用的遥控器红外码库索引后（即某型号遥控器可用），使用此索引绑定机顶盒遥控器到万能红外遥控器设备上；API(12)：API文档——添加机顶盒遥控器
  

• 使用刚才添加的遥控器，基于标准红外指令控制设备，标准指令参考；API(13)：API文档——控制遥控器：已添加遥控器（基于通用标准按键）
  

API 列表：

• 获取省份列表：获取省份列表。

• 获取城市列表：根据省份 ID 获取城市列表。

• 获取区域列表：根据省份 ID 和城市 ID 获取区域列表。

• 根据区域获取运营商列表：针对于机顶盒类型设备，可获取指定区域支持的 IPTV s 列表。

• 根据运营商获取品牌列表：针对机顶盒设备，根据运营商支持的品牌列表。

• 根据品牌/区域获取遥控器索引列表：根据类型 ID/区域 ID 获取支持 IPTV 运营商的遥控器索引。

• 添加机顶盒遥控器：添加机顶盒遥控器。

• 查询电视频道列表：根据遥控器 ID 查询频道列表。

• 切换电视频道：切换电视片频道

空调遥控器控制

此场景只是推荐的红外流程，可以根据各自不同的需要，基于已开放的接口开发并丰富各自的业务流程场景。。

操作流程：

•    获取支持的红外空调设备的品牌；API(1)：API文档——获取指定类型品牌列表
  

• 选择指定的品牌获取遥控器红外码库索引；API(2)：API文档——获取品牌支持遥控器索引列表
  

• 一个品牌可能会有多个不同的遥控器红外码库索引，这时需要试用是否合适需要控制的红外设备，一般建议至少测试三个按键有效后再确认添加遥控器；API(3)：API文档——测试空调遥控器
  

• 确认可用的遥控器红外码库索引后，使用此索引绑定空调遥控器到万能红外遥控器设备上；API(4)：API文档——添加普通遥控器
  

• 使用普通遥控器，基于标准红外指令控制设备；标准指令参考：API文档——控制遥控器：已添加遥控器（基于通用标准按键）
  

或者空调专有指令控制设备；API(5)：API文档——控制空调遥控器

• 部分业务场景存在直接控制空调相关参数的情况，调用多条件的空调指令直接控制空调的相关参数，但请注意并不是所有的组合条件都可以支持直接下发红外码；API(6)：API文档——多条件控制空调
  

空调类遥控器只支持 API 文档中描述的标准指令，不支持非标准指令。

API 列表

• 测试空调遥控器：用于在测试空调遥控器是否匹配空调设备时，根据遥控器索引下发单个的空调遥控器按键指令。

• 控制空调遥控器：下发单个的空调遥控器按键指令。

• 多条件控制空调：多条件的空调指令下发，用于在部分联动场景下对空调的控制。

• 查询空调状态：查询空调状态。

三、其他接口列表：

通用接口 API 列表：

• 获取红外设备下面绑定的遥控器列表：根据红外设备 ID 来获取红外设备下面绑定的遥控器列表。

• 添加/删除/设置遥控器：此接口可以兼容机顶盒、电视、空调等类型设备的遥控器添加/删除/设置。

• 获取遥控器配对规则：根据遥控器 ID 获取配对规则，获取到 key 用于红外码下发。

• 控制遥控器：测试场景按键（基于通用标准按键）：在测试遥控器是否匹配设备时使用。使用通用标准 key 控制，标准 key 见附录。支持空调的标准指令下发。

• 控制遥控器：测试场景按键（基于配对规则）：在测试遥控器是否匹配设备时使用。根据 key 来下发红外码，请求参数中的 key 是从获取配对规则中获得 key。非标准指令不支持空调，空调使用专有的指令下发。

• 控制遥控器：已添加遥控器（基于配对规则）：控制已绑定的遥控器下发指令，根据 raw_key 来下发红外码，请求参数中的 raw_key 是从获取配对规则中获得 key，目前这个接口只支持电视和机顶盒，空调使用专有的指令下发。

• 获取遥控器支持的按键列表：可查询指定遥控器支持的按键列表，同时返回可支持的标准 key 和非标准 key。

• 获取空调遥控器支持的按键规则列表：仅查询指定空调类的遥控器支持的按键列表，同时返回可支持的标准 key 和非标准 key，同时返回支持的按键范围。

红外码学习 API 列表

开启学习状态后，再使用真实的遥控器对准万能红外设备按下需要学习的按键，然后再使用查询学习到的学习码的 API 获取学习到的学习码。

• 更新学习状态：进入学习状态

• 查询学习到的红外码：获取学习到的红外码。传入的参数建议直接使用更新学习状态时返回的时间戳 t。

• 下发/更新/删除学习到的红外码：下发/更新/删除学习到的红外码。

• 保存学习到的红外码：保存学习到的红外码，生成遥控器 id

• 获取保存的学习红外码：获取保存的学习红外码

红外码智能匹配 API 列表

部分品牌下的预设的遥控器红外码库索引可能比较多，有时候为了尝试出某个索引是否支持需要控制的设备，可能需要测试多次，造成匹配成功一个遥控器需要耗费大量的时间和精力。​ 因此提供红外码智能匹配功能，可以根据学习到的红外码来快速匹配遥控器红外码库索引。

前提是需要提供真实的遥控器进行学习匹配。

操作流程：

1. 开启红外网关学习状态；API文档——更新学习状态
   

2. 用户使用遥控器对准红外网关发送红外码；

3. 获取红外网关学习到的学习码； API文档——查询学习到的红外码
   

4. 使用学习到的 学习码 请求智能匹配，返回 智能匹配 token； API文档——生成智能匹配令牌
   

5. 使用 智能匹配 token 请求匹配列表；API文档——获取智能匹配遥控器列表
   

6. 用户在返回的匹配列表中依次查看遥控器索引信息； API文档——获取遥控器索引支持的品牌信息
   

7. 循环尝试匹配列表的遥控器索引中的按键；

API文档——控制遥控器：测试场景按键（基于通用标准按键）

API文档——测试空调遥控器

1. 如果找到合适的，则确认遥控器，结束此次智能匹配动作；否则继续后续步骤；API文档——添加遥控器
   

2. 如果未找到合适的，则继续使用 智能匹配 token 请求匹配列表，进行步骤 5 的操作，这里就是在有多个匹配结果的时候，进行的分页处理，如果只有 1 页，则不需要再进行步骤 5 的操作；

3. 如果接口返回无数据，则匹配列表结束；

4. 如果需要进一步缩小匹配范围，则可以再次开启红外网关学习状态，下发新的学习码，然后获取新的 智能匹配 token （步骤 1、2、3、4）；

5. 然后使用新的 智能匹配 token 同时带上步骤 5 中的旧的 智能匹配 token 一起请求匹配列表，系统则会在使用步骤 3 学习到的红外码匹配的基础上，再使用步骤 11 获取的红外码进一步缩小匹配范围；

6. 然后再重复步骤 6、7、8、9、10、11，直到找到合适的遥控器索引，或者未匹配到。

API 列表：

• 生产智能匹配令牌：使用红外网关学习到的红外码，生成智能匹配令牌 token，用于后续分页查询智能匹配结果。

• 获取智能匹配遥控器列表：使用生成的智能匹配令牌 token，分页查询智能匹配结果列表。

• 获取遥控器索引支持的品牌信息：查询指定遥控器索引支持的品牌的信息。

红外定时任务 API 列表

• 添加红外定时任务：添加一个红外定时任务。

• 获取/更新/删除红外定时任务：查询/更新/删除红外定时任务。

• 删除所有定时任务：删除所有定时任务。

• 更新红外分组定时状态：更新红外分组定时状态。

以上所有所有接口地址可在此处查询>>>涂鸦云平台接口列表