Skip to Content

Changes for page ThingsBoard

Last modified by Dilisi S on 2025/04/23 19:23
From version 125.1
edited by Dilisi S
on 2025/03/08 20:47
Change comment: There is no comment for this version
To version 99.1
edited by Dilisi S
on 2025/03/08 04:21
Change comment: Uploaded new attachment "add-integration-downlink-data-converter.png", version {1}

Summary

Details

Page properties
Content
... ... @@ -17,118 +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 -[[image:thingsboard-3.png||height="651" width="500"]]
46 -
47 -
48 -== 2.2 HiveMQ Cloud ==
49 -
50 -
51 -Go to [[https:~~/~~/www.hivemq.com>>https://www.hivemq.com]]
52 -
53 -Click on the **Start Free** button.
54 -
55 -[[image:hivwmq-1.png]]
56 -
57 -
58 -Click on the **Sign Up FREE Now** button in the **HIVEMQ CLOUD** section.
59 -
60 -[[image:hivemq-2.png]]
61 -
62 -
63 -Click on the **Sign Up** button.
64 -
65 -You can sign up with HiveMQ using your **GitHub**, **Google**, or **LinkedIn** account.
66 -
67 -If not, provide your **email address** and a **password** to create an account by clicking on the **Sign Up** button.
68 -
69 -
70 -[[image:hivemq-3.png]]
71 -
72 -
73 -You will receive an email to verify your email address. Click on the **Confirm my account** button.
74 -
75 -
76 -[[image:hivemq-4.jpg||height="889" width="400"]]
77 -
78 -
79 -You will be redirected to a page asking you to complete your profile. Once done, click the **Continue** button.
80 -
81 -
82 -[[image:hivemq-5.png||height="655" width="700"]]
83 -
84 -
85 -Select the CloudMQ Cloud plan you need. For testing purposes, select the **Serverless FREE** plan by clicking on the **Create Serverless Cluster** button.
86 -
87 -
88 -[[image:hivemq-6.png]]
89 -
90 -
91 -You will be navigated to the **Your Clusters** page. Click on the **Manage Cluster** button.
92 -
93 -[[image:hivemq-7.png]]
94 -
95 -
96 -In your cluster page, you can find some useful parameters you need to create a MQTT connection.
97 -
98 -**URL**: This is the host name. Click on the copy button to copy it.
99 -
100 -**Port**: 8883
101 -
102 -
103 -Click on the **Getting Started** tab to setup the username and the password as the connection credentials.
104 -
105 -
106 -[[image:hivemq-8.png]]
107 -
108 -
109 -In the '**Create Connection Credentials**' section, provide a **username** and **password**, then click the **Add** button.
110 -
111 -
112 -[[image:hivemq-9.png]]
113 -
114 -
115 -
116 -If everything is successful, you will see the following message.
117 -
118 -
119 -[[image:hivemq-10.png||height="206" width="500"]]
120 -
121 -
122 -You will need these MQTT connection parameters when configuring the MQTT integration in the '**Add Integration**' section.
123 -
124 -
125 -= 3. Data Converters =
126 -
127 -
128 128  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.
129 129  
130 130  
131 -== 3.1 Uplink ==
29 +== 2.1 Uplink ==
132 132  
133 133  
134 134  In the left navigation, click **Integrations center**, and then click **Data converters**.
... ... @@ -188,9 +188,9 @@
188 188  
189 189  You should see that the newly added **MQTT Uplink converter **NB/CB is listed on the **Data Converters** page.
190 190  
191 -[[image:data-converter-list-showing-uplink-dc.png]]
192 192  
193 193  
91 +[[image:create-new-converter-menu.png||width="500"]]
194 194  
195 195  == 3.2 Downlink ==
196 196  
... ... @@ -197,11 +197,9 @@
197 197  
198 198  On the **Data converters** page, click on the ‘**+**’ button, and then click on the **Create new converter** from the dropdown menu.
199 199  
98 +[[image:ThingsBoard-new-data-converter.png||height="282" width="500"]]
200 200  
201 -[[image:create-new-converter-menu.png||width="500"]]
202 202  
203 -
204 -
205 205  The **Add data converter** window will appear. Name it ‘**MQTT Downlink Converter NB/CB**’ and select the Type as **Downlink**.
206 206  
207 207  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.
... ... @@ -256,22 +256,19 @@
256 256  You should see that the newly added **MQTT Downlink** Converter NB/CB is listed on the **Data Converters** page.
257 257  
258 258  
155 +
259 259  [[image:data-converters-list.png]]
260 260  
158 += 3. Add Integration =
261 261  
262 262  
263 -= 4. Add Integration =
264 -
265 -
266 266  In the left navigation, click **Integrations center**, and then click **Integrations**.
267 267  
268 -
269 -[[image:integrations-list-empty.png]]
270 -
271 -
272 272  On the **Integrations** page, click on the '**+**' button.
273 273  
165 +[[image:data-converter-list-page.png]]
274 274  
167 +
275 275  The **Add integration** window appears.
276 276  
277 277  In the **Add integration** window, configure the following settings:
... ... @@ -281,13 +281,9 @@
281 281  
282 282  * **Integration type**: MQTT
283 283  * **Name**: MQTT integration NB/CB
284 -* **Enable integration**: YES
285 -* **Allows create devices or assets**: YES
286 286  
287 287  Click **Next** button.
288 288  
289 -
290 -
291 291  [[image:add-integration-basic-settings.png||height="511" width="500"]]
292 292  
293 293  
... ... @@ -298,11 +298,9 @@
298 298  
299 299  Click **Next** button.
300 300  
190 +[[image:add-integration-uplink-data-converter.png||width="500"]]
301 301  
302 302  
303 -[[image:add-integration-uplink-data-converter.png||height="511" width="500"]]
304 -
305 -
306 306  **Downlink data converter:**
307 307  
308 308  * Click on the **Select existing** button.
... ... @@ -310,11 +310,9 @@
310 310  
311 311  Click **Next** button.
312 312  
200 +[[image:add-integration-downlink-data-converter.png||height="510" width="500"]]
313 313  
314 314  
315 -[[image:add-integration-downlink-data-converter.png||height="511" width="500"]]
316 -
317 -
318 318  **Connection:**
319 319  
320 320  * **Host**: Cluster URL (Eg. 011731f7928541588a6cdfbbedfc63f4.s1.eu.hivemq.cloud)
... ... @@ -325,41 +325,28 @@
325 325  * **Password:** Password (from your HiveMQ Cloud Cluster with your credentials)
326 326  * **Topic:** tb/mqtt-integration-tutorial/sensors/+/telemetry (the + replaces any 'device name' and creates devices in the Entities -> Devices)
327 327  * **QoS:** 0-At most once
328 -
329 -[[image:add-integration-connection.png||height="511" width="500"]]
330 -
331 -
332 -Click on the **Advanced settings** button.
333 -
334 334  * **Clean session:** NO
335 335  * **Retained**: NO
336 336  
337 -[[image:add-integration-connection-advanced-settings.png||height="510" width="500"]]
338 -
339 -
340 340  Click on the **Check connection** button to verify the MQTT connection using the provided parameters.
341 341  
218 +[[image:add-integration-connection.png||width="500"]]
342 342  
343 -[[image:check-connection.png||height="83" width="300"]]
344 344  
221 +If the connection is successful, you will see the **Connected** message.
345 345  
346 -If the connection is successful, you will see the **Connected** message. If not, check your connection parameters again.
223 +Click on the **Add** button.
347 347  
225 +[[image:add-connection-success.png||height="511" width="500"]]
348 348  
349 -[[image:connection-success.png||height="511" width="500"]]
350 350  
351 -
352 -Click on the **Add** button.
353 -
354 354  You should see that the newly added integration is listed on the **Integrations** page.
355 355  
356 356  Since we haven't received data from a device yet, the integration **Status** is shown as **Pending.**
357 357  
232 +[[image:integrations-list-added-pending.png]]
358 358  
359 359  
360 -[[image:new-integration-pending.png]]
361 -
362 -
363 363  = 5. Verifying the receipt of data from the device =
364 364  
365 365  
... ... @@ -370,3 +370,4 @@
370 370  {{/code}}
371 371  
372 372  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
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -155.2 KB
Content
add-integration-connection.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -124.4 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
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
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