接口说明#

接口访问#

码垛工作站提供了HTTP接口，用户可通过HTTP接口获取码垛工作站的状态信息，以及对码垛工作站做启停、切换配置等。

访问端口：7410

示例： 若码垛工作站控制器IP为192.168.1.10，要获取码垛站的状态信息。发送GET类型请求，http://192.168.1.10:7410/api/status/system

接口列表#

获取码垛站状态信息#

获取码垛站的状态机、基本信息

接口URL：/api/status/system

Content-Type：application/json

请求方式：GET

返回示例：

{
  "success": true,
  "message": "",
  "data": {
    "system_status": 1,
    "left_status": 1,
    "right_status": 1,
    "system_mode": 1,
    "robot_status": 6,
    "left_enable": false,
    "right_enable": false,
    "left_full_status": false,
    "right_full_status": false,
    "current_project": "test",
    "lift_enable": false,
    "error": "",
    "remote_enable": true
  }
}

返回参数说明：

参数名

示例值

参数 类型

参数描述

success

true

Boolean

是否执行成功

message

String

失败描述

data

Object

数据

data.system_status

1

Integer

系统状态 0 初始化 1 待机 2 故障 3 复位 4 运行中 5 暂停

data.left_status

1

Integer

左垛状态 0 等待清垛 1 等待开始 2 码垛中 3 待机

data.right_status

1

Integer

右垛状态 0 等待清垛 1 等待开始 2 码垛中 3 待机

data.system_mode

1

Integer

系统模式 1 配置模式； 2 运行模式

data.robot_status

6

Integer

机器人状态 4 断电 5 断使能 6 使能

data.left_enable

false

Boolean

左垛启用

data.right_enable

false

Boolean

右垛启用

data.left_full_status

false

Boolean

左满垛

data.right_full_status

false

Boolean

右满垛

data.current_project

test

String

当前使用的配置

data.lift_enable

false

Boolean

升降柱是否启用

data.error

String

故障信息

data.remote_enable

true

Boolean

是 否允许远程控制

获取码垛信息#

获取码垛过程的信息

接口URL：/api/status/pallet

Content-Type：application/json

请求方式：GET

返回示例：

{
  "success": true,
  "message": "",
  "data": {
    "left_cur_layer": 0,
    "left_cur_box": 0,
    "left_boxes": 16,
    "left_layers": 4,
    "left_box_curr_layer": 1,
    "right_cur_layer": 0,
    "right_cur_box": 0,
    "right_boxes": 16,
    "right_layers": 4,
    "right_box_curr_layer": 1
  }
}

返回参数说明：

参数名

示例值

参数 类型

参数描述

success

true

Boolean

是否成功

message

String

失败描述

data

Object

数据

data.left_cur_layer

0

Integer

左垛当前层

data.left_cur_box

0

Integer

左垛当前箱

data.left_boxes

16

Integer

左垛总箱数

data.left_layers

4

Integer

左垛总层数

data.left_box_curr_layer

1

Integer

左 垛当前层第几箱

data.right_cur_layer

0

Integer

右垛当前层

data.right_cur_box

0

Integer

右垛当前箱

data.right_boxes

16

Integer

右垛总箱数

data.right_layers

4

Integer

右垛总层数

data.right_box_curr_layer

1

Integer

右 垛当前层第几箱

获取传感器信息#

获取码垛站传感器的状态

接口URL：/api/status/sensor

Content-Type：application/json

请求方式：GET

返回示例：

{
  "success": true,
  "message": "",
  "data": {
    "left_stack_in_position": false,
    "right_stack_in_position": false,
    "sucker_vacuum_reached": [
      false,
      false,
      false
    ],
    "pick_station_has_box": false
  }
}

返回参数说明：

参数名

示例值

参数 类型

参数描述

success

true

Boolean

是否成功

message

String

失败描述

data

Object

数据

data.left_stack_in_position

false

Boolean

左垛板到位

data.right_stack_in_position

false

Boolean

右垛板到位

data.sucker_vacuum_reached

Object

吸盘达到真空度

data.pick_station_has_box

false

Boolean

取料工位有料

获取统计信息#

获取码垛站的统计类型信息，如总垛数、总箱数、节拍等

接口URL：/api/statistics

Content-Type：application/json

请求方式：GET

返回示例：

{
  "success": true,
  "message": "",
  "data": {
    "left_sum_box": 100,
    "left_sum_stack": 8,
    "left_average_beat": 0,
    "left_average_time": 0,
    "right_sum_box": 100,
    "right_sum_stack": 8,
    "right_average_beat": 0,
    "right_average_time": 0,
    "total_sum_box": 100,
    "total_sum_stack": 8,
    "total_average_box_speed": 0,
    "total_average_stack_speed": 0
  }
}

返回参数说明：

参数名

示例值

参数 类型

参数描述

success

true

Boolean

是否成功

message

String

失败描述

data

Object

数据

data.left_sum_box

100

Integer

左垛累计箱数

data.left_sum_stack

8

