Updated documentation for MQTT connector #2371

Andry925 · 2025-10-16T17:23:37Z

PR description

The documentation updated for Thingsboard IOT gateway MQTT connector.

Link checker

The links will be checked by the build agent automatically once you create or update your PR.

You can use the following command to check the broken links locally.

docker run --rm -it --network=host --name=linkchecker ghcr.io/linkchecker/linkchecker --check-extern --no-warnings http://0.0.0.0:4000/

…ing clientID

CLAassistant · 2025-10-16T17:23:43Z

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

…section

…entation

samson0v · 2025-11-18T09:21:10Z

docs/iot-gateway/config/mqtt.md

+These settings cover the basic connection parameters, mqtt version protocol that will be used for security configuration, and 
+authentication modes.


Rewrite this sentence

samson0v · 2025-11-18T09:22:05Z

docs/iot-gateway/config/mqtt.md

-Basic<small></small>%,%basic%,%templates/iot-gateway/mqtt-connector/connection-to-broker-basic-section.md%br%
-Advanced<small></small>%,%advanced%,%templates/iot-gateway/mqtt-connector/connection-to-broker-advanced-section.md{% endcapture %}
+This subsection specifies the target MQTT broker and how the gateway interacts with it. It includes the broker's host,
+port, mqtt version protocol, client id.


...port, mqtt version protocol and client id.

samson0v · 2025-11-18T09:26:04Z

docs/iot-gateway/config/mqtt.md

+#### Anonymous

-{% capture mqttsecuritysubsection %}
-Basic<small></small>%,%basic%,%templates/iot-gateway/mqtt-connector/security-subsection-basic.md%br%
-Advanced<small></small>%,%advanced%,%templates/iot-gateway/mqtt-connector/security-subsection-advanced.md{% endcapture %}
+{% include /templates/iot-gateway/mqtt-connector/security-subsection-anonymous.md %}

