Modbus Connector Configuration

To add new configuration for connection to server, navigate to the “Master Connections” tab and click the “plus” icon:

Due to the nature of preferred way of communication between Modbus master there are 2 options how to configure this part: if using TCP, UDP or via Serial port.

To add new configuration for connection to server, navigate to the “Configuration” tab.

Due to the nature of preferred way of communication between Modbus master there are 2 options how to configure this part: if using TCP, UDP or via Serial port.

1
2
3
4
5
6
7
8
9
10
11
12
"master": {
    "slaves": [
        {
            "host": "127.0.0.1",
            "port": 5021,
            "method": "socket",
            "unitId": 1,
            "deviceName": "Temp Sensor",
            "deviceType": "default",
        }
    ]
}

1
2
3
4
5
6
7
8
9
10
11
12
"master": {
    "slaves": [
        {
            "host": "127.0.0.1",
            "port": 5021,
            "method": "socket",
            "unitId": 1,
            "deviceName": "Temp Sensor",
            "deviceType": "default",
        }
    ]
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
"master": {
    "slaves": [
        {
            "method": "ascii",
            "baudrate": 4800,
            "stopbits": 1,
            "bytesize": 5,
            "parity": "N",
            "strict": true,
            "unitId": 1,
            "deviceName": "Temp Sensor",
            "deviceType": "default",
        }
    ]
}

This subsection enabling report strategy for data sending, and you can use one of 3 behavior scenarios:

• On report period - data will be collected and send every period of time (in milliseconds).
• On value change - data will be send after change.
• On value change or report period - data will be sent either when it changes or after a report period has passed since the last time it was sent.

The table below describes the parameters required to configure report strategy:

This subsection enabling report strategy for data sending, and you can use one of 3 behavior scenarios:

• ON_REPORT_PERIOD - data will be collected and send every period of time (in milliseconds).
• ON_CHANGE - data will be send after change.
• ON_CHANGE_OR_REPORT_PERIOD - data will be sent either when it changes or after a report period has passed since the last time it was sent.

The table below describes the parameters required to configure report strategy:

Configuration example:

1
2
3
4
reportStrategy: {
    "type": "ON_REPORT_PERIOD",
    "reportPeriod": 30000
}

You can configure additional settings like: TLS connection, polling time, byte order and word order, and other. The table below describes the parameters for this purpose:

• Click on the “Advanced connection settings” subsection to open it;

• Make the necessary settings.

Also, you can configure TLS connection (can be used only for TCP/UDP connection type). The table below describes the parameters required to configure TLS connection:

You can configure additional settings like: TLS connection, polling time, byte order and word order, and other. The table below describes the parameters for this purpose:

Example:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
"master": {
  "slaves": [
    {
      "timeout": 35,
      "byteOrder": "LITTLE",
      "wordOrder": "LITTLE",
      "retries": true,
      "retryOnEmpty": true,
      "retryOnInvalid": true,
      "pollPeriod": 5000,
      "sendDataOnlyOnChange": true,
      "connectAttemptTimeMs": 5000,
      "connectAttemptCount": 5,
      "waitAfterFailedAttemptsMs": 300000,
    }
  ]
}

The configuration in this unit provides settings for processing data on Modbus server. These settings will be interpreted in ThingsBoard platform instance as attributes/time series of the device. For adding new attribute or time series use the following steps:

• Click on “pencil” icon in the “Attributes” or “Time series” section (depends on the selected section);

• In the opened window click “Add attribute” or “Add time series” (depends on selected section);

• Fill in key, type, function code, objects count and address fields. Click “Apply”.

Also, modifier for attribute/time series value can be applied using the following settings:

The configuration in this unit provides settings for processing data on Modbus server. These settings will be interpreted in ThingsBoard platform instance as attributes/time series of the device.

The table below describes the attributes and time series parameters:

Example of attributes section:

1
2
3
4
5
6
7
8
9
"attributes": [
  {
    "tag": "string_read",
    "type": "string",
    "functionCode": 4,
    "objectsCount": 4,
    "address": 1
  }
]

Example of time series section:

1
2
3
4
5
6
7
8
9
"timeseries": [
  {
    "tag": "16uint_read",
    "type": "16uint",
    "functionCode": 4,
    "objectsCount": 2,
    "address": 18
  },
]

• To add new requests mapping, navigate to the “Attribute updates” section and click the “pencil” icon;

• In the opened window click “Add attribute update”;

• Set an attribute key name, type, function code, objects count, and address. Then, click “Apply”.

The table below describes the attribute updates parameters:

For example, create a new attribute “maxTemperature” and give it a value “25”.

• Go to the “Devices” page. Click on your device to open the device details, then navigate to the “Attributes” tab. Select “Server attributes” as the entity attributes scope. Then, click the “plus” icon to add a new attribute;

• Name the attribute “maxTemperature”, select “Integer” as the value type, and set the value to 25;

• Shared attribute is added.

The table below describes the attribute updates parameters:

Example:

1
2
3
4
5
6
7
8
9
"attributeUpdates": [
  {
    "tag": "shared_attribute_write",
    "type": "32int",
    "functionCode": 6,
    "objectsCount": 2,
    "address": 29
  }
]

• To add new requests mapping, navigate to the “RPC requests” section and click the “pencil” icon;

• In the opened window click the “Add request”;

• Fill in key, type, function code, objects count and address fields. Click “Apply”.

The table below describes the RPC request parameters:

The table below describes the RPC request parameters:

Example:

1
2
3
4
5
6
7
8
9
"rpc": [
  {
    "tag": "setValue",
    "type": "bits",
    "functionCode": 5,
    "objectsCount": 1,
    "address": 31
  }
]

Due to the nature of preferred way of communication between Modbus master there are 2 options how to configure this part: if using TCP/UDP or via Serial port.

Due to the nature of preferred way of communication between Modbus master there are 2 options how to configure this part: if using TCP/UDP or via Serial port.

You can configure additional settings like: TLS connection, byte order, word order, and other. The table below describes the parameters for this purpose:

• Click on the “Advanced connection settings” subsection to open it;

• Make the necessary settings.

You can configure additional settings like: TLS connection, byte order, word order, and other. The table below describes the parameters for this purpose:

To add new value to the gateway slave, use the following steps:

• Click on “pencil” icon in the row of the selected section;

• In the opened window click “Add attribute” or other (depends on selected section);

• Fill in key, type, function code, objects count, address and value fields. Click “Apply”.