Skip to Content

Changes for page ThingsBoard

Last modified by Dilisi S on 2025/04/23 19:23
From version 132.1
edited by Dilisi S
on 2025/03/09 03:05
Change comment: Uploaded new attachment "device-provision-1.png", version {1}
To version 101.1
edited by Dilisi S
on 2025/03/08 04:30
Change comment: Uploaded new attachment "add-integration-connection-advanced-settings.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**.
... ... @@ -207,9 +207,9 @@
207 207  
208 208  You should see that the newly added **MQTT Uplink converter **NB/CB is listed on the **Data Converters** page.
209 209  
210 -[[image:data-converter-list-showing-uplink-dc.png]]
211 211  
212 212  
91 +[[image:create-new-converter-menu.png||width="500"]]
213 213  
214 214  == 3.2 Downlink ==
215 215  
... ... @@ -216,11 +216,9 @@
216 216  
217 217  On the **Data converters** page, click on the ‘**+**’ button, and then click on the **Create new converter** from the dropdown menu.
218 218  
98 +[[image:ThingsBoard-new-data-converter.png||height="282" width="500"]]
219 219  
220 -[[image:create-new-converter-menu.png||width="500"]]
221 221  
222 -
223 -
224 224  The **Add data converter** window will appear. Name it ‘**MQTT Downlink Converter NB/CB**’ and select the Type as **Downlink**.
225 225  
226 226  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.
... ... @@ -275,22 +275,19 @@
275 275  You should see that the newly added **MQTT Downlink** Converter NB/CB is listed on the **Data Converters** page.
276 276  
277 277  
155 +
278 278  [[image:data-converters-list.png]]
279 279  
158 += 3. Add Integration =
280 280  
281 281  
282 -= 4. Add Integration =
283 -
284 -
285 285  In the left navigation, click **Integrations center**, and then click **Integrations**.
286 286  
287 -
288 -[[image:integrations-list-empty.png]]
289 -
290 -
291 291  On the **Integrations** page, click on the '**+**' button.
292 292  
165 +[[image:data-converter-list-page.png]]
293 293  
167 +
294 294  The **Add integration** window appears.
295 295  
296 296  In the **Add integration** window, configure the following settings:
... ... @@ -300,13 +300,9 @@
300 300  
301 301  * **Integration type**: MQTT
302 302  * **Name**: MQTT integration NB/CB
303 -* **Enable integration**: YES
304 -* **Allows create devices or assets**: YES
305 305  
306 306  Click **Next** button.
307 307  
308 -
309 -
310 310  [[image:add-integration-basic-settings.png||height="511" width="500"]]
311 311  
312 312  
... ... @@ -317,11 +317,9 @@
317 317  
318 318  Click **Next** button.
319 319  
190 +[[image:add-integration-uplink-data-converter.png||width="500"]]
320 320  
321 321  
322 -[[image:add-integration-uplink-data-converter.png||height="511" width="500"]]
323 -
324 -
325 325  **Downlink data converter:**
326 326  
327 327  * Click on the **Select existing** button.
... ... @@ -329,11 +329,9 @@
329 329  
330 330  Click **Next** button.
331 331  
200 +[[image:add-integration-downlink-data-converter.png||height="510" width="500"]]
332 332  
333 333  
334 -[[image:add-integration-downlink-data-converter.png||height="511" width="500"]]
335 -
336 -
337 337  **Connection:**
338 338  
339 339  * **Host**: Cluster URL (Eg. 011731f7928541588a6cdfbbedfc63f4.s1.eu.hivemq.cloud)
... ... @@ -344,78 +344,36 @@
344 344  * **Password:** Password (from your HiveMQ Cloud Cluster with your credentials)
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 -
348 -[[image:add-integration-connection.png||height="511" width="500"]]
349 -
350 -
351 -Click on the **Advanced settings** button.
352 -
353 353  * **Clean session:** NO
354 354  * **Retained**: NO
355 355  
356 -[[image:add-integration-connection-advanced-settings.png||height="510" width="500"]]
357 -
358 -
359 359  Click on the **Check connection** button to verify the MQTT connection using the provided parameters.
360 360  
218 +[[image:add-integration-connection.png||width="500"]]
361 361  
362 -[[image:check-connection.png||height="83" width="300"]]
363 363  
221 +If the connection is successful, you will see the **Connected** message.
364 364  
365 -If the connection is successful, you will see the **Connected** message. If not, check your connection parameters again.
223 +Click on the **Add** button.
366 366  
225 +[[image:add-connection-success.png||height="511" width="500"]]
367 367  
368 -[[image:connection-success.png||height="511" width="500"]]
369 369  
370 -
371 -Click on the **Add** button.
372 -
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  
232 +[[image:integrations-list-added-pending.png]]
377 377  
378 378  
379 -[[image:new-integration-pending.png]]
235 += 5. Verifying the receipt of data from the device =
380 380  
381 381  
382 -= 5. Verifying the receipt of data from virtual devices =
238 +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 -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.
388 -
389 -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.
390 -
391 -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.
392 -
393 -
394 -**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.**
395 -
396 -
397 -For example, if you send two MQTT messages with different device names in the topic:
398 -
399 -1. v1/devices/**S31B-NB**/telemetry
400 -1. v1/devices/**S31B-CB**/telemetry
401 -
402 -ThingsBoard will create two devices named **S31B-NB** and **S31B-CB** in the **//Devices//** section.
403 -
404 -
405 -The MQTT payload format is as follows, for example:
406 -
407 407  {{code language="none"}}
408 -{"temperature":10.4, "humidity":85}
241 +mosquitto_pub -d -q 1 -h mqtt.eu.thingsboard.cloud -p 1883 -t v1/devices/S31B-NB/telemetry -u "24vk3w9h7sqdld1me5eh" -m "{temperature:20}"
409 409  {{/code}}
410 410  
411 -
412 -== 5.2 Sending messages ==
413 -
414 -
415 -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.
416 -
417 -{{code language="none"}}
418 -mosquitto_pub -d -q 1 -h 011731f7928541588a6cdfbbedfc63f4.s1.eu.hivemq.cloud -p 8883 -t "tb/mqtt-integration-tutorial/sensors/SN-001/telemetry" -u "pradeeka" -P "Kalpani123@" -m '{"temperature":10.4, "humidity":85}'
419 -{{/code}}
420 -
421 421  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.
245 +
add-integration-connection-advanced-settings.png
Size
... ... @@ -1,1 +1,1 @@
1 -155.2 KB
1 +167.9 KB
Content
check-connection.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -14.7 KB
Content
connection-success.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -90.0 KB
Content
device-provision-1.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -268.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-2.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -300.7 KB
Content
hivemq-3.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -535.2 KB
Content
hivemq-4.jpg
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -309.8 KB
Content
hivemq-5.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -115.0 KB
Content
hivemq-6.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -321.0 KB
Content
hivemq-7.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -203.5 KB
Content
hivemq-8.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -268.7 KB
Content
hivemq-9.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -303.7 KB
Content
hivwmq-1.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -380.3 KB
Content
integration-active.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -64.2 KB
Content
new-integration-pending.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -199.7 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