前序系列文章 >>>
【涂鸦物联网脚印】涂鸦云平台接口列表
咱们系列文章,都会围绕如何实现一款智能“隔空接吻机”的开发。心愿能帮到各异地恋 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 列表
局部品牌下的预设的遥控器红外码库索引可能比拟多,有时候为了尝试出某个索引是否反对须要管制的设施,可能须要测试屡次,造成匹配胜利一个遥控器须要消耗大量的工夫和精力。 因而提供红外码智能匹配性能,能够依据学习到的红外码来疾速匹配遥控器红外码库索引。
前提是须要提供实在的遥控器进行学习匹配。
操作流程:
- 开启红外网关学习状态;API 文档——更新学习状态
- 用户应用遥控器对准红外网关发送红外码;
- 获取红外网关学习到的 学习码;API 文档——查问学习到的红外码
- 应用学习到的 学习码 申请智能匹配,返回 智能匹配token;API 文档——生成智能匹配令牌
- 应用 智能匹配token 申请匹配列表;API 文档——获取智能匹配遥控器列表
- 用户在返回的匹配列表中顺次查看遥控器索引信息;API 文档——获取遥控器索引反对的品牌信息
- 循环尝试匹配列表的遥控器索引中的按键;
API 文档——管制遥控器:测试场景按键(基于通用规范按键)
API 文档——测试空调遥控器
- 如果找到适合的,则确认遥控器,完结此次智能匹配动作;否则持续后续步骤;API 文档——增加遥控器
- 如果未找到适合的,则持续应用 智能匹配token 申请匹配列表,进行步骤 5 的操作,这里就是在有多个匹配后果的时候,进行的分页解决,如果只有 1 页,则不须要再进行步骤 5 的操作;
- 如果接口返回无数据,则匹配列表完结;
- 如果须要进一步放大匹配范畴,则能够再次开启红外网关学习状态,下发新的学习码,而后获取新的 智能匹配token(步骤 1、2、3、4);
- 而后应用新的 智能匹配 token 同时带上步骤 5 中的旧的 智能匹配token 一起申请匹配列表,零碎则会在应用步骤 3 学习到的红外码匹配的根底上,再应用步骤 11 获取的红外码进一步放大匹配范畴;
- 而后再反复步骤 6、7、8、9、10、11,直到找到适合的遥控器索引,或者未匹配到。
API列表:
- 生产智能匹配令牌:应用红外网关学习到的红外码,生成智能匹配令牌 token,用于后续分页查问智能匹配后果。
- 获取智能匹配遥控器列表:应用生成的智能匹配令牌 token,分页查问智能匹配后果列表。
- 获取遥控器索引反对的品牌信息:查问指定遥控器索引反对的品牌的信息。
红外定时工作 API 列表
- 增加红外定时工作:增加一个红外定时工作。
- 获取 / 更新 / 删除红外定时工作:查问 / 更新 / 删除红外定时工作。
- 删除所有定时工作:删除所有定时工作。
- 更新红外分组定时状态:更新红外分组定时状态。
以上所有所有接口地址可在此处查问 >>> 涂鸦云平台接口列表