Template:Networking rutos manual modbus: Difference between revisions

Note:</b> On {{{name}}}, Modbus TCP Slave/Master and MQTT Gateway is additional software that can be installed from the <b>Services → [[{{{name}}} Package Manager|Package Manager]]</b> page.</u><br>}}

==Modbus TCP Slave==

A <b>Modbus TCP Slave</b> listens for connections from a TCP master (client) and sends out a response or sets some system related parameter in accordance with the given query. This provides the user with the possibility to set or get system parameters.  

       <td>The device's Modbus slave ID. When set to 0, it will respond to requests addressed to any ID.</td>

         <td>Allows keep the connection open after responding a Modbus TCP master request.</td>

==Modbus Serial Slave==

A <b>Modbus Serial Slave</b> listens for connections from a serial master (client) and sends out a response or sets some system related parameter in accordance with the given query. This provides the user with the possibility to set or get system parameters.  

===Modbus Serial Slave Configuration===

The <b>Modbus Serial Slave Configuration</b> section is used to configure serial slaves. By default, the list is empty. To add a new slave instance, enter the instance name, select serial interface and click the 'Add' button.

After clicking 'Add' you will be redirected to the newly added slave instance configuration page.

         <td>Enables this Modbus Serial Slave instance configuration.</td>

         <td>Name of the serial slave instance. Used for management purposes only.</td>

==Modbus TCP Master==

A <b>Modbus Master</b> device can request data from Modbus slaves. The Modbus TCP Master section is used to configure Modbus TCP slaves. By default, the slave list is empty. To add a new slave, click the 'Add' button

After clicking 'Add' you will be redirected to the newly added slave's configuration page.

===Slave Device Configuration===

The <b>Slave Device Configuration</b> section is used to configure the parameters of Modbus TCP slaves that the Master (this {{{name}}} device) will be querying with requests. The figure below is an example of the Slave Device Configuration and the table below provides information on the fields contained in that section:

         <td>Turns communication with the slave device on or off.</td>

         <td>Slave device's name, used for easier management purposes.</td>

         <td>Slave ID</td>

         <td>Slave ID. Each slave in a network is assigned a unique identifier ranging from 1 to 255. When the master requests data from a slave, the first byte it sends is the Slave ID. When set to 0, the slave will respond to requests addressed to any ID.</td>

         <td>Slave device's IP address.</td>

         <td>Slave device's Modbus TCP port.</td>

         <td>Interval at which requests are sent to the slave device.</td>

A Modbus <b>request</b> is a way of obtaining data from Modbus slaves. The master sends a request to a slave specifying the function code to be performed. The slave then sends the requested data back to the Modbus master.

<span style="color:red"> <b>Note: </b></span> Modbus TCP Master uses <i>Register Number</i> instead of <i>Register Address</i> for pointing to a register. For example, to request the <i>Uptime</i> of a device, you must use <b>2</b> in the <i>First Register</i> field.

<b>Alarms</b> are a way of setting up automated actions when some Modbus values meet user-defined conditions. When the Modbus TCP Master (this {{{name}}} device) requests some information from a slave device it compares that data to with the parameters set in an Alarm Configuration. If the comparison meets the specified condition (more than, less than, equal to, not equal to), the Master performs a user-specified action, for example, a Modbus write request or switching the state of an output.

         <td>Modbus function used for this alarm's Modbus request. The Modbus TCP Master (this {{{name}}} device) perform this request as often as specified in the 'Period' field in [[#Slave_Device_Configuration|Slave Device Configuration]].</td>

                 <li><b>Modbus Request</b> - sends a Modbus Write request to a specified slave.</li>

         <td>Modbus slave's IP address.</td>

         <td>Modbus slave's port.</td>

         <td>Modbus slave ID.</td>

==Modbus Serial Master==

The <b>Modbus Serial Master</b> page is used to configure the device as a Modbus RTU Master. Modbus RTU (remote terminal unit) is a serial communication protocol mainly used in communication via serial interfaces.

