Skip to Content

Changes for page ThingsBoard

Last modified by Dilisi S on 2025/04/23 19:23
From version 179.1
edited by Dilisi S
on 2025/03/27 01:21
Change comment: There is no comment for this version
To version 15.1
edited by Dilisi S
on 2025/03/03 02:41
Change comment: Uploaded new attachment "add-integration-connection.png", version {1}

Summary

Details

Page properties
Content
... ... @@ -2,600 +2,252 @@
2 2  
3 3  {{toc/}}
4 4  
5 -{{warning}}
6 -Draft Document
7 -{{/warning}}
8 8  
6 += Introduction =
9 9  
8 +This document guides you on integrating Dragino -NB and -CB series devices with ThingsBoard. For this guide, we use ThingsBoard Cloud, which is one of the ThingsBoard versions that allows you to try it for free.
10 10  
11 11  
12 -= 1. Introduction =
11 += Add New Device =
13 13  
13 +In the left navigation, click **Entities** and then click **Devices**.
14 14  
15 -This document guides you on integrating Dragino **-NB** and **-CB** series devices data with ThingsBoard. For this guide, we use ThingsBoard Cloud, which is one of the ThingsBoard versions that allows you to try it for free.
16 16  
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**.
16 +[[image:ThingsBoard-Device.png]]
18 18  
19 19  
20 -= 2. Prerequisites =
19 +On the ‘**Devices**’ page, click on the ‘**+**’ button, and then click on the ‘**Add new device**’ from the dropdown menu.
21 21  
22 -To complete this tutorial, you need to have the following:
23 23  
24 -* ThingsBoard cloud account
25 -* MQTT Broker (public or private) such as,
26 -** **[[HiveMQ Cloud>>https://www.hivemq.com]] - You can create a free account to try it or subscribe for a paid account. - We use HiveMQ Cloud as the MQTT broker to build example in this tutorial.**
27 -** [[emqx>>https://www.emqx.com/zh/mqtt/public-mqtt5-broker]] - The public MQTT server is only used for MOTT learning and testing, and should not be used in the production environment.
28 -** [[lns1.thingseye.io>>http://lns1.thingseye.io/]] - This is Dragino's MQTT broker, which requires a CA certificate to use.
22 +[[image:ThingsBoard-add-new-device.png||height="279" width="500"]]
29 29  
30 -== 2.1 ThingsBoard Cloud ==
31 31  
32 32  
33 -Go to [[https:~~/~~/thingsboard.io/>>https://thingsboard.io/]]
26 += Data Converters =
34 34  
35 -Click on the **Try it now**.
36 36  
29 +== Uplink ==
37 37  
38 -[[image:thingsboard-1.png]]
31 +In the left navigation, click ‘Integrations center’, and then click ‘Data converters’.
39 39  
40 40  
41 -Select either the **North America** or **Europe** region. Here, we use the Europe region.
34 +[[image:ThingsBoard-Data-Converters.png]]
42 42  
43 -[[image:thingsboard-2.png]]
44 44  
37 +On the ‘Data converters’ page, click on the ‘+’ button, and then click on the ‘Create new converter’ from the dropdown menu.
45 45  
46 -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**.
47 47  
48 -Click on the **Sign up** button.
40 +[[image:ThingsBoard-new-data-converter.png||height="282" width="500"]]
49 49  
50 -[[image:thingsboard-3.png||height="651" width="500"]]
51 51  
43 +The ‘Add data converter’ window will appear. Name it ‘**UDP Uplink Converter NB/CB**’ and select the Type as ‘Uplink’.
52 52  
53 -You will be navigated to the following page.
45 +Click on the ‘JavaScript’ button. Now copy and paste the following script to the ‘Decoder function’ section:
54 54  
55 -[[image:thingsboard-5.png||height="109" width="500"]]
56 -
57 -
58 -simultaneously, you will receive an email to confirm your email address. Click on the **Activate Your Account** button.
59 -
60 -
61 -[[image:thingsboard-4.png||height="249" width="500"]]
62 -
63 -
64 -Now losing to the account using your credentials:
65 -
66 -
67 -[[image:thingsboard-6.png||height="244" width="500"]]
68 -
69 -
70 -== 2.2 HiveMQ Cloud ==
71 -
72 -=== 2.2.1 HiveMQ Cloud ===
73 -
74 -
75 -Go to [[https:~~/~~/www.hivemq.com>>https://www.hivemq.com]]
76 -
77 -Click on the **Start Free** button.
78 -
79 -[[image:hivwmq-1.png]]
80 -
81 -
82 -Click on the **Sign Up FREE Now** button in the **HIVEMQ CLOUD** section.
83 -
84 -[[image:hivemq-2.png]]
85 -
86 -
87 -Click on the **Sign Up** button.
88 -
89 -You can sign up with HiveMQ using your **GitHub**, **Google**, or **LinkedIn** account.
90 -
91 -If not, provide your **email address** and a **password** to create an account by clicking on the **Sign Up** button.
92 -
93 -
94 -[[image:hivemq-3.png]]
95 -
96 -
97 -You will receive an email to verify your email address. Click on the **Confirm my account** button.
98 -
99 -
100 -[[image:hivemq-4.jpg||height="889" width="400"]]
101 -
102 -
103 -You will be redirected to a page asking you to complete your profile. Once done, click the **Continue** button.
104 -
105 -
106 -[[image:hivemq-5.png||height="655" width="700"]]
107 -
108 -
109 -Select the CloudMQ Cloud plan you need. For testing purposes, select the **Serverless FREE** plan by clicking on the **Create Serverless Cluster** button.
110 -
111 -
112 -[[image:hivemq-6.png]]
113 -
114 -
115 -You will be navigated to the **Your Clusters** page. Click on the **Manage Cluster** button.
116 -
117 -[[image:hivemq-7.png]]
118 -
119 -
120 -In your cluster page, you can find some useful parameters you need to create a MQTT connection.
121 -
122 -**URL**: This is the host name. Click on the copy button to copy it.
123 -
124 -**Port**: 8883
125 -
126 -
127 -Click on the **Getting Started** tab to setup the username and the password as the connection credentials.
128 -
129 -
130 -[[image:hivemq-8.png]]
131 -
132 -
133 -In the '**Create Connection Credentials**' section, provide a **username** and **password**, then click the **Add** button.
134 -
135 -
136 -[[image:hivemq-9.png]]
137 -
138 -
139 -
140 -If everything is successful, you will see the following message.
141 -
142 -
143 -[[image:hivemq-10.png||height="206" width="500"]]
144 -
145 -
146 -You will need these MQTT connection parameters when configuring the MQTT integration in the '**Add Integration**' section.
147 -
148 -
149 -=== 2.2.2 emqx ===
150 -
151 -
152 -The [[emqx>>https://www.emqx.com/zh/mqtt/public-mqtt5-broker]] public MQTT server is only used for MOTT learning and testing, and should not be used in the production environment.
153 -
154 -
155 -[[image:emqx.png||height="420" width="500"]]
156 -
157 -
158 -=== 2.2.3 Ins1.thingseye.io ===
159 -
160 -[[lns1.thingseye.io>>http://lns1.thingseye.io/]] is the Dragino's MQTT broker, which requires a CA certificate file, Certificate file, and the Private key file to use.
161 -
162 -If customers need to use this MQTT connection with ThingsBoard, they need to contact the TE team to obtain three license files.
163 -
164 -[[image:ins1.png||height="310" width="500"]]
165 -
166 -
167 -= 3. Creating Devices =
168 -
169 -
170 -First, you need to create devices in ThingsBoard to represent your physical devices. For example, you can name it **Device A**, and the second device could be **Device B** or any name you prefer. The device name should be unique within the **Devices** space.
171 -
172 -
173 -In the left navigation, click Entities -> Devices.
174 -
175 -Click the **Add Device** button (the button with the **+** sign), and from the dropdown menu, click **Add new device**.
176 -
177 -In the **Add new device** dialog box, enter the device name in the **Name** text box. For example, we will use **Device A**.
178 -
179 -Click the **Add** button.
180 -
181 -Skip the **connectivity testing** by clicking the **Close** button.
182 -
183 -The device is created and listed on the **Devices** page. Note that its initial state is **Inactive** because it has not received any data yet.
184 -
185 -
186 -= 4. Data Converters =
187 -
188 -
189 -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.
190 -
191 -
192 -== 4.1 Uplink ==
193 -
194 -
195 -In the left navigation, click **Integrations center**, and then click **Data converters**.
196 -
197 -
198 -[[image:data-converters-list-empty.png]]
199 -
200 -
201 -On the **Data converters** page, click on the ‘**+**’ button, and then click on the **Create new converter** from the dropdown menu.
202 -
203 -
204 -
205 -[[image:create-new-converter-menu.png||height="259" width="500"]]
206 -
207 -
208 -The **Add data converter** window will appear. Name it ‘**MQTT Uplink Converter NB/CB**’ and select the Type as **Uplink**.
209 -
210 -Click on the **TBEL** button if it has not been selected by default.
211 -
212 -Modify the default TBEL function to match with your device as described below:
213 -
214 -
215 -~1. Uncomment line 11:
216 -
217 -var data = decodeToJson(payload)
218 -
219 -[[image:Screenshot 2025-03-26 at 18.15.08.png||height="219" width="500"]]
220 -
221 -
222 -3. Modify the telemetry section to allow parsed data to be assigned to the fields.
223 -
224 -telemetry: {
225 - temperature: data.temperature,
226 - humidity: data.humidity,
227 - rawData: payloadStr
228 - }
229 -
230 -
231 -
232 232  {{code language="JavaScript"}}
233 -// Decode an uplink message from a buffer
234 -// payload - array of bytes
235 -// metadata - key/value object
236 -
237 -/** Decoder **/
238 -
48 +//Version: 0.1
239 239  // decode payload to string
240 240  var payloadStr = decodeToString(payload);
241 241  
242 242  // decode payload to JSON
53 +var objdata = {};
54 +var obj1 = {};
243 243  var data = decodeToJson(payload);
56 +var deviceName = data.IMEI;
57 +delete data.IMEI;
58 +var modelname = "Dragino " + data.Model;
59 +//var mod = data.mod
60 +delete data.Model;
61 +//delete data.mod
62 +var timestamp = new Date().getTime();
244 244  
245 -var deviceName = 'Device B';
246 -var deviceType = 'thermostat';
247 -var customerName = 'Customer C';
248 -var groupName = 'thermostat devices';
249 -var manufacturer = 'Example corporation';
250 -// use assetName and assetType instead of deviceName and deviceType
251 -// to automatically create assets instead of devices.
252 -// var assetName = 'Asset A';
253 -// var assetType = 'building';
64 +for (var key in data) {
65 +
66 + if (Number(key)) {
67 + obj1[key] = data[key];
68 + obj1[key][obj1[key].length - 1] = Number(new Date(
69 + obj1[key][obj1[key].length - 1]));
254 254  
255 -// Result object with device/asset attributes/telemetry data
71 + }
72 +//Alec submitted25/02/25
73 +//turn old key into new
74 + else if (key === "Reading") {
75 + objdata["reading"] = data[key];
76 + } else if (key === "work mode") {
77 + objdata["work_mode"] = data[key];
78 + } else if (key === "hum") {
79 + objdata["humidity"] = data[key];
80 + }else if (key === "hum2") {
81 + objdata["humidity2"] = data[key];
82 + } else if (key === "hum3") {
83 + objdata["humidity3"] = data[key];
84 + } else if (key === "tem") {
85 + objdata["temperature"] = data[key];
86 + } else if (key === "tem2") {
87 + objdata["temperature2"] = data[key];
88 + } else if (key === "tem3") {
89 + objdata["temperature3"] = data[key];
90 + } else if (key === "DS18B20_Temp") {
91 + objdata["temperature_pro"] = data[key];
92 + } else if (key === "ds18b20_temperature") {
93 + objdata["temperature_pro"] = data[key];
94 + } else if (key === "DS18B20_temperature_pro") {
95 + objdata["temperature_pro"] = data[key];
96 + } else if (key === "tdc send flag") {
97 + objdata["tdc_send_flag"] = data[key];
98 + } else if (key === "trigger mode") {
99 + objdata["trigger_mode"] = data[key];
100 + } else if (key === "soil dielectric constant") {
101 + objdata["soil_dielectric_constant"] = data[key];
102 + } else if (key === "door open num") {
103 + objdata["door_open_num"] = data[key];
104 + } else if (key === "door duration") {
105 + objdata["door_duration"] = data[key];
106 + } else if (key === "count time") {
107 + objdata["count_time"] = data[key];
108 + } else if (key === "last open time2") {
109 + objdata["last_open_time2"] = data[key];
110 + } else if (key === "last open time3") {
111 + objdata["last_open_time3"] = data[key];
112 + }
113 +//Alec submitted25/02/25
114 + else {
115 + objdata[key] = data[key]
116 + }
117 +}
118 +var listdata = [{
119 + "ts": timestamp,
120 + "values": objdata
121 +}]
122 +for (var key1 in obj1) {
123 + if (modelname == "Dragino RS485-NB") {
124 + listdata.push({
125 + "ts": obj1[key1][obj1[key1].length - 1],
126 + "values": {
127 + "Payload": obj1[key1][0],
128 + }
129 + })
130 + } else {
131 + listdata.push({
132 + "ts": obj1[key1][obj1[key1].length - 1],
133 + "values": {
134 + "values": obj1[key1]
135 + },
136 + })
137 + }
138 +}
256 256  var result = {
257 -// Use deviceName and deviceType or assetName and assetType, but not both.
258 - deviceName: deviceName,
259 - deviceType: deviceType,
260 -// assetName: assetName,
261 -// assetType: assetType,
262 -// customerName: customerName,
263 - groupName: groupName,
264 - attributes: {
265 - model: 'Model A',
266 - serialNumber: 'SN111',
267 - integrationName: metadata['integrationName'],
268 - manufacturer: manufacturer
269 - },
270 - telemetry: {
271 - temperature: data.temperature,
272 - humidity: data.humidity,
273 - rawData: payloadStr
274 - }
275 -};
276 276  
277 -/** Helper functions 'decodeToString' and 'decodeToJson' are already built-in **/
141 + deviceName: deviceName,
142 + deviceType: modelname,
143 + attributes: {
144 + model: modelname,
145 + //customerName: "NB-CB",
146 + //groupName: "NB-CB",
147 + //integrationName: metadata['integrationName']
278 278  
279 -return result;
280 -{{/code}}
149 + },
150 + telemetry: listdata
151 +}
281 281  
282 -We use the same decoder function for all our devices. However, you need to modify a few things for each device. Among these, **deviceName** is a **mandatory** field. You should assign a device name to the **deviceName** field that matches the name of your device in the **Devices** section.
153 +function decodeToString(payload) {
154 + return String.fromCharCode.apply(String, payload);
155 +}
283 283  
284 -For example, if your device name is **Device B**, you can change **Device A** to **Device B**.
157 +function decodeToJson(payload) {
158 + // covert payload to string.
159 + var str = decodeToString(payload);
285 285  
161 + // parse string to JSON
162 + var data = JSON.parse(str);
163 + return data;
164 +}
286 286  
287 -{{code language="JavaScript"}}
288 -var deviceName = 'Device A';
289 -var deviceType = 'thermostat';
290 -var customerName = 'Customer C';
291 -var groupName = 'thermostat devices';
292 -var manufacturer = 'Example corporation';
293 -{{/code}}
166 +return result;
294 294  
295 -
296 -Once you modify the decoder function, click on the **Add** button.
297 -
298 -
299 -[[image:mqtt-uplink.png||width="500"]]
300 -
301 -
302 -
303 -You should see that the newly added **MQTT Uplink converter **NB/CB is listed on the **Data Converters** page.
304 -
305 -
306 -[[image:data-converter-list-showing-uplink-dc.png]]
307 -
308 -
309 -= 5. Add Integration =
310 -
311 -
312 -In the left navigation, click **Integrations center**, and then click **Integrations**.
313 -
314 -
315 -[[image:integrations-list-empty.png]]
316 -
317 -
318 -On the **Integrations** page, click on the '**+**' button.
319 -
320 -
321 -The **Add integration** window appears.
322 -
323 -In the **Add integration** window, configure the following settings:
324 -
325 -
326 -**Basic settings:**
327 -
328 -* **Integration type**: MQTT
329 -* **Name**: MQTT integration NB/CB
330 -* **Enable integration**: YES
331 -* **Allows create devices or assets**: YES
332 -
333 -Click **Next** button.
334 -
335 -
336 -[[image:add-integration-basic-settings.png||height="511" width="500"]]
337 -
338 -
339 -**Uplink data converter:**
340 -
341 -* Click on the **Select existing** button.
342 -* **Uplink data converter**: Select **MQTT Uplink Converter NB/CB **from the dropdown list.
343 -
344 -Click **Next** button.
345 -
346 -
347 -[[image:add-integration-uplink-data-converter.png||height="511" width="500"]]
348 -
349 -
350 -**Downlink data converter:**
351 -
352 -Dragino NB/CB devices don't require a downlink data converter to decode their payloads, so you can skip this step.
353 -
354 -* Click on the **Skip **button in the Downlink data converter section.
355 -
356 -Click **Skip** button.
357 -
358 -
359 -[[image:integration-dl-skip.png||height="511" width="500"]]
360 -
361 -
362 -
363 -**Connection:**
364 -
365 -* **Host**: Cluster URL (Eg. **//011731f7xxxxxxxxxxxfbbedfc63f4.s1.eu.hivemq.cloud//**)
366 -* **Port**: 8883
367 -* **Credentials**: Basic
368 -* **Enable SSL**: YES
369 -* **Username**: Username (from your HiveMQ Cloud Cluster with your credentials)
370 -* **Password:** Password (from your HiveMQ Cloud Cluster with your credentials)
371 -* **Topic: v1/devices/me/telemetry** (The topic can be anything; you can even use just the device name. For example, you can use your device name here, such as devices/a/telemetry.)
372 -* **QoS:** 0-At most once
373 -
374 -[[image:add-integration-connection.png||height="511" width="500"]]
375 -
376 -
377 -Click on the **Advanced settings** button.
378 -
379 -* **Clean session:** YES
380 -* **Retained**: YES
381 -
382 -[[image:add-integration-connection-advanced-settings.png||height="510" width="500"]]
383 -
384 -
385 -Click on the **Check connection** button to verify the MQTT connection using the provided parameters.
386 -
387 -
388 -[[image:check-connection.png||height="83" width="300"]]
389 -
390 -
391 -If the connection is successful, you will see the **Connected** message. If not, check your connection parameters again.
392 -
393 -
394 -[[image:connection-success.png||height="511" width="500"]]
395 -
396 -
397 -Click on the **Add** button.
398 -
399 -You should see that the newly added integration is listed on the **Integrations** page.
400 -
401 -Since we haven't received data from a device yet, the integration **Status** is shown as **Pending.**
402 -
403 -
404 -[[image:new-integration-pending.png]]
405 -
406 -
407 -= 6. Verifying the receipt of data from virtual devices =
408 -
409 -
410 -== 6.1 How does it work? ==
411 -
412 -
413 -We use the Mosquitto MQTT client to simulate MQTT messages, acting as a virtual device. First, install the Mosquitto client on your computer from [[this link>>url:https://mosquitto.org/download/]]. The Mosquitto client publishes messages to the MQTT broker (HiveMQ) on a specified MQTT topic. ThingsBoard subscribes to these messages using the same topic.
414 -
415 -The Mosquitto client publishes messages (payloads) on the topic **v1/devices/me/telemetry**. Of course, you can use any topic for testing.
416 -
417 -(% id="cke_bm_37386S" style="display:none" %) (%%)The MQTT payload format is as follows, which is common for all **~-~-NB** and **~-~-CB** series devices. The **IMEI** field is mandatory and is used to provision a new device with the name assigned to it in ThingsBoard.
418 -
419 -{{code language="none"}}
420 -{"IMEI": "S31B-NB", "temperature": 27, ......}
421 421  {{/code}}
422 422  
423 -Once ThingsBoard receives this message, it automatically creates (provisions) the device mentioned in the **IMEI**, for example, S31B-NB.
170 +Click on the ‘Add’ button.
424 424  
425 425  
426 -== 5.2 Sending messages ==
173 +[[image:ThingsBoard-add-data-converter-uplink.png||width="500"]]
427 427  
428 428  
429 -On the terminal, issue the following MQTT command which simulates the device S31B-NB. The message payload contains the fields temperature and humidity, which hold the values S31B-NB and 27, respectively. This payload is also (technically) known as telemetry.
176 +The uplink data converter is added to ThingsBoard and appears on the ‘Data Converters’ page
430 430  
431 -{{code language="none"}}
432 -mosquitto_pub -d -q 1 -h 011731f7928xxxxx.s1.eu.hivemq.cloud -p 8883 -t "v1/devices/me/telemetry" -u "xxxxx" -P "xxxxx" -m '{"IMEI": "S31B-NB", "temperature": 27}'
433 -{{/code}}
434 434  
435 -If the integration was performed without errors, the status of the integration changes to 'Active' after the first telemetry transmission.
179 +== Downlink ==
436 436  
181 +On the ‘Data converters’ page, click on the ‘+’ button, and then click on the ‘Create new converter’ from the dropdown menu.
437 437  
438 -[[image:integration-active.png]]
439 439  
184 +[[image:ThingsBoard-new-data-converter.png||height="282" width="500"]]
440 440  
441 -Also, a new device named **S31B-NB** will appear under **//Entities -> Devices -> All//**. This means the first MQTT message triggers ThingsBoard to provision a device named **S31B-NB**.
442 442  
187 +The ‘**Add data converter**’ window will appear. Name it ‘**UDP Downlink Converter NB/CB**’ and select the Type as ‘**Downlink**’.
443 443  
444 -[[image:new-device.png]]
189 +Click on the ‘**JavaScript**’ button. Now copy and paste the following script to the ‘**Encoder function**’ section:
445 445  
446 446  
447 -== 6.3 Viewing messages ==
448 -
449 -
450 -Go back to the **Integrations** page.
451 -
452 -Click on the **MQTT integration NB/CB** in the **Integrations** page to see its details.
453 -
454 -Click on the **Edit** button (//**pen icon**//).
455 -
456 -Click on the **Disabled** button in the upper-right corner.
457 -
458 -Turn on the **All messages (15 min)** option. This will enable displaying all messages in the **Events** tab. This setting will expire in 15 minutes, and you will need to repeat the same steps if you want to view the messages in the Events tab later.
459 -
460 -Click on the **Apply** button.
461 -
462 -Then click on the **Apply changes** (//**tick icon**//) button.
463 -
464 -
465 -[[image:Screenshot 2025-03-18 at 09.23.10.png]]
466 -
467 -
468 -Now go to the **Events** tab.
469 -
470 -Select the Event type as **Debug** from the dropdown list.
471 -
472 -Now you can see all the Uplink messages you are simulating through the MQTT broker. The status should be OK if there is no errors in your integration.
473 -
474 -
475 -[[image:Screenshot 2025-03-16 at 18.38.59.png]]
476 -
477 -
478 -Then click on the **three dots (...)** in the **Message** column. You can see the uplink message's **payload** in the **Message** window.
479 -
480 -
481 -[[image:Screenshot 2025-03-16 at 18.39.12.png]]
482 -
483 -
484 -Now, you have successfully tested your integration with a simulated uplink payload and verified that it is received by ThingsBoard, and the device is provisioned.
485 -
486 -
487 -= 7. Creating a Dashboard =
488 -
489 -ThingsBoard **Dashboards** provide a powerful way to visualize and monitor real-time and historical data from connected devices. They allow users to create interactive, customizable panels displaying telemetry data, device status, and other key metrics. With a variety of widgets, including charts, maps, and tables, dashboards help users gain insights, track trends, and manage IoT deployments efficiently.
490 -
491 -
492 -This section guides you on how to create a dashboard to display temperature and humidity data from the device on a time-series chart. You may also use other widgets in ThingsBoard to display data according to your requirements.
493 -
494 -
495 -First simulate a few messages using MQTT. This time, we have added the 'humidity' field to the payload. Eg:
496 -
497 -{{code language="none"}}mosquitto_pub -d -q 1 -h 011731f7928xxxxx.s1.eu.hivemq.cloud -p 8883 -t "v1/devices/me/telemetry" -u "xxxxx" -P "xxxxx" -m '{"IMEI": "S31B-NB", "temperature": 22, "humidity":80}'{{/code}}
192 +{{code language="JavaScript"}}
193 +function hexToBase64(hexString) {
194 + // 将16进制字符串两个字符转换为一个字节
195 + var bytes = hexString.match(/.{2}/g);
196 + // 对每个字节进行解析，并转换为对应的字符
197 + var binaryString = bytes.map(function(byte) {
198 + return String.fromCharCode(parseInt(byte, 16));
199 + }).join('');
498 498  
201 + // 使用btoa进行base64编码
202 + return btoa(binaryString);
203 +}
499 499  
500 -In **ThingsBoard**, from the left navigation menu, click **Dashboards**. Then, click the **+** button and select **Create new dashboard** from the dropdown menu.
205 +// Result object with encoded downlink payload
206 +var result = {
207 + // downlink data content type: JSON, TEXT or BINARY (base64 format)
208 + contentType: "BINARY",
501 501  
210 + // downlink data
211 + data:hexToBase64(metadata.shared_value)
502 502  
503 -[[image:dashboard-1.png]]
213 + // Optional metadata object presented in key/value format
214 + //metadata: {}
504 504  
216 +};
505 505  
506 -In the **Title** text box, enter **NB/CB Test Dashboard** as the title of the dashboard.
218 +return result;
219 +{{/code}}
507 507  
221 +
508 508  Click on the **Add** button.
509 509  
510 510  
511 -[[image:dashboard-2.png||height="526" width="500"]]
225 +[[image:ThingsBoard-add-data-converter-downlink.png||height="532" width="500"]]
512 512  
513 513  
514 -Click on the **Add widget / Add new widget** button.
228 += Add Integration =
515 515  
230 +In the left navigation, click ‘Integrations center’, and then click ‘Integrations’.
516 516  
517 -[[image:dashboard-3.png]]
232 +On the ‘Integrations’ page, click on the “+” button.
518 518  
519 519  
520 -In the **Select widgets bundle** window, click **Charts**.
235 +[[image:ThingsBoard-add-integration.png]]
521 521  
522 522  
523 -[[image:dashboard-4.png||height="537" width="700"]]
238 +The ‘Add integration’ window appears.
524 524  
240 +In the Add Integration window, configure the following settings:
525 525  
242 +**Basic settings:**
526 526  
527 -In the **Charts: select widget** window, click **Time series chart**.
244 +* **Integration type**: UDP
245 +* **Name**: UDP Integration NB/CB
528 528  
247 +Click **Next** button.
529 529  
530 -[[image:dashboard-5.png||height="525" width="700"]]
531 531  
532 532  
533 -Configure the **Time series chart** widget as follows:
534 534  
535 -* **Datasource** - select S31B-NB device you provisioned.
536 -* **Series**:
537 -** **temperature** - you can see this key by default.
538 -** **humidity** - Click **Add series** button. Then add the **humidity** for the key and then type **%** as its unit.
539 -* Click on the **Add** button.
540 540  
541 -[[image:timeseries-1.png||height="491" width="700"]]
542 -
543 -
544 -The time-series chart will appear in edit mode. Resize it by clicking and dragging the lower-right corner.
545 -
546 -Click the **Save** button to add the widget to the dashboard.
547 -
548 -
549 -[[image:timeseries-3.png||height="347" width="700"]]
550 -
551 -
552 -Now send the following MQTT messages from the terminal to simulate the data.
553 -
554 -
555 -{{code language="none"}}
556 -mosquitto_pub -d -q 1 -h 011731f7928xxxxx.s1.eu.hivemq.cloud -p 8883 -t "v1/devices/me/telemetry" -u "xxxxx" -P "xxxxx" -m '{"IMEI": "S31B-NB", "temperature": 22, "humidity":70}'
557 -
558 -mosquitto_pub -d -q 1 -h 011731f7928xxxxx.s1.eu.hivemq.cloud -p 8883 -t "v1/devices/me/telemetry" -u "xxxxx" -P "xxxxx" -m '{"IMEI": "S31B-NB", "temperature": 27, "humidity":72}'
559 -
560 -mosquitto_pub -d -q 1 -h 011731f7928xxxxx.s1.eu.hivemq.cloud -p 8883 -t "v1/devices/me/telemetry" -u "xxxxx" -P "xxxxx" -m '{"IMEI": "S31B-NB", "temperature": 19, "humidity":80}'
561 -
562 -{{/code}}
563 -
564 -The chart will update with the values in realtime, as shown in the below image.
565 -
566 -
567 -[[image:timeseries-4.png||height="316" width="700"]]
568 -
569 -
570 -= 8. Configure NB-IoT Sensor =
571 -
572 -
573 -Now, let's experiment with sending data to ThingsBoard using a real NB-IoT device. For example, we will use the **TS01-NB**.
574 -
575 -First, configure the NB-IoT device with the necessary MQTT settings using AT commands. Below is a list of AT commands you can use.
576 -
577 -
578 -**AT Commands**
579 -
580 -* **AT+PRO=3,3    **~/~/ Use MQTT to connect to ThingsBoard. Payload Type set to 3.
581 -* **AT+SUBTOPIC=<MQTT subscribe topic> Eg: TS01-NB**
582 -* **AT+PUBTOPIC=<MQTT publish topic> Eg: TS01-NB**
583 -* **AT+CLIENT=null**
584 -* **AT+UNAME=<MQTT Username>**
585 -* **AT+PWD=<MQTT Password>**
586 -* **AT+SERVADDR=<Broker address, Port>**
587 -
588 -Test your uplink by pressing the ACT button for 1 second.
589 589  
590 -
591 -
592 -The following image shows the uplink payload of a real Dragino device. The publish topic is **TS01-NB**, and the device name is **861275077962896**, which is represented by the **IMEI**.
593 -
594 -{{info}}
595 -The ThingsBoard uses the device's IMEI number included in the payload to create a device in the Devices section.
596 -{{/info}}
597 -
598 -[[image:image-4.png]]
599 -
600 -
601 -
Screenshot 2025-03-16 at 18.38.59.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -221.2 KB
Content
Screenshot 2025-03-16 at 18.39.12.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -211.9 KB
Content
Screenshot 2025-03-18 at 09.23.10.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -78.7 KB
Content
Screenshot 2025-03-26 at 18.15.08.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -92.2 KB
Content
add-downlink-data-converter.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -175.2 KB
Content
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
Size
... ... @@ -1,1 +1,1 @@
1 -158.1 KB
1 +124.4 KB
Content
add-uplink-data-converter.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -174.1 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
create-new-converter-menu.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -31.5 KB
Content
dashboard-1.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -271.1 KB
Content
dashboard-2.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -112.2 KB
Content
dashboard-3.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -141.3 KB
Content
dashboard-4.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -803.7 KB
Content
dashboard-5.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -476.1 KB
Content
data-converter-list-showing-uplink-dc.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -194.9 KB
Content
data-converters-list-empty.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -260.7 KB
Content
data-converters-list.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -212.2 KB
Content
device-provision-1.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -265.7 KB
Content
device-provision-2.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -213.9 KB
Content
emqx.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -39.1 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
image-4.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -96.0 KB
Content
ins1.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -28.8 KB
Content
integration-active.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -64.2 KB
Content
integration-dl-skip.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -105.5 KB
Content
integrations-list-empty.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -264.5 KB
Content
mqtt-uplink.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -175.1 KB
Content
new-device.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -143.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
telemetry-1.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -191.9 KB
Content
telemetry-2.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -185.1 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
thingsboard-4.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -122.1 KB
Content
thingsboard-5.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -106.7 KB
Content
thingsboard-6.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -119.3 KB
Content
timeseries-1.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -179.1 KB
Content
timeseries-3.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -174.2 KB
Content
timeseries-4.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -159.0 KB
Content
ThingsBoard-Data-Converters.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +100.3 KB
Content
ThingsBoard-Device.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +225.5 KB
Content
ThingsBoard-add-data-converter-downlink.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +128.6 KB
Content
ThingsBoard-add-data-converter-uplink.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +128.6 KB
Content
ThingsBoard-add-data-converter.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +128.6 KB
Content
ThingsBoard-add-integration.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +128.6 KB
Content
ThingsBoard-add-new-device.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +89.7 KB
Content
ThingsBoard-new-data-converter.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +100.3 KB
Content