Difference between revisions of "Modbus Master RutOS configuration example"

From Teltonika Networks Wiki
m (Typo)
Line 1: Line 1:
 
=Summary=
 
=Summary=
 
Modbus TCP Master section is used for configuring your router as a master device and other routers configured in this section as slave devices. A Modbus TCP master device can then request data from these Modbus TCP slaves.
 
Modbus TCP Master section is used for configuring your router as a master device and other routers configured in this section as slave devices. A Modbus TCP master device can then request data from these Modbus TCP slaves.
 +
 +
[[File:ModbusTcpMasterSchemeTopology.png|frame|center|Topology]]
  
 
First, let’s configure our second router which will be acting as a slave device.  
 
First, let’s configure our second router which will be acting as a slave device.  
Line 14: Line 16:
  
 
[[File:Picture3.png|frame|center|Modbus Slave Configuration]]
 
[[File:Picture3.png|frame|center|Modbus Slave Configuration]]
 +
 +
<table class="nd-mantable">
 +
    <tr>
 +
        <th>Field</th>
 +
        <th>Value</th>
 +
        <th>Description</th>
 +
    </tr>
 +
    <tr>
 +
        <td>Enable</td>
 +
        <td>off | on; default <b>off</b></td>
 +
        <td>Turns Modbus TCP on or off.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Port</td>
 +
        <td>integer [0..65535]; default: <b>502</b></td>
 +
        <td>TCP port used for Modbus communications.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Device ID</td>
 +
        <td>integer [0..255]; default: <b>1<b/></td>
 +
        <td>The device's Modbus slave ID. When set to 0, it will respond to requests addressed to any ID.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Allow Remote Access</td>
 +
        <td>off | on; default: <b>off</b></td>
 +
        <td>Allows remote Modbus connections by adding an exception to the device's firewall on the port specified in the field above.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Keep persistent connection</td>
 +
        <td>off | on; default: <b>off</b></td>
 +
        <td>Allows keep the connection open after responding a Modbus TCP master request.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Connection timeout</td>
 +
        <td>integer; default: <b>0</b></td>
 +
        <td>Sets TCP timeout in seconds after which the connection is forcefully closed.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Enable custom register block</td>
 +
        <td>off | on; default: <b>off</b></td>
 +
        <td>Allows the usage of custom register block.</td>
 +
    </tr>
 +
 +
 +
</table>
  
 
=Configuring Modbus TCP master device=
 
=Configuring Modbus TCP master device=
Line 25: Line 72:
  
 
[[File:Picture5.png|frame|center|Modbus Slave Configuration on Master Device Pop Menu]]
 
[[File:Picture5.png|frame|center|Modbus Slave Configuration on Master Device Pop Menu]]
 +
 +
<table class="nd-mantable">
 +
    <tr>
 +
        <th>Field</th>
 +
        <th>Value</th>
 +
        <th>Description</th>
 +
    </tr>
 +
    <tr>
 +
        <td>Enable</td>
 +
        <td>string; default: <b>none</b></td>
 +
        <td>Slave device's name, used for easier management purposes.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Name</td>
 +
        <td>off | on; default: <b>off</b></td>
 +
        <td>Turns communication with the slave device on or off.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Slave ID</td>
 +
        <td>integer [0..255]; default: <b>none</b></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>
 +
    </tr>
 +
    <tr>
 +
        <td>IP address</td>
 +
        <td>ip; default: <b>none</b></td>
 +
        <td>Slave device's IP address.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Port</td>
 +
        <td>integer [0..65535]; default: <b>none</b></td>
 +
        <td>Slave 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 slave device.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Timeout</td>
 +
        <td>integer [1..30]; default: <b>5</b></td>
 +
        <td>Maximum response wait time.</td>
 +
    </tr>
 +
 +
</table>
  
 
Scroll down and click “Save and Apply”
 
Scroll down and click “Save and Apply”
Line 50: Line 141:
  
 
[[File:Picture11.png|frame|center|Configuring Request]]
 
[[File:Picture11.png|frame|center|Configuring Request]]
 +
 +
