Skip to Content

Changes for page ThingsBoard

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

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 -** **[[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.
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.
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  
... ... @@ -335,8 +335,6 @@
335 335  * **Topic**: # (the # symbol indicates that it filters all topics).
336 336  * **QoS:** 0-At most once
337 337  
338 -
339 -
340 340  [[image:add-integration-4.png||height="484" width="500"]]
341 341  
342 342  
... ... @@ -367,8 +367,8 @@
367 367  Since we haven't received data from a device yet, the integration **Status** is shown as **Pending.**
368 368  
369 369  
370 -[[image:integration-added.png]]
371 371  
378 +[[image:integrations-pending.png]]
372 372  
373 373  
374 374  = 5. Verifying the receipt of data from virtual devices =
... ... @@ -379,38 +379,47 @@
379 379  
380 380  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.
381 381  
382 -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.
383 383  
384 -(% id="cke_bm_37386S" style="display:none" %) (%%)The MQTT payload format is as follows:
385 385  
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 +
386 386  {{code language="none"}}
387 -{"IMEI": "350693903995577", "temperature":25, "humidity":80, "pressure":1005}
395 +{"IMEI":"350693903995577", "Model":"TS01-NB", "temperature":30, "humidity":80, "pressure":1005}
388 388  {{/code}}
389 389  
390 -Once ThingsBoard receives this message, it forwards this payload to the matching device through the integration.
391 391  
392 -
393 393  == 5.2 Sending messages ==
394 394  
395 395  
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.
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.
397 397  
398 398  {{code language="none"}}
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}'
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}'
400 400  {{/code}}
401 401  
402 -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.
403 403  
404 404  
405 -[[image:integration-active.png]]
411 +[[image:new-device-1.png]]
406 406  
407 407  
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 +
408 408  == 5.3 Viewing messages ==
409 409  
410 410  
411 411  Go back to the **Integrations** page.
412 412  
413 -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.
414 414  
415 415  Click on the **Edit** button (//**pen icon**//).
416 416  
... ... @@ -423,11 +423,10 @@
423 423  Then click on the **Apply changes** (//**tick icon**//) button.
424 424  
425 425  
426 -[[image:debug-enabled.png||height="301" width="700"]]
427 427  
443 +[[image:Screenshot 2025-04-21 122936.png||height="247" width="500"]]
428 428  
429 429  
430 -
431 431  Now go to the **Events** tab.
432 432  
433 433  Select the **Event type** as **Debug** from the dropdown list.
... ... @@ -435,24 +435,19 @@
435 435  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:
436 436  
437 437  {{code language="none"}}
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}'
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}'
439 439  {{/code}}
440 440  
441 441  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.
442 442  
443 443  
444 -[[image:Screenshot 2025-03-26 at 19.49.31.png]]
445 -
446 -
447 -
448 448  Then click on the **three dots (...)** in the **Message** column. You can see the uplink message's **payload** in the **Message** window.
449 449  
450 450  
451 -[[image:Screenshot 2025-03-26 at 19.47.52.png]]
452 452  
463 +[[image:Screenshot 2025-04-21 122909.png]]
453 453  
454 454  
455 -
456 456  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.
457 457  
458 458  
... ... @@ -464,11 +464,6 @@
464 464  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.
465 465  
466 466  
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 -
472 472  In **ThingsBoard**, from the left navigation menu, click **Dashboards**. Then, click the **+** button and select **Create new dashboard** from the dropdown menu.
473 473  
474 474  
... ... @@ -504,10 +504,11 @@
504 504  
505 505  Configure the **Time series chart** widget as follows:
506 506  
507 -* **Datasource** - select **Device A** device you provisioned.
512 +* **Datasource** - select **350693903995577 **you provisioned.
508 508  * **Series**:
509 509  ** **temperature** - you can see this key by default.
510 -** **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.
511 511  * Click on the **Add** button.
512 512  
513 513  {{info}}
... ... @@ -514,34 +514,27 @@
514 514  You can add only the relevant fields from the device's payload to display data on a widget. These fields are called 'keys'.
515 515  {{/info}}
516 516  
517 -[[image:Screenshot 2025-03-31 at 06.51.15.png||height="485" width="700"]]
518 518  
519 519  
525 +[[image:Screenshot 2025-04-21 123647.png||height="466" width="700"]]
526 +
527 +
520 520  The time-series chart will appear in edit mode. Resize it by clicking and dragging the lower-right corner.
521 521  
522 522  Click the **Save** button to add the widget to the dashboard.
523 523  
524 524  
525 -[[image:timeseries-3.png||height="347" width="700"]]
533 +[[image:Screenshot 2025-04-21 124145.png||height="443" width="700"]]
526 526  
527 527  
528 -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.**
529 529  
538 +**The chart will update with the values in real time, and you will see a live chart similar to this:**
530 530  
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}'
533 533  
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}'
541 +[[image:Screenshot 2025-04-21 124054.png||height="441" width="700"]]
535 535  
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}}
538 538  
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 -
545 545  = 8. Configure Physical NB-IoT Sensor =
546 546  
547 547  
... ... @@ -553,8 +553,8 @@
553 553  **AT Commands**
554 554  
555 555  * **AT+PRO=3,3    **~/~/ Use MQTT to connect to ThingsBoard. Payload Type set to 3.
556 -* **AT+SUBTOPIC=<MQTT subscribe topic> Eg: TS01-NB**
557 -* **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: #**
558 558  * **AT+CLIENT=null**
559 559  * **AT+UNAME=<MQTT Username>**
560 560  * **AT+PWD=<MQTT Password>**
... ... @@ -563,7 +563,6 @@
563 563  Test your uplink by pressing the ACT button for 1 second.
564 564  
565 565  
566 -
567 567  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.
568 568  
569 569  
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
new-device-1.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +34.7 KB
Content