Skip to Content

Changes for page ThingsBoard

Last modified by Dilisi S on 2025/04/23 19:23
From version 22.1
edited by Dilisi S
on 2025/03/04 04:36
Change comment: Uploaded new attachment "Integrations-list.png", version {1}
To version 50.1
edited by Dilisi S
on 2025/03/06 03:34
Change comment: Uploaded new attachment "integrations-list-added-pending.png", version {1}

Summary

Details

Page properties
Content
... ... @@ -38,7 +38,7 @@
38 38  In the left navigation, click **Integrations center**, and then click **Data converters**.
39 39  
40 40  
41 -[[image:ThingsBoard-Data-Converters.png]]
41 +[[image:data-converter-list-page.png]]
42 42  
43 43  
44 44  On the **Data converters** page, click on the ‘+’ button, and then click on the **Create new converter** from the dropdown menu.
... ... @@ -47,9 +47,9 @@
47 47  [[image:ThingsBoard-new-data-converter.png||height="282" width="500"]]
48 48  
49 49  
50 -The **Add data converter** window will appear. Name it ‘**UDP Uplink Converter NB/CB**’ and select the Type as **Uplink**.
50 +The **Add data converter** window will appear. Name it ‘**MQTT Uplink Converter NB/CB**’ and select the Type as **Uplink**.
51 51  
52 -Click on the **JavaScript** button. Now copy and paste the following script to the **Decoder function** section:
52 +Click on the **JavaScript** button. Now copy and paste the following JavaScript to the **Decoder function** section. This decoder function is valid for both NB and CB series devices.
53 53  
54 54  {{code language="JavaScript"}}
55 55  //Version: 0.1
... ... @@ -177,15 +177,16 @@
177 177  Click on the **Add** button.
178 178  
179 179  
180 -[[image:ThingsBoard-add-data-converter-uplink.png||width="500"]]
180 +[[image:uplink-data-converter.png||height="529" width="500"]]
181 181  
182 182  
183 -The uplink data converter is added to ThingsBoard and is listed on the **Data Converters** page.
184 184  
184 +You should see that the newly added **uplink data converter** is listed on the **Data Converters** page.
185 185  
186 -[[image:Data-converter-list-uplink-only.png]]
187 187  
187 +[[image:data-converter-list-showing-uplink-dc.png]]
188 188  
189 +
189 189  == Downlink ==
190 190  
191 191  On the **Data converters** page, click on the ‘**+**’ button, and then click on the **Create new converter** from the dropdown menu.
... ... @@ -194,9 +194,9 @@
194 194  [[image:ThingsBoard-new-data-converter.png||height="282" width="500"]]
195 195  
196 196  
197 -The **Add data converter** window will appear. Name it ‘**UDP Downlink Converter NB/CB**’ and select the Type as **Downlink**.
198 +The **Add data converter** window will appear. Name it ‘**MQTT Downlink Converter NB/CB**’ and select the Type as **Downlink**.
198 198  
199 -Click on the **JavaScript** button. Now copy and paste the following script to the **Encoder function **section:
200 +Click on the **JavaScript** button. Now copy and paste the following JavaScript to the **Encoder function **section. This encoder function is valid for both NB and CB series devices.
200 200  
201 201  
202 202  {{code language="JavaScript"}}
... ... @@ -232,15 +232,16 @@
232 232  Click on the **Add** button.
233 233  
234 234  
235 -[[image:ThingsBoard-add-data-converter-downlink.png||height="532" width="500"]]
236 +[[image:downlink-data-converter.png||height="530" width="500"]]
236 236  
237 237  
238 -The downlink data converter is added to ThingsBoard and is listed on the **Data Converters** page.
239 239  
240 +You should see that the newly added **downlink data converter** is listed on the **Data Converters** page.
240 240  
241 -[[image:Data-converter-list.png]]
242 242  
243 +[[image:data-converter-list.png]]
243 243  
245 +
244 244  = Add Integration =
245 245  
246 246  In the left navigation, click **Integrations center**, and then click **Integrations**.
... ... @@ -248,19 +248,18 @@
248 248  On the **Integrations** page, click on the '**+**' button.
249 249  
250 250  
251 -[[image:ThingsBoard-add-integration.png]]
253 +[[image:data-converter-list-page.png]]
252 252  
253 253  
254 254  The **Add integration** window appears.
255 255  
256 -In the Add Integration window, configure the following settings:
258 +In the **Add integration** window, configure the following settings:
257 257  
258 258  
259 -
260 260  **Basic settings:**
261 261  
262 -* **Integration type**: UDP
263 -* **Name**: UDP Integration NB/CB
263 +* **Integration type**: MQTT
264 +* **Name**: MQTT integration NB/CB
264 264  
265 265  Click **Next** button.
266 266  
... ... @@ -268,47 +268,67 @@
268 268  [[image:add-integration-basic-settings.png||height="511" width="500"]]
269 269  
270 270  
272 +
271 271  **Uplink data converter:**
272 272  
273 273  * Click on the **Select existing** button.
274 -* **Uplink data converter**: Select **UDP Uplink Converter NB/CB **from the dropdown list.
276 +* **Uplink data converter**: Select **MQTT Uplink Converter NB/CB **from the dropdown list.
275 275  
276 276  Click **Next** button.
277 277  
278 278  
279 -[[image:add-integration-uplink-data-converter.png||height="511" width="500"]]
281 +[[image:add-integration-uplink-data-converter.png||width="500"]]
280 280  
281 281  
284 +
282 282  **Downlink data converter:**
283 283  
284 284  * Click on the **Select existing** button.
285 -* **Downlink data converter**: Select **UDP Downlink Converter NB/CB **from the dropdown list.
288 +* **Downlink data converter**: Select **MQTT Downlink Converter NB/CB **from the dropdown list.
286 286  
287 287  Click **Next** button.
288 288  
289 289  
290 -[[image:add-integration-downlink-data-converter.png||height="512" width="500"]]
293 +[[image:add-integration-downlink-data-converter.png||height="510" width="500"]]
291 291  
292 292  
296 +
293 293  **Connection:**
294 294  
295 -* **Port**: 11582
296 -* **Size of the buffer for inbound socket (in KB)**: 64
297 -* **Cache Size**: 10000000
298 -* **Cache time to live in minutes**: 1440
299 +* **Host**: mqtt.eu.thingsboard.cloud (This is the host name you copied from the device - See section xxxxx for more information)
300 +* **Port**: 1883 (This is the port number you copied from the device - See section xxxxx for more information)
301 +* **Credentials**: Basic
302 +* **Username**: Access token (This is the access token you copied from the device)
303 +* **Password** - Leave it as blank
304 +* **Topic** - v1/devices/+/telemetry (sightly modify the topic 'v1/devices/me/telemetry' you copied for the device to enable receiving data from any 'device name')
305 +* **QoS** - 0-At most once
299 299  
300 -Copy the two keys, **Integration key** and **Integration secret** into a text editor, as you will need them in the section ‘xxxxx’.
307 +Click on the **Check connection** button to verify the MQTT connection using the provided parameters.
301 301  
309 +
310 +[[image:add-integration-connection.png||width="500"]]
311 +
312 +
313 +If the connection is successful, you will see the **Connected** message.
314 +
302 302  Click on the **Add** button.
303 303  
304 304  
305 -[[image:add-integration-connection.png||height="511" width="500"]]
318 +[[image:add-connection-success.png||height="511" width="500"]]
306 306  
307 307  
308 308  
309 -= Verifying the receipt of data from the device =
310 310  
311 -Connect **S31B-NB** to transfer information. If the integration was performed without errors, after the transmission of the first telemetry, a new device with the name “xxxxx” 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.
312 312  
313 313  
314 -
325 +
326 +You should see that the newly added integration is listed on the **Integrations** page.
327 +
328 +Since we haven't received data from a device yet, the integration **Status** is shown as **Pending.**
329 +
330 +[[image:Integrations-list.png]]
331 +
332 +
333 += Verifying the receipt of data from the device =
334 +
335 +Connect **S31B-NB** to transfer information. If the integration was performed without errors, after the transmission of the first telemetry, a new device with the name “xxxxx” 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.
Data-converter-list-uplink-only.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -128.6 KB
Content
Data-converter-list.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -128.6 KB
Content
Integrations-list.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -128.6 KB
Content
ThingsBoard-Data-Converters.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -100.3 KB
Content
ThingsBoard-add-data-converter-downlink.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -128.6 KB
Content
ThingsBoard-add-data-converter-uplink.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -128.6 KB
Content
ThingsBoard-add-integration.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -128.6 KB
Content
add-connection-success.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +202.8 KB
Content
data-converter-list-page.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +190.8 KB
Content
data-converter-list-showing-uplink-dc.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +194.9 KB
Content
data-converter-list.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +202.8 KB
Content
downlink-data-converter.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +207.8 KB
Content
integrations-list-added-pending.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +202.8 KB
Content
uplink-data-converter.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +128.6 KB
Content