Integer

左垛累计垛数

data.left_average_beat

0

Integer

左垛平均节拍

data.left_average_time

0

Integer

左垛平均耗时

data.right_sum_box

100

Integer

右垛累计箱数

data.right_sum_stack

8

Integer

右垛累计垛数

data.right_average_beat

0

Integer

右垛平均节拍

data.right_average_time

0

Integer

右垛平均耗时

data.total_sum_box

100

Integer

总累计箱数

data.total_sum_stack

8

Integer

总累计垛数

data.total_average_box_speed

0

Integer

总平均速度-箱

data.total_average_stack_speed

0

Integer

总平均速度-垛

获取所有配置#

获取码垛站的所有配置列表

接口URL：/api/project/list

Content-Type：application/json

请求方式：GET

返回示例：

{
  "success": true,
  "message": "",
  "data": {
    "list": [
      {
          "name": "pro1",
          "description": ""
      },
      {
          "name": "pro2",
          "description": ""
      }
    ]
  }
}

返回参数说明：

参数名

示例值

参数 类型

参数描述

success

true

Boolean

是否成功

message

String

失败描述

data

Object

数据

data.list

Object

配置列表

data.list.name

pro1

String

配置名称

data.list.description

String

配置描述

获取某个配置基本信息#

获取某个配置的基本信息

接口URL：/api/project/info?name=pro1

Content-Type：application/json

请求方式：GET

URI参数说明：

参数名

示例值

参数 类型

是 否必 填

参数描述

name

pro1

String

是

配置名称

返回示例：

{
  "success": true,
  "message": "",
  "data": {
    "d1": 1000,
    "d2": 1000,
    "l1": 200,
    "l2": 100,
    "weight": 10
  }
}

返回参数说明：

参数名

示例值

参数 类型

参数描述

success

true

Boolean

是否成功

message

String

失败描述

data

Object

数据

data.d1

1000

Integer

栈板d1长

data.d2

1000

Integer

栈板d2长

data.l1

200

Integer

箱子长l1

data.l2

100

Integer

箱子长l2

data.weight

10

Integer

箱子重量

启动码垛#

启动码垛，用户需要指定从左垛开始，还是右垛开始。为保证安全，通过该接口启动码垛时，需要满足：外部控制接口已启用，并且对应的垛板上没有料时，对应的垛处于清垛或者待机状态，且机器人、升降柱都处于原位，吸盘已释放的状态才能启动。

接口URL：/api/action/pallet/start

Content-Type：application/json

请求方式：POST

请求体参数说明：

{
    "password": "1",
    "type": 1
}

参数名

示例值

参数 类型

是 否必 填

参数描述

password

1

String

是

系统密码

type

1

Number

是

1: 左垛开始 2: 右垛开始

返回示例：

{
  "success": true,
  "message": "",
  "code": ""
}

返回参数说明：

参数名

示例值

参数 类型

参数描述

success

false

Boolean

是否执行成功

message

String

执行失败的描述

code

String

错误码

切换配置#

切换使用的配置。为保证安全，通过该接口切换配置时，仅在外部控制已启用、左右垛板都无物料且为待机状态时才能生效。

接口URL：/api/action/project/switch

Content-Type：application/json

请求方式：POST

请求体参数说明：

{
  "project": "pro1"
}

参数名

示例值

参数 类型

是 否必 填

参数描述

project

pro1

String

是

配置名称

返回示例：

{
  "success": true,
  "message": "",
  "code": ""
}

返回参数说明：

参数名

示例值

参数 类型

参数描述

success

false

Boolean

是否执行成功

message

String

执行失败的描述

code

String

错误码

垛板物体检测同步#

将垛板上是否有物料的信息发送给码垛站，建议周期性发送给码垛站

接口URL：/api/signal/stack

Content-Type：application/json

请求方式：POST

请求体参数说明：

{
  "left": [false,false],
  "right": [false, false]
}

参数名

示例值

参数 类型

是 否必 填

参数描述

left

Object

是

左垛板 有无物料，多个 信号均为false时 ，认为垛板已清

right

Object

是

右垛板 有无物料，多个 信号均为false时 ，认为垛板已清

停止码垛#

停止码垛

接口URL：/api/action/pallet/stop

Content-Type：application/json

请求方式：POST

请求示例：

{
  "password": "1"
}

启用或者禁用外部控制接口#

禁用时，码垛站不响应远程启动码垛信号。码垛站开机时，默认禁用外部控制接口

接口URL：/api/action/enable

Content-Type：application/json

请求方式：POST

请求体参数说明：

{
  "enable": false
}

参数名

示例值

参数 类型

是 否必 填

参数描述

enable

Boolean

是

为tru e时，可以响应远 程的启停信号， 为false时，不响 应远程启停信号

返回示例：

{
  "success": true,
  "message": "",
  "code": ""
}

返回参数说明：

参数名

示例值

参数 类型

参数描述

success

false

Boolean

是否执行成功

message

String

执行失败的描述

code

String

错误码