Skip to Content

Changes for page ThingsBoard

Last modified by Dilisi S on 2025/04/23 19:23
From version 176.1
edited by Dilisi S
on 2025/03/26 20:27
Change comment: Mar 26 edits - part 1
To 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}

Summary

Details

Page properties
Content
... ... @@ -164,33 +164,13 @@
164 164  [[image:ins1.png||height="310" width="500"]]
165 165  
166 166  
167 -(% class="wikigeneratedid" %)
168 -= 3. Creating Devices =
167 += 3. Data Converters =
169 169  
170 170  
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 -
190 190  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.
191 191  
192 192  
193 -== 4.1 Uplink ==
173 +== 3.1 Uplink ==
194 194  
195 195  
196 196  In the left navigation, click **Integrations center**, and then click **Data converters**.
... ... @@ -212,9 +212,6 @@
212 212  
213 213  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.
214 214  
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}}
218 218  
219 219  {{code language="JavaScript"}}
220 220  //Version: 0.1
... ... @@ -352,9 +352,75 @@
352 352  [[image:data-converter-list-showing-uplink-dc.png]]
353 353  
354 354  
355 -= 5. Add Integration =
332 +== 3.2 Downlink ==
356 356  
357 357  
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 +
358 358  In the left navigation, click **Integrations center**, and then click **Integrations**.
359 359  
360 360  
... ... @@ -395,17 +395,15 @@
395 395  
396 396  **Downlink data converter:**
397 397  
398 -Dragino NB/CB devices don't require a downlink data converter to decode their payloads, so you can skip this step.
441 +* Click on the **Select existing** button.
442 +* **Downlink data converter**: Select **MQTT Downlink Converter NB/CB **from the dropdown list.
399 399  
400 -* Click on the **Skip **button in the Downlink data converter section.
444 +Click **Next** button.
401 401  
402 -Click **Skip** button.
403 403  
447 +[[image:add-integration-downlink-data-converter.png||height="511" width="500"]]
404 404  
405 -[[image:integration-dl-skip.png||height="511" width="500"]]
406 406  
407 -
408 -
409 409  **Connection:**
410 410  
411 411  * **Host**: Cluster URL (Eg. 011731f7xxxxxxxxxxxfbbedfc63f4.s1.eu.hivemq.cloud)
... ... @@ -414,7 +414,7 @@
414 414  * **Enable SSL**: YES
415 415  * **Username**: Username (from your HiveMQ Cloud Cluster with your credentials)
416 416  * **Password:** Password (from your HiveMQ Cloud Cluster with your credentials)
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.)
458 +* **Topic: v1/devices/+/telemetry** (the + replaces any 'device name' will create a device in the Entities -> Devices)
418 418  * **QoS:** 0-At most once
419 419  
420 420  
... ... @@ -448,13 +448,14 @@
448 448  Since we haven't received data from a device yet, the integration **Status** is shown as **Pending.**
449 449  
450 450  
492 +
451 451  [[image:new-integration-pending.png]]
452 452  
453 453  
454 -= 6. Verifying the receipt of data from virtual devices =
496 += 5. Verifying the receipt of data from virtual devices =
455 455  
456 456  
457 -== 6.1 How does it work? ==
499 +== 5.1 How does it work? ==
458 458  
459 459  
460 460  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.
... ... @@ -488,51 +488,41 @@
488 488  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**.
489 489  
490 490  
533 +
491 491  [[image:new-device.png]]
492 492  
493 493  
494 -== 6.3 Viewing messages ==
537 +Click on the device S31B-NB on the devices list to see its details.
495 495  
539 +Then go to the **Latest telemetry** tab.
496 496  
497 -Go back to the **Integrations** page.
541 +You can see the fields temperature and humidity with the values you previously sent using the MQTT message.
498 498  
499 -Click on the **MQTT integration NB/CB** in the **Integrations** page to see its details.
500 500  
501 -Click on the **Edit** button (//**pen icon**//).
544 +[[image:telemetry-1.png]]
502 502  
503 -Click on the **Disabled** button in the upper-right corner.
504 504  
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.
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//.
506 506  
507 -Click on the **Apply** button.
508 508  
509 -Then click on the **Apply changes** (//**tick icon**//) button.
550 +[[image:telemetry-2.png]]
510 510  
511 511  
512 -[[image:Screenshot 2025-03-18 at 09.23.10.png]]
553 +Let's provision the second device named **LDS25-NB **with initial telemetry. Use the following MQTT message.
513 513  
514 514  
515 -Now go to the **Events** tab.
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}}
516 516  
517 -Select the Event type as **Debug** from the dropdown list.
560 +Now, refresh the **Devices** page, and you will see the second device, **LDS25-NB**, which was recently provisioned.
518 518  
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.
520 520  
563 +[[image:device-provision-2.png]]
521 521  
522 -[[image:Screenshot 2025-03-16 at 18.38.59.png]]
523 523  
566 += 6. Creating a Dashboard =
524 524  
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 -
536 536  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.
537 537  
538 538  
... ... @@ -539,11 +539,6 @@
539 539  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.
540 540  
541 541  
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 -
547 547  In **ThingsBoard**, from the left navigation menu, click **Dashboards**. Then, click the **+** button and select **Create new dashboard** from the dropdown menu.
548 548  
549 549  
... ... @@ -600,11 +600,11 @@
600 600  
601 601  
602 602  {{code language="none"}}
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}'
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}'
604 604  
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}'
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}'
606 606  
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}'
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}'
608 608  
609 609  {{/code}}
610 610  
... ... @@ -614,10 +614,10 @@
614 614  [[image:timeseries-4.png||height="316" width="700"]]
615 615  
616 616  
617 -= 8. Configure NB-IoT Sensor =
644 += 7. Configure NB-IoT Sensor =
618 618  
619 619  
620 -Now, let's experiment with sending data to ThingsBoard using a real NB-IoT device. For example, we will use the **TS01-NB**.
647 +Now, let's experiment with sending data to ThingsBoard using a real NB-IoT device. For example, we will use the **S31B-NB**.
621 621  
622 622  First, configure the NB-IoT device with the necessary MQTT settings using AT commands. Below is a list of AT commands you can use.
623 623  
... ... @@ -625,8 +625,8 @@
625 625  **AT Commands**
626 626  
627 627  * **AT+PRO=3,3    **~/~/ Use MQTT to connect to ThingsBoard. Payload Type set to 3.
628 -* **AT+SUBTOPIC=<MQTT subscribe topic> Eg: TS01-NB**
629 -* **AT+PUBTOPIC=<MQTT publish topic> Eg: TS01-NB**
655 +* **AT+SUBTOPIC=<MQTT topic>**
656 +* **AT+PUBTOPIC=<MQTT topic>**
630 630  * **AT+CLIENT=null**
631 631  * **AT+UNAME=<MQTT Username>**
632 632  * **AT+PWD=<MQTT Password>**
... ... @@ -633,16 +633,3 @@
633 633  * **AT+SERVADDR=<Broker address, Port>**
634 634  
635 635  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 -
Screenshot 2025-03-16 at 18.39.12.png
Size
... ... @@ -1,1 +1,1 @@
1 -211.9 KB
1 +277.0 KB
Content
Screenshot 2025-03-18 at 09.23.10.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -78.7 KB
Content
add-integration-connection.png
Size
... ... @@ -1,1 +1,1 @@
1 -158.1 KB
1 +153.2 KB
Content
image-4.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -96.0 KB
Content
integration-dl-skip.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -105.5 KB
Content