<table class="nd-mantable">
 +
    <tr>
 +
        <th>Field</th>
 +
        <th>Value</th>
 +
        <th>Description</th>
 +
    </tr>
 +
    <tr>
 +
        <td>Name</td>
 +
        <td>string; default: <b>Unnamed Parameter</b></td>
 +
        <td>Request name. Used for easier management purposes.</td>
 +
    </tr>
 +
    <tr>
 +
        <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, Byte order 1,2,3,4 | 32bit float, Byte order 4,3,2,1 | 32bit float, Byte order 2,1,4,3 | 32bit float, Byte order 3,4,1,2; default: <b>16bit INT, high byte first</b></td>
 +
        <td>How read data will be stored.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Function</td>
 +
        <td>1 | 2 | 3 | 4 | 5 | 6 | 15 | 16; default: <b>3</b></td>
 +
        <td>A function code specifies the type of register being addressed by a Modbus request. The codes represent these functions:<br>
 +
            <ul>
 +
                <li><b>1</b> - read Coil Status</li>
 +
                <li><b>2</b> - read Input Status</li>
 +
                <li><b>3</b> - read Holding Registers</li>
 +
                <li><b>4</b> - read Input Registers</li>
 +
                <li><b>5</b> - force Single Coil</li>
 +
                <li><b>6</b> - preset Single Register</li>
 +
                <li><b>15</b> - force Multiple Coils</li>
 +
                <li><b>16</b> - force Multiple Registers</li>
 +
            </ul>
 +
        </td>
 +
    </tr>
 +
    <tr>
 +
        <td>First Register</td>
 +
        <td>integer [0..65535]; default: <b>1</b></td>
 +
        <td>First Modbus register from which data will be read.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Number of Registers</td>
 +
        <td>integer [1..2000]; default: <b>none</b></td>
 +
        <td>Number of Modbus registers that will be read during the request.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Enabled</td>
 +
        <td>yes | no; default: <b>no</b></td>
 +
        <td>Turns the request on or off.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Test</td>
 +
        <td>- (interactive button)</td>
 +
        <td>Generates a Modbus request according to given parameters in order to test the request configuration. You must first save the configuration before you can use the Test button.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Delete</td>
 +
        <td>- (interactive button)</td>
 +
        <td>Deletes the request.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Add</td>
 +
        <td>- (interactive button)</td>
 +
        <td>Adds a new request configuration.</td>
 +
    </tr>
 +
</table>
  
 
Under the “Request Configuration” section there will be another section called “Request Configuration Testing” this is where you can test that the parameters that you set work properly. Just select the request that you want to test and click the test button and you should get and output.
 
Under the “Request Configuration” section there will be another section called “Request Configuration Testing” this is where you can test that the parameters that you set work properly. Just select the request that you want to test and click the test button and you should get and output.
Line 63: Line 218:
  
 
[[File:Picture14.png|frame|center|Alarm Configuration Menu]]
 
[[File:Picture14.png|frame|center|Alarm Configuration Menu]]
 +
 +
