跳转到内容

七、MQTT 通讯

启用 MQTT 通讯,并开启目标机台/机组的自动采集任务(详见3.3.1.2. 任务设置,以及 3.4.1.2. 机组任务设置)后,网关会基于 MQTT 协议,将自动采集任务结果数据转化成 JSON 格式的报文,并发布至指定 MQTT 服务器。普通模式的数据上报主题默认为 “r”;GeWu 模式使用格物云规定的主题。网关也支持 RPC 接口。用户可以参照3.6.3. MQTT 配置的说明配置 MQTT 服务。

网关 MQTT 协议数据上报的报文支持多种模式,包括 Default,MKT,TB,TB2,Brm,IoTDA,GeWu,WisIoT 等。

各模式下报文内容结构如下:

{
"type": <type>,
"unixtimestamp": <time>,
"data": {
"<field>": <value>
},
"<tag>": <value>,
"<entityID>": <value>
}
{
"unixtimestamp": <time>,
"<entityID>_<fieldID>_<field>": <value>
}
{
"<alias>": [
{
"ts": <time>,
"values": {
"<fieldID>_<field>": <value>
}
}
]
}
{
"<entityID>": [
{
"ts": <time>,
"values": {
"<fieldID>_<field>": <value>
}
}
]
}
[
{
"type": <type>,
"ts": <time>,
"data": {
"<field>": <value>
},
"<tag>": <value>,
"<entityID>": <value>
}
]
{
"devices": [
{
"device_id": <entityID>,
"services": [
{
"service_id": <fieldID>,
"properties": {
"<field>": <value>
},
"event_time": <time>
}
]
}
]
}

IoTDA 模式将数据类和标签组成的 <fieldID> 放在 service_id 中;properties 的键仅使用原字段名 <field>,不再加标签前缀,也不单独上报标签。

格物云的子设备属性上报主题由网关产品和设备标识生成:$sys/<gatewayProductKey>/<gatewayDeviceKey>/subdevice/propertyEvent/pub。机台或机组作为网关子设备上报;发送前网关会将启用的子设备添加到拓扑,见3.6.3. MQTT 配置。

{
"messageId": "<messageId>",
"params": {
"subDevices": [
{
"productKey": "<machineProductKey 或 groupProductKey>",
"deviceKey": "<entityID>",
"properties": [
{
"key": "<fieldID>",
"value": { "<field>": <value> },
"ts": "<time>"
}
],
"events": []
}
]
}
}

deviceKey 是机台 machineID 或机组 groupID;key 是数据类与标签组成的 <fieldID>,value 对象内使用原字段名。ts 为毫秒时间戳的字符串,布尔字段值以小写字符串 "true" / "false" 上报。一条报文可包含多个子设备,但其 properties 合计最多 10 项;同一个 key 的多次采样保留为独立项。

{
"properties": [
{
"key": <entityID>_<fieldID>_<field>,
"name": <fieldID>_<field>,
"value": <value>,
"time": <time>
}
]
}
  1. <entityID> 机台或机组标识:如当前数据属于机台数据时,<entityID> 为机台标识 machineID;如当前数据属于机组数据时,<entityID> 为机组标识 groupID。machineID 与 groupID 见 4.1. 基本说明。
  2. <alias> 机台或机组名称:用户自定义的机台名称或机组名称(详见3.3.1. 添加机台,3.4.1. 添加机组)。
  3. <type> 类,<field> 字段与 <tag> 标签:一个类包含至少一个字段和不定数量的标签。字段是数据的名称。当某类不能仅以机台或机组进行区分时,我们需要为此数据种类添加标签。例如,类 SpindleOverload(主轴过载数据)包含字段 CumulativeTime(累计过载时间),和标签 SpindleNo(主轴号)。
  4. 标签的字段形式由标签缩写和标签值组成。如 S1 表示 SpindleNo=1;多个标签的字段形式之间用下横线连接。
  5. <fieldID> 字段标识:若类中不包含标签,则字段标识与类一致。若类包含标签,则字段标识由类和标签的字段形式构成。类和多个标签的字段形式间由下横线隔开。标签在字段形式中的顺序由下文中标签的序号决定。例如,字段标识 SpindleOverload_S1 表示第一主轴的过载数据,其中 S1 是 SpindleNo=1 的字段形式;字段标识 ToolLife_G1_I2 表示刀组 1 中第 2 把刀的寿命数据,其中 G1_I2 是 GroupNum=1;Index=2 的字段形式。
  6. <time> 时间戳:表示任务执行时的时间,单位是毫秒。
  7. <value> 数值:数值或内容。
  8. Default 和 MKT 模式,每条报文仅含来自同一机台或机组 <entityID> 的同一个数据类 <type> 的数据。TB、TB2、IoTDA、Brm、GeWu 和 WisIoT 等模式支持把不同机台或机组、不同数据类的数据合并到一条报文中。

