Overview | 仙工智能帮助中心

帮助中心主页

Core API 协议文档

Overview

RDSCore是上海仙工智能科技有限公司（SEER）为搭载 SRC 系列核心控制器的移动机器人而开发的资源调度系统。该系统具备串并行任务模型，任务启动暂停终止管理，优先级、动态调度、抢占等高级特性，支持全局排程排产。
本手册是 RDSCore 的二次开发 API 使用手册，旨在帮助用户通过 API 进行二次开发，从而实现调度 SEER机器人的目的。

基本路径

[ Base URL: localhost:8088/ ]

例如服务器IP为 192.168.1.100的程序，API的基础路径为 http://192.168.1.100:8088/

名词释义

Name	Description
运单	为 `RDSCore` 执行任务的基本概念，一个运单由一系列子运单组成，每一个子运单为一个`动作块`，它定义了机器人可执行的动作；机器人按照顺序执行`动作块`，完成一系列动作，此为机器人执行运单的过程。
blocks	此为 `RDSCore` 中单个运单的`动作块`集合。描述了一系列机器人可执行的动作。
拼合单	拼合单是一种特殊运单，用于给拥有运输多个货物能力的机器人执行的运单。拼合单作用与地图中的库位，拼合单指令是将取货点、送货点等指令发给调度系统。调度系统依据当前机器人自身的空闲位置，a机器人当前和未来要去的目标点，以及新加入拼合单指令的起点和目标点，按总体路径最优的方式，将新的拼合单指令新加入到合适机器人的运单队列中。可以将拼合单理解为顺风车。

HTTP Verbs

Verb	Description
GET	用于获取数据
POST	用于创建数据

HTTP 提交数据说明

当 POST 请求的时候，请确保 Request Content-Type 是 application/json 类型。

json

req.Headers.Add("Content-Type", "application/json")

HTTP 状态码

200 - 成功
400 - 请求的参数不正确，或缺少必要信息，请对比文档
404 - 数据不存在，或未开放
406 - 无法接收请求
500 - 服务器异常

常用端口

Port	Description
19204	`RDSCore` 基本信息获取端口
19207	`RDSCore` 基本信息配置端口
19208	`Robod`数据交互端口
20204	`RDSCore`TCP端口
20206	`RDSCore`TCP端口
20207	`RDSCore`TCP端口
8080	`RDS`HTTP端口
8090	`RDS`HTTPS端口
8088	`RDSCore`HTTP端口
8089	`RDSCore WebSocket`端口
502	`RDSCore ModbusTCP`端口

响应错误码说明

请求会固定返回如下字段：

Name	Type	Description	Ignore
code	number	API 错误码	是
create_on	string	API 返回时间戳	是
msg	string	错误信息	是

其中，API 错误码为 HTTP 请求响应数据区 JSON 对象包含的错误码（code），用于指示对请求执行不成功或请求出错等错误。若 code 为 0 或缺省，说明没有错误，若不为0，说明发生了错误，错误码见下表:

错误码	名称	描述
40000	RDSCORE_NOT_ACTIVATED	RDSCore 未激活
50000	JSON_PARSE_ERROR	HTTP 请求数据格式不为 JSON
50001	JSON_FORMAT_ERROR	HTTP 请求数据 JSON 字段缺失或者字段类型错误
50002	REQ_UNAVAILABLE	不支持该请求
50003	REQ_NOT_ACCEPTABLE	该请求不可接受