Skip to Content

Changes for page ThingsBoard

Last modified by Dilisi S on 2025/04/23 19:23
From version 121.1
edited by Dilisi S
on 2025/03/08 20:30
Change comment: Mar 8 edits - part 2
To version 103.1
edited by Dilisi S
on 2025/03/08 04:34
Change comment: Uploaded new attachment "check-connection.png", version {1}

Summary

Details

Page properties
Content
... ... @@ -17,103 +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  
23 += 2. Data Converters =
27 27  
28 -== 2.1 ThingsBoard Cloud ==
29 29  
30 -
31 -Add details here
32 -
33 -== 2.2 HiveMQ Cloud ==
34 -
35 -
36 -Go to [[https:~~/~~/www.hivemq.com>>https://www.hivemq.com]]
37 -
38 -Click on the **Start Free** button.
39 -
40 -[[image:hivwmq-1.png]]
41 -
42 -
43 -Click on the **Sign Up FREE Now** button in the **HIVEMQ CLOUD** section.
44 -
45 -[[image:hivemq-2.png]]
46 -
47 -
48 -Click on the **Sign Up** button.
49 -
50 -You can sign up with HiveMQ using your **GitHub**, **Google**, or **LinkedIn** account.
51 -
52 -If not, provide your **email address** and a **password** to create an account by clicking on the **Sign Up** button.
53 -
54 -
55 -[[image:hivemq-3.png]]
56 -
57 -
58 -You will receive an email to verify your email address. Click on the **Confirm my account** button.
59 -
60 -
61 -[[image:hivemq-4.jpg||height="889" width="400"]]
62 -
63 -
64 -You will be redirected to a page asking you to complete your profile. Once done, click the **Continue** button.
65 -
66 -
67 -[[image:hivemq-5.png||height="655" width="700"]]
68 -
69 -
70 -Select the CloudMQ Cloud plan you need. For testing purposes, select the **Serverless FREE** plan by clicking on the **Create Serverless Cluster** button.
71 -
72 -
73 -[[image:hivemq-6.png]]
74 -
75 -
76 -You will be navigated to the **Your Clusters** page. Click on the **Manage Cluster** button.
77 -
78 -[[image:hivemq-7.png]]
79 -
80 -
81 -In your cluster page, you can find some useful parameters you need to create a MQTT connection.
82 -
83 -**URL**: This is the host name. Click on the copy button to copy it.
84 -
85 -**Port**: 8883
86 -
87 -
88 -Click on the **Getting Started** tab to setup the username and the password as the connection credentials.
89 -
90 -
91 -[[image:hivemq-8.png]]
92 -
93 -
94 -In the '**Create Connection Credentials**' section, provide a **username** and **password**, then click the **Add** button.
95 -
96 -
97 -[[image:hivemq-9.png]]
98 -
99 -
100 -
101 -If everything is successful, you will see the following message.
102 -
103 -
104 -[[image:hivemq-10.png||height="206" width="500"]]
105 -
106 -
107 -You will need these MQTT connection parameters when configuring the MQTT integration in the '**Add Integration**' section.
108 -
109 -
110 -= 3. Data Converters =
111 -
112 -
113 113  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.
114 114  
115 115  
116 -== 3.1 Uplink ==
29 +== 2.1 Uplink ==
117 117  
118 118  
119 119  In the left navigation, click **Integrations center**, and then click **Data converters**.
... ... @@ -173,9 +173,9 @@
173 173  
174 174  You should see that the newly added **MQTT Uplink converter **NB/CB is listed on the **Data Converters** page.
175 175  
176 -[[image:data-converter-list-showing-uplink-dc.png]]
177 177  
178 178  
91 +[[image:create-new-converter-menu.png||width="500"]]
179 179  
180 180  == 3.2 Downlink ==
181 181  
... ... @@ -182,11 +182,9 @@
182 182  
183 183  On the **Data converters** page, click on the ‘**+**’ button, and then click on the **Create new converter** from the dropdown menu.
184 184  
98 +[[image:ThingsBoard-new-data-converter.png||height="282" width="500"]]
185 185  
186 -[[image:create-new-converter-menu.png||width="500"]]
187 187  
188 -
189 -
190 190  The **Add data converter** window will appear. Name it ‘**MQTT Downlink Converter NB/CB**’ and select the Type as **Downlink**.
191 191  
192 192  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.
... ... @@ -241,22 +241,19 @@
241 241  You should see that the newly added **MQTT Downlink** Converter NB/CB is listed on the **Data Converters** page.
242 242  
243 243  
155 +
244 244  [[image:data-converters-list.png]]
245 245  
158 += 3. Add Integration =
246 246  
247 247  
248 -= 4. Add Integration =
249 -
250 -
251 251  In the left navigation, click **Integrations center**, and then click **Integrations**.
252 252  
253 -
254 -[[image:integrations-list-empty.png]]
255 -
256 -
257 257  On the **Integrations** page, click on the '**+**' button.
258 258  
165 +[[image:data-converter-list-page.png]]
259 259  
167 +
260 260  The **Add integration** window appears.
261 261  
262 262  In the **Add integration** window, configure the following settings:
... ... @@ -266,13 +266,9 @@
266 266  
267 267  * **Integration type**: MQTT
268 268  * **Name**: MQTT integration NB/CB
269 -* **Enable integration**: YES
270 -* **Allows create devices or assets**: YES
271 271  
272 272  Click **Next** button.
273 273  
274 -
275 -
276 276  [[image:add-integration-basic-settings.png||height="511" width="500"]]
277 277  
278 278  
... ... @@ -283,11 +283,9 @@
283 283  
284 284  Click **Next** button.
285 285  
190 +[[image:add-integration-uplink-data-converter.png||width="500"]]
286 286  
287 287  
288 -[[image:add-integration-uplink-data-converter.png||height="511" width="500"]]
289 -
290 -
291 291  **Downlink data converter:**
292 292  
293 293  * Click on the **Select existing** button.
... ... @@ -295,11 +295,9 @@
295 295  
296 296  Click **Next** button.
297 297  
200 +[[image:add-integration-downlink-data-converter.png||height="510" width="500"]]
298 298  
299 299  
300 -[[image:add-integration-downlink-data-converter.png||height="511" width="500"]]
301 -
302 -
303 303  **Connection:**
304 304  
305 305  * **Host**: Cluster URL (Eg. 011731f7928541588a6cdfbbedfc63f4.s1.eu.hivemq.cloud)
... ... @@ -310,41 +310,28 @@
310 310  * **Password:** Password (from your HiveMQ Cloud Cluster with your credentials)
311 311  * **Topic:** tb/mqtt-integration-tutorial/sensors/+/telemetry (the + replaces any 'device name' and creates devices in the Entities -> Devices)
312 312  * **QoS:** 0-At most once
313 -
314 -[[image:add-integration-connection.png||height="511" width="500"]]
315 -
316 -
317 -Click on the **Advanced settings** button.
318 -
319 319  * **Clean session:** NO
320 320  * **Retained**: NO
321 321  
322 -[[image:add-integration-connection-advanced-settings.png||height="510" width="500"]]
323 -
324 -
325 325  Click on the **Check connection** button to verify the MQTT connection using the provided parameters.
326 326  
218 +[[image:add-integration-connection.png||width="500"]]
327 327  
328 -[[image:check-connection.png||height="83" width="300"]]
329 329  
221 +If the connection is successful, you will see the **Connected** message.
330 330  
331 -If the connection is successful, you will see the **Connected** message. If not, check your connection parameters again.
223 +Click on the **Add** button.
332 332  
225 +[[image:add-connection-success.png||height="511" width="500"]]
333 333  
334 -[[image:connection-success.png||height="511" width="500"]]
335 335  
336 -
337 -Click on the **Add** button.
338 -
339 339  You should see that the newly added integration is listed on the **Integrations** page.
340 340  
341 341  Since we haven't received data from a device yet, the integration **Status** is shown as **Pending.**
342 342  
232 +[[image:integrations-list-added-pending.png]]
343 343  
344 344  
345 -[[image:new-integration-pending.png]]
346 -
347 -
348 348  = 5. Verifying the receipt of data from the device =
349 349  
350 350  
... ... @@ -355,3 +355,4 @@
355 355  {{/code}}
356 356  
357 357  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 +
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