Skip to Content

Changes for page ThingsBoard

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

Summary

Details

Page properties
Content
... ... @@ -17,9 +17,76 @@
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 =
20 20  
22 +To complete this tutorial, you need to have the following:
21 21  
24 +* ThingsBoard cloud account -
25 +* HiveMQ Cloud account
22 22  
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 +
23 23  = 2. Data Converters =
24 24  
25 25  
... ... @@ -86,9 +86,9 @@
86 86  
87 87  You should see that the newly added **MQTT Uplink converter **NB/CB is listed on the **Data Converters** page.
88 88  
156 +[[image:data-converter-list-showing-uplink-dc.png]]
89 89  
90 90  
91 -[[image:create-new-converter-menu.png||width="500"]]
92 92  
93 93  == 3.2 Downlink ==
94 94  
... ... @@ -95,9 +95,11 @@
95 95  
96 96  On the **Data converters** page, click on the ‘**+**’ button, and then click on the **Create new converter** from the dropdown menu.
97 97  
98 -[[image:ThingsBoard-new-data-converter.png||height="282" width="500"]]
99 99  
166 +[[image:create-new-converter-menu.png||width="500"]]
100 100  
168 +
169 +
101 101  The **Add data converter** window will appear. Name it ‘**MQTT Downlink Converter NB/CB**’ and select the Type as **Downlink**.
102 102  
103 103  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.
... ... @@ -152,19 +152,22 @@
152 152  You should see that the newly added **MQTT Downlink** Converter NB/CB is listed on the **Data Converters** page.
153 153  
154 154  
155 -
156 156  [[image:data-converters-list.png]]
157 157  
226 +
227 +
158 158  = 3. Add Integration =
159 159  
160 160  
161 161  In the left navigation, click **Integrations center**, and then click **Integrations**.
162 162  
163 -On the **Integrations** page, click on the '**+**' button.
164 164  
165 -[[image:data-converter-list-page.png]]
234 +[[image:integrations-list-empty.png]]
166 166  
167 167  
237 +On the **Integrations** page, click on the '**+**' button.
238 +
239 +
168 168  The **Add integration** window appears.
169 169  
170 170  In the **Add integration** window, configure the following settings:
... ... @@ -174,9 +174,13 @@
174 174  
175 175  * **Integration type**: MQTT
176 176  * **Name**: MQTT integration NB/CB
249 +* **Enable integration**: YES
250 +* **Allows create devices or assets**: YES
177 177  
178 178  Click **Next** button.
179 179  
254 +
255 +
180 180  [[image:add-integration-basic-settings.png||height="511" width="500"]]
181 181  
182 182  
... ... @@ -187,9 +187,11 @@
187 187  
188 188  Click **Next** button.
189 189  
190 -[[image:add-integration-uplink-data-converter.png||width="500"]]
191 191  
192 192  
268 +[[image:add-integration-uplink-data-converter.png||height="511" width="500"]]
269 +
270 +
193 193  **Downlink data converter:**
194 194  
195 195  * Click on the **Select existing** button.
... ... @@ -197,9 +197,11 @@
197 197  
198 198  Click **Next** button.
199 199  
200 -[[image:add-integration-downlink-data-converter.png||height="510" width="500"]]
201 201  
202 202  
280 +[[image:add-integration-downlink-data-converter.png||height="511" width="500"]]
281 +
282 +
203 203  **Connection:**
204 204  
205 205  * **Host**: Cluster URL (Eg. 011731f7928541588a6cdfbbedfc63f4.s1.eu.hivemq.cloud)
... ... @@ -210,28 +210,41 @@
210 210  * **Password:** Password (from your HiveMQ Cloud Cluster with your credentials)
211 211  * **Topic:** tb/mqtt-integration-tutorial/sensors/+/telemetry (the + replaces any 'device name' and creates devices in the Entities -> Devices)
212 212  * **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 +
213 213  * **Clean session:** NO
214 214  * **Retained**: NO
215 215  
302 +[[image:add-integration-connection-advanced-settings.png||height="510" width="500"]]
303 +
304 +
216 216  Click on the **Check connection** button to verify the MQTT connection using the provided parameters.
217 217  
218 -[[image:add-integration-connection.png||width="500"]]
219 219  
308 +[[image:check-connection.png||height="83" width="300"]]
220 220  
221 -If the connection is successful, you will see the **Connected** message.
222 222  
223 -Click on the **Add** button.
311 +If the connection is successful, you will see the **Connected** message. If not, check your connection parameters again.
224 224  
225 -[[image:add-connection-success.png||height="511" width="500"]]
226 226  
314 +[[image:connection-success.png||height="511" width="500"]]
227 227  
316 +
317 +Click on the **Add** button.
318 +
228 228  You should see that the newly added integration is listed on the **Integrations** page.
229 229  
230 230  Since we haven't received data from a device yet, the integration **Status** is shown as **Pending.**
231 231  
232 -[[image:integrations-list-added-pending.png]]
233 233  
234 234  
325 +[[image:new-integration-pending.png]]
326 +
327 +
235 235  = 5. Verifying the receipt of data from the device =
236 236  
237 237  
... ... @@ -242,4 +242,3 @@
242 242  {{/code}}
243 243  
244 244  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,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +90.0 KB
Content
hivemq-2.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +300.7 KB
Content
hivemq-3.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +535.2 KB
Content
hivemq-4.jpg
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +309.8 KB
Content
hivemq-5.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +115.0 KB
Content
hivemq-6.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +321.0 KB
Content
hivemq-7.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +203.5 KB
Content
hivemq-8.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +294.1 KB
Content
hivwmq-1.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +380.3 KB
Content
new-integration-pending.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +199.7 KB
Content