仙知网络协议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 并没有规定这一点