-{% include content-toggle.liquid content-toggle-id="mqttsecuritysubsection" toggle-spec=mqttsecuritysubsection %}
+#### Basic
+
+{% include /templates/iot-gateway/mqtt-connector/security-subsection-basic.md %}
+
+#### Certificates
+
+{% include /templates/iot-gateway/mqtt-connector/security-subsection-certificates.md%}
+
+{% capture difference %}
+All configuration parameters list for each authentication mode, and their detailed description can be found in the 
+[Advanced configuration](/docs/iot-gateway/config/mqtt/#advanced-configuration) section.
+{% endcapture %}
+{% include templates/info-banner.md content=difference %}


Move these to selectable blocks

samson0v · 2025-11-18T09:29:39Z

docs/iot-gateway/config/mqtt.md

+### Subsection "Data conversion"
+
+- **Payload type** - The incoming data type that will be processed as  `JSON`, `Bytes`, `Custom` (more information about supported Payload types see in the [Additional information](/docs/iot-gateway/config/mqtt/#convertor-types) *Convertor types section* ).
+- **Name** - The name of the device in ThingsBoard. It can be parsed from `Message`, `Topic`, `Constant`, (more information about sources with screenshot examples can be found in the [Usage examples](/docs/iot-gateway/config/mqtt/#usage-examples) section).


Device name

samson0v · 2025-11-18T09:29:52Z

docs/iot-gateway/config/mqtt.md

+
+- **Payload type** - The incoming data type that will be processed as  `JSON`, `Bytes`, `Custom` (more information about supported Payload types see in the [Additional information](/docs/iot-gateway/config/mqtt/#convertor-types) *Convertor types section* ).
+- **Name** - The name of the device in ThingsBoard. It can be parsed from `Message`, `Topic`, `Constant`, (more information about sources with screenshot examples can be found in the [Usage examples](/docs/iot-gateway/config/mqtt/#usage-examples) section).
+- **Profile name** - The device profile in ThingsBoard. It can be parsed from `Message`, `Topic`, `Constant` (more information about sources with screenshot examples can be found in the [Usage examples](/docs/iot-gateway/config/mqtt/#usage-examples) section).


Device profile name

samson0v · 2025-11-18T11:31:49Z

_includes/templates/iot-gateway/mqtt-connector/examples/request-mapping/attribute-update.md

@@ -0,0 +1,110 @@
+For Attribute updates, the gateway needs to know which devices should receive updates for which attributes. You configure this using regular expressions for both device names and attribute names. When an attribute is updated in ThingsBoard, the gateway publishes the new value to a configured MQTT topic.


Same comments as for connect/disconnect requests examples

samson0v · 2025-11-18T11:31:59Z

_includes/templates/iot-gateway/mqtt-connector/examples/request-mapping/attribute-request.md

@@ -0,0 +1,141 @@
+For an Attribute request, the gateway must know which device name to target and which attribute to request. You can extract the device name either from the `Message` payload using [json-path](/docs/iot-gateway/config/mqtt/#json-path)


Same comments as for connect/disconnect requests examples

samson0v · 2025-11-18T11:32:24Z

_includes/templates/iot-gateway/mqtt-connector/examples/request-mapping/reserved-rpc.md

@@ -0,0 +1,111 @@
+## Reserved RPC Methods


Same comments as for connect/disconnect requests examples

samson0v · 2025-11-18T11:32:51Z

_includes/templates/iot-gateway/mqtt-connector/examples/request-mapping/configurable-rpc.md

@@ -0,0 +1,132 @@
+RPC to Device allows sending RPC commands to the device that is connected to ThingsBoard directly or via Gateway.


Same comments as for connect/disconnect requests examples

samson0v · 2025-11-18T11:34:04Z

docs/iot-gateway/config/mqtt.md

+Attribute request <small></small>%,%sharedidentifier%,%templates/iot-gateway/mqtt-connector/examples/request-mapping/attribute-request.md%br%
+Attribute update <small></small>%,%rpctodevice%,%templates/iot-gateway/mqtt-connector/examples/request-mapping/attribute-update.md%br%
+Reserved RPCs<small></small>%,%reservedrpc%,%templates/iot-gateway/mqtt-connector/examples/request-mapping/reserved-rpc.md%br%
+Configurable RPC methods to device <small></small>%,%rpctoconnector%,%templates/iot-gateway/mqtt-connector/examples/request-mapping/configurable-rpc.md{% endcapture %}


RPC to Device

Andry925 added 5 commits October 16, 2025 19:05

update mqtt documentation to the security subsection

23e9609

update includes pages

e1373fc

add new screenshots for mqtt connector

f94085d

rename mqtt version compatibility section, add screenshot for generat…

6d12f66

…ing clientID

update worker settings for mqtt documentation.

5c86dad

Andry925 added 24 commits October 22, 2025 15:09

rewrite mqtt documentation for security subsection.

c70f13a

add new screenshots for mqtt security subsection documentation

99006d5

delete outdated screenshots/md files for mqtt security documentation …

fc97560

…section

correct errors inside mqtt documentation, retake some screenshots

f7a47cc

fix small mistyping in mqtt documentation

f08da73

write initial data mapping section inside mqtt connector

ea1b634

add screenshots for data mapping section

f8718e4

completed the data conversion subsection for the mqtt connector docum…

244f50c

…entation

add screenshots for usage examples and data conversion subsection

dd12eff

finish data mapping section with usage examples

b7ea290

add screenshots for appropriate sections

cfd0616

delete outdated screenshots and .md files

535171d

Write connect request section for mqtt documentation

295b3ca

add empty .md files for futher request mapping section

0e7bad9

add empty .md files for futher request mapping section

5bf0a20

delete old connect request section files

3164c7b

Rewrite disconnect request for mqtt connector

c3ad175

Add screenshots for disconnect request subsection

9a88785

Delete old screenshots

58e83ec

write documentation for attribute request subsection

44ad402

add screenshots for attribute requests subsection

bf13ef5

implement subsection for attribute updates subsection

7c15e6d

add screenshots for attribute updates

5eaec9a

Delete outdated mqtt attribute updates part

2cd9917

Andry925 added 8 commits November 12, 2025 20:15

implement basic rpc subsection

4ffb915

implement subsection for configurable RPC methods to device

e88fd92

add screenshots for configurable RPC section

6582781

implement documentation section for reserved rpc

5c5303a

add screenshots for reserved rpc

3d58a6a

remove outdated screenshots

35ebc3a

rewrite iot gateway features mqtt rpc get/set

fc11200

correct errors in the mqtt documentation

e29f520

samson0v suggested changes Nov 18, 2025

View reviewed changes

Andry925 added 5 commits November 19, 2025 12:12

Apply requested improvements to MQTT documentation

17e667c

Add improvements to MQTT documentation

2c29873

fix errors in the mqtt documentation

108b873

retake screenshots, add note for usage examples.

aa2be4f

change screenshots for mqtt rpc's.

b375a8a

Andry925 changed the title ~~[WIP]: Updated documentation for MQTT connector.~~ Updated documentation for MQTT connector. Nov 25, 2025

Andry925 changed the title ~~Updated documentation for MQTT connector.~~ Updated documentation for MQTT connector Nov 26, 2025

ashvayka merged commit b4033cd into thingsboard:master Nov 26, 2025
1 of 2 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Updated documentation for MQTT connector #2371

Updated documentation for MQTT connector #2371

Uh oh!

Andry925 commented Oct 16, 2025

Uh oh!

CLAassistant commented Oct 16, 2025

Uh oh!

samson0v Nov 18, 2025

Uh oh!

samson0v Nov 18, 2025

Uh oh!

samson0v Nov 18, 2025

Uh oh!

samson0v Nov 18, 2025

Uh oh!

samson0v Nov 18, 2025

Uh oh!

samson0v Nov 18, 2025

Uh oh!

samson0v Nov 18, 2025

Uh oh!

samson0v Nov 18, 2025

Uh oh!

samson0v Nov 18, 2025

Uh oh!

samson0v Nov 18, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

		These settings cover the basic connection parameters, mqtt version protocol that will be used for security configuration, and
		authentication modes.

		@@ -0,0 +1,110 @@
		For Attribute updates, the gateway needs to know which devices should receive updates for which attributes. You configure this using regular expressions for both device names and attribute names. When an attribute is updated in ThingsBoard, the gateway publishes the new value to a configured MQTT topic.

		@@ -0,0 +1,141 @@
		For an Attribute request, the gateway must know which device name to target and which attribute to request. You can extract the device name either from the `Message` payload using [json-path](/docs/iot-gateway/config/mqtt/#json-path)

		@@ -0,0 +1,132 @@
		RPC to Device allows sending RPC commands to the device that is connected to ThingsBoard directly or via Gateway.

Updated documentation for MQTT connector #2371

Updated documentation for MQTT connector #2371

Uh oh!

Conversation

Andry925 commented Oct 16, 2025

PR description

Link checker

Uh oh!

CLAassistant commented Oct 16, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants