Difference between revisions of "RUT955 Modbus"

From Teltonika Networks Wiki
(20 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Template: Networking_rutos_manual_modbus_rut2_rut9
+
==Summary==
<!------------------------DEVICE----------------------->
+
 
| name   = RUT955
+
{{Template: webui_services_modbus_summary}}
| series  = RUT9
+
 
<!----------------------SEPARATORS--------------------->
+
==Modbus TCP==
| analog  = 1
+
 
| gps    = 1
+
{{Template: webui_services_modbus_modbus_tcp}}
| mobile  = 1
+
 
| dualsim = 1
+
[[File:Rut9xx webui services modbus modbus tcp v1.png]]
| rs232  = 1
+
 
| rs485   = 1
+
{{Template: webui_services_modbus_modbus_table}}
| usb    = 1
+
 
| serial = 1
+
===Get Parameters===
| wifi    = 1
+
----
}}
+
Router parameters are held within '''registers'''. Each register contains 2 bytes of information. For simplification, the number of registers for storing numbers is 2, while the number of registers for storing text information is 16. The register numbers and corresponding system values are described in the table below:
 +
 
 +
{| class="wikitable"
 +
|+
 +
! style="width: 467px; border: 1px solid white; border-bottom: 2px solid #0054A6; background: white; color: #0054A6; text-align: left;" | REQUIRED VALUE
 +
! style="width: 200px; border: 1px solid white; border-bottom: 2px solid #0054A6; background: white; color: #0054A6; text-align: left;" | REGISTER NUMBER
 +
! style="width: 200px; border: 1px solid white; border-bottom: 2px solid #0054A6; background: white; color: #0054A6; text-align: left;" | NUMBER OF REGISTERS
 +
! style="width: 200px; border: 1px solid white; border-bottom: 2px solid #0054A6; background: white; color: #0054A6; text-align: left;" | REPRESENTATION
 +
|-
 +
! style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | System uptime
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | 1
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | 2
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | 32 bit unsigned integer
 +
|-
 +
! style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | GSM signal strength (dBm)
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | 3
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | 2
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | 32 bit integer
 +
|-
 +
! style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | System temperature in 0.1 degrees Celcius
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | 5
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | 2
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | 32 bit integer
 +
|-
 +
! style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | System hostname
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | 7
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | 16
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | Text
 +
|-
 +
! style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | GSM operator name
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | 23
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | 16
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | Text
 +
|-
 +
! style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | Router serial number
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | 39
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | 16
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | Text
 +
|-
 +
! style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | Router MAC address
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | 55
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | 16
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | Text
 +
|-
 +
! style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | Router name
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | 71
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | 16
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | Text
 +
|-
 +
! style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | Current SIM card
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | 87
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | 16
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | Text
 +
|-
 +
! style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | Network registration
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | 103
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | 16
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | Text
 +
|-
 +
! style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | Network type
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | 119
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | 16
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | Text
 +
|-
 +
! style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | Digital input 1
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | 135
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | 2
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | 32 bit integer
 +
|-
 +
! style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | Digital input
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | 137
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | 2
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | 32 bit integer
 +
|-
 +
! style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | Current WAN IP address
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | 139
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | 2
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | 32 bit unsigned integer
 +
|-
 +
! style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | Analog input
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | 141
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | 2
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | 32 bit integer
 +
|-
 +
|}
 +
 
 +
===Set Parameters===
 +
----
 +
