Skip to Content

Changes for page ThingsBoard

Last modified by Dilisi S on 2025/04/23 19:23
From version 163.1
edited by Dilisi S
on 2025/03/18 04:59
Change comment: Uploaded new attachment "Screenshot 2025-03-16 at 18.39.12.png", version {1}
To version 170.1
edited by Dilisi S
on 2025/03/19 21:00
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -329,72 +329,10 @@
329 329  [[image:data-converter-list-showing-uplink-dc.png]]
330 330  
331 331  
332 -== 3.2 Downlink ==
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 336  
337 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 398  = 4. Add Integration =
399 399  
400 400  
... ... @@ -458,7 +458,6 @@
458 458  * **Topic: v1/devices/+/telemetry** (the + replaces any 'device name' will create a device in the Entities -> Devices)
459 459  * **QoS:** 0-At most once
460 460  
461 -
462 462  [[image:add-integration-connection.png||height="511" width="500"]]
463 463  
464 464  
... ... @@ -530,39 +530,49 @@
530 530  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**.
531 531  
532 532  
533 -
534 534  [[image:new-device.png]]
535 535  
536 536  
537 -Click on the device S31B-NB on the devices list to see its details.
473 +== 5.3 Viewing messages ==
538 538  
539 -Then go to the **Latest telemetry** tab.
540 540  
541 -You can see the fields temperature and humidity with the values you previously sent using the MQTT message.
476 +Go back to the **Integrations** page.
542 542  
478 +Click on the **MQTT integration NB/CB** in the **Integrations** page to see its details.
543 543  
544 -[[image:telemetry-1.png]]
480 +Click on the **Edit** button (//**pen icon**//).
545 545  
482 +Click on the **Disabled** button in the upper-right corner.
546 546  
547 -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//.
484 +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.
548 548  
486 +Click on the **Apply** button.
549 549  
550 -[[image:telemetry-2.png]]
488 +Then click on the **Apply changes** (//**tick icon**//) button.
551 551  
552 552  
553 -Let's provision the second device named **LDS25-NB **with initial telemetry. Use the following MQTT message.
491 +[[image:Screenshot 2025-03-18 at 09.23.10.png]]
554 554  
555 555  
556 -{{code language="none"}}
557 -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}'
558 -{{/code}}
494 +Now go to the **Events** tab.
559 559  
560 -Now, refresh the **Devices** page, and you will see the second device, **LDS25-NB**, which was recently provisioned.
496 +Select the Event type as **Debug** from the dropdown list.
561 561  
498 +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.
562 562  
563 -[[image:device-provision-2.png]]
564 564  
501 +[[image:Screenshot 2025-03-16 at 18.38.59.png]]
565 565  
503 +
504 +Then click on the **three dots (...)** in the **Message** column. You can see the uplink message's **payload** in the **Message** window.
505 +
506 +
507 +[[image:Screenshot 2025-03-16 at 18.39.12.png]]
508 +
509 +
510 +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.
511 +
512 +
566 566  = 6. Creating a Dashboard =
567 567  
568 568  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.
... ... @@ -571,6 +571,11 @@
571 571  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.
572 572  
573 573  
521 +First simulate a few messages using MQTT. This time, we have added the 'humidity' field to the payload. Eg:
522 +
523 +{{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}}
524 +
525 +
574 574  In **ThingsBoard**, from the left navigation menu, click **Dashboards**. Then, click the **+** button and select **Create new dashboard** from the dropdown menu.
575 575  
576 576  
... ... @@ -627,11 +627,11 @@
627 627  
628 628  
629 629  {{code language="none"}}
630 -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}'
582 +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}'
631 631  
632 -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}'
584 +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}'
633 633  
634 -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}'
586 +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}'
635 635  
636 636  {{/code}}
637 637  
... ... @@ -652,8 +652,8 @@
652 652  **AT Commands**
653 653  
654 654  * **AT+PRO=3,3    **~/~/ Use MQTT to connect to ThingsBoard. Payload Type set to 3.
655 -* **AT+SUBTOPIC=<MQTT topic>**
656 -* **AT+PUBTOPIC=<MQTT topic>**
607 +* **AT+SUBTOPIC=<MQTT subscribe topic> **
608 +* **AT+PUBTOPIC=<MQTT publish topic> Eg: TS01-NB**
657 657  * **AT+CLIENT=null**
658 658  * **AT+UNAME=<MQTT Username>**
659 659  * **AT+PWD=<MQTT Password>**
... ... @@ -660,3 +660,11 @@
660 660  * **AT+SERVADDR=<Broker address, Port>**
661 661  
662 662  Test your uplink by pressing the ACT button for 1 second.
615 +
616 +
617 +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**.
618 +
619 +[[image:image-4.png]]
620 +
621 +
622 +
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