帮助中心主页

SRD API 协议

使用指定名称创建一个新的运单

请求

功能：使用指定名称创建一个新的运单
方法：POST
接口说明：/transportOrders/{name}

POST "http://host:7100/api/route/transportOrders/{name}"

参数介绍

Name	Type	Description	example
deadline*	string($date-time)	执行运单的截止时间（UTC时区）	*2018-05-17T06:42:40.396Z*
intendedVehicle	string	（可选）预期执行此运单的机器人名称	*AMB-01*
category	string	（可选）运单的业务类型	*Park*
wrappingSequence	string	（可选）运单所属的运单序列。当此项被指定时，运单将添加至指定的序列	*Sequence-01*
destinations*	array	运单包含的目标工作站的序列
locationName*	string	目标工作站的名称	*Storage 01*
operation*	string	机器人在工作站要执行的操作的名称	*Load cargo*
properties*	array	destinations下属的元属性	没有则填`[]`即可。
~~properties~~	array	运单的元属性。此参数已弃用，3.0.127 及以后的版本，不再建议使用此字段，以免造成不必要的问题。	可以不传这个字段，或者字段的值为`[]`。
dependencies	array	运单依赖。执行本运单前，需要已经执行完毕的运单的名称列表	*TOrder-002*

请求示例

{
  "deadline": "2018-05-17T06:42:40.396Z",
  "intendedVehicle": "AMB-01",
  "category": "-",
  "wrappingSequence": "",
  "destinations": [
    {
      "locationName": "LOC-AP1",
      "operation": "Wait",
      "properties": [
        {
          "key": "duration",
          "value": "2000"
        }
      ]
    }
  ],
  "properties":[], 
  "dependencies": []
}

注意：

若指定 intendedVehicle，将把运单强制分配给该机器人。若不指定该字段，系统将自动为运单分配机器人
若不指定 category，系统将默认 category 为 "-"
若指定 wrappingSequence，运单将被添加至该运单序列。如果被指定的运单序列不存在，将返回 404 异常

响应

Responses Code 200

响应示例

请求已成功

Responses Code 404

响应示例

[
  "Unknown location 'Storage 01'."
]

Responses Code 409

响应示例

[
  "Transport order 'TOrder-01' already exists."
]

Responses Code 500

响应示例

[
  ""
]

应用示例

通用操作

设置车体的 DO 信号

【参数说明】

	字段名称	数据类型	必填	默认值	备注
操作描述（operation）	SetDO	string	是	-	-
操作属性（properties）	车体 DO 的索引 (用字符串表示)	string	否		设置机器人的 DO 状态。其值为用字符串表示的布尔值； "true" 表示将目标 DO 设置为被触发的状态； "false" 表示将目标 DO 设置为未被触发的状态。

【请求示例】

让任意机器人到达 LOC-AP1 后，触发 DO1（其索引为 1 ）。

{
  "destinations": [
    {
      "locationName": "LOC-AP1",
      "operation": "SetDO",
      "properties": [
        {
          "key": "1",
          "value": "true"
        }
      ]
    }
  ]
}

等待一段时间

【参数说明】

	字段名称	数据类型	必填	默认值	备注
操作描述（operation）	Wait	string	是	无	-
操作属性（properties）	duration	string	否	"1000"	机器人等待该时间后，结束等待动作。其值为用字符串表示的非负整数。单位为毫秒（ms）。
操作属性（properties）	inverse_angle	string	否	"false"	如果为 "true"，机器人在等待时，其自身角度与所在地标点的规定角度，相差 180°。

【请求示例】

让任意机器人到达 LOC-AP1 后，等待 5 秒。

{
  "destinations": [
    {
      "locationName": "LOC-AP1",
      "operation": "Wait",
      "properties": [
        {
          "key": "duration",
          "value": "5000"
        }
      ]
    }
  ]
}

等待车体的 DI 信号

【参数说明】

	字段名称	数据类型	必填	默认值	备注
操作描述（operation）	WaitKey	string	是	无	-
操作属性（properties）	车体 DI 的索引 (用字符串表示)	string	是	无	当指定的数字输入达到目标值时，结束等待动作。其值为用字符串表示的布尔值； "true" 表示期望目标 DI 被触发； "false" 表示期望目标 DI 未被触发。
操作属性（properties）	timeout	string	否	无穷大 (不超时)	机器人等待该时间后，直接结束等待动作。其值为用字符串表示的非负整数。单位为毫秒（ms）。

【请求示例】

让任意机器人到达 LOC-AP1 后，监测 DI3 （其索引为 3 ）的状态，直到其被触发。

{
  "destinations": [
    {
      "locationName": "LOC-AP1",
      "operation": "WaitKey",
      "properties": [
        {
          "key": "3",
          "value": "true"
        }
      ]
    }
  ]
}

