3.1. 協議格式¶
3.1.1. 控制命令¶
IN：<obj> <command> <params> [<seq>];
- 描述
- 控制命令協議格式，一般用來與機器人做控制上的交互
- 以
;作為結束符
- 參數
- obj (str): 控制對像字符串
- command (str): 控制命令字符串
- params (str): 命令參數字符串，一般為 <key> <value> 形式
- seq (str): 命令序號字符串，一般為 seq <seq_value> 形式，可選參數
OUT：<result> [<seq>];
- 描述
- 控制命令響應結果協議格式，一般用來確認控制命令執行結果
- 不做特殊說明的情況下，所有控制命令均有響應結果
- 以
;作為結束符
- 參數
- result (exec_result_enum): 執行結果字符串
- seq (str): 執行結果序號字符串，一般為 seq <seq_value> 形式
備註
<seq>
<seq> 可用來標識當前消息的唯一性，當控制命令中帶有 <seq> 參數時， 對應命令的響應結果結果中即包含對應的序號
3.1.2. 消息推送¶
OUT: <obj> push <attr> <value>;
- 描述
- 消息推送協議格式，通過控制命令打開某消息推送後即可接收到
- 消息推送將會以固定的頻率進行的推送，推送頻率取決於使能當前消息推送時的頻率設置
- 以
;作為結束符
- 參數
- obj (str): 推送對像
- attr (str): 推送數據屬性
- value (str): 推送數據數值
3.1.3. 事件上報¶
OUT: <obj> event <attr> <value>;
- 描述
- 事件上報協議格式，通過控制命令打開某事件上報開關後即可接收到
- 以
;作為結束符
- 參數
- obj (str): 發生事件的對象
- attr (str): 事件數據屬性
- value (str) 事件數據數值
備註
觸發機制
當成功使能對應 事件上報 功能後，若發生事件，則會進行一次事件上報
3.1.4. IP 廣播¶
OUT: robot ip <addr>;
- 參數
- addr (str): 當前連接模式下的機器人的 IPv4 地址
備註
廣播生命週期
當處於 Wi-Fi 組網 模式下，機器人會不斷在對應端口上廣播自己的 IPv4 地址，您可通過該 IP 地址連接到機器人，當成功連接後，廣播停止
3.1.5. 視頻流¶
OUT: H.264 編碼實時視頻流數據，分辨率為 1280*720，刷新率為 30 FPS，需要對視頻流數據進行正確的解碼操作才能實時顯示視頻畫面。
3.1.6. 音頻流¶
OUT: Opus 編碼實時音頻流數據，採樣率為 48000 bps，幀大小為 960 bit，單通道，需要對音頻流數據進行正確的解碼操作才能實時播放音頻。
備註
IN/OUT
該文檔中，控制指令中出現的前綴 IN 或者 OUT 在控制指令中無實際意義，僅為標識以機器人為主體的情況下，當前指令的數據流向：
IN：標識當前數據為從外部設備發送至機器人
OUT：標識當前數據為從機器人發送至外部設備
實際使用中，請忽略該標識，僅發送和接收實際的控制命令即可