Skip to Content

Changes for page ThingsBoard

Last modified by Dilisi S on 2025/04/23 19:23
From version 141.1
edited by Dilisi S
on 2025/03/09 03:49
Change comment: There is no comment for this version
To version 116.1
edited by Dilisi S
on 2025/03/08 20:12
Change comment: Uploaded new attachment "hivemq-8.png", version {1}

Summary

Details

Page properties
Content
... ... @@ -17,137 +17,16 @@
17 17  The **NB series** devices end with the suffix **-NB**, and the **CB series** devices end with the suffix **-CB**. For example, **S31B-NB** is an **NB device**, and **S31-CB** is a **CB device**.
18 18  
19 19  
20 -= 2. Prerequisites =
21 21  
22 -To complete this tutorial, you need to have the following:
23 23  
24 -* ThingsBoard cloud account
25 -* HiveMQ Cloud account
26 26  
27 -== 2.1 ThingsBoard Cloud ==
23 += 2. Data Converters =
28 28  
29 29  
30 -Go to [[https:~~/~~/thingsboard.io/>>https://thingsboard.io/]]
31 -
32 -Click on the **Try it now**.
33 -
34 -
35 -[[image:thingsboard-1.png]]
36 -
37 -
38 -Select either the **North America** or **Europe** region. Here, we use the Europe region.
39 -
40 -[[image:thingsboard-2.png]]
41 -
42 -
43 -You can sign up with your **Google**, **GitHub**, **Facebook**, or **Apple** account. If not you can create an account with providing your **name**, **email address** and a **password**.
44 -
45 -Click on the **Sign up** button.
46 -
47 -[[image:thingsboard-3.png||height="651" width="500"]]
48 -
49 -
50 -You will be navigated to the following page.
51 -
52 -[[image:thingsboard-5.png||height="109" width="500"]]
53 -
54 -
55 -simultaneously, you will receive an email to confirm your email address. Click on the **Activate Your Account** button.
56 -
57 -
58 -[[image:thingsboard-4.png||height="249" width="500"]]
59 -
60 -
61 -Now losing to the account using your credentials:
62 -
63 -
64 -[[image:thingsboard-6.png||height="244" width="500"]]
65 -
66 -
67 -== 2.2 HiveMQ Cloud ==
68 -
69 -
70 -Go to [[https:~~/~~/www.hivemq.com>>https://www.hivemq.com]]
71 -
72 -Click on the **Start Free** button.
73 -
74 -[[image:hivwmq-1.png]]
75 -
76 -
77 -Click on the **Sign Up FREE Now** button in the **HIVEMQ CLOUD** section.
78 -
79 -[[image:hivemq-2.png]]
80 -
81 -
82 -Click on the **Sign Up** button.
83 -
84 -You can sign up with HiveMQ using your **GitHub**, **Google**, or **LinkedIn** account.
85 -
86 -If not, provide your **email address** and a **password** to create an account by clicking on the **Sign Up** button.
87 -
88 -
89 -[[image:hivemq-3.png]]
90 -
91 -
92 -You will receive an email to verify your email address. Click on the **Confirm my account** button.
93 -
94 -
95 -[[image:hivemq-4.jpg||height="889" width="400"]]
96 -
97 -
98 -You will be redirected to a page asking you to complete your profile. Once done, click the **Continue** button.
99 -
100 -
101 -[[image:hivemq-5.png||height="655" width="700"]]
102 -
103 -
104 -Select the CloudMQ Cloud plan you need. For testing purposes, select the **Serverless FREE** plan by clicking on the **Create Serverless Cluster** button.
105 -
106 -
107 -[[image:hivemq-6.png]]
108 -
109 -
110 -You will be navigated to the **Your Clusters** page. Click on the **Manage Cluster** button.
111 -
112 -[[image:hivemq-7.png]]
113 -
114 -
115 -In your cluster page, you can find some useful parameters you need to create a MQTT connection.
116 -
117 -**URL**: This is the host name. Click on the copy button to copy it.
118 -
119 -**Port**: 8883
120 -
121 -
122 -Click on the **Getting Started** tab to setup the username and the password as the connection credentials.
123 -
124 -
125 -[[image:hivemq-8.png]]
126 -
127 -
128 -In the '**Create Connection Credentials**' section, provide a **username** and **password**, then click the **Add** button.
129 -
130 -
131 -[[image:hivemq-9.png]]
132 -
133 -
134 -
135 -If everything is successful, you will see the following message.
136 -
137 -
138 -[[image:hivemq-10.png||height="206" width="500"]]
139 -
140 -
141 -You will need these MQTT connection parameters when configuring the MQTT integration in the '**Add Integration**' section.
142 -
143 -
144 -= 3. Data Converters =
145 -
146 -
147 147  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.
148 148  
149 149  
150 -== 3.1 Uplink ==
29 +== 2.1 Uplink ==
151 151  
152 152  
153 153  In the left navigation, click **Integrations center**, and then click **Data converters**.
... ... @@ -277,9 +277,10 @@
277 277  
278 278  [[image:data-converters-list.png]]
279 279  
159 +(% class="wikigeneratedid" %)
280 280  
281 281  
282 -= 4. Add Integration =
162 += 3. Add Integration =
283 283  
284 284  
285 285  In the left navigation, click **Integrations center**, and then click **Integrations**.
... ... @@ -345,6 +345,7 @@
345 345  * **Topic:** tb/mqtt-integration-tutorial/sensors/+/telemetry (the + replaces any 'device name' and creates devices in the Entities -> Devices)
346 346  * **QoS:** 0-At most once
347 347  
228 +
348 348  [[image:add-integration-connection.png||height="511" width="500"]]
349 349  
350 350  
... ... @@ -359,10 +359,11 @@
359 359  Click on the **Check connection** button to verify the MQTT connection using the provided parameters.
360 360  
361 361  
243 +
362 362  [[image:check-connection.png||height="83" width="300"]]
363 363  
364 364  
365 -If the connection is successful, you will see the **Connected** message. If not, check your connection parameters again.
247 +If the connection is successful, you will see the **Connected** message.
366 366  
367 367  
368 368  [[image:connection-success.png||height="511" width="500"]]
... ... @@ -370,119 +370,22 @@
370 370  
371 371  Click on the **Add** button.
372 372  
255 +
256 +
373 373  You should see that the newly added integration is listed on the **Integrations** page.
374 374  
375 375  Since we haven't received data from a device yet, the integration **Status** is shown as **Pending.**
376 376  
261 +[[image:integrations-list-added-pending.png]]
377 377  
378 378  
379 -[[image:new-integration-pending.png]]
264 += 5. Verifying the receipt of data from the device =
380 380  
381 381  
382 -= 5. Verifying the receipt of data from virtual devices =
267 +On the terminal, issue the following MQTT command which simulates the device S31B-NB.
383 383  
384 -
385 -== 5.1 How does it work? ==
386 -
387 -
388 -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.
389 -
390 -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.
391 -
392 -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.
393 -
394 -
395 -**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.**
396 -
397 -
398 -For example, if you send two MQTT messages with different device names in the topic:
399 -
400 -1. v1/devices/**S31B-NB**/telemetry
401 -1. v1/devices/**LDS25-NB**/telemetry
402 -
403 -ThingsBoard will create two devices named **S31B-NB** and **LDS25-NB** in the **//Devices//** section.
404 -
405 -
406 -The MQTT payload format is as follows, which is common for all ~-~-NB and ~-~-CB series devices:
407 -
408 408  {{code language="none"}}
409 -{"temperature":10.4, "humidity":85}
270 +mosquitto_pub -d -q 1 -h mqtt.eu.thingsboard.cloud -p 1883 -t v1/devices/S31B-NB/telemetry -u "24vk3w9h7sqdld1me5eh" -m "{temperature:20}"
410 410  {{/code}}
411 411  
412 -
413 -== 5.2 Sending messages ==
414 -
415 -
416 -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.
417 -
418 -{{code language="none"}}
419 -mosquitto_pub -d -q 1 -h 011731f7928541588a6cdfbbedfc63f4.s1.eu.hivemq.cloud -p 8883 -t "tb/mqtt-integration-tutorial/sensors/S31B-NB/telemetry" -u "pradeeka" -P "Kalpani123@" -m '{"temperature":10.4, "humidity":85}'
420 -{{/code}}
421 -
422 -If the integration was performed without errors, the status of the integration changes to 'Active' after the first telemetry transmission.
423 -
424 -
425 -[[image:integration-active.png]]
426 -
427 -
428 -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**.
429 -
430 -
431 -[[image:device-provision-1.png]]
432 -
433 -
434 -Click on the device S31B-NB on the devices list to see its details.
435 -
436 -Then go to the **Latest telemetry** tab.
437 -
438 -You can see the fields temperature and humidity with the values you previously sent using the MQTT message.
439 -
440 -
441 -[[image:telemetry-1.png]]
442 -
443 -
444 -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//.
445 -
446 -
447 -[[image:telemetry-2.png]]
448 -
449 -
450 -Let's provision the second device named **LDS25-NB **with initial telemetry. Use the following MQTT message.
451 -
452 -
453 -{{code language="none"}}
454 -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}'
455 -{{/code}}
456 -
457 -Now, refresh the **Devices** page, and you will see the second device, **LDS25-NB**, which was recently provisioned.
458 -
459 -
460 -[[image:device-provision-2.png]]
461 -
462 -
463 -= 6. Creating a Dashboard =
464 -
465 -
466 -In ThingsBoard, from the left navigation menu, click **Dashboards**. Then, click the **+** button and select **Create new dashboard** from the dropdown menu.
467 -
468 -
469 -[[image:dashboard-1.png]]
470 -
471 -
472 -In the **Title** text box, enter **NB/CB Test Dashboard** as the title of the dashboard.
473 -
474 -Click on the **Add** button.
475 -
476 -
477 -[[image:dashboard-2.png||height="526" width="500"]]
478 -
479 -
480 -Click on the **Add widget / Add new widget** button.
481 -
482 -
483 -[[image:dashboard-3.png]]
484 -
485 -
486 -
487 -
488 -
273 +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.
dashboard-1.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -271.1 KB
Content
dashboard-2.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -112.2 KB
Content
dashboard-3.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -141.3 KB
Content
device-provision-1.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -265.7 KB
Content
device-provision-2.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -213.9 KB
Content
hivemq-10.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -82.7 KB
Content
hivemq-8.png
Size
... ... @@ -1,1 +1,1 @@
1 -268.7 KB
1 +294.1 KB
Content
hivemq-9.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -303.7 KB
Content
integration-active.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -64.2 KB
Content
telemetry-1.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -191.9 KB
Content
telemetry-2.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -185.1 KB
Content
thingsboard-1.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -1.9 MB
Content
thingsboard-2.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -901.1 KB
Content
thingsboard-3.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -146.3 KB
Content
thingsboard-4.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -122.1 KB
Content
thingsboard-5.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -106.7 KB
Content
thingsboard-6.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -119.3 KB
Content