让任意机器人到达 LOC-AP1 后，等待 DI3 （其索引为 3 ）被触发，超时时间为 10 秒。

{
  "destinations": [
    {
      "locationName": "LOC-AP1",
      "operation": "WaitKey",
      "properties": [
        {
          "key": "3",
          "value": "true"
        },
        {
          "key": "timeout",
          "value": "10000"
        }
      ]
    }
  ]
}

顶升车

顶升车抬起料架（载具）

【参数说明】

	字段名称	数据类型	必填	默认值	备注
操作描述（operation）	JackLoad	string	是	-	-
操作属性（properties）	recognize	string	否	"false"	顶升机器人在执行抬起料架的操作前，是否要通过 "识别" 来进行位置校准。 "true" 表示需要识别； "false" 表示不需要识别。
	recfile	string	否	无	当且仅当 recognize 的值为 "true" 时有效。顶升机器人执行识别操作时，需要从机器人中加载的识别文件的名称，例如 `shelf/s0002.shelf`。识别文件可通过 RoboshopPro 连上机器人之后，在“识别编辑”中查看（先全部拉取），如图
	use_pgv	string	否	"false"	是否启用 PGV 传感器。 "true" 表示启用； "false" 表示不启用。顶升车取货前，基本不再用 PGV 进行识别了。

【请求示例】

让顶升车 Jack-01 去 LOC-AP1 取货，且不需要识别。

{
  "intendedVehicle": "Jack-01",
  "destinations": [
    {
      "locationName": "LOC-AP1",
      "operation": "JackLoad",
      "properties": []
    }
  ]
}

让顶升车 Jack-01 去 LOC-AP1 取货，且需要加载文件 s0002.shelf 进行识别。

{
  "intendedVehicle": "Jack-01",
  "destinations": [
    {
      "locationName": "LOC-AP1",
      "operation": "JackLoad",
      "properties": [
        {
          "key": "recognize",
          "value": "false"
        },
        {
          "key": "recfile",
          "value": "shelf/s0002.shelf"
        }
      ]
    }
  ]
}

顶升车放下料架（载具）

【参数说明】

	字段名称	数据类型	必填	默认值	备注
操作描述（operation）	JackUnload	string	是	无	-
操作属性（properties）	recognize	string	否	"false"	顶升机器人在执行放下料架的操作前，是否要通过 "识别" 来进行位置校准。关于 "识别" 的详情请咨询仙工智能工程师。 "true" 表示需要识别； "false" 表示不需要识别。
操作属性（properties）	use_pgv	string	否	"false"	是否启用 PGV 传感器。 "true" 表示启用； "false" 表示不启用。

【请求示例】
让顶升车 Jack-01 去 LOC-AP1 放货，且不需要识别。

{
  "intendedVehicle": "Jack-01",
  "destinations": [
    {
      "locationName": "LOC-AP1",
      "operation": "JackLoad",
      "properties": []
    }
  ]
}

调整顶升机构到指定高度

【参数说明】

	字段名称	数据类型	必填	默认值	备注
操作描述（operation）	JackHeight	string	是	无	顶升到指定高度。
操作属性（properties）	recognize	string	否	"false"	顶升机器人在执行顶升料架至指定高度的操作前，是否要通过 "识别" 来进行位置校准。关于 "识别" 的详情请咨询仙工智能工程师。 "true" 表示需要识别； "false" 表示不需要识别。
	use_pgv	string	否	"false"	是否启用 PGV 传感器。 "true" 表示启用； "false" 表示不启用。
	jack_height	string	否	无	设置顶升高度（单位：米）。其值为用字符串表示的浮点数。

【请求示例】
让顶升车 Jack-01 去 LOC-AP1 将顶升机构举升到 0.5 米，且不需要识别。

{
  "intendedVehicle": "Jack-01",
  "destinations": [
    {
      "locationName": "LOC-AP1",
      "operation": "JackHeight",
      "properties": [
        {
          "key": "jack_height",
          "value": "0.5"
        }
      ]
    }
  ]
}

辊筒车/皮带车

辊筒车和皮带车的 operation 是一样的，下文同一用辊筒车进行描述。

辊筒预载货（预上料）

【参数说明】

	字段名称	数据类型	必填	默认值	备注
操作描述（operation）	RollerPreLoad	string	是	无	辊筒旋转并准备载入货物。
操作属性（properties）	direction	string	是	无	辊筒准备载入货物的方向。 "left" 指从辊筒机器人的左侧，向辊筒内载入货物。 "right" 指从辊筒机器人的右侧，向辊筒内载入货物。 "front" 指从辊筒机器人的前方，向辊筒内载入货物。 "back" 指从辊筒机器人的后方，向辊筒内载入货物。
	index	number	否	0	机器人上有多辊筒时，辊筒的 ID 。
	recognize	string	否	"false"	机器人在执行辊筒准备载货的操作前，是否要通过 "识别" 来进行位置校准。关于 "识别" 的详情请咨询仙工智能工程师。 "true" 表示启用； "false" 表示不启用。