<table class="nd-mantable">
 +
    <tr>
 +
        <th>Field</th>
 +
        <th>Value</th>
 +
        <th>Description</th>
 +
    </tr>
 +
    <tr>
 +
        <td>Enabled</td>
 +
        <td>yes | no; default: <b>no</b></td>
 +
        <td>Turns the alarm on or off</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Function code</td>
 +
        <td>Read Coil Status (1) | Read Input Status (2) | Read Holding Registers (3) | Read Input Registers (4); default: <b>Read Coil Status (1)</b></td>
 +
        <td>Modbus function used in Modbus request.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Register</td>
 +
        <td>integer [0..65535]; default: <b>none</b></td>
 +
        <td>Number of the Modbus coil/input/holding register/input register that will be read.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Condition</td>
 +
        <td>More than | Less than | Equal to | Not Equal to; default: <b>Equal to</b></td>
 +
        <td>When a value is obtained it will be compared against the value specified in the following field. The comparison will be made in accordance with the condition specified in this field.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Value</td>
 +
        <td>various; default: <b>none</b></td>
 +
        <td>The value against which the read data will be compared.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Action</td>
 +
        <td>SMS | Trigger output | Modbus Request; default: <b>SMS</b></td>
 +
        <td>Action that will be taken if the condition is met. Possible actions:
 +
            <ul>
 +
                <li><b>SMS</b> - sends and SMS message to a specified recipient(s).</li>
 +
                <li><b>Trigger output</b> - changes the state of a specified output(s).</li>
 +
                <li><b>Modbus Request</b> - sends a Modbus request to a specified slave.</li>
 +
            </ul>
 +
        </td>
 +
    </tr>
 +
    <tr>
 +
        <td><span style="color: #0054a6;">SMS: Message</span></td>
 +
        <td>string; default: <b>none</b></td>
 +
        <td>SMS message text.</td>
 +
    </tr>
 +
    <tr>
 +
        <td><span style="color: #0054a6;">SMS: Phone number</span></td>
 +
        <td>phone number; default: <b>none</b></td>
 +
        <td>Recipient's phone number.</td>
 +
    </tr>
 +
    <tr>
 +
        <td><span style="color: red;">Trigger output: Output</span></td>
 +
        <td>Open collector output | Relay output | Both; default: <b>Open collector output</b></td>
 +
        <td>Which output(s) will be triggered.</td>
 +
    </tr>
 +
    <tr>
 +
        <td><span style="color: red;">Trigger output: I/O Action</span></td>
 +
        <td>Turn On | Turn Off | Invert; default: <b>Turn On</b></td>
 +
        <td>Action that will taken on the specified output.</td>
 +
    </tr>
 +
    <tr>
 +
        <td><span style="color: purple;">Modbus Request: IP address</span></td>
 +
        <td>ip | host; default: <b>none</b></td>
 +
        <td>Modbus slave's IP address.</td>
 +
    </tr>
 +
    <tr>
 +
        <td><span style="color: purple;">Modbus Request: Port</span></td>
 +
        <td>integer [0..65535]; default: <b>none</b></td>
 +
        <td>Modbus slave's port.</td>
 +
    </tr>
 +
    <tr>
 +
        <td><span style="color: purple;">Modbus Request: Timeout</span></td>
 +
        <td>integer [1..30]; default: <b>5</b></td>
 +
        <td>Maximum time to wait for a response.</td>
 +
    </tr>
 +
    <tr>
 +
        <td><span style="color: purple;">Modbus Request: ID</span></td>
 +
        <td>integer [1..255]; default: <b>none</b></td>
 +
        <td>Modbus slave ID.</td>
 +
    </tr>
 +
    <tr>
 +
        <td><span style="color: purple;">Modbus Request: Modbus function</span></td>
 +
        <td>Read Coil Status (1) | Read Input Status (2) | Read Holding Registers (3) | Read Input Registers (4) | Force Single Coil (5) | Preset Single Register (6) | Force Multiple Coils (15) | Force Multiple Registers (16); default: <b>Force Single Coil (5)</b></td>
 +
        <td>A function code specifies the type of register being addressed by a Modbus request.</td>
 +
    </tr>
 +
    <tr>
 +
        <td><span style="color: purple;">Modbus Request: First register</span></td>
 +
        <td>integer [0..65535]; default: <b>none</b></td>
 +
        <td>Begins reading from the register specified in this field.</td>
 +
    </tr>
 +
    <tr>
 +
        <td><span style="color: purple;">Modbus Request: Number of registers</span></td>
 +
        <td>integer [0..65535]; default: <b>none</b></td>
 +
        <td>The number of registers that will be read from the first register.</td>
 +
    </tr>
 +
</table>

Revision as of 03:51, 6 April 2022

Summary

Modbus TCP Master section is used for configuring your router as a master device and other routers configured in this section as slave devices. A Modbus TCP master device can then request data from these Modbus TCP slaves.

Topology

First, let’s configure our second router which will be acting as a slave device.

Configure Modbus TCP slave device

In this example, we would be configuring our slave device to have a 192.168.1.2 internal IP address. This can be done by changing the IP address parameter on Network->WAN page:

Slave Device Wan Configuration
Slave Device Wan Configuration Pop menu

Now we need to enable Modbus service for this slave device as we will open a specific port for letting through TCP communications (it is also possible to 'Allow remote access' if we wish to access this router from external WAN using its public IP). This is done on Services->Modbus page:

Modbus Slave Configuration
Field Value Description
Enable off | on; default off Turns Modbus TCP on or off.
Port integer [0..65535]; default: 502 TCP port used for Modbus communications.
Device ID integer [0..255]; default: 1 The device's Modbus slave ID. When set to 0, it will respond to requests addressed to any ID.
Allow Remote Access off | on; default: off Allows remote Modbus connections by adding an exception to the device's firewall on the port specified in the field above.
Keep persistent connection off | on; default: off Allows keep the connection open after responding a Modbus TCP master request.
Connection timeout integer; default: 0 Sets TCP timeout in seconds after which the connection is forcefully closed.
Enable custom register block off | on; default: off Allows the usage of custom register block.

Configuring Modbus TCP master device

Adding a new slave device

On the master device (in this example master device has 192.168.1.1 internal IP address) open Services->Modbus->Modbus TCP Master. To add a new slave, first, click the add button.

Modbus Slave configuration on Master device

Once you have clicked that button, enter the following configuration so we can add the slave device:

Modbus Slave Configuration on Master Device Pop Menu
Field Value Description
Enable string; default: none Slave device's name, used for easier management purposes.
Name off | on; default: off Turns communication with the slave device on or off.
Slave ID integer [0..255]; default: none 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.
IP address ip; default: none Slave device's IP address.
Port integer [0..65535]; default: none Slave device's Modbus TCP port.
Period integer [1..86400]; default: 60 Interval at which requests are sent to the slave device.
Timeout integer [1..30]; default: 5 Maximum response wait time.

