Skip to Content

Changes for page ThingsBoard

Last modified by Dilisi S on 2025/04/23 19:23
From version 164.1
edited by Dilisi S
on 2025/03/18 05:03
Change comment: There is no comment for this version
To version 172.1
edited by Dilisi S
on 2025/03/20 15:36
Change comment: Mar 20 - edits

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  
... ... @@ -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.
379 +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.
381 +* Click on the **Skip **button in the Downlink data converter section.
445 445  
383 +Click **Skip** button.
446 446  
447 -[[image:add-integration-downlink-data-converter.png||height="511" width="500"]]
448 448  
386 +[[image:integration-dl-skip.png||height="511" width="500"]]
449 449  
388 +
389 +
450 450  **Connection:**
451 451  
452 452  * **Host**: Cluster URL (Eg. 011731f7xxxxxxxxxxxfbbedfc63f4.s1.eu.hivemq.cloud)
... ... @@ -455,7 +455,7 @@
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)
398 +* **Topic: v1/devices/me/telemetry** (The topic can be anything, even you can use just the device name, for example ts02-nb)
459 459  * **QoS:** 0-At most once
460 460  
461 461  [[image:add-integration-connection.png||height="511" width="500"]]
... ... @@ -532,29 +532,46 @@
532 532  [[image:new-device.png]]
533 533  
534 534  
535 -Click on the **MQTT integration NB/CB **list in the **Integrations** page to see its details.
475 +== 5.3 Viewing messages ==
536 536  
537 -Then go to the **Events** tab.
538 538  
539 -You can see the uplink message you sent from the MQTT broker.
478 +Go back to the **Integrations** page.
540 540  
480 +Click on the **MQTT integration NB/CB** in the **Integrations** page to see its details.
541 541  
542 -[[image:Screenshot 2025-03-16 at 18.38.59.png]]
482 +Click on the **Edit** button (//**pen icon**//).
543 543  
484 +Click on the **Disabled** button in the upper-right corner.
544 544  
486 +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.
545 545  
488 +Click on the **Apply** button.
546 546  
547 -Now click on the **three dots (...)** in the **Message** column. You can see the uplink message's **payload** in the **Message** window.
490 +Then click on the **Apply changes** (//**tick icon**//) button.
548 548  
549 549  
550 -[[image:Screenshot 2025-03-16 at 18.39.12.png]]
493 +[[image:Screenshot 2025-03-18 at 09.23.10.png]]
551 551  
552 552  
496 +Now go to the **Events** tab.
553 553  
554 -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.
498 +Select the Event type as **Debug** from the dropdown list.
555 555  
500 +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.
556 556  
557 557  
503 +[[image:Screenshot 2025-03-16 at 18.38.59.png]]
504 +
505 +
506 +Then click on the **three dots (...)** in the **Message** column. You can see the uplink message's **payload** in the **Message** window.
507 +
508 +
509 +[[image:Screenshot 2025-03-16 at 18.39.12.png]]
510 +
511 +
512 +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.
513 +
514 +
558 558  = 6. Creating a Dashboard =
559 559  
560 560  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.
... ... @@ -563,6 +563,11 @@
563 563  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.
564 564  
565 565  
523 +First simulate a few messages using MQTT. This time, we have added the 'humidity' field to the payload. Eg:
524 +
525 +{{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}}
526 +
527 +
566 566  In **ThingsBoard**, from the left navigation menu, click **Dashboards**. Then, click the **+** button and select **Create new dashboard** from the dropdown menu.
567 567  
568 568  
... ... @@ -619,11 +619,11 @@
619 619  
620 620  
621 621  {{code language="none"}}
622 -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}'
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": 22, "humidity":70}'
623 623  
624 -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}'
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": 27, "humidity":72}'
625 625  
626 -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}'
588 +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}'
627 627  
628 628  {{/code}}
629 629  
... ... @@ -636,7 +636,7 @@
636 636  = 7. Configure NB-IoT Sensor =
637 637  
638 638  
639 -Now, let's experiment with sending data to ThingsBoard using a real NB-IoT device. For example, we will use the **S31B-NB**.
601 +Now, let's experiment with sending data to ThingsBoard using a real NB-IoT device. For example, we will use the **TS01-NB**.
640 640  
641 641  First, configure the NB-IoT device with the necessary MQTT settings using AT commands. Below is a list of AT commands you can use.
642 642  
... ... @@ -644,8 +644,8 @@
644 644  **AT Commands**
645 645  
646 646  * **AT+PRO=3,3    **~/~/ Use MQTT to connect to ThingsBoard. Payload Type set to 3.
647 -* **AT+SUBTOPIC=<MQTT topic>**
648 -* **AT+PUBTOPIC=<MQTT topic>**
609 +* **AT+SUBTOPIC=<MQTT subscribe topic> **
610 +* **AT+PUBTOPIC=<MQTT publish topic> Eg: TS01-NB**
649 649  * **AT+CLIENT=null**
650 650  * **AT+UNAME=<MQTT Username>**
651 651  * **AT+PWD=<MQTT Password>**
... ... @@ -652,3 +652,16 @@
652 652  * **AT+SERVADDR=<Broker address, Port>**
653 653  
654 654  Test your uplink by pressing the ACT button for 1 second.
617 +
618 +
619 +
620 +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**.
621 +
622 +{{info}}
623 +The ThingsBoard uses the device's IMEI number included in the payload to create a device in the Devices section.
624 +{{/info}}
625 +
626 +[[image:image-4.png]]
627 +
628 +
629 +
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