【请求示例】

让单辊筒机器人 Roller-01 去 LOC-AP1 预载货，载货点位于机器人的左侧，且不需要识别。

{
  "intendedVehicle": "Roller-01",
  "destinations": [
    {
      "locationName": "LOC-AP1",
      "operation": "RollerPreLoad",
      "properties": [
        {
          "key": "direction",
          "value": "left"
        }
      ]
    }
  ]
}

辊筒载入货物（上料）

【参数说明】

	字段名称	数据类型	必填	默认值	备注
操作描述（operation）	RollerLoad	string	是	无	-
操作属性（properties）	direction	string	是	无	辊筒载入货物的方向。 "left" 指从辊筒机器人的左侧，向辊筒内载入货物。 "right" 指从辊筒机器人的右侧，向辊筒内载入货物。 "front" 指从辊筒机器人的前方，向辊筒内载入货物。 "back" 指从辊筒机器人的后方，向辊筒内载入货物。
	index	number	否	0	机器人上有多辊筒时，辊筒的 ID 。
	recognize	string	否	"false"	机器人在执行辊筒载货的操作前，是否要通过 "识别" 来进行位置校准。关于 "识别" 的详情请咨询仙工智能工程师。 "true" 表示启用； "false" 表示不启用。

【请求示例】

让单辊筒机器人 Roller-01 去 LOC-AP1 载货，载货点位于机器人的左侧，且不需要识别。

{
  "intendedVehicle": "Roller-01",
  "destinations": [
    {
      "locationName": "LOC-AP1",
      "operation": "RollerLoad",
      "properties": [
        {
          "key": "direction",
          "value": "left"
        }
      ]
    }
  ]
}

辊筒卸载货物（下料）

【参数说明】

	字段名称	数据类型	必填	默认值	备注
操作描述（operation）	RollerUnload	string	是	无	-
操作属性（properties）	direction	string	是	无	辊筒卸下货物的方向。 "left" 指从辊筒机器人的左侧，向辊筒内载入货物。 "right" 指从辊筒机器人的右侧，向辊筒内载入货物。 "front" 指从辊筒机器人的前方，向辊筒内载入货物。 "back" 指从辊筒机器人的后方，向辊筒内载入货物。
	index	number	否	0	机器人上有多辊筒时，辊筒的 ID 。
	recognize	string	否	"false"	机器人在执行辊筒卸货的操作前，是否要通过 "识别" 来进行位置校准。关于 "识别" 的详情请咨询仙工智能工程师。 "true" 表示启用； "false" 表示不启用。

【请求示例】

让单辊筒机器人 Roller-01 去 LOC-AP1 卸货，卸货点位于机器人的左侧，且不需要识别。

{
  "intendedVehicle": "Roller-01",
  "destinations": [
    {
      "locationName": "LOC-AP1",
      "operation": "RollerUnload",
      "properties": [
        {
          "key": "direction",
          "value": "left"
        }
      ]
    }
  ]
}

辊筒保持滚动

【参数说明】

	字段名称	数据类型	必填	默认值	备注
操作描述（operation）	RollerRoll	string	是	无	-
操作属性（properties）	direction	string	是	无	辊筒滚动的方向。 "left" 指让辊筒自左向右滚动。 "right" 指让辊筒自右向左滚动。 "front" 指让辊筒自前向后滚动。 "back" 指让辊筒自后向前滚动。

【请求示例】

让单辊筒机器人 Roller-01 到达 LOC-AP1 后，保持辊筒自左向右滚动。

{
  "intendedVehicle": "Roller-01",
  "destinations": [
    {
      "locationName": "LOC-AP1",
      "operation": "RollerRoll",
      "properties": [
        {
          "key": "direction",
          "value": "left"
        }
      ]
    }
  ]
}

双侧挡板下降并保持辊筒滚动

【参数说明】

	字段名称	数据类型	必填	默认值	备注
操作描述（operation）	RollerPass	string	是	无	双侧挡板下降并保持辊筒滚动。
操作属性（properties）	direction	string	是	无	辊筒滚动的方向。 "left" 指让辊筒自左向右滚动。 "right" 指让辊筒自右向左滚动。 "front" 指让辊筒自前向后滚动。 "back" 指让辊筒自后向前滚动。

【请求示例】

让单辊筒机器人 Roller-01 到达 LOC-AP1 后，降下两侧挡板，并保持辊筒自左向右滚动。

