跳转到内容
Bivrost彼络物联网关 通讯协议

2.9.4. 机组配置接口

机组配置接口用于获取、新增、修改，或删除机组配置。机组配置相关说明可以参考《说明书》5.4. 机组配置。机组的所有配置参数如下表，这些参数在机组配置接口中作为请求参数或返回参数。

机组配置参数

Section titled “机组配置参数”
参数 类型 说明
id Int32 机组数据库标识，详见 1.1.4. ID 数据库标识
number Int32 机组号，有效范围 1~16
useDefaultGroupID Bool 使用默认机组标识。true 时机组标识由机组号自动生成（g+机组号），请求中的 groupID 被忽略；要自定义 groupID 必须设置 useDefaultGroupID=false。
groupID String 机组标识，详见 1.1.2. groupID 机组标识
name String 机组名，留空时自动取 groupID
isActive Bool 激活状态，true=激活，false=未激活
machines Object[] 机组包含的机台信息，详见 machines 机台列表信息。
enableExternalMachines Bool 启用外部机台
externalMachines String 外部机台命令。enableExternalMachines 为 true 时必需，留空会报错；格式为 uid,machineID[|countMultiplier=1|name=xxx][,machineID...];...，格式非法时 create-group / update-group 返回错误。
taskCount Bool 机组加工计数任务，true=开启，false=关闭。
taskOEE Bool 机组 OEE 监控任务，true=开启，false=关闭。
taskCumulativeStatusTime Bool 机组累计状态时间任务，true=开启，false=关闭。

machines 机台列表信息

Section titled “machines 机台列表信息”

machines 是机组包含的机台列表，参数如下表所示，注意除了 id, machineID, 和 countMultiplier 产量系数以外，其它参数均为只读参数。用户通过在列表中添加、移除 id 或 machineID 的方式修改机组包含的机台。create-group / update-group 请求中每个 machines 条目必须同时提供 id（或 machineID）与 countMultiplier，缺少 countMultiplier 的条目会被忽略，该机台不会加入机组（接口仍返回成功）。使用机台配置接口修改机台配置后，机组的机台列表中相应机台信息会同步更新。

参数 类型 说明
id Int32 机台数据库标识，详见 1.1.4. ID 数据库标识。在列表中添加或移除 id 以添加指定机台到机组或从机组移除。
machineType String 机台类型，见machineType 对应机台类型。
system String 系统，同英文语言下添加机台窗口中的系统选项
model String 型号，同英文语言下添加机台窗口中的型号选项
name String 机台名
machineID String 机台标识，详见 1.1.1. machineID 机台标识。在列表中添加或移除 machineID 以添加指定机台到机组或从机组移除。如 ID 与 machineID 同时输入，machineID 被忽略。
slaveID Int32 从站标识，详见 1.1.3. slaveID 从站标识
ip String IP 地址
port Int32 端口号，0 代表各设备的默认端口。
isActive Bool 激活状态，true=激活，false=未激活
countMultiplier Int32 (必需)产量系数

2.9.4.1. group 获取机组配置

Section titled “2.9.4.1. group 获取机组配置”
GET /api/config/group?ID=ID&groupID=GROUPID
请求参数 类型 说明
id Int32 数据库标识，详见 1.1.4. ID 数据库标识
groupID String 目标机组标识，详见 1.1.2. groupID 机组标识。如 ID 与 groupID 同时输入，groupID 被忽略。

返回示例

{
  "id": 1,
  "number": 1,
  "useDefaultGroupID": true,
  "groupID": "g1",
  "name": "g1",
  "isActive": true,
  "machines": [
    {
      "id": 4,
      "machineType": "CNC",
      "system": "Mock",
      "model": "General",
      "name": "演示 1",
      "machineID": "1",
      "slaveID": 1,
      "ip": "127.0.0.1",
      "port": 0,
      "isActive": true,
      "countMultiplier": 1
    },
    {
      "id": 5,
      "machineType": "CNC",
      "system": "Mock",
      "model": "General",
      "name": "演示 2",
      "machineID": "2",
      "slaveID": 2,
      "ip": "127.0.0.2",
      "port": 0,
      "isActive": true,
      "countMultiplier": 0
    }
  ],
  "enableExternalMachines": false,
  "taskCount": true,
  "taskOEE": true,
  "taskCumulativeStatusTime": true
}

返回参数见机组配置参数。

2.9.4.2. groups 获取所有机组配置

Section titled “2.9.4.2. groups 获取所有机组配置”

此接口无请求参数。

GET /api/config/groups

返回示例

[
  {
    "id": 1,
    "number": 1,
    "useDefaultGroupID": true,
    "groupID": "g1",
    "name": "g1",
    "isActive": true,
    "machines": [
      {
        "id": 4,
        "machineType": "CNC",
        "system": "Mock",
        "model": "General",
        "name": "演示 1",
        "machineID": "1",
        "slaveID": 1,
        "ip": "127.0.0.1",
        "port": 0,
        "isActive": true,
        "countMultiplier": 0
      },
      {
        "id": 5,
        "machineType": "CNC",
        "system": "Mock",
        "model": "General",
        "name": "演示 2",
        "machineID": "2",
        "slaveID": 2,
        "ip": "127.0.0.2",
        "port": 0,
        "isActive": true,
        "countMultiplier": 0
      }
    ],
    "enableExternalMachines": false,
    "taskCount": true,
    "taskOEE": true,
    "taskCumulativeStatusTime": true
  },
  {
    "id": 3,
    "number": 7,
    "useDefaultGroupID": false,
    "groupID": "group7",
    "name": "g7",
    "isActive": true,
    "machines": [
      {
        "id": 6,
        "machineType": "CNC",
        "system": "Mock",
        "model": "General",
        "name": "演示 3",
        "machineID": "3",
        "slaveID": 3,
        "ip": "127.0.0.3",
        "port": 0,
        "isActive": true,
        "countMultiplier": 23
      },
      {
        "id": 7,
        "machineType": "CNC",
        "system": "Mock",
        "model": "General",
        "name": "演示 4",
        "machineID": "4",
        "slaveID": 4,
        "ip": "127.0.0.4",
        "port": 0,
        "isActive": true,
        "countMultiplier": 4
      }
    ],
    "enableExternalMachines": false,
    "taskCount": true,
    "taskOEE": true,
    "taskCumulativeStatusTime": true
  }
]

返回参数见机组配置参数。

2.9.4.3. create-group 添加机组配置

Section titled “2.9.4.3. create-group 添加机组配置”
POST /api/config/create-group

请求体示例

{
  "number": 7,
  "name": "g7",
  "useDefaultGroupID": false,
  "groupID": "group7",
  "isActive": true,
  "machines": [
    {
      "id": 6,
      "countMultiplier": 23
    },
    {
      "id": 7,
      "machineID": "4",
      "countMultiplier": 4
    }
  ],
  "enableExternalMachines": false,
  "taskCount": true,
  "taskOEE": true,
  "taskCumulativeStatusTime": true
}

请求参数见机组配置参数。注意请求体中不用设置数据库标识 id，id 由网关自动分配，创建成功后出现在返回体中。机组号 number 也可省略，省略时网关自动分配 1~16 中第一个未占用的机组号；机组号已用尽，或 number、groupID 与现有机组重复时，接口返回错误对象（见 2.2. 错误处理）。

返回示例

