Skip to Content

Changes for page ThingsBoard

Last modified by Dilisi S on 2025/04/23 19:23
From version 119.1
edited by Dilisi S
on 2025/03/08 20:22
Change comment: Uploaded new attachment "hivemq-9.png", version {1}
To version 102.1
edited by Dilisi S
on 2025/03/08 04:31
Change comment: Uploaded new attachment "add-integration-connection-advanced-settings.png", version {1}

Summary

Details

Page properties
Content
... ... @@ -17,76 +17,9 @@
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 -
28 -== 2.1 HiveMQ Cloud ==
29 -
30 -
31 -Go to [[https:~~/~~/www.hivemq.com>>https://www.hivemq.com]]
32 -
33 -Click on the **Start Free** button.
34 -
35 -[[image:hivwmq-1.png]]
36 -
37 -
38 -Click on the **Sign Up FREE Now** button in the **HIVEMQ CLOUD** section.
39 -
40 -[[image:hivemq-2.png]]
41 -
42 -
43 -Click on the **Sign Up** button.
44 -
45 -You can sign up with HiveMQ using your **GitHub**, **Google**, or **LinkedIn** account.
46 -
47 -If not, provide your **email address** and a **password** to create an account by clicking on the **Sign Up** button.
48 -
49 -
50 -[[image:hivemq-3.png]]
51 -
52 -
53 -You will receive an email to verify your email address. Click on the **Confirm my account** button.
54 -
55 -
56 -[[image:hivemq-4.jpg||height="889" width="400"]]
57 -
58 -
59 -You will be redirected to a page asking you to complete your profile. Once done, click the **Continue** button.
60 -
61 -
62 -[[image:hivemq-5.png||height="655" width="700"]]
63 -
64 -
65 -Select the CloudMQ Cloud plan you need. For testing purposes, select the **Serverless FREE** plan by clicking on the **Create Serverless Cluster** button.
66 -
67 -
68 -[[image:hivemq-6.png]]
69 -
70 -
71 -You will be navigated to the **Your Clusters** page. Click on the **Manage Cluster** button.
72 -
73 -[[image:hivemq-7.png]]
74 -
75 -
76 -In your cluster page, you can find some useful parameters you need to create a MQTT connection.
77 -
78 -**URL**: This is the host name. Click on the copy button to copy it.
79 -
80 -**Port**: 8883
81 -
82 -
83 -Click on the **Getting Started** tab to setup the username and the password.
84 -
85 -
86 -[[image:hivemq-8.png]]
87 -
88 -
89 -
90 90  = 2. Data Converters =
91 91  
92 92  
... ... @@ -153,9 +153,9 @@
153 153  
154 154  You should see that the newly added **MQTT Uplink converter **NB/CB is listed on the **Data Converters** page.
155 155  
156 -[[image:data-converter-list-showing-uplink-dc.png]]
157 157  
158 158  
91 +[[image:create-new-converter-menu.png||width="500"]]
159 159  
160 160  == 3.2 Downlink ==
161 161  
... ... @@ -162,11 +162,9 @@
162 162  
163 163  On the **Data converters** page, click on the ‘**+**’ button, and then click on the **Create new converter** from the dropdown menu.
164 164  
98 +[[image:ThingsBoard-new-data-converter.png||height="282" width="500"]]
165 165  
166 -[[image:create-new-converter-menu.png||width="500"]]
167 167  
168 -
169 -
170 170  The **Add data converter** window will appear. Name it ‘**MQTT Downlink Converter NB/CB**’ and select the Type as **Downlink**.
171 171  
172 172  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.
... ... @@ -221,22 +221,19 @@
221 221  You should see that the newly added **MQTT Downlink** Converter NB/CB is listed on the **Data Converters** page.
222 222  
223 223  
155 +
224 224  [[image:data-converters-list.png]]
225 225  
226 -
227 -
228 228  = 3. Add Integration =
229 229  
230 230  
231 231  In the left navigation, click **Integrations center**, and then click **Integrations**.
232 232  
233 -
234 -[[image:integrations-list-empty.png]]
235 -
236 -
237 237  On the **Integrations** page, click on the '**+**' button.
238 238  
165 +[[image:data-converter-list-page.png]]
239 239  
167 +
240 240  The **Add integration** window appears.
241 241  
242 242  In the **Add integration** window, configure the following settings:
... ... @@ -246,13 +246,9 @@
246 246  
247 247  * **Integration type**: MQTT
248 248  * **Name**: MQTT integration NB/CB
249 -* **Enable integration**: YES
250 -* **Allows create devices or assets**: YES
251 251  
252 252  Click **Next** button.
253 253  
254 -
255 -
256 256  [[image:add-integration-basic-settings.png||height="511" width="500"]]
257 257  
258 258  
... ... @@ -263,11 +263,9 @@
263 263  
264 264  Click **Next** button.
265 265  
190 +[[image:add-integration-uplink-data-converter.png||width="500"]]
266 266  
267 267  
268 -[[image:add-integration-uplink-data-converter.png||height="511" width="500"]]
269 -
270 -
271 271  **Downlink data converter:**
272 272  
273 273  * Click on the **Select existing** button.
... ... @@ -275,11 +275,9 @@
275 275  
276 276  Click **Next** button.
277 277  
200 +[[image:add-integration-downlink-data-converter.png||height="510" width="500"]]
278 278  
279 279  
280 -[[image:add-integration-downlink-data-converter.png||height="511" width="500"]]
281 -
282 -
283 283  **Connection:**
284 284  
285 285  * **Host**: Cluster URL (Eg. 011731f7928541588a6cdfbbedfc63f4.s1.eu.hivemq.cloud)
... ... @@ -290,41 +290,28 @@
290 290  * **Password:** Password (from your HiveMQ Cloud Cluster with your credentials)
291 291  * **Topic:** tb/mqtt-integration-tutorial/sensors/+/telemetry (the + replaces any 'device name' and creates devices in the Entities -> Devices)
292 292  * **QoS:** 0-At most once
293 -
294 -[[image:add-integration-connection.png||height="511" width="500"]]
295 -
296 -
297 -Click on the **Advanced settings** button.
298 -
299 299  * **Clean session:** NO
300 300  * **Retained**: NO
301 301  
302 -[[image:add-integration-connection-advanced-settings.png||height="510" width="500"]]
303 -
304 -
305 305  Click on the **Check connection** button to verify the MQTT connection using the provided parameters.
306 306  
218 +[[image:add-integration-connection.png||width="500"]]
307 307  
308 -[[image:check-connection.png||height="83" width="300"]]
309 309  
221 +If the connection is successful, you will see the **Connected** message.
310 310  
311 -If the connection is successful, you will see the **Connected** message. If not, check your connection parameters again.
223 +Click on the **Add** button.
312 312  
225 +[[image:add-connection-success.png||height="511" width="500"]]
313 313  
314 -[[image:connection-success.png||height="511" width="500"]]
315 315  
316 -
317 -Click on the **Add** button.
318 -
319 319  You should see that the newly added integration is listed on the **Integrations** page.
320 320  
321 321  Since we haven't received data from a device yet, the integration **Status** is shown as **Pending.**
322 322  
232 +[[image:integrations-list-added-pending.png]]
323 323  
324 324  
325 -[[image:new-integration-pending.png]]
326 -
327 -
328 328  = 5. Verifying the receipt of data from the device =
329 329  
330 330  
... ... @@ -335,3 +335,4 @@
335 335  {{/code}}
336 336  
337 337  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 +
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-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