<!--<u><b>Note:</b> Modbus Serial Master is additional software that can be installed from the <b>Services → [[{{{name}}} Package Manager|Package Manager]]</b> page.</u>-->

This section is used to create Modbus Serial Master's slave device instances. You may create a Serial Device instance for each supported serial interface.  

====RS Device Modbus Master Configuration====

This section is used to configure the Modbus Serial Master's slave device interface settings.

===Modbus Slave Device Configuration===

This section is used to create slave instances that the Master (this {{{name}}} device) will be querying with requests.

By default there are no instances created. To add a new slave configuration, enter an instance name, select a serial device instance and click the 'Add' button.

After clicking 'Add' you will be redirected to the newly added slave's configuration page.

====Slave Device Configuration====

The <b>Slave Device Configuration</b> section is used to configure the parameters of Modbus RTU slaves that the Master (this {{{name}}} device) will be querying with requests. The figure below is an example of the Slave Device Configuration and the table below provides information on the fields contained in that section:

         <td>Turns communication with the slave device on or off.</td>

         <td>Slave device's name, used for easier management purposes.</td>

         <td>Slave device</td>

         <td><i>slave device instance</i>; default: <b>none</b></td>

         <td>Specifies which serial device will be used on this slave.</td>

         <td>Slave ID</td>

         <td>Slave ID. Each slave in a network is assigned a unique identifier ranging from 1 to 255. When the master requests data from a slave, the first byte it sends is the Slave ID. When set to 0, the slave will respond to requests addressed to any ID.</td>

         <td>Interval at which requests are sent to the slave device.</td>

A Modbus <b>request</b> is a way of obtaining data from Modbus slaves. The master sends a request to a slave specifying the function code to be performed. The slave then sends the requested data back to the Modbus master.  

<span style="color:red"> <b>Note: </b></span> Modbus Serial Master uses <i>Register Number</i> instead of <i>Register Address</i> for pointing to a register. For example, to request the <i>Uptime</i> of a device, you must use <b>2</b> in the <i>First Register</i> field.

=====Modbus Master Alarms=====

<b>Alarms</b> are a way of setting up automated actions when some Modbus values meet user-defined conditions. When the Modbus Serial Master (this {{{name}}} device) requests some information from a slave device it compares that data to with the parameters set in an Alarm Configuration. If the comparison meets the specified condition (more than, less than, equal to, not equal to), the Master performs a user-specified action, for example, a Modbus write request or switching the state of an output.

The figure below is an example of the Modbus Master Alarms list. To create a new Alarm, click the 'Add' button.

         <td>Modbus function used for this alarm's Modbus request. The Modbus TCP Master (this {{{name}}} device) perform this request as often as specified in the 'Period' field in [[#Slave_Device_Configuration|Slave Device Configuration]].</td>

                 <li><b>Modbus Request</b> - sends a Modbus Write request to a specified slave.</li>

         <td>Modbus slave ID.</td>

This section is used to configure the Modbus Serial Master's <b>Console</b> serial interface settings. Refer to the figure and table below for information on Console configuration.

         <td>Turns Modbus Serial Master configuration via RS232 on or off. Both this and RS232 from Services → [[{{{name}}} RS232|RS232]] cannot be enabled at the same time.</td>

====Console Slave Devices List====

The <b>Console Slave Devices List</b> section is used to configure the parameters of Modbus RTU slaves that the Master (this {{{name}}} device) will be querying with requests.

The list is empty by default. In order to create a new slave device configuration, click the 'Add' button. A new configuration window should pop up.

=====Slave Device Configuration=====