The Modbus daemon can also set some system parameters. System related parameters and how to use them are described below. The register number specifies where to start writing the required values.
 +
 
 +
{| class="wikitable"
 +
|+
 +
! style="width: 337px; border: 1px solid white; border-bottom: 2px solid #0054A6; background: white; color: #0054A6; text-align: left;" | VALUE TO SET
 +
! style="width: 180px; border: 1px solid white; border-bottom: 2px solid #0054A6; background: white; color: #0054A6; text-align: left;" | REGISTER NUMBER
 +
! style="width: 150px; border: 1px solid white; border-bottom: 2px solid #0054A6; background: white; color: #0054A6; text-align: left;" | REGISTER VALUE
 +
! style="width: 400px; border: 1px solid white; border-bottom: 2px solid #0054A6; background: white; color: #0054A6; text-align: left;" | DESCRIPTION
 +
|-
 +
! style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | Digital output 1 (ON/OFF)
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | 201
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | 1/0
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | Changes the state of the Open collector (OC) output
 +
<ul>
 +
  <li>'''1''' - ON</li>
 +
  <li>'''0''' - OFF</li>
 +
</ul>
 +
|-
 +
! style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | Digital output 2 (ON/OFF)
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | 202
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | 1/0
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | Changes the state of the Relay output
 +
<ul>
 +
  <li>'''1''' - ON</li>
 +
  <li>'''0''' - OFF</li>
 +
</ul>
 +
|-
 +
! style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | Switch WiFi (ON/OFF)
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | 210
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | 1/0
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | Switches WiFi ON or OFF
 +
<ul>
 +
  <li>'''1''' - ON</li>
 +
  <li>'''0''' - OFF</li>
 +
</ul>
 +
|-
 +
! style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | Switch mobile data connection (ON/OFF)
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | 211
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | 1/0
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | Switches mobile data connection ON or OFF
 +
<ul>
 +
   <li>'''1''' - ON</li>
 +
  <li>'''0''' - OFF</li>
 +
</ul>
 +
|-
 +
! style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | Switch SIM card
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | 212
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | 1/2/0
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | Switches SIM card in use
 +
<ul>
 +
  <li>'''1''' - switch to SIM1</li>
 +
  <li>'''2''' - switch to SIM2</li>
 +
  <li>'''0''' - switch from the the SIM card currently in use (SIM1 → SIM2 or SIM2 → SIM1)</li>
 +
</ul>
 +
|-
 +
! style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | Change APN
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | 213
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | APN code
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | Changes APN. <br> The number of input registers may vary depending on the length of the APN, but the very first byte of set APN command denotes the number of the SIM card for which to set the APN. This byte should be set to:
 +
<ul>
 +
  <li>'''1''' - to change the APN for SIM1</li>
 +
  <li>'''2''' - to change the APN for SIM2</li>
 +
</ul>  
 +
|-
 +
! style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | Reboot
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | 220
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | 1
 +
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: top; background: white;" | Reboots the router
 +
|-
 +
|}
 +
 
 +
==See also==
 +
 
 +
You can find more information on how to use Modbus with RUT routers here: '''[[Monitoring via Modbus]]'''

Revision as of 12:26, 5 November 2018

Main Page > RUT Routers > RUT955 > RUT955 Manual > RUT955 WebUI > RUT955 Services section > RUT955 Modbus

Summary

Template:Webui services modbus summary

Modbus TCP

Template:Webui services modbus modbus tcp

Rut9xx webui services modbus modbus tcp v1.png

Template:Webui services modbus modbus table

Get Parameters


Router parameters are held within registers. Each register contains 2 bytes of information. For simplification, the number of registers for storing numbers is 2, while the number of registers for storing text information is 16. The register numbers and corresponding system values are described in the table below:

REQUIRED VALUE REGISTER NUMBER NUMBER OF REGISTERS REPRESENTATION
System uptime 1 2 32 bit unsigned integer
GSM signal strength (dBm) 3 2 32 bit integer
System temperature in 0.1 degrees Celcius 5 2 32 bit integer
System hostname 7 16 Text
GSM operator name 23 16 Text
Router serial number 39 16 Text
Router MAC address 55 16 Text
Router name 71 16 Text
Current SIM card 87 16 Text
Network registration 103 16 Text
Network type 119 16 Text
Digital input 1 135 2 32 bit integer
Digital input 137 2 32 bit integer
Current WAN IP address 139 2 32 bit unsigned integer
Analog input 141 2 32 bit integer

Set Parameters


The Modbus daemon can also set some system parameters. System related parameters and how to use them are described below. The register number specifies where to start writing the required values.

VALUE TO SET REGISTER NUMBER REGISTER VALUE DESCRIPTION
Digital output 1 (ON/OFF) 201 1/0 Changes the state of the Open collector (OC) output
  • 1 - ON
  • 0 - OFF
Digital output 2 (ON/OFF) 202 1/0 Changes the state of the Relay output
  • 1 - ON
  • 0 - OFF
Switch WiFi (ON/OFF) 210 1/0 Switches WiFi ON or OFF
  • 1 - ON
  • 0 - OFF
Switch mobile data connection (ON/OFF) 211 1/0 Switches mobile data connection ON or OFF
  • 1 - ON
  • 0 - OFF
Switch SIM card 212 1/2/0 Switches SIM card in use
  • 1 - switch to SIM1
  • 2 - switch to SIM2
  • 0 - switch from the the SIM card currently in use (SIM1 → SIM2 or SIM2 → SIM1)
Change APN 213 APN code Changes APN.
The number of input registers may vary depending on the length of the APN, but the very first byte of set APN command denotes the number of the SIM card for which to set the APN. This byte should be set to:
  • 1 - to change the APN for SIM1
  • 2 - to change the APN for SIM2
Reboot 220 1 Reboots the router

See also

You can find more information on how to use Modbus with RUT routers here: Monitoring via Modbus