设备端称重台排菜接口文档
接口概览
接口地址
POST
/api/device/equipment/pushDishes
认证方式
无需登录 token
请求格式
Form 表单或 JSON Body
业务用途
设备端设置称重台当前排菜,等价复用 PC 后台排菜逻辑,不改原
/p/equipment/pushDishes
请求参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
equipment_code |
string | 与 equipment_id 二选一 |
设备编号,对应 equipment.code。设备端推荐传此字段。 |
equipment_id |
int | 与 equipment_code 二选一 |
设备 ID,对应 equipment.id。兼容 PC 原接口参数。 |
left_dishes_uuid |
string | 否 | 左称菜品 UUID。传空字符串可清空左称排菜。 |
right_dishes_uuid |
string | 否 | 右称菜品 UUID;单称设备可为空。传空字符串可清空右称排菜。 |
{
"equipment_code": "10001-3",
"left_dishes_uuid": "C1BD5548-E958-34EF-87A9-A6BD24D2F9D2",
"right_dishes_uuid": ""
}
业务规则
| 规则 | 说明 |
|---|---|
| 设备范围 | 设备必须存在且 equipment.del_flag = 0,并且类型属于现有称重台排菜类型。 |
| 原接口保护 | 不修改 /p/equipment/pushDishes,新接口在设备端开放路径中复用同一套排菜逻辑。 |
| 当前排菜 | 更新 equipment.left_dishes_uuid、equipment.right_dishes_uuid、equipment.push_dishes_user、equipment.push_dishes_time。 |
| 排菜历史 | 写入 equipment_push_dishes,操作类型为排菜。 |
| 设备下发 | 沿用 PC 后台排菜逻辑;设备在线时会触发称重台排菜 MQTT 消息。 |
注意 该接口会修改设备当前排菜,联调时请使用测试设备或确认可覆盖当前排菜。
成功响应
{
"code": 0,
"message": "排菜完成",
"data": {
"equipment_id": 40,
"equipment_code": "10001-3",
"left_dishes_uuid": "C1BD5548-E958-34EF-87A9-A6BD24D2F9D2",
"right_dishes_uuid": ""
}
}
异常响应
| 场景 | 响应示例 |
|---|---|
| 未传设备标识 | {"code":1,"message":"设备ID或设备编号不能为空","data":[]} |
| 设备不存在或已删除 | {"code":1,"message":"设备不存在","data":[]} |
| 设备不是称重台排菜类型 | {"code":1,"message":"设备不存在","data":[]} |
| 服务端异常 | {"code":1,"message":"排菜失败","data":[]} |
调用示例
curl -X POST 'http://127.0.0.1/api/device/equipment/pushDishes' \
-H 'Content-Type: application/json' \
-d '{
"equipment_code": "10001-3",
"left_dishes_uuid": "C1BD5548-E958-34EF-87A9-A6BD24D2F9D2",
"right_dishes_uuid": ""
}'