获取机器人的信息集合 | 仙工智能帮助中心

帮助中心主页

SRD API 协议

获取机器人的信息集合

请求

功能：获取机器人的信息集合
方法：GET
接口说明：/vehicles

json

GET "http://host:7100/api/route/vehicles"

参数介绍

Name	Type	Description
procState	string	以机器人的业务状态，对机器人进行筛选 - UNAVAILABLE：机器人不可利用 - IDLE：机器人处于空闲状态 - AWAITING_ORDER：机器人在等待运单中新的子任务 - PROCESSING_ORDER：机器人正在执行运单

响应

Responses Code 200

响应示例

json

[
  {
    "name": "AMB-01",
    "properties": {
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    },
    "categories": [
      "groupA"
    ],
    "energyLevelGood": "90",
    "energyLevelCritical": "30",
    "energyLevelFullyRecharged": "95",
    "energyLevelSufficientlyRecharged": "35",
    "energyLevel": "60",
    "integrationLevel": "TO_BE_IGNORED",
    "procState": "UNAVAILABLE",
    "transportOrder": "TOrder-01",
    "orderSequence": "TOrder-01",
    "currentDestination": "Location-01",
    "unfinishedSteps": [
      "LM11 --- LM12"
    ],
    "paused": true,
    "loadDevices": [
      {
        "label": "basket",
        "full": true
      }
    ],
    "errorInfos": [
      {
        "timestamp": "2018-05-17T06:42:40Z",
        "count": 1,
        "level": "fatal, error, warning, info, etc.",
        "message": "报警代码 + 报警内容"
      }
    ],
    "owner": "srd@localhost",
    "isDominating": true,
    "allocations": [
      "LM11 --- LM12"
    ],
    "adapterEnabled": true,
    "currentPosition": "LM01",
    "state": "UNKNOWN"
  }
]

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

参数释义

Name	Type	Description	Example
name	string	机器人的名称	AMB-01
properties	string	机器人的元属性
categories	**	机器人可执行的业务类型	groupA
energyLevelGood	integer	机器人的剩余电量小于该值时，SRD 将判断机器人可以闲时充电	90
energyLevelCritical	integer	机器人的剩余电量小于该值时，SRD 将判断机器人必须充电	30
energyLevelFullyRecharged	integer	机器人在充电过程中，电量高于该值，SRD 判断机器人充满	95
energyLevelSufficientlyRecharged	integer	机器人在充电过程中，电量高于该值，SRD 判断机器人可以接单（配置中 dispatcher.keepRechargingUntilFullyCharged 为 false）	35
energyLevel	integer	器人的剩余电量值（单位：整数百分比）	60
integrationLevel	string	机器人在 SRD 系统中的在线状态 - TO_BE_IGNORED：机器人处于离线状态，SRD 不会标识出机器人位置。 - TO_BE_NOTICED：机器人处于离线状态，SRD 标识出机器人的位置。 - TO_BE_RESPECTED：机器人处于在线状态，但不能接受新的运单。 - TO_BE_UTILIZED：机器人处于在线状态，可以接受并执行新的运单。	_ _
procState	**	机器人当前的运单执行状态 - UNAVAILABLE：无法执行任何运单和任务 - IDLE：空闲状态 - AWAITING_ORDER：机器人在等待运单中新的子任务 - PROCESSING_ORDER：机器人正在执行运单
transportOrder	string($nullable)	机器人正在执行的运单的名称。null 表示机器人没有在执行任何运单。	TOrder-01
orderSequence	string($nullable)	机器人正在执行的运单序列的名称。null 表示机器人没有在执行任何运单序列。	TOrder-01
currentDestination	string($nullable)	机器人正在前往的目的地。目的地可能是节点，或者工作站。null 表示当前机器人没有目的地。	Location-01
unfinishedSteps	string	机器人在运单子任务中未完成的路径信息。
paused	boolean	机器人是否处于暂停状态
loadDevices	string	机器人的负载机构状况
errorInfos	string	机器人的报警信息
owner	string	机器人当前控制权所属者。
isDominating	boolean	机器人是否被本系统占用。
allocations	string	机器人占用的站点、路径资源。
adapterEnabled	boolean	调度是否启用对机器人的通信。
currentPosition	string($nullable)	机器人当前占据的点位的名称。null 表示机器人不在任何站点上。	LM01
state	string	机器人当前的自身状态 - UNKNOWN：未知状态 - UNAVAILABLE：通信超时或者已断开连接 - ERROR：错误状态 - IDLE：空闲状态 - EXECUTING：正在执行运单 - CHARGING：正在充电