运行中

启动二进制程序，传递给MQTT服务器的URL，包括任何凭证

$ modbus-mqtt mqtt://$MQTT_HOST[:$MQTT_PORT]/[$CUSTOM_MODBUS_TOPIC]

当前支持的协议仅为 tcp:///mqtt://，但打算支持： mqtts://、ssl:///tls://、ws://和wss://。

ModbusMQTT监控并发布的默认主题是modbus-mqtt。您可以通过更改MQTT URL的路径部分来更改此主题。

此外，您可以通过使用查询参数来更改其他MQTT选项，例如设置自定义的client_id

"mqtt://1.2.3.4/?client_id=$CUSTOM_CLIENT_ID"

有关支持的选项的完整列表，请检查MQTT客户端库的源代码。

连接到Modbus设备

要连接到Modbus设备，您需要将连接详情发布到MQTT的$prefix/$connection_id/connect主题下。这些消息应该被标记为保留，这样当ModbusMQTT重启或崩溃时，它会重新连接到您的设备。

例如，一个简单的配置可能如下

// PUBLISH modbus-mqtt/solar-inverter/connect
{
  "host": "10.10.10.219",
  "proto": "tcp",
}

如果连接成功，您将看到如下消息发送到MQTT服务器

// modbus-mqtt/solar-inverter/state
"connected"

完整的连接示例

请检查examples/目录中的示例，并请随时分享您自己的示例，注明相应的供应商/设备信息。

以下JSON包含所有支持的连接配置字段，其中可选字段显示默认值。

{
  // Common fields
  "address_offset": 0, // optional
  "unit": 1,           // optional, aliased to "slave"

  // TCP:
  "proto": "tcp",
  "host": "1.2.3.4",
  "port": 502, // optional

  // RTU / Serial:
  "proto": "rtu",
  "tty": "/dev/ttyACM0",
  "data_bits": "Eight",   // optional (TODO: accept numeric and lowercase)
                          //   valid: Five, Six, Seven, Eight
  "stop_bits": "One",     // optional (TODO: accept numeric and lowercase)
                          //   valid: One, Two
  "flow_control": "None", // optional (TODO: accept lowercase)
                          //   valid: None, Software, Hardware
  "parity": "None",       // optional (TODO: accept lowercase)
                          //   valid: None, Odd, Even

  // Sungrow WiNet-S dongle
  "proto": "winet-s",
  "host": "1.2.3.4",
}

监控寄存器

向$MODBUS_MQTT_TOPIC/$CONNECTION_ID/$ADDRESS发送以下负载（可选字段显示默认值）

{
  "address": 5123,          // REQUIRED

  "register_type": "input", // OPTIONAL

  "name": null,             // OPTIONAL - gives the register a name which is used in the register MQTT topics (must be a valid topic component)

  "interval": "1m",         // OPTIONAL - how often to update the registers value to MQTT
                            //   e.g.: 3s (every 3 seconds)
                            //         2m (every 2 minutes)
                            //         1h (every 1 hour)

  "swap_bytes": false,      // OPTIONAL
  "swap_words": false,      // OPTIONAL

  "type": "s16",            // OPTIONAL
                            //   valid: s8, s16, s32, s64 (signed)
                            //          u8, u16, u32, u64 (unsigned)
                            //          f32, f64          (floating point)

  "scale": 0,               // OPTIONAL - number in register will be multiplied by 10^(scale)
                            //   e.g.: to turn kW into W, you would provide scale=3
                            //         to turn W into kW, you would provide scale=-3

  "offset": 0,              // OPTIONAL - will be added to the final result (AFTER scaling)
}

寄存器缩写

在发出connect负载时，您可以可选地包含一个顶级的registers数组，包含上述寄存器模式。如果存在，这些负载将作为如果用户分别指定了每个寄存器一样，被重播到MQTT服务器。

这是指定连接的推荐方式，但寄存器被分开列出，以便它们也可以动态添加。

开发

TODO：设置类似于https://hub.docker.com/r/oitc/modbus-server的东西以进行测试

类似的项目

• https://github.com/Instathings/modbus2mqtt
  • https://github.com/mbs38/spicierModbus2mqtt
• https://github.com/BlackZork/mqmgateway
• https://github.com/TenySmart/ModbusTCP2MQTT - Sungrow逆变器专用
• https://github.com/bohdan-s/SunGather - Sungrow逆变器专用