Skip to Content

Changes for page ThingsBoard

Last modified by Dilisi S on 2025/04/23 19:23
From version 46.1
edited by Dilisi S
on 2025/03/05 14:48
Change comment: Uploaded new attachment "add-integration-downlink-data-converter.png", version {1}
To version 64.1
edited by Dilisi S
on 2025/03/07 00:17
Change comment: Mar 6 edits - part 2

Summary

Details

Page properties
Content
... ... @@ -15,10 +15,12 @@
15 15  
16 16  = Add New Device =
17 17  
18 +First, we will add a device to simulate data using MQTT. This device does not represent a real physical device but serves as a common virtual device for all Dragino NB/CB devices.
19 +
18 18  In the left navigation, click **Entities** and then click **Devices**.
19 19  
20 20  
21 -[[image:ThingsBoard-Device.png]]
23 +[[image:device-list-empty.png]]
22 22  
23 23  
24 24  On the **Devices **page, click on the ‘**+**’ button, and then click on the **Add new device **from the dropdown menu.
... ... @@ -27,7 +27,62 @@
27 27  [[image:ThingsBoard-add-new-device.png||height="279" width="500"]]
28 28  
29 29  
32 +The **Add new device** window appears. Name the device, for example '**Virtual NB/CB device**'.
30 30  
34 +Click on the **Next: Credentials** button.
35 +
36 +
37 +[[image:new-device-device-details.png||height="529" width="500"]]
38 +
39 +
40 +Click the **Access token** button if it is not selected by default.
41 +
42 +Copy the **Access token** to a text editor, as you will need it in the section **'Sending data from an MQTT client'**.
43 +
44 +Click on the **Add** button.
45 +
46 +[[image:new-device-access-token.png||height="528" width="500"]]
47 +
48 +
49 +Click on the **MQTT** button.
50 +
51 +Then, select the operating system you are going to use with the **Mosquitto MQTT Broker**. This example shows sending a command from a computer running **MacOS**. First, install the necessary client tools on your computer.
52 +
53 +Copy the MQTT pub command in the '**Execute the following command**' section.
54 +
55 +{{code language="none"}}
56 +mosquitto_pub -d -q 1 -h mqtt.eu.thingsboard.cloud -p 1883 -t v1/devices/me/telemetry -u "24vk3w9h7sqdld1me5eh" -m "{temperature:25}"
57 +{{/code}}
58 +
59 +Note that the **State** is still shown as **'Inactive'** in the **Latest telemetry** section.
60 +
61 +[[image:new-device-check-connectivity.png||height="522" width="500"]]
62 +
63 +
64 +On the terminal, enter the command you copied. This command sends the MQTT payload **{temperature:25}** as telemetry data from a virtual device named **'me'**. Of course, you can replace **'me'** with a device name or use the wildcard character **'+'** to match any device name.
65 +
66 +
67 +[[image:mqtt-command-1.png||height="228" width="700"]]
68 +
69 +
70 +If the command is successful, you can see the telemetry data you sent under the **Latest telemetry** section. Note that the **State** is now **'Active'** in the **Latest telemetry** section.
71 +
72 +
73 +[[image:new-device-telemetry-test.png||height="520" width="500"]]
74 +
75 +
76 +Send the same command again, only changing the **temperature** value, to see how the **Latest telemetry** section updates its data.
77 +
78 +Once you are done experimenting with this, close the window by clicking the **Close** button.
79 +
80 +
81 +[[image:mqtt-command-2.png||height="227" width="700"]]
82 +
83 +
84 +
85 +[[image:virtual-device-active.png]]
86 +
87 +
31 31  = Data Converters =
32 32  
33 33  In **ThingsBoard**, **Data Converters** are components used to transform incoming or outgoing data between different formats, typically to convert raw telemetry data from devices into a structured format that ThingsBoard can understand, or vice versa.
... ... @@ -250,7 +250,7 @@
250 250  On the **Integrations** page, click on the '**+**' button.
251 251  
252 252  
253 -[[image:ThingsBoard-add-integration.png]]
310 +[[image:data-converter-list-page.png]]
254 254  
255 255  
256 256  The **Add integration** window appears.
... ... @@ -260,8 +260,8 @@
260 260  
261 261  **Basic settings:**
262 262  
263 -* **Integration type**: UDP
264 -* **Name**: UDP Integration NB/CB
320 +* **Integration type**: MQTT
321 +* **Name**: MQTT integration NB/CB
265 265  
266 266  Click **Next** button.
267 267  
... ... @@ -269,41 +269,53 @@
269 269  [[image:add-integration-basic-settings.png||height="511" width="500"]]
270 270  
271 271  
329 +
272 272  **Uplink data converter:**
273 273  
274 274  * Click on the **Select existing** button.
275 -* **Uplink data converter**: Select **UDP Uplink Converter NB/CB **from the dropdown list.
333 +* **Uplink data converter**: Select **MQTT Uplink Converter NB/CB **from the dropdown list.
276 276  
277 277  Click **Next** button.
278 278  
279 279  
280 -[[image:add-integration-uplink-data-converter.png||height="511" width="500"]]
338 +[[image:add-integration-uplink-data-converter.png||width="500"]]
281 281  
282 282  
341 +
283 283  **Downlink data converter:**
284 284  
285 285  * Click on the **Select existing** button.
286 -* **Downlink data converter**: Select **UDP Downlink Converter NB/CB **from the dropdown list.
345 +* **Downlink data converter**: Select **MQTT Downlink Converter NB/CB **from the dropdown list.
287 287  
288 288  Click **Next** button.
289 289  
290 290  
291 -[[image:add-integration-downlink-data-converter.png||height="512" width="500"]]
350 +[[image:add-integration-downlink-data-converter.png||height="510" width="500"]]
292 292  
293 293  
353 +
294 294  **Connection:**
295 295  
296 -* **Port**: 11582
297 -* **Size of the buffer for inbound socket (in KB)**: 64
298 -* **Cache Size**: 10000000
299 -* **Cache time to live in minutes**: 1440
356 +* **Host**: mqtt.eu.thingsboard.cloud (This is the host name you copied from the device - See section xxxxx for more information)
357 +* **Port**: 1883 (This is the port number you copied from the device - See section xxxxx for more information)
358 +* **Credentials**: Basic
359 +* **Username**: Access token (This is the access token you copied from the device)
360 +* **Password** - Leave it as blank
361 +* **Topic** - v1/devices/+/telemetry (sightly modify the topic 'v1/devices/me/telemetry' you copied from the device to enable receiving data from any 'device name')
362 +* **QoS** - 0-At most once
300 300  
301 -Copy the two keys, **Integration key** and **Integration secret** into a text editor, as you will need them in the section ‘xxxxx’.
364 +Click on the **Check connection** button to verify the MQTT connection using the provided parameters.
302 302  
366 +
367 +[[image:add-integration-connection.png||width="500"]]
368 +
369 +
370 +If the connection is successful, you will see the **Connected** message.
371 +
303 303  Click on the **Add** button.
304 304  
305 305  
306 -[[image:add-integration-connection.png||height="511" width="500"]]
375 +[[image:add-connection-success.png||height="511" width="500"]]
307 307  
308 308  
309 309  You should see that the newly added integration is listed on the **Integrations** page.
... ... @@ -310,11 +310,18 @@
310 310  
311 311  Since we haven't received data from a device yet, the integration **Status** is shown as **Pending.**
312 312  
313 -[[image:Integrations-list.png]]
314 314  
315 315  
384 +[[image:integrations-list-added-pending.png]]
385 +
386 +
316 316  = Verifying the receipt of data from the device =
317 317  
318 -Connect **S31B-NB** to transfer information. If the integration was performed without errors, after the transmission of the first telemetry, a new device with the name “xxxxx” will appear in the Devices → All. Also, you can verify the input and output data, respectively, before and after conversion in Data converters → UDP Uplink Converter NB/CB → Events.
389 +On the terminal, issue the following MQTT command which simulates the device S31B-NB.
319 319  
320 320  
392 +{{code language="none"}}
393 +mosquitto_pub -d -q 1 -h mqtt.eu.thingsboard.cloud -p 1883 -t v1/devices/S31B-NB/telemetry -u "24vk3w9h7sqdld1me5eh" -m "{temperature:20}"
394 +{{/code}}
395 +
396 +If the integration was performed without errors, after the transmission of the first telemetry, a new device with the name “S31B-NB” will appear in the Devices → All. Also, you can verify the input and output data, respectively, before and after conversion in Data converters → UDP Uplink Converter NB/CB → Events.
ThingsBoard-Device.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -225.5 KB
Content
add-connection-success.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +202.8 KB
Content
add-integration-connection.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +124.4 KB
Content
device-list-empty.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +202.8 KB
Content
integrations-list-added-pending.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +202.8 KB
Content
mqtt-command-1.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +202.8 KB
Content
mqtt-command-2.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +202.8 KB
Content
new-device-access-token.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +202.8 KB
Content
new-device-check-connectivity.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +202.8 KB
Content
new-device-device-details.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +88.4 KB
Content
new-device-telemetry-test.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +202.8 KB
Content
virtual-device-active.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +202.8 KB
Content