示例 1–3 为 Default 模式下报文。

{
"type": "CNCStatus",
"unixtimestamp": 1698908463135,
"data": {
"cncStatus": "MANUAL",
"alarmStatus": "NO_ALARM"
},
"machineID": "10"
}

第 2 行,"type": "CNCStatus",

<type> 数据类,用 “CNCStatus” 作为关键词,可以在 4.2. 数据说明中 <type> 数据类表中找到,由此找到 4.2.4. CNCStatus:机台状态,识别本条报文中的数据为机台状态数据。

第 3 行,"unixtimestamp": 1698908463135,

<unixtimestamp> 时间戳,数值 1698908463135 即此条报文的时间戳。

第 4 行到第 7 行,

"data": {
"cncStatus": "MANUAL",
"alarmStatus": "NO_ALARM"
},

<data> 数据内容,可通过 <type> 申明的数据类查找对应内容的解释说明。这里查找 4.2.4. CNCStatus:机台状态,“cncStatus” 和 “alarmStatus” 是数据类 CNCStatus 下的 <field> 数据字段,代表 CNC 运行状态为调机状态:一般调机,警报状态为当前无警报。

第 8 行,"machineID": "10"

<entityID> 机台或机组标识:如当前数据属于机台数据时,<entityID> 为机台标识 machineID;如当前数据属于机组数据时,<entityID> 为机组标识 groupID。machineID 与 groupID 见 4.1. 基本说明。

第 8 行内容代表这条报文的数据来自机台标识为 10 的机台。

{
"type": "GroupCount",
"unixtimestamp": 1698911434710,
"data": {
"cumulativeCount": 233
},
"groupID": "g1"
}

第 2 行,"type": "GroupCount",

<type> 数据类,用 “GroupCount” 作为关键词,可以在 4.2. 数据说明中 <type> 数据类表中找到,由此找到 4.2.11. GroupCount:机组加工计数数据,识别本条报文中的数据为机组加工计数数据。

第 3 行,"unixtimestamp": 1698911434710,

<unixtimestamp> 时间戳,数值 1698911434710 即此条报文的时间戳。

第 4 行到第 6 行,

"data": {
"cumulativeCount": 233
},

<data> 数据内容,可通过 <type> 申明的数据类查找对应内容的解释说明。这里查找 4.2.11. GroupCount:机组加工计数数据,“cumulativeCount” 是数据 GroupCount 下的 <field> 数据字段,代表机组累计加工计数。

第 7 行,"groupID": "g1"

<entityID> 机台或机组标识:此处为 groupID 机组标识。

第 7 行内容代表这条报文的数据来自机组标识为 g1 的机组。

{
"type": "ToolLife",
"unixtimestamp": 1698908397751,
"data": {
"timeLimit": 1800,
"currentTime": 1620,
"prewarningTime": 1680
},
"toolNum": 9,
"toolOffsetNum": 2,
"machineID": "10"
}

第 2 行,"type": "ToolLife",

<type> 数据类,用 “ToolLife” 作为关键词,可以在 4.2. 数据说明中 <type> 数据类表中找到,由此找到 4.2.25. ToolLife:刀具寿命数据,识别本条报文中的数据为刀具寿命数据。

