【塗鴉物聯網足跡】塗鴉雲平臺接口列表—萬能紅外遙控器

前序系列文章>>>

【塗鴉物聯網足跡】塗鴉雲平臺接口列表

咱們系列文章，都會圍繞如何完成一款智能「隔空接吻機」的開發。但願能幫到各異地戀or異國戀的情侶們！

本文咱們會大概講解API接口列表中的垂直品類之一的萬能紅外遙控器~

目前塗鴉雲開發平臺除了提供了共12個基礎的接口列表（見上一篇文章）， 還提供5個垂直品類的接口。所謂的「垂直品類」，就是基於場景化的接口啦~咱們接下來一一介紹一下吧~

1、萬能紅外總體介紹：

萬能紅外：萬能紅外遙控器，也稱萬能紅外網關，可替代國內外 99% 主流品牌紅外遙控器，支持 DIY 學習功能。可讓家裏的傳統家電快速接入互聯網，支持手機端控制，場景聯動等各類豐富的功能。有關產品介紹和相關參數，請訪問 萬能紅外遙控器。

其中場景類型包括：普通遙控器控制、機頂盒遙控器控制、空調遙控器，另外還有通用接口、紅外碼學習、紅外碼智能匹配、紅外定時任務等等。

2、場景類接口列表：

普通遙控器控制

用於控制電視和風扇的遙控器類型。此場景只是推薦的紅外流程，能夠根據各自不一樣的須要，基於已開放的接口開發並豐富各自的業務流程場景。

操做流程以下：

• 首先能夠獲取當前云云對接支持的紅外設備類型；當前支持電視、機頂盒、空調和風扇類型；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列表

• 測試空調遙控器：用於在測試空調遙控器是否匹配空調設備時，根據遙控器索引下發單個的空調遙控器按鍵指令。
• 控制空調遙控器：下發單個的空調遙控器按鍵指令。
• 多條件控制空調：多條件的空調指令下發，用於在部分聯動場景下對空調的控制。
• 查詢空調狀態：查詢空調狀態。

3、其餘接口列表：

通用接口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 （步驟一、二、三、4）；
5. 而後使用新的 智能匹配token 同時帶上步驟5中的舊的 智能匹配token 一塊兒請求匹配列表，系統則會在使用步驟3學習到的紅外碼匹配的基礎上，再使用步驟11獲取的紅外碼進一步縮小匹配範圍；
6. 而後再重複步驟六、七、八、九、十、11，直到找到合適的遙控器索引，或者未匹配到。

API列表：

• 生產智能匹配令牌：使用紅外網關學習到的紅外碼，生成智能匹配令牌token，用於後續分頁查詢智能匹配結果。
• 獲取智能匹配遙控器列表：使用生成的智能匹配令牌token，分頁查詢智能匹配結果列表。
• 獲取遙控器索引支持的品牌信息：查詢指定遙控器索引支持的品牌的信息。

紅外定時任務API列表

• 添加紅外定時任務：添加一個紅外定時任務。
• 獲取/更新/刪除紅外定時任務：查詢/更新/刪除紅外定時任務。
• 刪除全部定時任務：刪除全部定時任務。
• 更新紅外分組定時狀態：更新紅外分組定時狀態。

以上全部全部接口地址可在此處查詢>>>塗鴉雲平臺接口列表