PRTG Manual: Modbus TCP Custom Sensor
The Modbus TCP Custom sensor connects to a Modbus Transmission Control Protocol (TCP) server and monitors up to ten returned numeric values.
For a detailed list and descriptions of the channels that this sensor can show, see section Channel List.
- Dutch: Modbus TCP Aangepast
- French: Modbus TCP personnalisé
- German: Modbus TCP (Benutzerdefiniert)
- Japanese: Modbus TCP カスタム
- Portuguese: Modbus TCP customizado
- Russian: Пользовательский Modbus TCP
- Simplified Chinese: Modbus TCP 自定义
- Spanish: Modbus TCP (personalizado)
Consider the following remarks and requirements for this sensor:
Remark |
Description |
---|---|
IPv6 |
This sensor supports IPv6. |
Performance impact |
This sensor has a very low performance impact. |
Lookups |
This sensor uses lookups to determine the status values of one or more channels. |
Multi-platform probe |
You can add this sensor to a multi-platform probe. |
Knowledge Base |
Knowledge Base: How can I apply Zoom Service Status sensors and Modbus sensors via device templates? |
Setting |
Description |
---|---|
Channel #1 - #10 Name |
Enter a name for the channel.
You can change this value later in the channel settings of this sensor. |
Channel #1 - #10 Unit |
Enter a unit for the channel. You can change this value later in the channel settings of this sensor. |
Channel #2 - #10 |
You can define up to 10 channels. You must define at least one channel, so you see all available settings for Channel #1. Specify how to handle all other possible channels:
It is not possible to enable or disable channels after sensor creation. |
The sensor has the following default tags that are automatically predefined in the sensor's settings when you add the sensor:
- modbus
For more information about basic sensor settings, see section Sensor Settings.
Setting |
Description |
---|---|
Port |
Enter the port for the connection to the Modbus TCP server. The default port is 502. |
Receive Timeout (msec) |
Enter a receive timeout in milliseconds (msec). If the reply from the device takes longer than this value, the request is aborted and triggers an error message. The default value is 500 msec (0.5 seconds). |
Unit ID |
Enter the Modbus unit ID that you want to monitor. In a standard Modbus network, there are up to 255 unit IDs, each with a unique assigned identifier from 1 to 255. |
Byte Order |
Select the sequence of the transmitted information:
|
Setting |
Description |
---|---|
Channel #1 - #10 Register Type |
Select the type of the register:
You cannot change this value after sensor creation. |
Channel #1 - #10 Register Number |
Enter the register number from which you want to retrieve information. The register number must be a number that contains one to five digits. The sensor supports numbers between 0 and 65534. Depending on your Modbus device, you might need to remove the register type prefix. For example, you need to enter 60 for the input register 30060 or 316 for the holding register 40316. |
Channel #1 - #10 Value Type |
This setting is only visible if you select Input register or Holding register above. Select the value type that the channel displays:
This mode only works if the difference between the last and the current value is positive and increases with each scanning interval. This mode does not support negative values and decreasing values. |
Channel #1 - #10 Data Type |
This setting is only visible if you select Input register or Holding register above. Select the data type of the register:
You cannot change this value after sensor creation. |
Channel #1 - #10 Register Width |
This setting is only visible if you select Input register or Holding register above. Select the width of the value in the register:
|
Channel #1 - #10 Bit Index |
This setting is only visible if you select Input register or Holding register above. Enter the index of the bit that you want to monitor. Enter a value between 0 and 15, 31, or 63, depending on the Channel #1 - #10 Register Width. 0 monitors the least significant bit. To monitor the most significant bit, enter 15 for a 16-bit register, 31 for a 32-bit register, or 63 for a 64-bit register. |
Setting |
Description |
---|---|
Primary Channel |
Select a channel from the list to define it as the primary channel. In the device tree, PRTG displays the last value of the primary channel below the sensor's name. The available options depend on what channels are available for this sensor. You can set a different primary channel later by clicking below a channel gauge on the sensor's Overview tab. |
Graph Type |
Define how this sensor shows different channels:
|
Stack Unit |
This setting is only visible if you select Stack channels on top of each other above. Select a unit from the list. PRTG stacks all channels with this unit on top of each other. By default, you cannot exclude single channels from stacking if they use the selected unit. However, there is an advanced procedure to do so. |
Setting |
Description |
---|---|
Result Handling |
Define what PRTG does with the sensor result:
This option is not available when the sensor runs on the hosted probe of a PRTG Hosted Monitor instance. In a cluster, PRTG stores the result in the PRTG data directory of the master node. |
By default, all of these settings are inherited from objects that are higher in the hierarchy. We recommend that you change them centrally in the root group settings if necessary. To change a setting for this object only, click under the corresponding setting name to disable the inheritance and to display its options.
For more information, see section Inheritance of Settings.
Which channels the sensor actually shows might depend on the target device, the available components, and the sensor setup.
Channel |
Description |
---|---|
Downtime |
In the channel table on the Overview tab, this channel never shows any values. PRTG uses this channel in graphs and reports to show the amount of time in which the sensor was in the Down status |
[Value] |
The returned numeric values in up to ten channels |
KNOWLEDGE BASE
How can I apply Zoom Service Status sensors and Modbus sensors via device templates?
What security features does PRTG include?