Skip to Content

Changes for page ThingsBoard

Last modified by Dilisi S on 2025/04/23 19:23
From version 157.1
edited by Dilisi S
on 2025/03/17 01:45
Change comment: There is no comment for this version
To version 176.1
edited by Dilisi S
on 2025/03/26 20:27
Change comment: Mar 26 edits - part 1

Summary

Details

Page properties
Content
... ... @@ -164,13 +164,33 @@
164 164  [[image:ins1.png||height="310" width="500"]]
165 165  
166 166  
167 -= 3. Data Converters =
167 +(% class="wikigeneratedid" %)
168 += 3. Creating Devices =
168 168  
169 169  
171 +First, you need to create devices in ThingsBoard to represent your physical devices. For example, you can name it **Device A**, and the second device could be **Device B** or any name you prefer. The device name should be unique within the **Devices** space.
172 +
173 +
174 +In the left navigation, click Entities -> Devices.
175 +
176 +Click the **Add Device** button (the button with the **+** sign), and from the dropdown menu, click **Add new device**.
177 +
178 +In the **Add new device** dialog box, enter the device name in the **Name** text box. For example, we will use **Device A**.
179 +
180 +Click the **Add** button.
181 +
182 +Skip the **connectivity testing** by clicking the **Close** button.
183 +
184 +The device is created and listed on the **Devices** page. Note that its initial state is **Inactive** because it has not received any data yet.
185 +
186 +
187 += 4. Data Converters =
188 +
189 +
170 170  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.
171 171  
172 172  
173 -== 3.1 Uplink ==
193 +== 4.1 Uplink ==
174 174  
175 175  
176 176  In the left navigation, click **Integrations center**, and then click **Data converters**.
... ... @@ -192,6 +192,9 @@
192 192  
193 193  Delete the default decoder function in the code editor. Now copy and paste the following decoder function written in **JavaScript** in to the **code editor**. This decoder function is compatible for both NB and CB series devices.
194 194  
215 +{{info}}
216 +Please note that the value assigned to the IMEI field in the payload will be used by ThingsBoard to create a device on the platform with the same name.
217 +{{/info}}
195 195  
196 196  {{code language="JavaScript"}}
197 197  //Version: 0.1
... ... @@ -329,75 +329,9 @@
329 329  [[image:data-converter-list-showing-uplink-dc.png]]
330 330  
331 331  
332 -== 3.2 Downlink ==
355 += 5. Add Integration =
333 333  
334 334  
335 -On the **Data converters** page, click on the ‘**+**’ button, and then click on the **Create new converter** from the dropdown menu.
336 -
337 -
338 -[[image:create-new-converter-menu.png||width="500"]]
339 -
340 -
341 -
342 -The **Add data converter** window will appear. Name it ‘**MQTT Downlink Converter NB/CB**’ and select the Type as **Downlink**.
343 -
344 -Click on the **TBEL** button if not selected it by default. Now copy and paste the following encoder function written in **TBEL (ThingsBoard Expression Language)** in to the **code editor**. This encoder function is compatible for both NB and CB series devices.
345 -
346 -
347 -{{code language="JavaScript"}}
348 -// Encode downlink data from incoming Rule Engine message
349 -
350 -// msg - JSON message payload downlink message json
351 -// msgType - type of message, for ex. 'ATTRIBUTES_UPDATED', 'POST_TELEMETRY_REQUEST', etc.
352 -// metadata - list of key-value pairs with additional data about the message
353 -// integrationMetadata - list of key-value pairs with additional data defined in Integration executing this converter
354 -
355 -/** Encoder **/
356 -
357 -var data = {};
358 -
359 -// Process data from incoming message and metadata
360 -
361 -data.tempFreq = msg.temperatureUploadFrequency;
362 -data.humFreq = msg.humidityUploadFrequency;
363 -
364 -data.devSerialNumber = metadata['ss_serialNumber'];
365 -
366 -// Result object with encoded downlink payload
367 -var result = {
368 -
369 - // downlink data content type: JSON, TEXT or BINARY (base64 format)
370 - contentType: "JSON",
371 -
372 - // downlink data
373 - data: JSON.stringify(data),
374 -
375 - // Optional metadata object presented in key/value format
376 - metadata: {
377 - topic: metadata['deviceType']+'/'+metadata['deviceName']+'/upload'
378 - }
379 -
380 -};
381 -
382 -return result;
383 -{{/code}}
384 -
385 -
386 -Click on the **Add** button.
387 -
388 -
389 -[[image:add-downlink-data-converter.png||height="529" width="500"]]
390 -
391 -
392 -You should see that the newly added **MQTT Downlink** Converter NB/CB is listed on the **Data Converters** page.
393 -
394 -
395 -[[image:data-converters-list.png]]
396 -
397 -
398 -= 4. Add Integration =
399 -
400 -
401 401  In the left navigation, click **Integrations center**, and then click **Integrations**.
402 402  
403 403  
... ... @@ -438,15 +438,17 @@
438 438  
439 439  **Downlink data converter:**
440 440  
441 -* Click on the **Select existing** button.
442 -* **Downlink data converter**: Select **MQTT Downlink Converter NB/CB **from the dropdown list.
398 +Dragino NB/CB devices don't require a downlink data converter to decode their payloads, so you can skip this step.
443 443  
444 -Click **Next** button.
400 +* Click on the **Skip **button in the Downlink data converter section.
445 445  
402 +Click **Skip** button.
446 446  
447 -[[image:add-integration-downlink-data-converter.png||height="511" width="500"]]
448 448  
405 +[[image:integration-dl-skip.png||height="511" width="500"]]
449 449  
407 +
408 +
450 450  **Connection:**
451 451  
452 452  * **Host**: Cluster URL (Eg. 011731f7xxxxxxxxxxxfbbedfc63f4.s1.eu.hivemq.cloud)
... ... @@ -455,9 +455,10 @@
455 455  * **Enable SSL**: YES
456 456  * **Username**: Username (from your HiveMQ Cloud Cluster with your credentials)
457 457  * **Password:** Password (from your HiveMQ Cloud Cluster with your credentials)
458 -* **Topic: v1/devices/+/telemetry** (the + replaces any 'device name' will create a device in the Entities -> Devices)
417 +* **Topic: v1/devices/me/telemetry** (The topic can be anything; you can even use just the device name. For example, you can use your device name here, such as S31B-NB.)
459 459  * **QoS:** 0-At most once
460 460  
420 +
461 461  [[image:add-integration-connection.png||height="511" width="500"]]
462 462  
463 463  
... ... @@ -488,48 +488,35 @@
488 488  Since we haven't received data from a device yet, the integration **Status** is shown as **Pending.**
489 489  
490 490  
491 -
492 492  [[image:new-integration-pending.png]]
493 493  
494 494  
495 -= 5. Verifying the receipt of data from virtual devices =
454 += 6. Verifying the receipt of data from virtual devices =
496 496  
497 497  
498 -== 5.1 How does it work? ==
457 +== 6.1 How does it work? ==
499 499  
500 500  
501 501  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.
502 502  
503 -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.
462 +The Mosquitto client publishes messages (payloads) on the topic **v1/devices/me/telemetry**. Of course, you can use any topic for testing.
504 504  
505 -On the ThingsBoard side, we configure the MQTT topic subscription as v1/devices/+/telemetry. The + wildcard represents any device name and allows ThingsBoard to automatically create (provision) a device with that name, such as S31B-NB, for example.
464 +(% id="cke_bm_37386S" style="display:none" %) (%%)The MQTT payload format is as follows, which is common for all **~-~-NB** and **~-~-CB** series devices. The **IMEI** field is mandatory and is used to provision a new device with the name assigned to it in ThingsBoard.
506 506  
507 -
508 -**The new device is created the first time the MQTT topic is received. For subsequent MQTT topics with the same device name, no duplicate devices will be created.**
509 -
510 -
511 -For example, if you send two MQTT messages with different device names in the topic:
512 -
513 -1. v1/devices/**S31B-NB**/telemetry
514 -1. v1/devices/**LDS25-NB**/telemetry
515 -
516 -ThingsBoard will create two devices named **S31B-NB** and **LDS25-NB** in the **//Devices//** section.
517 -
518 -
519 -The MQTT payload format is as follows, which is common for all ~-~-NB and ~-~-CB series devices:
520 -
521 521  {{code language="none"}}
522 -{"temperature":10.4, "humidity":85}
467 +{"IMEI": "S31B-NB", "temperature": 27, ......}
523 523  {{/code}}
524 524  
470 +Once ThingsBoard receives this message, it automatically creates (provisions) the device mentioned in the **IMEI**, for example, S31B-NB.
525 525  
472 +
526 526  == 5.2 Sending messages ==
527 527  
528 528  
529 -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.
476 +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 S31B-NB and 27, respectively. This payload is also (technically) known as telemetry.
530 530  
531 531  {{code language="none"}}
532 -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}'
479 +mosquitto_pub -d -q 1 -h 011731f7928xxxxx.s1.eu.hivemq.cloud -p 8883 -t "v1/devices/me/telemetry" -u "xxxxx" -P "xxxxx" -m '{"IMEI": "S31B-NB", "temperature": 27}'
533 533  {{/code}}
534 534  
535 535  If the integration was performed without errors, the status of the integration changes to 'Active' after the first telemetry transmission.
... ... @@ -541,40 +541,51 @@
541 541  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**.
542 542  
543 543  
544 -[[image:device-provision-1.png]]
491 +[[image:new-device.png]]
545 545  
546 546  
547 -Click on the device S31B-NB on the devices list to see its details.
494 +== 6.3 Viewing messages ==
548 548  
549 -Then go to the **Latest telemetry** tab.
550 550  
551 -You can see the fields temperature and humidity with the values you previously sent using the MQTT message.
497 +Go back to the **Integrations** page.
552 552  
499 +Click on the **MQTT integration NB/CB** in the **Integrations** page to see its details.
553 553  
554 -[[image:telemetry-1.png]]
501 +Click on the **Edit** button (//**pen icon**//).
555 555  
503 +Click on the **Disabled** button in the upper-right corner.
556 556  
557 -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//.
505 +Turn on the **All messages (15 min)** option. This will enable displaying all messages in the **Events** tab. This setting will expire in 15 minutes, and you will need to repeat the same steps if you want to view the messages in the Events tab later.
558 558  
507 +Click on the **Apply** button.
559 559  
560 -[[image:telemetry-2.png]]
509 +Then click on the **Apply changes** (//**tick icon**//) button.
561 561  
562 562  
563 -Let's provision the second device named **LDS25-NB **with initial telemetry. Use the following MQTT message.
512 +[[image:Screenshot 2025-03-18 at 09.23.10.png]]
564 564  
565 565  
566 -{{code language="none"}}
567 -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}'
568 -{{/code}}
515 +Now go to the **Events** tab.
569 569  
570 -Now, refresh the **Devices** page, and you will see the second device, **LDS25-NB**, which was recently provisioned.
517 +Select the Event type as **Debug** from the dropdown list.
571 571  
519 +Now you can see all the Uplink messages you are simulating through the MQTT broker. The status should be OK if there is no errors in your integration.
572 572  
573 -[[image:device-provision-2.png]]
574 574  
522 +[[image:Screenshot 2025-03-16 at 18.38.59.png]]
575 575  
576 -= 6. Creating a Dashboard =
577 577  
525 +Then click on the **three dots (...)** in the **Message** column. You can see the uplink message's **payload** in the **Message** window.
526 +
527 +
528 +[[image:Screenshot 2025-03-16 at 18.39.12.png]]
529 +
530 +
531 +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.
532 +
533 +
534 += 7. Creating a Dashboard =
535 +
578 578  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.
579 579  
580 580  
... ... @@ -581,6 +581,11 @@
581 581  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.
582 582  
583 583  
542 +First simulate a few messages using MQTT. This time, we have added the 'humidity' field to the payload. Eg:
543 +
544 +{{code language="none"}}mosquitto_pub -d -q 1 -h 011731f7928xxxxx.s1.eu.hivemq.cloud -p 8883 -t "v1/devices/me/telemetry" -u "xxxxx" -P "xxxxx" -m '{"IMEI": "S31B-NB", "temperature": 22, "humidity":80}'{{/code}}
545 +
546 +
584 584  In **ThingsBoard**, from the left navigation menu, click **Dashboards**. Then, click the **+** button and select **Create new dashboard** from the dropdown menu.
585 585  
586 586  
... ... @@ -637,11 +637,11 @@
637 637  
638 638  
639 639  {{code language="none"}}
640 -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}'
603 +mosquitto_pub -d -q 1 -h 011731f7928xxxxx.s1.eu.hivemq.cloud -p 8883 -t "v1/devices/me/telemetry" -u "xxxxx" -P "xxxxx" -m '{"IMEI": "S31B-NB", "temperature": 22, "humidity":70}'
641 641  
642 -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}'
605 +mosquitto_pub -d -q 1 -h 011731f7928xxxxx.s1.eu.hivemq.cloud -p 8883 -t "v1/devices/me/telemetry" -u "xxxxx" -P "xxxxx" -m '{"IMEI": "S31B-NB", "temperature": 27, "humidity":72}'
643 643  
644 -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}'
607 +mosquitto_pub -d -q 1 -h 011731f7928xxxxx.s1.eu.hivemq.cloud -p 8883 -t "v1/devices/me/telemetry" -u "xxxxx" -P "xxxxx" -m '{"IMEI": "S31B-NB", "temperature": 19, "humidity":80}'
645 645  
646 646  {{/code}}
647 647  
... ... @@ -651,10 +651,10 @@
651 651  [[image:timeseries-4.png||height="316" width="700"]]
652 652  
653 653  
654 -= 7. Configure NB-IoT Sensor =
617 += 8. Configure NB-IoT Sensor =
655 655  
656 656  
657 -Now, let's experiment with sending data to ThingsBoard using a real NB-IoT device. For example, we will use the **S31B-NB**.
620 +Now, let's experiment with sending data to ThingsBoard using a real NB-IoT device. For example, we will use the **TS01-NB**.
658 658  
659 659  First, configure the NB-IoT device with the necessary MQTT settings using AT commands. Below is a list of AT commands you can use.
660 660  
... ... @@ -662,8 +662,8 @@
662 662  **AT Commands**
663 663  
664 664  * **AT+PRO=3,3    **~/~/ Use MQTT to connect to ThingsBoard. Payload Type set to 3.
665 -* **AT+SUBTOPIC=<MQTT topic>**
666 -* **AT+PUBTOPIC=<MQTT topic>**
628 +* **AT+SUBTOPIC=<MQTT subscribe topic> Eg: TS01-NB**
629 +* **AT+PUBTOPIC=<MQTT publish topic> Eg: TS01-NB**
667 667  * **AT+CLIENT=null**
668 668  * **AT+UNAME=<MQTT Username>**
669 669  * **AT+PWD=<MQTT Password>**
... ... @@ -670,3 +670,16 @@
670 670  * **AT+SERVADDR=<Broker address, Port>**
671 671  
672 672  Test your uplink by pressing the ACT button for 1 second.
636 +
637 +
638 +
639 +The following image shows the uplink payload of a real Dragino device. The publish topic is **TS01-NB**, and the device name is **861275077962896**, which is represented by the **IMEI**.
640 +
641 +{{info}}
642 +The ThingsBoard uses the device's IMEI number included in the payload to create a device in the Devices section.
643 +{{/info}}
644 +
645 +[[image:image-4.png]]
646 +
647 +
648 +
add-integration-connection.png
Size
... ... @@ -1,1 +1,1 @@
1 -124.4 KB
1 +158.1 KB
Content
Screenshot 2025-03-16 at 18.38.59.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +221.2 KB
Content
Screenshot 2025-03-16 at 18.39.12.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +211.9 KB
Content
Screenshot 2025-03-18 at 09.23.10.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +78.7 KB
Content
image-4.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +96.0 KB
Content
integration-dl-skip.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +105.5 KB
Content
new-device.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +143.3 KB
Content