Skip to content
This repository was archived by the owner on May 22, 2026. It is now read-only.

Commit 483f69a

Browse files
ashvaykaashvayka
committed
Merge branch 'staging/4.2' into release/4.2
2 parents 0554fcb + cb1bac0 commit 483f69a

4 files changed

Lines changed: 25 additions & 161 deletions

File tree

‎_includes/templates/iot-gateway/modbus-connector/attributes-and-time-series-subsections-basic.md‎

Lines changed: 0 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,6 @@ For adding a new attribute or time series, use the following steps:
3232
%}
3333
{% include images-gallery.liquid showListImageTitles="true" imageCollection=attributes %}
3434

35-
##### Report strategy
36-
3735
You can enable a specific report strategy for each time series or attribute. This strategy defines how often
3836
data is sent to the ThingsBoard server. The following strategies are available:
3937

@@ -47,8 +45,6 @@ Additional information about the report strategy can be found [here](/docs/iot-g
4745
{% endcapture %}
4846
{% include templates/info-banner.md content=difference %}
4947

50-
##### Modifier
51-
5248
Also, **modifier** for attribute/time series value can be applied using the following settings:
5349

5450
| **Parameter** | **Description** |
@@ -57,47 +53,4 @@ Also, **modifier** for attribute/time series value can be applied using the foll
5753
| Value | The value that will be used to modify the read value |
5854
| --- | |
5955

60-
{% capture difference %}
61-
More usage examples can be found in the [Example usage](/docs/iot-gateway/config/modbus/#usage-examples) section.
62-
{% endcapture %}
63-
{% include templates/info-banner.md content=difference %}
64-
6556
![image](https://img.thingsboard.io/gateway/modbus-connector/modifier.png)
66-
67-
##### Batch reading (Advanced configuration mode only)
68-
69-
To optimize the reading process, you can group multiple registers into a single batch read request. This approach
70-
reduces the number of requests sent to the Modbus server, which can enhance performance and decrease network traffic.
71-
Take attention that the registers in a batch read request must be of the same type and function code.
72-
73-
Two parameters are important for group reading configuration: `address` and `tag`. Let's look at them in more detail:
74-
75-
- **address** - is the address of the starting register and the address of the ending register, separated by a `-`
76-
character. For example, `0-10` means that the group read starts with the register at address `0` and ends at the
77-
register at address `10`, inclusive.
78-
- **tag** - is a unique identifier for each register within a group read. It is used to identify a specific register within
79-
a given address range. The tag name can be formed using an expression using the following variables:
80-
- `${address}` - register address within group read.
81-
- `${unitId}` - slave ID.
82-
- `${functionCode}` - function code.
83-
- `${type}` - data type of register.
84-
- `${objectsCount}` - number of objects.
85-
86-
Also, `divider` and `multiplier` parameters work as expected.
87-
88-
Example of group reading configuration:
89-
90-
```json
91-
{
92-
"tag": "${unitId} - ${type} - ${address}",
93-
"type": "16int",
94-
"functionCode": 3,
95-
"objectsCount": 1,
96-
"address": "0-10"
97-
}
98-
```
99-
100-
{% capture difference %}
101-
More usage examples can be found in the [Example usage](/docs/iot-gateway/config/modbus/#usage-examples) section.
102-
{% endcapture %}
103-
{% include templates/info-banner.md content=difference %}

‎_includes/templates/iot-gateway/modbus-connector/examples/time-series-and-attributes/batch-reading.md‎

Lines changed: 0 additions & 88 deletions
This file was deleted.

‎docs/iot-gateway/config/modbus.md‎

Lines changed: 25 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ In the data mapping, you can specify how the Modbus master will interact with th
124124
the slaves. You can also use this section to configure which data will be sent as device attributes or telemetry.
125125
Data mapping contains all the necessary settings for flexible data management.
126126

127-
#### Attributes and time series
127+
#### Subsection "Attributes" and "Time series"
128128

129129
{% include /templates/iot-gateway/modbus-connector/attributes-and-time-series-subsections-basic.md %}
130130

@@ -133,8 +133,7 @@ Data mapping contains all the necessary settings for flexible data management.
133133
{% capture modbus-attributes-timeseries-examples %}
134134
Reading attributes/time series<small></small>%,%readingattributesandtimeseries%,%templates/iot-gateway/modbus-connector/examples/time-series-and-attributes/reading-attributes-and-time-series.md%br%
135135
Multiplier<small>in attributes/time series</small>%,%multiplierinattributesandtimeseries%,%templates/iot-gateway/modbus-connector/examples/time-series-and-attributes/multiplier-in-attributes-and-time-series.md%br%
136-
Divider<small>in attributes/time series</small>%,%dividerinattributesandtimeseries%,%templates/iot-gateway/modbus-connector/examples/time-series-and-attributes/divider-in-attributes-and-time-series.md%br%
137-
Batch reading<small>(advanced configuration mode only)</small>%,%batchreading%,%templates/iot-gateway/modbus-connector/examples/time-series-and-attributes/batch-reading.md{% endcapture %}
136+
Divider<small>in attributes/time series</small>%,%dividerinattributesandtimeseries%,%templates/iot-gateway/modbus-connector/examples/time-series-and-attributes/divider-in-attributes-and-time-series.md{% endcapture %}
138137
{% include content-toggle.liquid content-toggle-id="modbus-attributes-timeseries-examples" toggle-spec=modbus-attributes-timeseries-examples %}
139138

140139
### Requests mapping
@@ -355,29 +354,29 @@ Example of the serial slave configuration:
355354

356355
##### Device attributes and time series
357356

358-
| **Parameter** | **Description** |
359-
|:-------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
360-
| server.slaves[].attributes[] | List of attributes that will be sent to the ThingsBoard platform instance. |
361-
| server.slaves[].attributes[].tag | Key name of the attribute in ThingsBoard. It can be specified as a static value. |
362-
| server.slaves[].attributes[].type | [Data type](/docs/iot-gateway/config/modbus/#data-types) of value. |
363-
| server.slaves[].attributes[].functionCode | [Function code](/docs/iot-gateway/config/modbus/#modbus-functions) to use for reading the attribute value from the Modbus slave. |
364-
| server.slaves[].attributes[].objectsCount | Number of objects to read from the Modbus slave. |
365-
| server.slaves[].attributes[].address | Address of the object in the Modbus slave. Can be configured for [batch reading](/docs/iot-gateway/config/modbus/#batch-reading-advanced-configuration-mode-only). |
366-
| server.slaves[].attributes[].divider | (Optional) Divider for the value. If not specified, the value will be sent as is. |
367-
| server.slaves[].attributes[].multiplier | (Optional) Multiplier for the value. If not specified, the value will be sent as is. |
368-
| server.slaves[].attributes[].bitTargetType | The response type can be either an integer (0/1) or a boolean (True/False). **Used only with type `bits`**. |
369-
| mapping[].attributes[].reportStrategy | (Optional) Report strategy for the attributes data. If not specified, the device report strategy will be used. |
370-
| server.slaves[].timeseries[] | List of time series that will be sent to the ThingsBoard platform instance. |
371-
| server.slaves[].timeseries[].tag | Key name of the time series in ThingsBoard. It can be specified as a static value. |
372-
| server.slaves[].timeseries[].type | [Data type](/docs/iot-gateway/config/modbus/#data-types) of value. |
373-
| server.slaves[].timeseries[].functionCode | [Function code](/docs/iot-gateway/config/modbus/#modbus-functions) to use for reading the time series value from the Modbus slave. |
374-
| server.slaves[].timeseries[].objectsCount | Number of objects to read from the Modbus slave. |
375-
| server.slaves[].timeseries[].address | Address of the object in the Modbus slave. Can be configured for [batch reading](/docs/iot-gateway/config/modbus/#batch-reading-advanced-configuration-mode-only). |
376-
| server.slaves[].timeseries[].divider | (Optional) Divider for the value. If not specified, the value will be sent as is. |
377-
| server.slaves[].timeseries[].multiplier | (Optional) Multiplier for the value. If not specified, the value will be sent as is. |
378-
| server.slaves[].timeseries[].bitTargetType | The response type can be either an integer (0/1) or a boolean (True/False). **Used only with type `bits`**. |
379-
| mapping[].attributes[].reportStrategy | (Optional) Report strategy for the time series data. If not specified, the device report strategy will be used. |
380-
| --- | |
357+
| **Parameter** | **Description** |
358+
|:-------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------|
359+
| server.slaves[].attributes[] | List of attributes that will be sent to the ThingsBoard platform instance. |
360+
| server.slaves[].attributes[].tag | Key name of the attribute in ThingsBoard. It can be specified as a static value. |
361+
| server.slaves[].attributes[].type | [Data type](/docs/iot-gateway/config/modbus/#data-types) of value. |
362+
| server.slaves[].attributes[].functionCode | [Function code](/docs/iot-gateway/config/modbus/#modbus-functions) to use for reading the attribute value from the Modbus slave. |
363+
| server.slaves[].attributes[].objectsCount | Number of objects to read from the Modbus slave. |
364+
| server.slaves[].attributes[].address | Address of the object in the Modbus slave. |
365+
| server.slaves[].attributes[].divider | (Optional) Divider for the value. If not specified, the value will be sent as is. |
366+
| server.slaves[].attributes[].multiplier | (Optional) Multiplier for the value. If not specified, the value will be sent as is. |
367+
| server.slaves[].attributes[].bitTargetType | The response type can be either an integer (0/1) or a boolean (True/False). **Used only with type `bits`**. |
368+
| mapping[].attributes[].reportStrategy | (Optional) Report strategy for the attributes data. If not specified, the device report strategy will be used. |
369+
| server.slaves[].timeseries[] | List of time series that will be sent to the ThingsBoard platform instance. |
370+
| server.slaves[].timeseries[].tag | Key name of the time series in ThingsBoard. It can be specified as a static value. |
371+
| server.slaves[].timeseries[].type | [Data type](/docs/iot-gateway/config/modbus/#data-types) of value. |
372+
| server.slaves[].timeseries[].functionCode | [Function code](/docs/iot-gateway/config/modbus/#modbus-functions) to use for reading the time series value from the Modbus slave. |
373+
| server.slaves[].timeseries[].objectsCount | Number of objects to read from the Modbus slave. |
374+
| server.slaves[].timeseries[].address | Address of the object in the Modbus slave. |
375+
| server.slaves[].timeseries[].divider | (Optional) Divider for the value. If not specified, the value will be sent as is. |
376+
| server.slaves[].timeseries[].multiplier | (Optional) Multiplier for the value. If not specified, the value will be sent as is. |
377+
| server.slaves[].timeseries[].bitTargetType | The response type can be either an integer (0/1) or a boolean (True/False). **Used only with type `bits`**. |
378+
| mapping[].attributes[].reportStrategy | (Optional) Report strategy for the time series data. If not specified, the device report strategy will be used. |
379+
| --- | |
381380

382381
Example of the attributes and telemetry configuration:
383382

‎images/gateway/modbus-connector/examples/batch-reading-overview.png‎

-423 KB
Binary file not shown.

0 commit comments

Comments
 (0)