1,108
edits
Changes
no edit summary
[[File:Networking Topology MQTT MODBUS flespi configuration v1.png|center|class=tlt-border|800x800px]]
[[File:Networking Topology MQTT MODBUS flespi configuration v1.png|center|class=tlt-border|800x800px]]
===Configuring RUT955 Modbus TCP Slave===
===Configuring RUT955 MQTT Gateway===
----
----
Go to '''Services → Modbus → Modbus TCP Slave''':
Go to '''Services → Modbus → MQTT Gateway''' and there:
#Check '''Enable'''
# '''Enable''' the '''instance''';
#Enter port that will be used, in this example 502 will be used
# '''Enter Host''' (copied from flespi connection settings without 'wss://' and port);
#Enter device ID
# '''Enter Username''' (Copied from flespi Connection settings generated '''token''');
#Press '''Save & Apply'''
# '''Enter Password'''.
[[File:MQTT Gateway config.png|border|center|class=tlt-border|862x412px]]
''Modbus TCP Slave RUT955 is now configured''.
'''Note''': ''Everything else can be left as default or changed according to your needs.''
===Configuring RUT955 Modbus TCP Master===
===Configuring RUT955 Serial Gateway===
----
----
Under the MQTT Gateway configuration, create the Serial Gateway:
# Enter the desired device ID;
# Select the desired serial interface.
[[File:Serial gateway config.png|border|center|class=tlt-border|868x308px]]
[[File:Networking_MQTT_MODBUS_flespi_configuration_master_add_v1.png|alt=|border|class=tlt-border|1007x1007px]]
===Configuring Flespi.io MQTT Broker===
===Configuring Flespi.io MQTT Broker===
----
----
'''Log in''' or '''create an account''' on '''https://flespi.io''';
#Navigate to '''MQTT Board''' on the '''left side''' menu;
#On the right-hand panel, top right corner, next to the name of the MQTT board, press the cogwheel-looking icon to open ''Connection Settings'';
#In the opened window, press "Get flespi token" to generate a username;
#Enter the Client name;
#Copy the Host address;
#Copy Username;
#Create a password.
Once done, save all the changes
[[File:Flespi board.png|border|center|class=tlt-border|1102x729px]]
[[File:Networking MQTT modbus fespi Connection settings v1.png|border|class=tlt-border|544x544px]] [[File:Networking MQTT Modbus flespi board.png|border|class=tlt-border|544x544px]]
===Message format for MQTT publisher===
===Message format for MQTT publisher===
----
----
<b>1 <COOKIE> <SERIAL_DEVICE_ID> <TIMEOUT> <SLAVE_ID> <MODBUS_FUNCTION> <FIRST_REGISTER> <REGISTER_COUNT/VALUES></b>
The format is in the text - heavier and slower, but less difficult to edit.
The format is in the text - heavier and slower, but less difficult to edit.
{| class="wikitable"
{| class="wikitable"
|1. Format version
|1. Format version
|'''0'''
|'''1'''
|-
|-
|2. Cookie
|2. Cookie
|from '''0''' to '''2<sup>64</sup> -1'''
|from '''0''' to '''2<sup>64</sup> -1'''
|-
|-
|3. IP Type
|3. Serial device ID
|'''0''' - IPv4; '''1''' - IPv6; '''2''' - hostname
|a string used to identify a serial device. Must match with <u>Device ID</u> field in MQTT Gateway page Serial gateway configuration section
|-
|-
|4. IP
|4. Timeout
|IPv6 must be in full format (for example: '''2001:0db8:0000:0000:0000:8a2e:0370:7334''')
|timeout for Modbus connection, in seconds. Range [1..999].
|-
|-
|5. Port
|5. Slave ID
|Port number (for example: '''502''')
|Indicates to which slave request is sent
|-
|-
|6. Timeout in seconds (time to wait for response)
|6. Modbus function
|from '''1''' to '''999'''
|Modbus task type that will be executed. Possible values are:
<ul>
<li><b>1</b> - read coils;</li>
<li><b>2</b> - read input coils;</li>
<li><b>3</b> - read holding registers;</li>
<li><b>4</b> - read input registers;</li>
<li><b>5</b> - set single coil;</li>
<li><b>6</b> - write to a single holding register;</li>
<li><b>15</b> - set multiple coils;</li>
<li><b>16</b> - write to multiple holding registers.</li>
</ul>
|-
|-
|7. Slave ID - Indicates to which slave request is sent
|7. First register
|from '''1''' to '''255'''
|number (not address) of the first register/coil/input (in range [1..65536]) from which the registers/coils/inputs will be read/written to.
|-
|-
|8. Function
|8. Registry count
|'''3''' - read registers; '''6''' - write single register; '''16''' - write multiple registers
| <li><b>1</b> - <u>coil count</u> (in range [1..2000]); must not exceed the boundary (first coil number + coil count <= 65537);</li>
<li><b>2</b> - <u>input count</u> (in range [1..2000]); must not exceed the boundary (first input number + input count <= 65537);</li>
<li><b>3</b> - <u>holding register count</u> (in range [0..125]); must not exceed the boundary (first register number + holding register count <= 65537);</li>
<li><b>4</b> - <u>input register count</u> (in range [0..125]); must not exceed the boundary (first register number + input register count <= 65537);</li>
<li><b>5</b> - <u>coil value</u> (in range [0..1]);</li>
<li><b>6</b> - <u>holding register value</u> (in range [0..65535]);</li>
<li><b>15</b> - <u>coil count</u> (in range [1..1968]); must not exceed the boundary (first coil number + coil count <= 65537); and <u>coil values</u> separated with commas, without spaces (e.g., <i>1,2,3,654,21,789</i>); there must be exactly as many values as specified (with coil count); each value must be in the range of [0..1].
|-
|-
|9. Number of the first register from which information will be read or written
|9.register count
|from '''1''' to '''65535'''
|register count</u> (in range [1..123]); must not exceed the boundary (first register number + register count <= 65537); and <u>register values</u> separated with commas, without spaces (e.g., <i>1,2,3,654,21,789</i>); there must be exactly as many values as specified (with register count); each value must be in the range of [0..65535].
|}
====Examples====
====Examples====
