Skip to Content

Changes for page ThingsBoard

Last modified by Dilisi S on 2025/04/23 19:23
From version 138.1
edited by Dilisi S
on 2025/03/09 03:31
Change comment: Uploaded new attachment "dashboard-1.png", version {1}
To version 156.1
edited by Dilisi S
on 2025/03/17 00:34
Change comment: Uploaded new attachment "mqtt-uplink.png", version {1}

Summary

Details

Page properties
Content
... ... @@ -22,7 +22,10 @@
22 22  To complete this tutorial, you need to have the following:
23 23  
24 24  * ThingsBoard cloud account
25 -* HiveMQ Cloud account
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.
28 +** [[lns1.thingseye.io>>http://lns1.thingseye.io/]] - This is Dragino's MQTT broker, which requires a CA certificate to use.
26 26  
27 27  == 2.1 ThingsBoard Cloud ==
28 28  
... ... @@ -64,9 +64,12 @@
64 64  [[image:thingsboard-6.png||height="244" width="500"]]
65 65  
66 66  
70 +(% class="wikigeneratedid" %)
67 67  == 2.2 HiveMQ Cloud ==
68 68  
73 +=== 2.2.1 HiveMQ Cloud ===
69 69  
75 +
70 70  Go to [[https:~~/~~/www.hivemq.com>>https://www.hivemq.com]]
71 71  
72 72  Click on the **Start Free** button.
... ... @@ -141,6 +141,24 @@
141 141  You will need these MQTT connection parameters when configuring the MQTT integration in the '**Add Integration**' section.
142 142  
143 143  
150 +=== 2.2.2 emqx ===
151 +
152 +
153 +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.
154 +
155 +
156 +[[image:emqx.png||height="420" width="500"]]
157 +
158 +
159 +=== 2.2.3 Ins1.thingseye.io ===
160 +
161 +[[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.
162 +
163 +If customers need to use this MQTT connection with ThingsBoard, they need to contact the TE team to obtain three license files.
164 +
165 +[[image:ins1.png||height="310" width="500"]]
166 +
167 +
144 144  = 3. Data Converters =
145 145  
146 146  
... ... @@ -350,8 +350,8 @@
350 350  
351 351  Click on the **Advanced settings** button.
352 352  
353 -* **Clean session:** NO
354 -* **Retained**: NO
377 +* **Clean session:** YES
378 +* **Retained**: YES
355 355  
356 356  [[image:add-integration-connection-advanced-settings.png||height="510" width="500"]]
357 357  
... ... @@ -384,6 +384,7 @@
384 384  
385 385  == 5.1 How does it work? ==
386 386  
411 +
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 389  The Mosquitto client publishes messages on the topic v1/devices/[device_name]/telemetry. The [device_name]placeholder can be replaced with any device name, for example, 'S31B-NB'. Then, the MQTT topic would be v1/devices/S31B-NB/telemetry.
... ... @@ -397,12 +397,12 @@
397 397  For example, if you send two MQTT messages with different device names in the topic:
398 398  
399 399  1. v1/devices/**S31B-NB**/telemetry
400 -1. v1/devices/**S31B-CB**/telemetry
425 +1. v1/devices/**LDS25-NB**/telemetry
401 401  
402 -ThingsBoard will create two devices named **S31B-NB** and **S31B-CB** in the **//Devices//** section.
427 +ThingsBoard will create two devices named **S31B-NB** and **LDS25-NB** in the **//Devices//** section.
403 403  
404 404  
405 -The MQTT payload format is as follows, for example:
430 +The MQTT payload format is as follows, which is common for all ~-~-NB and ~-~-CB series devices:
406 406  
407 407  {{code language="none"}}
408 408  {"temperature":10.4, "humidity":85}
... ... @@ -415,7 +415,144 @@
415 415  On the terminal, issue the following MQTT command which simulates the device S31B-NB. The message payload contains the fields temperature and humidity, which hold the values 10.4 and 85, respectively. This payload is also (technically) known as telemetry.
416 416  
417 417  {{code language="none"}}
418 -mosquitto_pub -d -q 1 -h 011731f7928541588a6cdfbbedfc63f4.s1.eu.hivemq.cloud -p 8883 -t "tb/mqtt-integration-tutorial/sensors/SN-001/telemetry" -u "pradeeka" -P "Kalpani123@" -m '{"temperature":10.4, "humidity":85}'
443 +mosquitto_pub -d -q 1 -h 011731f7928xxxxx.s1.eu.hivemq.cloud -p 8883 -t "tb/mqtt-integration-tutorial/sensors/S31B-NB/telemetry" -u "xxxxx" -P "xxxxx" -m '{"temperature":10.4, "humidity":85}'
419 419  {{/code}}
420 420  
421 -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.
446 +If the integration was performed without errors, the status of the integration changes to 'Active' after the first telemetry transmission.
447 +
448 +
449 +[[image:integration-active.png]]
450 +
451 +
452 +Also, a new device named **S31B-NB** will appear under **//Entities -> Devices -> All//**. This means the first MQTT message triggers ThingsBoard to provision a device named **S31B-NB**.
453 +
454 +
455 +[[image:device-provision-1.png]]
456 +
457 +
458 +Click on the device S31B-NB on the devices list to see its details.
459 +
460 +Then go to the **Latest telemetry** tab.
461 +
462 +You can see the fields temperature and humidity with the values you previously sent using the MQTT message.
463 +
464 +
465 +[[image:telemetry-1.png]]
466 +
467 +
468 +Now, change the values of the fields and send the MQTT message again. For example, set temperature to 20 and humidity to 70. Observe how the values update in //Latest Telemetry//.
469 +
470 +
471 +[[image:telemetry-2.png]]
472 +
473 +
474 +Let's provision the second device named **LDS25-NB **with initial telemetry. Use the following MQTT message.
475 +
476 +
477 +{{code language="none"}}
478 +mosquitto_pub -d -q 1 -h 011731f7928541588a6cdfbbedfc63f4.s1.eu.hivemq.cloud -p 8883 -t "tb/mqtt-integration-tutorial/sensors/LDS25-NB/telemetry" -u "pradeeka" -P "Kalpani123@" -m '{"temperature":11, "humidity":87}'
479 +{{/code}}
480 +
481 +Now, refresh the **Devices** page, and you will see the second device, **LDS25-NB**, which was recently provisioned.
482 +
483 +
484 +[[image:device-provision-2.png]]
485 +
486 +
487 += 6. Creating a Dashboard =
488 +
489 +ThingsBoard **Dashboards** provide a powerful way to visualize and monitor real-time and historical data from connected devices. They allow users to create interactive, customizable panels displaying telemetry data, device status, and other key metrics. With a variety of widgets, including charts, maps, and tables, dashboards help users gain insights, track trends, and manage IoT deployments efficiently.
490 +
491 +
492 +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.
493 +
494 +
495 +In **ThingsBoard**, from the left navigation menu, click **Dashboards**. Then, click the **+** button and select **Create new dashboard** from the dropdown menu.
496 +
497 +
498 +[[image:dashboard-1.png]]
499 +
500 +
501 +In the **Title** text box, enter **NB/CB Test Dashboard** as the title of the dashboard.
502 +
503 +Click on the **Add** button.
504 +
505 +
506 +[[image:dashboard-2.png||height="526" width="500"]]
507 +
508 +
509 +Click on the **Add widget / Add new widget** button.
510 +
511 +
512 +[[image:dashboard-3.png]]
513 +
514 +
515 +In the **Select widgets bundle** window, click **Charts**.
516 +
517 +
518 +[[image:dashboard-4.png||height="537" width="700"]]
519 +
520 +
521 +
522 +In the **Charts: select widget** window, click **Time series chart**.
523 +
524 +
525 +[[image:dashboard-5.png||height="525" width="700"]]
526 +
527 +
528 +Configure the **Time series chart** widget as follows:
529 +
530 +* **Datasource** - select S31B-NB device you provisioned.
531 +* **Series**:
532 +** **temperature** - you can see this key by default.
533 +** **humidity** - Click **Add series** button. Then add the **humidity** for the key and then type **%** as its unit.
534 +* Click on the **Add** button.
535 +
536 +[[image:timeseries-1.png||height="491" width="700"]]
537 +
538 +
539 +The time-series chart will appear in edit mode. Resize it by clicking and dragging the lower-right corner.
540 +
541 +Click the **Save** button to add the widget to the dashboard.
542 +
543 +
544 +[[image:timeseries-3.png||height="347" width="700"]]
545 +
546 +
547 +Now send the following MQTT messages from the terminal to simulate the data.
548 +
549 +
550 +{{code language="none"}}
551 +mosquitto_pub -d -q 1 -h 011731f7928xxxxx.s1.eu.hivemq.cloud -p 8883 -t "tb/mqtt-integration-tutorial/sensors/S31B-NB/telemetry" -u "xxxxx" -P "xxxxx" -m '{"temperature":20, "humidity":70}'
552 +
553 +mosquitto_pub -d -q 1 -h 011731f7928xxxxx.s1.eu.hivemq.cloud -p 8883 -t "tb/mqtt-integration-tutorial/sensors/S31B-NB/telemetry" -u "xxxxx" -P "xxxxx" -m '{"temperature":22, "humidity":71}'
554 +
555 +mosquitto_pub -d -q 1 -h 011731f7928xxxxx.s1.eu.hivemq.cloud -p 8883 -t "tb/mqtt-integration-tutorial/sensors/S31B-NB/telemetry" -u "xxxxx" -P "xxxxx" -m '{"temperature":18, "humidity":79}'
556 +
557 +{{/code}}
558 +
559 +The chart will update with the values in realtime, as shown in the below image.
560 +
561 +
562 +[[image:timeseries-4.png||height="316" width="700"]]
563 +
564 +
565 += 7. Configure NB-IoT Sensor =
566 +
567 +
568 +Now, let's experiment with sending data to ThingsBoard using a real NB-IoT device. For example, we will use the **S31B-NB**.
569 +
570 +First, configure the NB-IoT device with the necessary MQTT settings using AT commands. Below is a list of AT commands you can use.
571 +
572 +
573 +**AT Commands**
574 +
575 +* **AT+PRO=3,3    **~/~/ Use MQTT to connect to ThingsBoard. Payload Type set to 3.
576 +* **AT+SUBTOPIC=<MQTT topic>**
577 +* **AT+PUBTOPIC=<MQTT topic>**
578 +* **AT+CLIENT=null**
579 +* **AT+UNAME=<MQTT Username>**
580 +* **AT+PWD=<MQTT Password>**
581 +* **AT+SERVADDR=<Broker address, Port>**
582 +
583 +Test your uplink by pressing the ACT button for 1 second.
dashboard-2.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +112.2 KB
Content
dashboard-3.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +141.3 KB
Content
dashboard-4.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +803.7 KB
Content
dashboard-5.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +476.1 KB
Content
emqx.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +39.1 KB
Content
ins1.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +28.8 KB
Content
mqtt-uplink.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +175.1 KB
Content
timeseries-1.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +179.1 KB
Content
timeseries-3.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +174.2 KB
Content
timeseries-4.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +159.0 KB
Content