Skip to Content

Changes for page ThingsBoard

Last modified by Dilisi S on 2025/04/23 19:23
From version 222.1
edited by Dilisi S
on 2025/04/23 19:23
Change comment: There is no comment for this version
To version 210.1
edited by Dilisi S
on 2025/04/21 18:14
Change comment: Uploaded new attachment "device-1.png", version {1}

Summary

Details

Page properties
Content
... ... @@ -23,9 +23,8 @@
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)
27 -** **[[HiveMQ Cloud>>https://www.hivemq.com]] **-** **You can create a free account to try it or subscribe for a paid account.
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.
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.
29 29  ** [[lns1.thingseye.io>>http://lns1.thingseye.io/]] - This is Dragino's MQTT broker, which requires a CA certificate to use.
30 30  
31 31  == 2.1 ThingsBoard Cloud ==
... ... @@ -68,19 +68,11 @@
68 68  [[image:thingsboard-6.png||height="244" width="500"]]
69 69  
70 70  
71 -== 2.2 MQTT Brokers ==
70 +== 2.2 HiveMQ Cloud ==
72 72  
73 -This section introduces some MQTT brokers that you can use to publish messages from the device side and subscribe from the ThingsBoard side.
72 +=== 2.2.1 HiveMQ Cloud ===
74 74  
75 75  
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 -
84 84  Go to [[https:~~/~~/www.hivemq.com>>https://www.hivemq.com]]
85 85  
86 86  Click on the **Start Free** button.
... ... @@ -155,7 +155,7 @@
155 155  You will need these MQTT connection parameters when configuring the MQTT integration in the '**Add Integration**' section.
156 156  
157 157  
158 -=== 2.2.3 emqx ===
149 +=== 2.2.2 emqx ===
159 159  
160 160  
161 161  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.
... ... @@ -164,7 +164,7 @@
164 164  [[image:emqx.png||height="420" width="500"]]
165 165  
166 166  
167 -=== 2.2.4 Ins1.thingseye.io ===
158 +=== 2.2.3 Ins1.thingseye.io ===
168 168  
169 169  [[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.
170 170  
... ... @@ -344,6 +344,8 @@
344 344  * **Topic**: # (the # symbol indicates that it filters all topics).
345 345  * **QoS:** 0-At most once
346 346  
338 +
339 +
347 347  [[image:add-integration-4.png||height="484" width="500"]]
348 348  
349 349  
... ... @@ -374,8 +374,8 @@
374 374  Since we haven't received data from a device yet, the integration **Status** is shown as **Pending.**
375 375  
376 376  
370 +[[image:integration-added.png]]
377 377  
378 -[[image:integrations-pending.png]]
379 379  
380 380  
381 381  = 5. Verifying the receipt of data from virtual devices =
... ... @@ -386,47 +386,38 @@
386 386  
387 387  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.
388 388  
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 +The Mosquitto client publishes messages (payloads) on the topic **/device/a**. Of course, you can use any topic for testing.
390 390  
384 +(% id="cke_bm_37386S" style="display:none" %) (%%)The MQTT payload format is as follows:
391 391  
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 -
394 394  {{code language="none"}}
395 -{"IMEI":"350693903995577", "Model":"TS01-NB", "temperature":30, "humidity":80, "pressure":1005}
387 +{"IMEI": "350693903995577", "temperature":25, "humidity":80, "pressure":1005}
396 396  {{/code}}
397 397  
390 +Once ThingsBoard receives this message, it forwards this payload to the matching device through the integration.
398 398  
392 +
399 399  == 5.2 Sending messages ==
400 400  
401 401  
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 +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.
403 403  
404 404  {{code language="none"}}
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 +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}'
406 406  {{/code}}
407 407  
408 -If the integration was performed without errors, a new device named **350693903995577 **is created in the **Devices **section.
402 +If the integration was performed without errors, the status of the integration changes to 'Active' after the first telemetry transmission.
409 409  
410 410  
411 -[[image:new-device-1.png]]
405 +[[image:integration-active.png]]
412 412  
413 413  
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 -
424 424  == 5.3 Viewing messages ==
425 425  
426 426  
427 427  Go back to the **Integrations** page.
428 428  
429 -Click on the **MQTT integration** in the **Integrations** page to see its details.
413 +Click on the **MQTT integration NB/CB** in the **Integrations** page to see its details.
430 430  
431 431  Click on the **Edit** button (//**pen icon**//).
432 432  
... ... @@ -439,10 +439,11 @@
439 439  Then click on the **Apply changes** (//**tick icon**//) button.
440 440  
441 441  
426 +[[image:debug-enabled.png||height="301" width="700"]]
442 442  
443 -[[image:Screenshot 2025-04-21 122936.png||height="247" width="500"]]
444 444  
445 445  
430 +
446 446  Now go to the **Events** tab.
447 447  
448 448  Select the **Event type** as **Debug** from the dropdown list.
... ... @@ -450,19 +450,24 @@
450 450  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:
451 451  
452 452  {{code language="none"}}
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 +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}'
454 454  {{/code}}
455 455  
456 456  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.
457 457  
458 458  
444 +[[image:Screenshot 2025-03-26 at 19.49.31.png]]
445 +
446 +
447 +
459 459  Then click on the **three dots (...)** in the **Message** column. You can see the uplink message's **payload** in the **Message** window.
460 460  
461 461  
451 +[[image:Screenshot 2025-03-26 at 19.47.52.png]]
462 462  
463 -[[image:Screenshot 2025-04-21 122909.png]]
464 464  
465 465  
455 +
466 466  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.
467 467  
468 468  
... ... @@ -474,6 +474,11 @@
474 474  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.
475 475  
476 476  
467 +First simulate a few messages using MQTT. This time, we have added the 'humidity' field to the payload. Eg:
468 +
469 +{{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}}
470 +
471 +
477 477  In **ThingsBoard**, from the left navigation menu, click **Dashboards**. Then, click the **+** button and select **Create new dashboard** from the dropdown menu.
478 478  
479 479  
... ... @@ -509,11 +509,10 @@
509 509  
510 510  Configure the **Time series chart** widget as follows:
511 511  
512 -* **Datasource** - select **350693903995577 **you provisioned.
507 +* **Datasource** - select **Device A** device you provisioned.
513 513  * **Series**:
514 514  ** **temperature** - you can see this key by default.
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 +** **humidity** - Click **Add series** button. Then add the **humidity** for the key and then type **%** as its unit.
517 517  * Click on the **Add** button.
518 518  
519 519  {{info}}
... ... @@ -520,27 +520,34 @@
520 520  You can add only the relevant fields from the device's payload to display data on a widget. These fields are called 'keys'.
521 521  {{/info}}
522 522  
517 +[[image:Screenshot 2025-03-31 at 06.51.15.png||height="485" width="700"]]
523 523  
524 524  
525 -[[image:Screenshot 2025-04-21 123647.png||height="466" width="700"]]
526 -
527 -
528 528  The time-series chart will appear in edit mode. Resize it by clicking and dragging the lower-right corner.
529 529  
530 530  Click the **Save** button to add the widget to the dashboard.
531 531  
532 532  
533 -[[image:Screenshot 2025-04-21 124145.png||height="443" width="700"]]
525 +[[image:timeseries-3.png||height="347" width="700"]]
534 534  
535 535  
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 +Now send the following MQTT messages from the terminal to simulate the data.
537 537  
538 -**The chart will update with the values in real time, and you will see a live chart similar to this:**
539 539  
531 +{{code language="none"}}
532 +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}'
540 540  
541 -[[image:Screenshot 2025-04-21 124054.png||height="441" width="700"]]
534 +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}'
542 542  
536 +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}'
537 +{{/code}}
543 543  
539 +The chart will update with the values in realtime, as shown in the below image.
540 +
541 +
542 +[[image:timeseries-4.png||height="316" width="700"]]
543 +
544 +
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: # -  **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: #**
556 +* **AT+SUBTOPIC=<MQTT subscribe topic> Eg: TS01-NB**
557 +* **AT+PUBTOPIC=<MQTT publish topic> Eg: TS01-NB**
557 557  * **AT+CLIENT=null**
558 558  * **AT+UNAME=<MQTT Username>**
559 559  * **AT+PWD=<MQTT Password>**
... ... @@ -562,6 +562,7 @@
562 562  Test your uplink by pressing the ACT button for 1 second.
563 563  
564 564  
566 +
565 565  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.
566 566  
567 567  
Screenshot 2025-04-21 122154.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -21.2 KB
Content
Screenshot 2025-04-21 122909.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -59.9 KB
Content
Screenshot 2025-04-21 122936.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -72.0 KB
Content
Screenshot 2025-04-21 123647.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -77.9 KB
Content
Screenshot 2025-04-21 124054.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -60.4 KB
Content
Screenshot 2025-04-21 124145.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -50.9 KB
Content
new-device-1.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -34.7 KB
Content