View source for Configuring Modbus TCP Master

=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. Here is the scheme to make things easier to understand:

[[File:ModbusTcpMasterScheme.png|center]]


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

==Configuring Modbus TCP slave device==

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

[[File:ModbusTCPMasterSlaveLanIP.png]]

Now we need to enable Modbus service for this slave device as we will open 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 it's public IP). This is done in '''Services->Modbus''' page:

[[File:ModbusTCPMasterSlaveEnableTCP.png]]

==Configuring Modbus TCP master device==

===Adding new slave device===

On '''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, enter a custom name, slave's ID, IP address and port and click the "Add" button:

[[File:AddNewSlave.png]]

'''Note''': Slave's ID, IP and Port should be exactly the same as configured in the slave's device '''Services->Modbus''' page


After clicking the 'Add' button you will be redirected to advanced slave's configuration page:

[[File:AdvancedSlaveConfig.png]]

<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 communication with the slave device on or off.</td>
    </tr>
    <tr>
        <td>Name</td>
        <td>string; default: <b>none</b></td>
        <td>Slave device's name, used for easier management purposes.</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..6400]; default: <b>none</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>none</b></td>
        <td>Maximum response wait time.</td>
    </tr>
</table>


Enable this slave's configuration by clicking on the checkbox and enter the timeout in seconds. Click '''Save'''.

Now the slave device is added to the Modbus TCP Master section but we need to test if it is working.

===Testing===

[[File:AddedSlaveDevice.png]]

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.

We click ''''Edit'''' button in the slave device's configuration. 

[[File:NewRequest.png]]

By clicking the ''''Add'''' button in the Requests configuration section we will be able to configure a new request. Let's say that in our case we are interested in the '''System Uptime''' parameter which is located in the first 2 registers of our device (more about the parameters and their registers we can get or set using Modbus service: '''[[RUT955 Modbus]]'''). Here is how our request should look like for this purpose:

[[File:SystemUptimeRequestSlave.png]]

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


'''Note''': During the time this article is written, we need to 'Save' the configuration first before clicking the 'Test' button. This will redirect you to the Modbus TCP Master page and you will need to click 'Edit' button again to try and test the functionality of this request.


Now by clicking the 'Test' button we can get the System Uptime value from the first 2 registers:

[[File:SystemUptimeTime.png]]

We can see that the slave device returns the registers master device has asked for. More information about how to understand the information we are getting from registers: '''[[Monitoring via Modbus]]'''

===Alarms===

Alarms are a way of setting up automated actions when some Modbus values meet user specified conditions. To configure these alarms we click on ''''Alarms'''' button:

[[File:AddedSlaveDevice.png]]

Select appropriate function and click ''''Add''''.

[[File:AddAlarm.png]]

Say in this simple example we want to trigger output (specifically relay output) when our system uptime value will be higher than 0 (this is always true since the second register where the information is hold stores router's system uptime in seconds). After saving configuration every minute (because period for sending requests to the slave device is set to 60 seconds) the relay output would invert and if you are close to the device you should hear it. The following alarm configuration will be looking like this:

[[File:RelayOutputAlarm.png]]
 
The table below provides information on fields that this page contains:

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

===Clone Slave Configuration===

[[File:AddedSlaveDevice.png]]

By clicking ''''Clone'''' button you will create the same exact slave configuration with all the alarms. This way you can just edit the cloned configuration and enter the correct IP address, ID and port for that slave device to act exactly as the router configured before.

[[File:ClonedSlaveConfig.png]]