Skip to content

Updated Gateway documentation #562

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
samson0v wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Updated Gateway documentation #562

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9abd1c4
Added security type env variable description
samson0v Jul 21, 2026
06614b8
Added description for maxRegistersPerRequest parameter in Modbus conn…
samson0v Jul 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/content/_includes/docs/iot-gateway/config/general.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ Full list of supported variables:
|----------|---------|-------------|
| `TB_GW_HOST` | `host.docker.internal` | Hostname or IP address of ThingsBoard server |
| `TB_GW_PORT` | `1883` | MQTT service port on ThingsBoard server |
| `TB_GW_SECURITY_TYPE` | `accessToken` | Security type: `accessToken`, `usernamePassword`, `tlsAccessToken` |
| `TB_GW_ACCESS_TOKEN` | — | Access token for the gateway |
| `TB_GW_CA_CERT` | — | Path to CA certificate file |
| `TB_GW_PRIVATE_KEY` | — | Path to private key file |
Expand Down
4 changes: 3 additions & 1 deletion src/content/_includes/docs/iot-gateway/config/modbus.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1799,7 +1799,8 @@ Example of the serial slave configuration:
| server.slaves[].attributes[].type | [Data type](/docs/iot-gateway/config/modbus/#data-types) of value. |
| server.slaves[].attributes[].functionCode | [Function code](/docs/iot-gateway/config/modbus/#modbus-functions) to use for reading the attribute value from the Modbus slave. |
| server.slaves[].attributes[].objectsCount | Number of objects to read from the Modbus slave. |
| server.slaves[].attributes[].address | Address of the object in the Modbus slave. Can be configured for [batch reading](/docs/iot-gateway/config/modbus/#usage-examples). |
| server.slaves[].attributes[].address | Address of the object in the Modbus slave. Can be configured for [batch reading](/docs/iot-gateway/config/modbus/#usage-examples). |
| server.slaves[].attributes[].maxRegistersPerRequest | (Optional) Maximum number of registers to read in a single request. If not specified, the default value is 16. Can be used only with [batch reading](/docs/iot-gateway/config/modbus/#usage-examples) feature. |
| server.slaves[].attributes[].divider | (Optional) Divider for the value. If not specified, the value will be sent as is. |
| server.slaves[].attributes[].multiplier | (Optional) Multiplier for the value. If not specified, the value will be sent as is. |
| server.slaves[].attributes[].bitTargetType | The response type can be either an integer (0/1) or a boolean (True/False). **Used only with type `bits`**. |
Expand All @@ -1810,6 +1811,7 @@ Example of the serial slave configuration:
| 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. |
| server.slaves[].timeseries[].objectsCount | Number of objects to read from the Modbus slave. |
| server.slaves[].timeseries[].address | Address of the object in the Modbus slave. Can be configured for [batch reading](/docs/iot-gateway/config/modbus/#usage-examples). |
| server.slaves[].timeseries[].maxRegistersPerRequest | (Optional) Maximum number of registers to read in a single request. If not specified, the default value is 16. Can be used only with [batch reading](/docs/iot-gateway/config/modbus/#usage-examples) feature. |
| server.slaves[].timeseries[].divider | (Optional) Divider for the value. If not specified, the value will be sent as is. |
| server.slaves[].timeseries[].multiplier | (Optional) Multiplier for the value. If not specified, the value will be sent as is. |
| server.slaves[].timeseries[].bitTargetType | The response type can be either an integer (0/1) or a boolean (True/False). **Used only with type `bits`**. |
Expand Down