仙知网络协议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%。仙工智能，以实力引领工业物流智能化进程。