# MQTT API
MQTT 客户端和 Neuron 进行交互的所有主题。包括读、写、订阅。
所有主题中的 {client-id} 指的是实际的 MQTT 客户端 id，在 Neuron UI 的北向应用配置中设置。
# 上传数据
# 响应
默认主题 neuron/{client-id}/upload
# Body (Tags format)
{
"node": "modbus-tcp-2",
"group": "group-1",
"timestamp": 1647497389075,
"tags": [
{
"value": 123,
"name": "data1",
},
{
"name": "data2",
"error": 2014
}
]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
2
3
4
5
6
7
8
9
10
11
12
13
14
15
# Body (Values format)
{
"node": "opcua-1",
"group": "group-1",
"timestamp": 1650006388943,
"values":
{
"cstr01": "hello!"
},
"errors":
{
"cstr100": 10002
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
2
3
4
5
6
7
8
9
10
11
12
13
提示
当数值被正确读取时，将显示读取到的数值。当读点位数值发生错误时，将显示错误码，不再显示数值。一个 Group 发送一条信息。
上传主题可以在驱动配置表单中设置，一旦设置成自定义主题，则默认主题将被停用。
Body 有两种消息格式，您可以在 Neuron UI 中 mqtt 配置表单中选择。
# 心跳数据
# 响应
默认主题 neuron/{client-id}/heartbeat
# Body
{
"version": "2.1.0",
"timestamp": 1658134132237,
"states": [
{
"node": "mqtt-client",
"link": 2,
"running": 3
},
{
"node": "fx5u-client",
"link": 2,
"running": 3
}
]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
心跳主题可以在驱动配置表单中设置，一旦设置成自定义主题，则默认主题将被停用。
目前的心跳报文被默认设置为每3秒发送一次。
# 读 Tags
# 请求
主题 neuron/{client-id}/read/req
# Body
{
"uuid": "E21AEE51-1269-B228-E9E5-CD252CE10877",
"node": "modbus-tcp-1",
"group": "group-2"
}
1
2
3
4
5
2
3
4
5
# 响应
主题 neuron/{client-id}/read/resp
# Body
{
"uuid": "E21AEE51-1269-B228-E9E5-CD252CE10877",
"tags": [
{
"value": 4,
"name": "data1",
},
{
"name": "data2",
"error": 2014
}
]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
2
3
4
5
6
7
8
9
10
11
12
13
提示
当读点位数值发生错时，将显示 error 字段，不再显示 value 字段。
# 写 Tag
# 请求
主题 neuron/{client-id}/write/req
# Body
{
"uuid": "E21AEE51-1269-B228-E9E5-CD252CE10877",
"node": "modbus-tcp-1",
"group": "group-2",
"tag": "tag1",
"value": 1234
}
1
2
3
4
5
6
7
2
3
4
5
6
7
# 响应
主题 neuron/{client-id}/write/resp
# Body
{
"uuid": "E21AEE51-1269-B228-E9E5-CD252CE10877",
"error": 0
}
1
2
3
4
2
3
4