|
|
| Line 13: |
Line 13: |
| ===Get Parameters=== | | ===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:
| | {{Template: webui_services_modbus_modbus_tcp_get_parameters}} |
|
| |
|
| {| class="wikitable" | | {{Template: webui_services_modbus_modbus_tcp_get_parameters_table}} |
| |+
| |
| ! 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=== | | ===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.
| | {{Template: webui_services_modbus_modbus_tcp_set_parameters}} |
|
| |
|
| {| class="wikitable" | | {{Template: webui_services_modbus_modbus_tcp_set_parameters_table}} |
| |+
| |
| ! 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== | | ==See also== |
|
| |
|
| You can find more information on how to use Modbus with RUT routers here: '''[[Monitoring via Modbus]]'''
| | {{Template: webui_services_modbus_see_also}} |
