Changes

no edit summary
Line 1: Line 1: −
{{Template: Networking_rutos_manual_fw_disclosure
+
{{Template: Networking_device_manual_fw_disclosure
| fw_version ={{Template: Networking_rutos_manual_latest_fw
+
| series = {{{series}}}
 +
| name  = {{{name}}}
 +
| fw_version ={{Template: Networking_device_manual_latest_fw
 
  | series = {{{series}}}
 
  | series = {{{series}}}
 
  | name  = {{{name}}}
 
  | name  = {{{name}}}
 
  }}
 
  }}
 
}}
 
}}
{{#ifeq: {{{series}}} | RUT9 |<br><i><b>Note</b>: <b>[[{{{name}}} Modbus (legacy WebUI)|click here]]</b> for the old style WebUI (FW version {{Template: Networking_rutos_manual_latest_fw | series = RUT9XX}} and earlier) user manual page.</i>|}}
+
{{#ifeq: {{{series}}} | RUT9 |<br><i><b>Note</b>: <b>[[{{{name}}} Modbus (legacy WebUI)|click here]]</b> for the old style WebUI (FW version {{Template: Networking_device_manual_latest_fw | series = RUT9XX}} and earlier) user manual page.</i>|}}
{{#ifeq: {{{series}}} | RUT2 |<br><i><b>Note</b>: <b>[[{{{name}}} Modbus (legacy WebUI)|click here]]</b> for the old style WebUI (FW version {{Template: Networking_rutos_manual_latest_fw | series = RUT2XX}} and earlier) user manual page.</i>|}}
+
{{#ifeq: {{{series}}} | RUT2 |<br><i><b>Note</b>: <b>[[{{{name}}} Modbus (legacy WebUI)|click here]]</b> for the old style WebUI (FW version {{Template: Networking_device_manual_latest_fw | series = RUT2XX}} and earlier) user manual page.</i>|}}
 
==Summary==
 
==Summary==
   Line 16: Line 18:  
| RUTM =
 
| RUTM =
 
| TRB1 =  
 
| TRB1 =  
| TRB2 =  
+
| TRB2 =
 +
| TRB2M =
 
| RUT9|RUT9M =
 
| RUT9|RUT9M =
 
| #default =
 
| #default =
 
<u><b>
 
<u><b>
   −
Note:</b> On {{{name}}}, Modbus TCP Server/Client and MQTT Gateway is additional software that can be installed from the <b>Services → [[{{{name}}} Package Manager|Package Manager]]</b> page.</u><br>}}
+
Note:</b> On {{{name}}}, Modbus TCP Server/Client and MQTT Gateway is additional software that can be installed from the <b>System → [[{{{name}}} Package Manager|Package Manager]]</b> page.</u><br>}}
 
{{Template:Networking_rutos_manual_basic_advanced_webui_disclaimer
 
{{Template:Networking_rutos_manual_basic_advanced_webui_disclaimer
 
| series = {{{series}}}
 
| series = {{{series}}}
Line 144: Line 147:  
     <tr>
 
     <tr>
 
         <td>Data bits</td>
 
         <td>Data bits</td>
         <td>{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1|{{#ifeq:{{{series}}}|TRB2||5 {{!}} 6 {{!}}}} 7 {{!}} |}}8; default: <b>8</b></td>
+
         <td>{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1|{{#switch:{{{series}}}|TRB2|TRB2M=|#default=5 {{!}} 6 {{!}}}} 7 {{!}} |}}8; default: <b>8</b></td>
 
         <td>Number of data bits for each character.</td>
 
         <td>Number of data bits for each character.</td>
 
     </tr>
 
     </tr>
Line 225: Line 228:  
A <b>Modbus Client</b> device can request data from Modbus servers. The Modbus TCP Client section is used to configure Modbus TCP servers and enable Client. By default, the server list is empty and client is disabled. To add a new server, click the 'Add' button
 
A <b>Modbus Client</b> device can request data from Modbus servers. The Modbus TCP Client section is used to configure Modbus TCP servers and enable Client. By default, the server list is empty and client is disabled. To add a new server, click the 'Add' button
   −
[[File:Networking_rutos_manual_modbus_modbus_tcp_client_modbus_tcp_server_devices_add_button.png|border|class=tlt-border]]
+
[[File:Networking_rutos_manual_modbus_modbus_tcp_client_modbus_tcp_server_devices_add_button_v2.png|border|class=tlt-border]]
    
After clicking 'Add' you will be redirected to the newly added server's configuration page.
 
After clicking 'Add' you will be redirected to the newly added server's configuration page.
Line 265: Line 268:  
         <td>integer [0..65535]; default: <b>none</b></td>
 
         <td>integer [0..65535]; default: <b>none</b></td>
 
         <td>Server device's Modbus TCP port.</td>
 
         <td>Server device's Modbus TCP port.</td>
    </tr>
  −
    <tr>
  −
        <td>Period</td>
  −
        <td>integer [1..86400]; default: <b>60</b></td>
  −
        <td>Interval at which requests are sent to the server device.</td>
   
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
Line 330: Line 328:  
     <tr>
 
     <tr>
 
         <td>Data type</td>
 
         <td>Data type</td>
         <td>8bit INT {{!}} 8bit UINT {{!}} 16bit INT, high byte first {{!}} 16bit INT, low byte first {{!}} 16bit UINT, high byte first {{!}} 16bit UINT, low byte first {{!}} 32bit float (various Byte order) {{!}} 32bit INT (various Byte order) {{!}} 32bit UINT (various Byte order) {{!}} ASCII {{!}} Hex {{!}} Bool; default: <b>16bit INT, high byte first</b></td>
+
         <td>8bit INT {{!}} 8bit UINT {{!}} 16bit INT, high byte first {{!}} 16bit INT, low byte first {{!}} 16bit UINT, high byte first {{!}} 16bit UINT, low byte first {{!}} 32bit float (various Byte order) {{!}} 32bit INT (various Byte order) {{!}} 32bit UINT (various Byte order) {{!}} ASCII {{!}} Hex {{!}} Bool {{!}} PDU; default: <b>16bit INT, high byte first</b></td>
 
         <td>Defines how read data will be stored.</td>
 
         <td>Defines how read data will be stored.</td>
 
     </tr>
 
     </tr>
Line 380: Line 378:  
The figure below is an example of the Alarms Configuration list. To create a new Alarm, click the 'Add' button.
 
The figure below is an example of the Alarms Configuration list. To create a new Alarm, click the 'Add' button.
   −
[[File:Networking_rutos_manual_modbus_modbus_tcp_client_alarms_configuration_add_button.png|border|class=tlt-border]]
+
[[File:Networking_rutos_manual_modbus_modbus_tcp_client_alarms_configuration_add_button_v2.png|border|class=tlt-border]]
    
After adding the Alarm you should be redirected to its configuration page which should look similar to this:
 
After adding the Alarm you should be redirected to its configuration page which should look similar to this:
Line 439: Line 437:  
     <tr>
 
     <tr>
 
         <td>Action</td>
 
         <td>Action</td>
         <td>{{#ifeq:{{{mobile}}}|1|<span style="color: #0054a6;">SMS</span> {{!}}|}} <span style="color: purple;">MODBUS Write Request</span>{{#switch:{{{series}}}|TCR1=|TRB2=|#default= {{!}} Trigger output}} | <span style="color: red;">MQTT message</span>; default: <b>MODBUS Write Request</b></td>
+
         <td>Ubus event {{!}} {{#ifeq:{{{mobile}}}|1|<span style="color: #0054a6;">SMS</span> {{!}}|}} <span style="color: purple;">MODBUS Write Request</span>{{#switch:{{{series}}}|TCR1|TRB2|TRB2M=|#default= {{!}} Trigger output}} | <span style="color: red;">MQTT message</span>; default: <b>MODBUS Write Request</b></td>
 
         <td>Action that will be taken if the condition is met. Possible actions:
 
         <td>Action that will be taken if the condition is met. Possible actions:
 
             <ul>{{#ifeq: {{{mobile}}} | 1 |
 
             <ul>{{#ifeq: {{{mobile}}} | 1 |
 
                 <li><b>SMS</b> - sends and SMS message to a specified recipient(s).</li>|}}
 
                 <li><b>SMS</b> - sends and SMS message to a specified recipient(s).</li>|}}
 
                 <li><b>Modbus Request</b> - sends a Modbus Write request to a specified server.</li>
 
                 <li><b>Modbus Request</b> - sends a Modbus Write request to a specified server.</li>
{{#switch:{{{series}}}|TCR1=|TRB2=|#default=<li><b>Trigger output</b> - changes state of selected I/O output pin.</li>}}
+
{{#switch:{{{series}}}|TCR1|TRB2|TRB2M=|#default=<li><b>Trigger output</b> - changes state of selected I/O output pin.</li>}}
 
             </ul>
 
             </ul>
 
         </td>
 
         </td>
Line 497: Line 495:  
         <td>integer [0..65535]; default: <b>none</b></td>
 
         <td>integer [0..65535]; default: <b>none</b></td>
 
         <td>Register/Coil values to be written (multiple values must be separated by space character).</td>
 
         <td>Register/Coil values to be written (multiple values must be separated by space character).</td>
     </tr>{{#switch:{{{series}}}|TCR1=|TRB2=|#default=
+
     </tr>{{#switch:{{{series}}}|TCR1|TRB2|TRB2M=|#default=
 
     <tr>
 
     <tr>
 
         <td><span style="color: green;">Trigger output: Output</span></td>{{#switch:{{{series}}}
 
         <td><span style="color: green;">Trigger output: Output</span></td>{{#switch:{{{series}}}
Line 545: Line 543:  
         <td>At most once (0) | At least once (1) | Exactly once (2); default: <b>At most once (0)</b></td>
 
         <td>At most once (0) | At least once (1) | Exactly once (2); default: <b>At most once (0)</b></td>
 
         <td>A period of time (in seconds) which has to pass after a trigger event before this Action is executed.</td>
 
         <td>A period of time (in seconds) which has to pass after a trigger event before this Action is executed.</td>
 +
    </tr>
 +
    <tr>
 +
        <td><span style="color: red;">MQTT message: Use root CA</span></td>
 +
        <td>off | on; default: <b>off</b></td>
 +
        <td>Use root CA for verifying the servers certificates </td>
 +
    </tr>
 +
    <tr>
 +
        <td><span style="color: red;">MQTT message: Use TLS</span></td>
 +
        <td>off | on; default: <b>off</b></td>
 +
        <td>Turns the use of TLS/SSL for this MQTT connection on or off.</td>
 +
    </tr><tr>
 +
        <td><span style="color: red;">MQTT message: Use credentials</span></td>
 +
        <td>off | on; default: <b>off</b></td>
 +
        <td>Turns the use of username and password for this MQTT connection on or off.</td>
 
     </tr>
 
     </tr>
 
</table>
 
</table>
Line 552: Line 564:  
The <b>Modbus Serial Client</b> page is used to configure the device as a Modbus RTU Client. Modbus RTU (remote terminal unit) is a serial communication protocol mainly used in communication via serial interfaces.
 
The <b>Modbus Serial Client</b> page is used to configure the device as a Modbus RTU Client. Modbus RTU (remote terminal unit) is a serial communication protocol mainly used in communication via serial interfaces.
   −
[[File:Networking_rutos_manual_modbus_modbus_serial_client.png|border|class=tlt-border]]
+
[[File:Networking_rutos_manual_modbus_modbus_serial_client_v2.png|border|class=tlt-border]]
<!--<u><b>Note:</b> Modbus Serial Client is additional software that can be installed from the <b>Services → [[{{{name}}} Package Manager|Package Manager]]</b> page.</u>-->
+
<!--<u><b>Note:</b> Modbus Serial Client is additional software that can be installed from the <b>System → [[{{{name}}} Package Manager|Package Manager]]</b> page.</u>-->
    
===Modbus Serial Device Configuration===
 
===Modbus Serial Device Configuration===
Line 601: Line 613:  
     <tr>
 
     <tr>
 
         <td>Data bits</td>
 
         <td>Data bits</td>
         <td>{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1|{{#ifeq:{{{series}}}|TRB2||5 {{!}} 6 {{!}}}} 7 {{!}} |}}8; default: <b>8</b></td>
+
         <td>{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1|{{#switch:{{{series}}}|TRB2|TRB2M=|#default=5 {{!}} 6 {{!}}}} 7 {{!}} |}}8; default: <b>8</b></td>
 
         <td>Number of data bits for each character.</td>
 
         <td>Number of data bits for each character.</td>
 
     </tr>
 
     </tr>
Line 673: Line 685:  
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td>Server device</td>
+
         <td>Serial device</td>
         <td><i>server device instance</i>; default: <b>none</b></td>
+
         <td><i>serial device instance</i>; default: <b>none</b></td>
 
         <td>Specifies which serial device will be used on this server.</td>
 
         <td>Specifies which serial device will be used on this server.</td>
 
     </tr>
 
     </tr>
Line 731: Line 743:  
     <tr>
 
     <tr>
 
         <td>Data type</td>
 
         <td>Data type</td>
         <td>8bit INT {{!}} 8bit UINT {{!}} 16bit INT, high byte first {{!}} 16bit INT, low byte first {{!}} 16bit UINT, high byte first {{!}} 16bit UINT, low byte first {{!}} 32bit float (various Byte order) {{!}} 32bit INT (various Byte order) {{!}} 32bit UINT (various Byte order) {{!}} ASCII {{!}} Hex {{!}} Bool; default: <b>16bit INT, high byte first</b></td>
+
         <td>8bit INT {{!}} 8bit UINT {{!}} 16bit INT, high byte first {{!}} 16bit INT, low byte first {{!}} 16bit UINT, high byte first {{!}} 16bit UINT, low byte first {{!}} 32bit float (various Byte order) {{!}} 32bit INT (various Byte order) {{!}} 32bit UINT (various Byte order) {{!}} ASCII {{!}} Hex {{!}} Bool {{!}} PDU; default: <b>16bit INT, high byte first</b></td>
 
         <td>Defines how read data will be stored.</td>
 
         <td>Defines how read data will be stored.</td>
 
     </tr>
 
     </tr>
Line 840: Line 852:  
     <tr>
 
     <tr>
 
         <td>Action</td>
 
         <td>Action</td>
         <td>{{#ifeq:{{{mobile}}}|1|SMS {{!}}|}} MODBUS Write Request{{#switch:{{{series}}}|TCR1=|TRB2=|#default= {{!}} Trigger output}}; default: <b>MODBUS Write Request</b></td>
+
         <td>{{#ifeq:{{{mobile}}}|1|SMS {{!}}|}} MODBUS Write Request{{#switch:{{{series}}}|TCR1|TRB2|TRB2M=|#default= {{!}} Trigger output}}; default: <b>MODBUS Write Request</b></td>
 
         <td>Action that will be taken if the condition is met. Possible actions:
 
         <td>Action that will be taken if the condition is met. Possible actions:
 
             <ul>{{#ifeq: {{{mobile}}} | 1 |
 
             <ul>{{#ifeq: {{{mobile}}} | 1 |
 
                 <li><b>SMS</b> - sends and SMS message to a specified recipient(s).</li>|}}
 
                 <li><b>SMS</b> - sends and SMS message to a specified recipient(s).</li>|}}
 
                 <li><b>Modbus Request</b> - sends a Modbus Write request to a specified server.</li>
 
                 <li><b>Modbus Request</b> - sends a Modbus Write request to a specified server.</li>
{{#switch:{{{series}}}|TCR1=|TRB2=|#default=<li><b>Trigger output</b> - changes state of selected I/O output pin.</li>}}
+
{{#switch:{{{series}}}|TCR1|TRB2|TRB2M|#default=<li><b>Trigger output</b> - changes state of selected I/O output pin.</li>}}
 
             </ul>
 
             </ul>
 
         </td>
 
         </td>
Line 888: Line 900:  
         <td>integer [0..65535]; default: <b>none</b></td>
 
         <td>integer [0..65535]; default: <b>none</b></td>
 
         <td>Register/Coil values to be written (multiple values must be separated by space character).</td>
 
         <td>Register/Coil values to be written (multiple values must be separated by space character).</td>
     </tr>{{#switch:{{{series}}}|TCR1=|TRB2=|#default=
+
     </tr>{{#switch:{{{series}}}|TCR1|TRB2|TRB2M=|#default=
 
     <tr>
 
     <tr>
 
         <td><span style="color: green;">Trigger output: Output</span></td>{{#switch:{{{series}}}
 
         <td><span style="color: green;">Trigger output: Output</span></td>{{#switch:{{{series}}}
Line 1,192: Line 1,204:  
|}}
 
|}}
   −
==MQTT Gateway==
+
==MQTT Modbus Gateway==
   −
The <b>MQTT Gateway</b> function is used to transfer Modbus data (send requests, receive responses) over MQTT. When it is enabled, the device (this {{{name}}}) subscribes to a REQUEST topic and publishes on a RESPONSE topic on a specified MQTT broker. It translates received MQTT message payload to a Modbus request and relays it to the specified Modbus TCP server.
+
The <b>MQTT Modbus Gateway</b> function is used to transfer Modbus data (send requests, receive responses) over MQTT. When it is enabled, the device (this {{{name}}}) subscribes to a REQUEST topic and publishes on a RESPONSE topic on a specified MQTT broker. It translates received MQTT message payload to a Modbus request and relays it to the specified Modbus TCP server.
    
When the MQTT Gateway receives a response from the server, it translates it to an MQTT message and publishes it on the RESPONSE topic.
 
When the MQTT Gateway receives a response from the server, it translates it to an MQTT message and publishes it on the RESPONSE topic.
Line 1,347: Line 1,359:  
     <tr>
 
     <tr>
 
         <td>Data bits</td>
 
         <td>Data bits</td>
         <td>{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1|{{#ifeq:{{{series}}}|TRB2||5 {{!}} 6 {{!}}}} 7 {{!}} |}}8; default: <b>8</b></td>
+
         <td>{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1|{{#switch:{{{series}}}|TRB2|TRB2M=|#default=5 {{!}} 6 {{!}}}} 7 {{!}} |}}8; default: <b>8</b></td>
 
         <td>Number of data bits for each character.</td>
 
         <td>Number of data bits for each character.</td>
 
     </tr>
 
     </tr>
Line 1,499: Line 1,511:  
After this you should be redirected to instance's configuration page which should look similar to this:
 
After this you should be redirected to instance's configuration page which should look similar to this:
   −
[[File:Networking_rutos_manual_modbus_modbus_tcp_over_serial_gateway_configuration_rs232_{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1|1|0}}_v1.png|border|class=tlt-border]]
+
[[File:Networking_rutos_manual_modbus_modbus_tcp_over_serial_gateway_configuration_rs232_{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1|1|0}}_v2.png|border|class=tlt-border]]
    
<table class="nd-mantable">
 
<table class="nd-mantable">
Line 1,529: Line 1,541:  
     <tr>
 
     <tr>
 
         <td>Data bits</td>
 
         <td>Data bits</td>
         <td>{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1|{{#ifeq:{{{series}}}|TRB2||5 {{!}} 6 {{!}}}} 7 {{!}} |}}8; default: <b>8</b></td>
+
         <td>{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1|{{#ifeq:{{{series}}}|TRB2|TRB2M=|#default=5 {{!}} 6 {{!}}}} 7 {{!}} |}}8; default: <b>8</b></td>
 
         <td>Number of data bits for each character.</td>
 
         <td>Number of data bits for each character.</td>
 
     </tr>
 
     </tr>
Line 1,609: Line 1,621:  
Then enter the IP address and save.
 
Then enter the IP address and save.
   −
[[File:Networking_rutos_manual_console_ip_filter_instance.png|border|class=tlt-border]]
+
[[File:Networking_rutos_manual_console_ip_filter_instance_v2.png|border|class=tlt-border]]
 
|}}
 
|}}
 +
 
==See also==
 
==See also==
    
<ul>
 
<ul>
     <li><b>[[{{{name}}} Monitoring via Modbus|Monitoring via Modbus]]</b> - detailed examples on how to use Modbus TCP</li>
+
     <li><b>[[Monitoring via Modbus|Monitoring via Modbus]]</b> - detailed examples on how to use Modbus TCP</li>
 
</ul>
 
</ul>
    
[[Category:{{{name}}} Services section]]
 
[[Category:{{{name}}} Services section]]

Navigation menu