Skip to Content

Changes for page ThingsBoard

Last modified by Dilisi S on 2025/04/23 19:23
From version 207.1
edited by Dilisi S
on 2025/04/21 17:00
Change comment: Uploaded new attachment "add-integration-4.png", version {1}
To version 221.1
edited by Dilisi S
on 2025/04/23 01:38
Change comment: April 22 edits

Summary

Details

Page properties
Content
... ... @@ -23,8 +23,9 @@
23 23  
24 24  * ThingsBoard cloud account
25 25  * MQTT Broker (public or private) such as,
26 +** [[ThingsBoard MQTT broker>>https://thingsboard.io/docs/mqtt-broker/]] (TBMQ)
26 26  ** **[[HiveMQ Cloud>>https://www.hivemq.com]] - You can create a free account to try it or subscribe for a paid account. - We use HiveMQ Cloud as the MQTT broker to build example in this tutorial.**
27 -** [[emqx>>https://www.emqx.com/zh/mqtt/public-mqtt5-broker]] - The public MQTT server is only used for MOTT learning and testing, and should not be used in the production environment.
28 +** [[emqx>>https://www.emqx.com/zh/mqtt/public-mqtt5-broker]] - The public MQTT server is only used for MQTT learning and testing, and should not be used in the production environment.
28 28  ** [[lns1.thingseye.io>>http://lns1.thingseye.io/]] - This is Dragino's MQTT broker, which requires a CA certificate to use.
29 29  
30 30  == 2.1 ThingsBoard Cloud ==
... ... @@ -67,11 +67,19 @@
67 67  [[image:thingsboard-6.png||height="244" width="500"]]
68 68  
69 69  
70 -== 2.2 HiveMQ Cloud ==
71 +== 2.2 MQTT Brokers ==
71 71  
72 -=== 2.2.1 HiveMQ Cloud ===
73 +This section introduces some MQTT brokers that you can use to publish messages from the device side and subscribe from the ThingsBoard side.
73 73  
74 74  
76 +=== 2.2.1 ThingsBoard MQTT broker (TBMQ) ===
77 +
78 +The complete instructions for installing, configuring, and using the TBMQ can be found [[here>>https://thingsboard.io/docs/mqtt-broker/getting-started/]].
79 +
80 +
81 +=== 2.2.2 HiveMQ Cloud ===
82 +
83 +
75 75  Go to [[https:~~/~~/www.hivemq.com>>https://www.hivemq.com]]
76 76  
77 77  Click on the **Start Free** button.
... ... @@ -146,7 +146,7 @@
146 146  You will need these MQTT connection parameters when configuring the MQTT integration in the '**Add Integration**' section.
147 147  
148 148  
149 -=== 2.2.2 emqx ===
158 +=== 2.2.3 emqx ===
150 150  
151 151  
152 152  The [[emqx>>https://www.emqx.com/zh/mqtt/public-mqtt5-broker]] public MQTT server is only used for MOTT learning and testing, and should not be used in the production environment.
... ... @@ -155,7 +155,7 @@
155 155  [[image:emqx.png||height="420" width="500"]]
156 156  
157 157  
158 -=== 2.2.3 Ins1.thingseye.io ===
167 +=== 2.2.4 Ins1.thingseye.io ===
159 159  
160 160  [[lns1.thingseye.io>>http://lns1.thingseye.io/]] is the Dragino's MQTT broker, which requires a CA certificate file, Certificate file, and the Private key file to use.
161 161  
... ... @@ -288,7 +288,7 @@
288 288  **Basic settings:**
289 289  
290 290  * **Integration type**: MQTT
291 -* **Name**: MQTT integration - Device A
300 +* **Name**: MQTT integration
292 292  * **Enable integration**: YES
293 293  * **Allow create devices or assets**: YES
294 294  
... ... @@ -295,11 +295,10 @@
295 295  Click **Next** button.
296 296  
297 297  
298 -[[image:add-integration-basic-settings.png||height="504" width="500"]]
299 299  
308 +[[image:add-integration-part-1.png||height="483" width="500"]]
300 300  
301 301  
302 -
303 303  **Uplink data converter:**
304 304  
305 305  * Click on the **Select existing** button.
... ... @@ -308,8 +308,8 @@
308 308  Click **Next** button.
309 309  
310 310  
311 -[[image:add-integration-ul-data-converter.png||height="505" width="500"]]
312 312  
320 +[[image:add-integration-part-2.png||height="484" width="500"]]
313 313  
314 314  
315 315  **Downlink data converter:**
... ... @@ -327,16 +327,16 @@
327 327  
328 328  **Connection:**
329 329  
330 -* **Host**: Host URL (Eg. **//011731f7xxxxxxxxxxxfbbedfc63f4.s1.eu.hivemq.cloud//**)
331 -* **Port**: 8883
338 +* **Host**: Host URL (Eg, **//011731f7xxxxxxxxxxxfbbedfc63f4.s1.eu.hivemq.cloud//**)
339 +* **Port**: 8883 (the port number may differ based on your MQTT broker)
332 332  * **Credentials type**: Basic
333 333  * **Username**: Username (from your HiveMQ Cloud Cluster with your credentials)
334 334  * **Password:** Password (from your HiveMQ Cloud Cluster with your credentials)
335 335  * **Enable SSL**: YES
336 -* **Topic: device/a** (The topic can be anything; you can even use just the device name.)
344 +* **Topic**: # (the # symbol indicates that it filters all topics).
337 337  * **QoS:** 0-At most once
338 338  
339 -[[image:add-integartion-connection.png||height="505" width="500"]]
347 +[[image:add-integration-4.png||height="484" width="500"]]
340 340  
341 341  
342 342  Click on the **Advanced settings** button.
... ... @@ -366,8 +366,8 @@
366 366  Since we haven't received data from a device yet, the integration **Status** is shown as **Pending.**
367 367  
368 368  
369 -[[image:integration-added.png]]
370 370  
378 +[[image:integrations-pending.png]]
371 371  
372 372  
373 373  = 5. Verifying the receipt of data from virtual devices =
... ... @@ -378,38 +378,47 @@
378 378  
379 379  We use the Mosquitto MQTT client to simulate MQTT messages, acting as a virtual device. First, install the Mosquitto client on your computer from [[this link>>url:https://mosquitto.org/download/]]. The Mosquitto client publishes messages to the MQTT broker (HiveMQ) on a specified MQTT topic. ThingsBoard subscribes to these messages using the same topic.
380 380  
381 -The Mosquitto client publishes messages (payloads) on the topic **/device/a**. Of course, you can use any topic for testing.
389 +The Mosquitto client publishes messages (payloads) to a topic - for example, # or device/ts01-nb. You can, of course, use any topic you prefer.
382 382  
383 -(% id="cke_bm_37386S" style="display:none" %) (%%)The MQTT payload format is as follows:
384 384  
392 +(% id="cke_bm_37386S" style="display:none" %) (%%)The MQTT payload format is as follows. The **IMEI **and **Model **are mandatory fields. For other fields, you can use any number of key-value pairs.
393 +
385 385  {{code language="none"}}
386 -{"IMEI": "350693903995577", "temperature":25, "humidity":80, "pressure":1005}
395 +{"IMEI":"350693903995577", "Model":"TS01-NB", "temperature":30, "humidity":80, "pressure":1005}
387 387  {{/code}}
388 388  
389 -Once ThingsBoard receives this message, it forwards this payload to the matching device through the integration.
390 390  
391 -
392 392  == 5.2 Sending messages ==
393 393  
394 394  
395 -On your computer's terminal, issue the following MQTT command which simulates the device '**Device A'**. The message payload contains the fields IMEI, temperature, humidity, and pressure, which hold the values 350693903995577, 30, 80, and 1005 respectively. This payload is also (technically) known as telemetry.
402 +On your computer's terminal, issue the following MQTT command, which simulates the device named '**350693903995577'**. The message payload contains the fields IMEI, Model, temperature, humidity, and pressure, which hold the values 350693903995577,  TS01-NB, 30, 80, and 1005 respectively. This payload is also (technically) known as telemetry.
396 396  
397 397  {{code language="none"}}
398 -mosquitto_pub -d -q 1 -h 011731f7928xxxxx.s1.eu.hivemq.cloud -p 8883 -u "xxxxx" -P "xxxxx" -t "device/a" -m '{"IMEI":"350693903995577", "temperature":30, "humidity":80, "pressure":1005}'
405 +mosquitto_pub -d -q 1 -h 011731f7928xxxxx.s1.eu.hivemq.cloud -p 8883 -u "xxxxx" -P "xxxxx" -t "device/350693903995577" -m '{"IMEI":"350693903995577", "Model":"TS01-NB", "temperature":30, "humidity":80, "pressure":1005}'
399 399  {{/code}}
400 400  
401 -If the integration was performed without errors, the status of the integration changes to 'Active' after the first telemetry transmission.
408 +If the integration was performed without errors, a new device named **350693903995577 **is created in the **Devices **section.
402 402  
403 403  
404 -[[image:integration-active.png]]
411 +[[image:new-device-1.png]]
405 405  
406 406  
414 +The status of the integration also changes to '**Active**' after the first telemetry transmission.
415 +
416 +
417 +[[image:Screenshot 2025-04-21 122154.png]]
418 +
419 +
420 +
421 +**When ThingsBoard receives this message for the first time, it will automatically create a new device named '350693903995577' in the Devices section. The device name is based on the IMEI number. For subsequent messages with the same IMEI, no duplicate devices will be created. Each new IMEI number will result in a unique entry in the Devices section, representing a physical device.**
422 +
423 +
407 407  == 5.3 Viewing messages ==
408 408  
409 409  
410 410  Go back to the **Integrations** page.
411 411  
412 -Click on the **MQTT integration NB/CB** in the **Integrations** page to see its details.
429 +Click on the **MQTT integration** in the **Integrations** page to see its details.
413 413  
414 414  Click on the **Edit** button (//**pen icon**//).
415 415  
... ... @@ -422,11 +422,10 @@
422 422  Then click on the **Apply changes** (//**tick icon**//) button.
423 423  
424 424  
425 -[[image:debug-enabled.png||height="301" width="700"]]
426 426  
443 +[[image:Screenshot 2025-04-21 122936.png||height="247" width="500"]]
427 427  
428 428  
429 -
430 430  Now go to the **Events** tab.
431 431  
432 432  Select the **Event type** as **Debug** from the dropdown list.
... ... @@ -434,24 +434,19 @@
434 434  Publish another message (of course, you can repeat the previous message by pressing the UP arrow on your keyboard and then press Enter key) to your MQTT broker from your terminal, for example:
435 435  
436 436  {{code language="none"}}
437 -mosquitto_pub -d -q 1 -h 011731f7928xxxxx.s1.eu.hivemq.cloud -p 8883 -u "xxxxx" -P "xxxxx" -t "device/a" -m '{"IMEI":"350693903995577", "temperature":30, "humidity":80, "pressure":1005}'
453 +mosquitto_pub -d -q 1 -h 011731f7928xxxxx.s1.eu.hivemq.cloud -p 8883 -u "xxxxx" -P "xxxxx" -t "device/350693903995577" -m '{"IMEI":"350693903995577", "Model":"TS01-NB", "temperature":30, "humidity":82, "pressure":1005}'
438 438  {{/code}}
439 439  
440 440  Now you can see that uplink message in the **Events** tab (Click the **refresh** button if you didn't see any messages in the Events tab). The status should be **OK **if there is no errors in your integration.
441 441  
442 442  
443 -[[image:Screenshot 2025-03-26 at 19.49.31.png]]
444 -
445 -
446 -
447 447  Then click on the **three dots (...)** in the **Message** column. You can see the uplink message's **payload** in the **Message** window.
448 448  
449 449  
450 -[[image:Screenshot 2025-03-26 at 19.47.52.png]]
451 451  
463 +[[image:Screenshot 2025-04-21 122909.png]]
452 452  
453 453  
454 -
455 455  Now, you have successfully tested your integration with a simulated uplink payload and verified that it is received by ThingsBoard, and the device is provisioned.
456 456  
457 457  
... ... @@ -463,11 +463,6 @@
463 463  This section guides you on how to create a dashboard to display temperature and humidity data from the device on a time-series chart. You may also use other widgets in ThingsBoard to display data according to your requirements.
464 464  
465 465  
466 -First simulate a few messages using MQTT. This time, we have added the 'humidity' field to the payload. Eg:
467 -
468 -{{code language="none"}}mosquitto_pub -d -q 1 -h 011731f7928xxxxx.s1.eu.hivemq.cloud -p 8883 -u "xxxxx" -P "xxxxx" -t "device/a" -m '{"IMEI":"350693903995577", "temperature":22, "humidity":80, "pressure":1005}'{{/code}}
469 -
470 -
471 471  In **ThingsBoard**, from the left navigation menu, click **Dashboards**. Then, click the **+** button and select **Create new dashboard** from the dropdown menu.
472 472  
473 473  
... ... @@ -503,10 +503,11 @@
503 503  
504 504  Configure the **Time series chart** widget as follows:
505 505  
506 -* **Datasource** - select **Device A** device you provisioned.
512 +* **Datasource** - select **350693903995577 **you provisioned.
507 507  * **Series**:
508 508  ** **temperature** - you can see this key by default.
509 -** **humidity** - Click **Add series** button. Then add the **humidity** for the key and then type **%** as its unit.
515 +** **humidity** - Click **Add series** button. Then choose **humidity** for the key, and then type **%** as its unit.
516 +** pressure -  Click **Add series** button. Then choose **humidity** for the key, and then type Pa as its unit.
510 510  * Click on the **Add** button.
511 511  
512 512  {{info}}
... ... @@ -513,34 +513,27 @@
513 513  You can add only the relevant fields from the device's payload to display data on a widget. These fields are called 'keys'.
514 514  {{/info}}
515 515  
516 -[[image:Screenshot 2025-03-31 at 06.51.15.png||height="485" width="700"]]
517 517  
518 518  
525 +[[image:Screenshot 2025-04-21 123647.png||height="466" width="700"]]
526 +
527 +
519 519  The time-series chart will appear in edit mode. Resize it by clicking and dragging the lower-right corner.
520 520  
521 521  Click the **Save** button to add the widget to the dashboard.
522 522  
523 523  
524 -[[image:timeseries-3.png||height="347" width="700"]]
533 +[[image:Screenshot 2025-04-21 124145.png||height="443" width="700"]]
525 525  
526 526  
527 -Now send the following MQTT messages from the terminal to simulate the data.
536 +**Now send a few MQTT messages from the terminal to simulate the data. Use different values for temperature, humidity, and pressure in each message.**
528 528  
538 +**The chart will update with the values in real time, and you will see a live chart similar to this:**
529 529  
530 -{{code language="none"}}
531 -mosquitto_pub -d -q 1 -h 011731f7928xxxxx.s1.eu.hivemq.cloud -p 8883 -u "xxxxx" -P "xxxxx" -t "device/a" -m '{"IMEI":"350693903995577", "temperature":22, "humidity":70, "pressure":1005}'
532 532  
533 -mosquitto_pub -d -q 1 -h 011731f7928xxxxx.s1.eu.hivemq.cloud -p 8883 -u "xxxxx" -P "xxxxx" -t "device/a" -m '{"IMEI":"350693903995577", "temperature":27, "humidity":72, "pressure":1005}'
541 +[[image:Screenshot 2025-04-21 124054.png||height="441" width="700"]]
534 534  
535 -mosquitto_pub -d -q 1 -h 011731f7928xxxxx.s1.eu.hivemq.cloud -p 8883 -u "xxxxx" -P "xxxxx" -t "device/a" -m '{"IMEI":"350693903995577", "temperature":19, "humidity":80, "pressure":1005}'
536 -{{/code}}
537 537  
538 -The chart will update with the values in realtime, as shown in the below image.
539 -
540 -
541 -[[image:timeseries-4.png||height="316" width="700"]]
542 -
543 -
544 544  = 8. Configure Physical NB-IoT Sensor =
545 545  
546 546  
... ... @@ -552,8 +552,8 @@
552 552  **AT Commands**
553 553  
554 554  * **AT+PRO=3,3    **~/~/ Use MQTT to connect to ThingsBoard. Payload Type set to 3.
555 -* **AT+SUBTOPIC=<MQTT subscribe topic> Eg: TS01-NB**
556 -* **AT+PUBTOPIC=<MQTT publish topic> Eg: TS01-NB**
555 +* **AT+SUBTOPIC=<MQTT subscribe topic> Eg: # -  **You can leave the SUBTOPIC configuration as it is, since we are not sending downlink messages to the device at the moment.
556 +* **AT+PUBTOPIC=<MQTT publish topic> Eg: #**
557 557  * **AT+CLIENT=null**
558 558  * **AT+UNAME=<MQTT Username>**
559 559  * **AT+PWD=<MQTT Password>**
... ... @@ -562,7 +562,6 @@
562 562  Test your uplink by pressing the ACT button for 1 second.
563 563  
564 564  
565 -
566 566  The following image shows the uplink payload of a real Dragino device. The publish topic is '**TS01-NB' that contains fields in the payload, IMEI, IMSI, Model, temperature, etc**. Note that we have created a device named **TS01-NB** in the **Devices** section in advance.
567 567  
568 568  
Screenshot 2025-04-21 122154.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +21.2 KB
Content
Screenshot 2025-04-21 122909.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +59.9 KB
Content
Screenshot 2025-04-21 122936.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +72.0 KB
Content
Screenshot 2025-04-21 123647.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +77.9 KB
Content
Screenshot 2025-04-21 124054.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +60.4 KB
Content
Screenshot 2025-04-21 124145.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +50.9 KB
Content
device-1.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +34.5 KB
Content
integrations-pending.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +19.8 KB
Content
new-device-1.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +34.7 KB
Content