The <b>Slave Device Configuration</b> section is used to configure the parameters of Modbus RTU slaves that the Master (this {{{name}}} device) will be querying with requests. The figure below is an example of the Slave Device Configuration and the table below provides information on the fields contained in that section:

         <td>Turns communication with the slave device on or off.</td>

         <td>Slave device's name, used for easier management purposes.</td>

         <td>Slave ID</td>

         <td>Slave ID. Each slave in a network is assigned a unique identifier ranging from 1 to 255. When the master requests data from a slave, the first byte it sends is the Slave ID. When set to 0, the slave will respond to requests addressed to any ID.</td>

         <td>Interval at which requests are sent to the slave device.</td>

A Modbus <b>request</b> is a way of obtaining data from Modbus slaves. The master sends a request to a slave specifying the function code to be performed. The slave then sends the requested data back to the Modbus master.

<span style="color:red"> <b>Note: </b></span> Modbus Serial Master uses <i>Register Number</i> instead of <i>Register Address</i> for pointing to a register. For example, to request the <i>Uptime</i> of a device, you must use <b>2</b> in the <i>First Register</i> field.

=====Modbus Master Alarms=====

<b>Alarms</b> are a way of setting up automated actions when some Modbus values meet user-defined conditions. When the Modbus Serial Master (this {{{name}}} device) requests some information from a slave device it compares that data to with the parameters set in an Alarm Configuration. If the comparison meets the specified condition (more than, less than, equal to, not equal to), the Master performs a user-specified action, for example, a Modbus write request or switching the state of an output.

The figure below is an example of the Modbus Master Alarms list. To create a new Alarm, click the 'Add' button.

         <td>Modbus function used for this alarm's Modbus request. The Modbus TCP Master (this {{{name}}} device) perform this request as often as specified in the 'Period' field in [[#Slave_Device_Configuration|Slave Device Configuration]].</td>

                 <li><b>Modbus Request</b> - sends a Modbus Write request to a specified slave.</li>

         <td>Modbus slave ID.</td>

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 slave.

When the MQTT Gateway receives a response from the slave, it translates it to an MQTT message and publishes it on the RESPONSE topic.

   <b>0 <COOKIE> <IP_TYPE> <IP> <PORT> <TIMEOUT> <SLAVE_ID> <MODBUS_FUNCTION> <FIRST_REGISTER> <REGISTER_COUNT/VALUES></b>

   <b>1 <COOKIE> <SERIAL_DEVICE_ID> <TIMEOUT> <SLAVE_ID> <MODBUS_FUNCTION> <FIRST_REGISTER> <REGISTER_COUNT/VALUES></b>

     <li><b>IP</b> - IP address of a Modbus TCP slave. IPv6 must be presented in full form (e.g., <i>2001:0db8:0000:0000:0000:8a2e:0370:7334</i>).</li>

     <li><b>Port</b> - port number of the Modbus TCP slave.</li>

     <li><b>Slave ID</b> - Modbus TCP slave ID. Range [1..255].</li>

Below are a few <b>examples</b> of controlling/monitoring the internal Modbus TCP Slave on {{{name}}}.

The <b>Modbus TCP over Serial gateway</b> serial type allows redirecting TCP data coming to a specified port to an RTU specified by the Slave ID. The Slave ID can be specified by the user or be obtained directly from the Modbus header.

     <td>Slave ID configuration type</td>

         <td>Specifies whether slave IDs are user defined or automatically obtained from TCP.</td>

     <td><span style="color: green;">Slave ID</span></td>

         <td>Specifies the slave ID of range of permitted slave IDs. The way this field is named and its function depends on the value of the ''Slave ID configuration'' field. <br> A range of IDs can be specified by placing a hyphen (<i>-</i>) between two integer numbers. For example, if you permit slave IDs in the range of 10 to 20, you would specify it as: <i>10-20</i><br>You can also specify multiple values that are not connected in a range using commas (<i>,</i>). For example, to specify 6, 50 and 100 as permitted slave IDs, you would have to use: <i>6,50,100</i></td>

     <td><span style="color: purple;">Permitted slave IDs</span></td>

         <td>Read <i>Slave ID</i> field description.</td>