仙知網絡協議API使用指南

  上回，我們介紹了仙知網絡協議API的概念及API的類別。

  接下來的教程里將詳細講解：

  API使用教程、機器人狀態API、機器人控制API、機器人導航API、機器人配置API、其他API。

一、API 使用教程

  （一）常見方法

  本教程將介紹使用本 TCP API 協議控制機器人進行連續的路徑導航。

  （二）路徑導航流程

  1、機器人開機

  2、等待機器人啟動完成（使用 TCP 連接機器人成功后即為啟動完成）

  3、執行重定位2002

  4、查詢定位狀態，等待定位完成 1021

  5、確認定位正確 2003

  6、執行路徑導航 3051

  7、查詢導航狀態，等待導航完成 1020

  8、循環執行 6、7 即可實現持續的路徑導航

  提示：

  如果移動機器人上一次關機時定位正確，并且關機后移動機器人位置沒有移動，那么移動機器人開機后步驟 3 可以省略，查詢到定位完成后直接確認定位正確即可。

  （三）機器人狀態 API

  機器人狀態 API 用于查詢機器人的所有狀態量。

  （四）API 列表

  1、請求

  2、響應

  3、API 使用注意事項

  1）.JSON 中的類型為 Javascript 中的類型, 可以是數字(number)、字符串(string)、布爾值(boolean)、數組(array)、對象(object)、null；

  2）.所有未特別說明的數值的單位均為國際單位, 如 m、rad, m/s 等；

  3）.API響應的編號為請求的編號 + 10000 (0x2710), 請求與響應一一對應；

  4）.請不要發送任何非 ACSII 字符，特別是地圖名相關的操作，含有中文字符的地圖名將會被認為是非法的；

  5）.每一次返回的數據區 JSON Object 中 Key 的順序是不保證的，因為 JSON 并沒有規定這一點

上海仙工智能科技有限公司（簡稱仙工智能或 SEER）由 RoboCup 世界冠軍團隊創立，是一家以智能控制及數字化為核心的工業物流解決方案提供商。公司總部位于上海，全國設有 7 個辦事處、2 個生產基地，業務遍及全球 20 多個國家和地區。

仙工智能掌握世界領先的技術與理念，打造智能、高效、可靠、易用的端到端工業物流解決方案，方案涵蓋移動機器人控制器、各類移動機器人及相關數字化系統軟件，幫助客戶降本增效，實現智能化與數字化升級。

以【惠人達己，守正出奇，始終創業，追求極致】的品牌價值觀為導向，憑借卓越的產品力、方案力與服務力，仙工智能為西門子、菲尼克斯、濰柴動力、格力等全球 800 多家企業提供服務。客戶覆蓋半導體、3C、鋰電、光伏、汽車零部件、PCB、紡織、醫療等行業，項目交付率達 100%。仙工智能，以實力引領工業物流智能化進程。