{
  "intendedVehicle": "Roller-01",
  "destinations": [
    {
      "locationName": "LOC-AP1",
      "operation": "RollerPass",
      "properties": [
        {
          "key": "direction",
          "value": "left"
        }
      ]
    }
  ]
}

辊筒停止滚动

【参数说明】

	字段名称	数据类型	必填	默认值	备注
操作描述（operation）	RollerStop	string	是	无	双侧挡板下降并保持辊筒滚动。
操作属性（properties）	无	无	无	无	-

【请求示例】

让单辊筒机器人 Roller-01 在 LOC-AP1 停止转动辊筒。

{
  "intendedVehicle": "Roller-01",
  "destinations": [
    {
      "locationName": "LOC-AP1",
      "operation": "RollerStop",
      "properties": []
    }
  ]
}

叉车

叉车取货

【参数说明】

	字段名称	数据类型	必填	默认值	备注
操作描述（operation）	ForkLoad	string	是	无	叉车插起货物。
操作属性（properties）	start_height	string	否	无	在操作前，叉齿的起始高度（单位：米）。叉车高度不能低于最低高度。
	end_height	number	否	无	在插起货物后，叉齿的终止高度（单位：米）。
	recognize	string	否	"false"	无人叉车在执行插起货物的操作前，是否要通过 "识别" 来进行位置校准。关于 "识别" 的详情请咨询仙工智能工程师。 "true" 表示启用； "false" 表示不启用。

【请求示例】

让叉车 CDD14-01 去 LOC-AP1 取货，取货前的要求货叉的高度是 0.7 米，取货后要求货叉的高度是 0.9米，取货过程中，不需要识别。

{
  "intendedVehicle": "CDD14-01",
  "destinations": [
    {
      "locationName": "LOC-AP1",
      "operation": "ForkLoad",
      "properties": [
        {
          "key": "start_height",
          "value": "0.7"
        },
        {
          "key": "end_height",
          "value": "0.9"
        },
        {
          "key": "recognize",
          "value": "false"
        }
      ]
    }
  ]
}

叉车放货

【参数说明】

	字段名称	数据类型	必填	默认值	备注
操作描述（operation）	ForkUnload	string	是	无	叉车卸下货物。
操作属性（properties）	start_height	string	否	无	在操作前，叉齿的起始高度（单位：米）。叉车高度不能低于最低高度。
	end_height	number	否	无	在卸下货物后，叉齿的终止高度（单位：米）。
	recognize	string	否	"false"	无人叉车在执行卸下货物的操作前，是否要通过 "识别" 来进行位置校准。关于 "识别" 的详情请咨询仙工智能工程师。 "true" 表示启用； "false" 表示不启用。

【请求示例】

让叉车 CDD14-01 去 LOC-AP1 卸货，卸货前的要求货叉的高度是 0.35 米，卸货后要求货叉的高度是 0.2米，卸货过程中，不需要识别。

{
  "intendedVehicle": "CDD14-01",
  "destinations": [
    {
      "locationName": "LOC-AP1",
      "operation": "ForkUnload",
      "properties": [
        {
          "key": "start_height",
          "value": "0.35"
        },
        {
          "key": "end_height",
          "value": "0.2"
        },
        {
          "key": "recognize",
          "value": "false"
        }
      ]
    }
  ]
}

地牛

地牛取货

【参数说明】

	字段名称	数据类型	必填	默认值	备注
操作描述（operation）	ForkLoad	string	是	无	叉车插起货物。
操作属性（properties）	recognize	string	否	"false"	无人叉车在执行插起货物的操作前，是否要通过 "识别" 来进行位置校准。关于 "识别" 的详情请咨询仙工智能工程师。 "true" 表示启用； "false" 表示不启用。

【请求示例】

让地牛 DN-01 去 LOC-AP1 取货，取货过程中，不需要识别。

{
  "intendedVehicle": "DN-01",
  "destinations": [
    {
      "locationName": "LOC-AP1",
      "operation": "ForkLoad",
      "properties": [
        {
          "key": "recognize",
          "value": "false"
        }
      ]
    }
  ]
}

地牛放货

【参数说明】

	字段名称	数据类型	必填	默认值	备注
操作描述（operation）	ForkUnload	string	是	无	叉车卸下货物。
操作属性（properties）	recognize	string	否	"false"	无人叉车在执行卸下货物的操作前，是否要通过 "识别" 来进行位置校准。关于 "识别" 的详情请咨询仙工智能工程师。 "true" 表示启用； "false" 表示不启用。

【请求示例】

让地牛 DN-01 去 LOC-AP1 卸货，卸货过程中，不需要识别。

{
  "intendedVehicle": "DN-01",
  "destinations": [
    {
      "locationName": "LOC-AP1",
      "operation": "ForkUnload",
      "properties": [
        {
          "key": "recognize",
          "value": "false"
        }
      ]
    }
  ]
}