第 3 行,"unixtimestamp": 1698908397751,

<unixtimestamp> 时间戳,数值 1698908397751 即此条报文的时间戳。

第 4 行到第 8 行,

"data": {
"timeLimit": 1800,
"currentTime": 1620,
"prewarningTime": 1680
},

<data> 数据内容,可通过 <type> 申明的数据类查找对应内容的解释说明。这里查找 4.2.25. ToolLife:刀具寿命数据 <field> 数据字段,“timeLimit” 是寿命极限[秒],“currentTime” 是当前寿命[秒],“prewarningTime” 预警寿命[秒]。

第 9、第 10 行,"toolNum": 9, 与 "toolOffsetNum": 2,

可通过 <type> 申明的数据类查找对应内容的解释说明。这里查找 4.2.25. ToolLife:刀具寿命数据 <tag> 数据字段,“toolNum” 是刀号,“toolOffsetNum” 是刀补号。

第 9 第 10 两行内容代表这条报文的刀补数据属于 9 号刀 2 号刀补。

第 11 行,"machineID": "10"

<entityID> 机台或机组标识:此处为 machineID 机台标识,代表当前数据所属机台。

第 11 行内容代表这条报文的数据来自机台标识为 10 的机台。

{
"unixtimestamp": 1698908397751,
"10_ToolLife_T9_O2_timeLimit": 1800,
"10_ToolLife_T9_O2_currentTime": 1620,
"10_ToolLife_T9_O2_prewarningTime": 1680
}

第 2 行,"unixtimestamp": 1698908397751,

<unixtimestamp> 时间戳,数值 1698908397751 即此条报文的时间戳。

第 3 行,"10_ToolLife_T9_O2_timeLimit": 1800,

其格式为 "<entityID>_<fieldID>_<field>": <value>,

其中 10 是 <entityID> 机台或机组标识:此处为 machineID 机台标识,代表当前数据所属机台。

ToolLife_T9_O2 是 <fieldID> 数据字段标识,其中 ToolLife 是 <type> 数据类,用 “ToolLife” 作为关键词,可以在 4.2. 数据说明中 <type> 数据类表中找到,由此找到 4.2.25. ToolLife:刀具寿命数据,识别本条报文中的数据为刀具寿命数据。T9 与 O2 是 <tag> 数据标签缩写与标签内容的组合,查找 4.2.25. ToolLife:刀具寿命数据 <tag> 数据标签,得到 T 是 toolNum 刀号的缩写,O 是 toolOffsetNum 刀补号的缩写,代表这条报文的刀补数据属于 9 号刀 2 号刀补。

timeLimit 是 <field> 数据字段,查找 4.2.25. ToolLife:刀具寿命数据 <field> 数据字段,“timeLimit” 是寿命极限[秒]。

这一行的内容总结:来自机台标识为 10 的机台的 9 号刀 2 号刀补的刀具寿命数据,寿命极限为 1800 秒。

第 4 行,"10_ToolLife_T9_O2_currentTime": 1620,

类似第三行,此行内容总结:来自机台标识为 10 的机台的 9 号刀 2 号刀补的刀具寿命数据,当前寿命为 1620 秒。

第 5 行,"10_ToolLife_T9_O2_prewarningTime": 1680

类似第三行,此行内容总结:来自机台标识为 10 的机台的 9 号刀 2 号刀补的刀具寿命数据,预警寿命为 1680 秒。

{
"机台10": [ {
"ts": 1698908397751,
"values": {
"ToolLife_T9_O2_timeLimit": 1800,
"ToolLife_T9_O2_currentTime": 1620,
"ToolLife_T9_O2_prewarningTime": 1680
}
} ]
}