{
  "id": 3,
  "number": 7,
  "useDefaultGroupID": false,
  "groupID": "group7",
  "name": "g7",
  "isActive": true,
  "machines": [
    {
      "id": 6,
      "machineType": "CNC",
      "system": "Mock",
      "model": "General",
      "name": "演示 3",
      "machineID": "3",
      "slaveID": 3,
      "ip": "127.0.0.3",
      "port": 0,
      "isActive": true,
      "countMultiplier": 23
    },
    {
      "id": 7,
      "machineType": "CNC",
      "system": "Mock",
      "model": "General",
      "name": "演示 4",
      "machineID": "4",
      "slaveID": 4,
      "ip": "127.0.0.4",
      "port": 0,
      "isActive": true,
      "countMultiplier": 4
    }
  ],
  "enableExternalMachines": false,
  "taskCount": true,
  "taskOEE": true,
  "taskCumulativeStatusTime": true
}

返回参数见机组配置参数。

2.9.4.4. update-group 修改机组配置

Section titled “2.9.4.4. update-group 修改机组配置”

修改指定机组的配置信息并返回修改后的机组配置信息。

POST /api/config/update-group

请求体示例

{
  "id": 3,
  "number": 6,
  "name": "newName",
  "useDefaultGroupID": false,
  "groupID": "newGroupID",
  "isActive": true,
  "machines": [
    {
      "id": 6,
      "countMultiplier": 1
    }
  ],
  "taskCount": false,
  "taskOEE": false,
  "taskCumulativeStatusTime": false
}

请求参数见机组配置参数。注意：此接口使用 id 作为唯一标识，请求体中必须设置数据库标识 id。机组标识 groupID 可以通过这个接口修改，但修改 groupID 时必须在同一请求中设置 useDefaultGroupID=false；update-group 请求未带 groupID 时，机组标识会被重置为默认值。

返回示例

{
  "id": 3,
  "number": 6,
  "useDefaultGroupID": false,
  "groupID": "newGroupID",
  "name": "newName",
  "isActive": true,
  "machines": [
    {
      "id": 6,
      "machineType": "CNC",
      "system": "Mock",
      "model": "General",
      "name": "演示 3",
      "machineID": "3",
      "slaveID": 3,
      "ip": "127.0.0.3",
      "port": 0,
      "isActive": true,
      "countMultiplier": 1
    }
  ],
  "enableExternalMachines": false,
  "taskCount": false,
  "taskOEE": false,
  "taskCumulativeStatusTime": false
}

返回参数见机组配置参数。

2.9.4.5. delete-group 删除机组配置

Section titled “2.9.4.5. delete-group 删除机组配置”
GET /api/config/delete-group?ID=ID&groupID=GROUPID
请求参数 类型 说明
ID Int32 数据库标识，详见 1.1.4. ID 数据库标识
groupID String 目标机组标识，详见 1.1.2. groupID 机组标识。如 ID 与 groupID 同时输入，groupID 被忽略。

返回示例

{
  "errorCode": 0,
  "errorMsg": "Success"
}
返回参数 类型 说明
errorCode Int32 (必需)错误码，0 代表成功。
errorMsg String (必需)错误内容

2.9.4.6. batch-delete-groups 批量删除机组配置

Section titled “2.9.4.6. batch-delete-groups 批量删除机组配置”

此接口为 2.9.4.5. delete-group 删除机组配置的批量版本，通过在请求体中补充数据库 ID，可以一次删除多个机组。

POST /api/config/batch-delete-groups

请求体示例 application/json

{
  "ids": [
    2,
    3,
    4
  ]
}
请求参数 类型 说明
ids Int32[] (必需) 数据库标识，详见 1.1.4. ID 数据库标识

返回示例

{
  "deleted": 3
}

返回体只包含成功删除的机组数 deleted。ids 为空或缺失、以及一个机组都未删除时，接口返回错误对象（见 2.2. 错误处理），不会返回 deleted=0。

返回参数 类型 说明
deleted Int32 (必需)删除机组数
彼络微信客服二维码
扫码添加微信客服
© BIVROST TECHONOLOGIES Company Limited / 深圳市彼络科技有限公司 · 通讯协议 v1.19.7 · 联系电话：18824672282