Scroll down and click “Save and Apply”

Save and Apply

After this, this is how your main Modbus Master panel should look:

Modbus Slave Configuration on Master Device

Testing

For testing, if the functionality is working we can configure a request. A Modbus request 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. You can create a maximum of 64 request configurations for each slave device.First, click the edit button:

Modbus Slaves

Scroll down to the “Request configuration” section.

Request Configuration

Write a name for the request and click the “Add” button.

Add new request

And enter a data type, a function, first register, number of registers, if you need brackets or don’t and enable the request. In this case we are trying to get System uptime information so configure the next options:

Configuring Request
Field Value Description
Name string; default: Unnamed Parameter Request name. Used for easier management purposes.
Data type 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, Byte order 1,2,3,4 | 32bit float, Byte order 4,3,2,1 | 32bit float, Byte order 2,1,4,3 | 32bit float, Byte order 3,4,1,2; default: 16bit INT, high byte first How read data will be stored.
Function 1 | 2 | 3 | 4 | 5 | 6 | 15 | 16; default: 3 A function code specifies the type of register being addressed by a Modbus request. The codes represent these functions:
  • 1 - read Coil Status
  • 2 - read Input Status
  • 3 - read Holding Registers
  • 4 - read Input Registers
  • 5 - force Single Coil
  • 6 - preset Single Register
  • 15 - force Multiple Coils
  • 16 - force Multiple Registers
First Register integer [0..65535]; default: 1 First Modbus register from which data will be read.
Number of Registers integer [1..2000]; default: none Number of Modbus registers that will be read during the request.
Enabled yes | no; default: no Turns the request on or off.
Test - (interactive button) Generates a Modbus request according to given parameters in order to test the request configuration. You must first save the configuration before you can use the Test button.
Delete - (interactive button) Deletes the request.
Add - (interactive button) Adds a new request configuration.

Under the “Request Configuration” section there will be another section called “Request Configuration Testing” this is where you can test that the parameters that you set work properly. Just select the request that you want to test and click the test button and you should get and output.

Testing Configuration

Alarms

Alarms are a way of setting up automated actions when some Modbus values meet user-specified conditions. To configure these alarms, scroll to the end of the menu and click the “Add” button.

Alarm Configuration

After clicking the “Add” button the next menu should come up:

Alarm Configuration Menu
Field Value Description
Enabled yes | no; default: no Turns the alarm on or off
Function code Read Coil Status (1) | Read Input Status (2) | Read Holding Registers (3) | Read Input Registers (4); default: Read Coil Status (1) Modbus function used in Modbus request.
Register integer [0..65535]; default: none Number of the Modbus coil/input/holding register/input register that will be read.
Condition More than | Less than | Equal to | Not Equal to; default: Equal to When a value is obtained it will be compared against the value specified in the following field. The comparison will be made in accordance with the condition specified in this field.
Value various; default: none The value against which the read data will be compared.
Action SMS | Trigger output | Modbus Request; default: SMS Action that will be taken if the condition is met. Possible actions:
  • SMS - sends and SMS message to a specified recipient(s).
  • Trigger output - changes the state of a specified output(s).
  • Modbus Request - sends a Modbus request to a specified slave.
SMS: Message string; default: none SMS message text.
SMS: Phone number phone number; default: none Recipient's phone number.
Trigger output: Output Open collector output | Relay output | Both; default: Open collector output Which output(s) will be triggered.
Trigger output: I/O Action Turn On | Turn Off | Invert; default: Turn On Action that will taken on the specified output.
Modbus Request: IP address ip | host; default: none Modbus slave's IP address.
Modbus Request: Port integer [0..65535]; default: none Modbus slave's port.
Modbus Request: Timeout integer [1..30]; default: 5 Maximum time to wait for a response.
Modbus Request: ID integer [1..255]; default: none Modbus slave ID.
Modbus Request: Modbus function Read Coil Status (1) | Read Input Status (2) | Read Holding Registers (3) | Read Input Registers (4) | Force Single Coil (5) | Preset Single Register (6) | Force Multiple Coils (15) | Force Multiple Registers (16); default: Force Single Coil (5) A function code specifies the type of register being addressed by a Modbus request.
Modbus Request: First register integer [0..65535]; default: none Begins reading from the register specified in this field.
Modbus Request: Number of registers integer [0..65535]; default: none The number of registers that will be read from the first register.
Retrieved from "https://wiki.teltonika-networks.com/index.php?title=Modbus_Master_RutOS_configuration_example&oldid=90477"