第 2 行,"机台10": [ {

其格式为 "<alias>": [ {,

其中机台 10 是 <alias> 机台或机组名称,由用户在网关机台配置页,添加/编辑机台(机组)窗口设置,如未设置,则默认 alias 与 entityID 机台或机组标识相同。

第 3 到第 6 行,"ts": 1698908397751,

<ts> 时间戳,数值 1698908397751 即此条报文的时间戳。

第 4 行到第 8 行,

"values": {
"ToolLife_T9_O2_timeLimit": 1800,
"ToolLife_T9_O2_currentTime": 1620,
"ToolLife_T9_O2_prewarningTime": 1680
}

<values> 数据内容。以第 5 行为例:

"ToolLife_T9_O2_timeLimit": 1800,

其格式为 "<fieldID>_<field>": <value>,

ToolLife_T9_O2 是 <fieldID> 数据字段标识,其中 ToolLife 是 <type> 数据类,用 “ToolLife” 作为关键词,可以在 4.2. 数据说明中 <type> 数据类表中找到,由此找到 4.2.25. ToolLife:刀具寿命数据,识别本条报文中的数据为刀具寿命数据。T9 与 O2 是 <tag> 数据标签缩写与标签内容的组合,查找 4.2.25. ToolLife:刀具寿命数据 <tag> 可以找到 T 是 toolNum 刀号的缩写,O 是 toolOffsetNum 刀补号的缩写,代表这条报文的刀补数据属于 9 号刀 2 号刀补。

timeLimit 是 <field> 数据字段,查找 4.2.25. ToolLife:刀具寿命数据 <field> 数据字段,“timeLimit” 是寿命极限[秒]。

这一行的内容:9 号刀 2 号刀补的刀具寿命数据,寿命极限为 1800 秒。

类似的,第 6 行内容:9 号刀 2 号刀补的刀具寿命数据,当前寿命为 1620 秒。第 7 行内容:9 号刀 2 号刀补的刀具寿命数据,预警寿命为 1680 秒。

{
"devices": [
{
"device_id": "10",
"services": [
{
"service_id": "ToolLife_T9_O2",
"properties": {
"timeLimit": 1800,
"currentTime": 1620,
"prewarningTime": 1680},
"event_time": 1698908397751
}
]
}
]
}

第 4 行,"device_id": "10",

其格式为 "device_id": <entityID>,

其中 10 是 <entityID> 机台或机组标识:此处为 machineID 机台标识,代表当前数据所属机台。此行内容代表这条报文的数据来自机台标识为 10 的机台。

第 7 行,"service_id": "ToolLife_T9_O2",

其格式为 "service_id": <fieldID>。ToolLife 是数据类;T9 和 O2 分别表示 9 号刀和 2 号刀补。可在 4.2.25. ToolLife:刀具寿命数据中查到对应标签。

第 8 行到第 11 行,

"properties": {
"timeLimit": 1800,
"currentTime": 1620,
"prewarningTime": 1680},

标签已编码在 service_id 中,properties 仅使用数据字段名,不附加 T9_O2 前缀,也不另设标签字段。

timeLimit 是 <field> 数据字段,查找 4.2.25. ToolLife:刀具寿命数据 <field> 数据字段,“timeLimit” 是寿命极限[秒],“currentTime” 是当前寿命[秒],“prewarningTime” 预警寿命[秒]。

这一段的内容总结:9 号刀 2 号刀补的刀具寿命数据,寿命极限为 1800 秒,当前寿命为 1620 秒,预警寿命为 1680 秒。

第 12 行,"event_time": 1698908397751

其格式为 "event_time": <time>。数值 1698908397751 即此条报文的时间戳。

假设机台 MACHINE_01 的 ToolLife 数据属于 9 号刀、2 号刀补,机台产品标识为 machineProduct,网关会将其发布至 $sys/gatewayProduct/gateway_0001/subdevice/propertyEvent/pub:

{
"messageId": "12345",
"params": {
"subDevices": [
{
"productKey": "machineProduct",
"deviceKey": "MACHINE_01",
"properties": [
{
"key": "ToolLife_T9_O2",
"value": {
"timeLimit": 1800,
"currentTime": 1620,
"prewarningTime": 1680
},
"ts": "1698908397751"
}
],
"events": []
}
]
}
}

这里的 deviceKey 来自机台 machineID,key 中的 T9_O2 表示刀号与刀补号,value 的三个键保持 ToolLife 的原字段名。