Wiki source code of ThingsBoard
Hide last authors
author | version | line-number | content |
---|---|---|---|
![]() |
1.1 | 1 | **Table of Contents:** |
2 | |||
3 | {{toc/}} | ||
4 | |||
![]() |
16.1 | 5 | {{warning}} |
6 | Draft Document | ||
7 | {{/warning}} | ||
![]() |
1.1 | 8 | |
![]() |
65.1 | 9 | |
10 | |||
11 | |||
![]() |
64.2 | 12 | = 1. Introduction = |
![]() |
1.1 | 13 | |
![]() |
64.2 | 14 | |
![]() |
21.1 | 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. |
![]() |
2.1 | 16 | |
![]() |
21.1 | 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**. |
![]() |
11.1 | 18 | |
![]() |
17.1 | 19 | |
![]() |
117.1 | 20 | = 2. Prerequisites = |
![]() |
11.1 | 21 | |
![]() |
117.1 | 22 | To complete this tutorial, you need to have the following: |
![]() |
64.2 | 23 | |
![]() |
121.1 | 24 | * ThingsBoard cloud account |
![]() |
155.1 | 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. | ||
![]() |
59.1 | 29 | |
![]() |
121.1 | 30 | == 2.1 ThingsBoard Cloud == |
![]() |
117.1 | 31 | |
32 | |||
![]() |
125.1 | 33 | Go to [[https:~~/~~/thingsboard.io/>>https://thingsboard.io/]] |
![]() |
121.1 | 34 | |
![]() |
125.1 | 35 | Click on the **Try it now**. |
36 | |||
37 | |||
38 | [[image:thingsboard-1.png]] | ||
39 | |||
40 | |||
41 | Select either the **North America** or **Europe** region. Here, we use the Europe region. | ||
42 | |||
43 | [[image:thingsboard-2.png]] | ||
44 | |||
45 | |||
![]() |
129.1 | 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**. |
![]() |
125.1 | 47 | |
![]() |
129.1 | 48 | Click on the **Sign up** button. |
49 | |||
![]() |
125.1 | 50 | [[image:thingsboard-3.png||height="651" width="500"]] |
51 | |||
52 | |||
![]() |
129.1 | 53 | You will be navigated to the following page. |
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 | |||
![]() |
121.1 | 70 | == 2.2 HiveMQ Cloud == |
71 | |||
![]() |
155.1 | 72 | === 2.2.1 HiveMQ Cloud === |
![]() |
121.1 | 73 | |
![]() |
155.1 | 74 | |
![]() |
117.1 | 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 | |||
![]() |
121.1 | 127 | Click on the **Getting Started** tab to setup the username and the password as the connection credentials. |
![]() |
117.1 | 128 | |
129 | |||
130 | [[image:hivemq-8.png]] | ||
131 | |||
132 | |||
![]() |
121.1 | 133 | In the '**Create Connection Credentials**' section, provide a **username** and **password**, then click the **Add** button. |
![]() |
117.1 | 134 | |
![]() |
11.1 | 135 | |
![]() |
121.1 | 136 | [[image:hivemq-9.png]] |
![]() |
11.1 | 137 | |
![]() |
121.1 | 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 | |||
![]() |
155.1 | 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 | |||
![]() |
176.1 | 167 | (% class="wikigeneratedid" %) |
168 | = 3. Creating Devices = | ||
![]() |
121.1 | 169 | |
170 | |||
![]() |
176.1 | 171 | 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. |
172 | |||
173 | |||
174 | In the left navigation, click Entities -> Devices. | ||
175 | |||
176 | Click the **Add Device** button (the button with the **+** sign), and from the dropdown menu, click **Add new device**. | ||
177 | |||
178 | In the **Add new device** dialog box, enter the device name in the **Name** text box. For example, we will use **Device A**. | ||
179 | |||
180 | Click the **Add** button. | ||
181 | |||
182 | Skip the **connectivity testing** by clicking the **Close** button. | ||
183 | |||
184 | 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. | ||
185 | |||
186 | |||
187 | = 4. Data Converters = | ||
188 | |||
189 | |||
![]() |
93.1 | 190 | 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. |
![]() |
11.1 | 191 | |
192 | |||
![]() |
176.1 | 193 | == 4.1 Uplink == |
![]() |
11.1 | 194 | |
195 | |||
![]() |
93.1 | 196 | In the left navigation, click **Integrations center**, and then click **Data converters**. |
![]() |
11.1 | 197 | |
![]() |
59.1 | 198 | |
![]() |
93.1 | 199 | [[image:data-converters-list-empty.png]] |
![]() |
59.1 | 200 | |
201 | |||
![]() |
93.1 | 202 | On the **Data converters** page, click on the ‘**+**’ button, and then click on the **Create new converter** from the dropdown menu. |
![]() |
59.1 | 203 | |
204 | |||
205 | |||
![]() |
93.1 | 206 | [[image:create-new-converter-menu.png||height="259" width="500"]] |
![]() |
59.1 | 207 | |
208 | |||
![]() |
36.1 | 209 | The **Add data converter** window will appear. Name it ‘**MQTT Uplink Converter NB/CB**’ and select the Type as **Uplink**. |
![]() |
11.1 | 210 | |
![]() |
157.1 | 211 | Click on the **JavaScript** button. |
![]() |
11.1 | 212 | |
![]() |
157.1 | 213 | Delete the default decoder function in the code editor. Now copy and paste the following decoder function written in **JavaScript** in to the **code editor**. This decoder function is compatible for both NB and CB series devices. |
214 | |||
![]() |
175.1 | 215 | {{info}} |
216 | Please note that the value assigned to the IMEI field in the payload will be used by ThingsBoard to create a device on the platform with the same name. | ||
217 | {{/info}} | ||
![]() |
157.1 | 218 | |
![]() |
11.1 | 219 | {{code language="JavaScript"}} |
![]() |
157.1 | 220 | //Version: 0.1 |
![]() |
11.1 | 221 | // decode payload to string |
222 | var payloadStr = decodeToString(payload); | ||
223 | |||
224 | // decode payload to JSON | ||
![]() |
157.1 | 225 | var objdata = {}; |
226 | var obj1 = {}; | ||
227 | var data = decodeToJson(payload); | ||
228 | var deviceName = data.IMEI; | ||
229 | delete data.IMEI; | ||
230 | var modelname = "Dragino " + data.Model; | ||
231 | //var mod = data.mod | ||
232 | delete data.Model; | ||
233 | //delete data.mod | ||
234 | var timestamp = new Date().getTime(); | ||
![]() |
11.1 | 235 | |
![]() |
157.1 | 236 | for (var key in data) { |
237 | |||
238 | if (Number(key)) { | ||
239 | obj1[key] = data[key]; | ||
240 | obj1[key][obj1[key].length - 1] = Number(new Date( | ||
241 | obj1[key][obj1[key].length - 1])); | ||
242 | |||
243 | } | ||
244 | //Alec submitted25/02/25 | ||
245 | //turn old key into new | ||
246 | else if (key === "Reading") { | ||
247 | objdata["reading"] = data[key]; | ||
248 | } else if (key === "work mode") { | ||
249 | objdata["work_mode"] = data[key]; | ||
250 | } else if (key === "hum") { | ||
251 | objdata["humidity"] = data[key]; | ||
252 | }else if (key === "hum2") { | ||
253 | objdata["humidity2"] = data[key]; | ||
254 | } else if (key === "hum3") { | ||
255 | objdata["humidity3"] = data[key]; | ||
256 | } else if (key === "tem") { | ||
257 | objdata["temperature"] = data[key]; | ||
258 | } else if (key === "tem2") { | ||
259 | objdata["temperature2"] = data[key]; | ||
260 | } else if (key === "tem3") { | ||
261 | objdata["temperature3"] = data[key]; | ||
262 | } else if (key === "DS18B20_Temp") { | ||
263 | objdata["temperature_pro"] = data[key]; | ||
264 | } else if (key === "ds18b20_temperature") { | ||
265 | objdata["temperature_pro"] = data[key]; | ||
266 | } else if (key === "DS18B20_temperature_pro") { | ||
267 | objdata["temperature_pro"] = data[key]; | ||
268 | } else if (key === "tdc send flag") { | ||
269 | objdata["tdc_send_flag"] = data[key]; | ||
270 | } else if (key === "trigger mode") { | ||
271 | objdata["trigger_mode"] = data[key]; | ||
272 | } else if (key === "soil dielectric constant") { | ||
273 | objdata["soil_dielectric_constant"] = data[key]; | ||
274 | } else if (key === "door open num") { | ||
275 | objdata["door_open_num"] = data[key]; | ||
276 | } else if (key === "door duration") { | ||
277 | objdata["door_duration"] = data[key]; | ||
278 | } else if (key === "count time") { | ||
279 | objdata["count_time"] = data[key]; | ||
280 | } else if (key === "last open time2") { | ||
281 | objdata["last_open_time2"] = data[key]; | ||
282 | } else if (key === "last open time3") { | ||
283 | objdata["last_open_time3"] = data[key]; | ||
284 | } | ||
285 | //Alec submitted25/02/25 | ||
286 | else { | ||
287 | objdata[key] = data[key] | ||
288 | } | ||
289 | } | ||
290 | var listdata = [{ | ||
291 | "ts": timestamp, | ||
292 | "values": objdata | ||
293 | }] | ||
294 | for (var key1 in obj1) { | ||
295 | if (modelname == "Dragino RS485-NB") { | ||
296 | listdata.push({ | ||
297 | "ts": obj1[key1][obj1[key1].length - 1], | ||
298 | "values": { | ||
299 | "Payload": obj1[key1][0], | ||
300 | } | ||
301 | }) | ||
302 | } else { | ||
303 | listdata.push({ | ||
304 | "ts": obj1[key1][obj1[key1].length - 1], | ||
305 | "values": { | ||
306 | "values": obj1[key1] | ||
307 | }, | ||
308 | }) | ||
309 | } | ||
310 | } | ||
![]() |
11.1 | 311 | var result = { |
![]() |
157.1 | 312 | |
![]() |
11.1 | 313 | deviceName: deviceName, |
![]() |
157.1 | 314 | deviceType: modelname, |
![]() |
11.1 | 315 | attributes: { |
![]() |
157.1 | 316 | model: modelname, |
317 | //customerName: "NB-CB", | ||
318 | //groupName: "NB-CB", | ||
319 | //integrationName: metadata['integrationName'] | ||
320 | |||
![]() |
11.1 | 321 | }, |
![]() |
157.1 | 322 | telemetry: listdata |
323 | } | ||
![]() |
11.1 | 324 | |
![]() |
157.1 | 325 | function decodeToString(payload) { |
326 | return String.fromCharCode.apply(String, payload); | ||
327 | } | ||
![]() |
11.1 | 328 | |
![]() |
157.1 | 329 | function decodeToJson(payload) { |
330 | // covert payload to string. | ||
331 | var str = decodeToString(payload); | ||
332 | |||
333 | // parse string to JSON | ||
334 | var data = JSON.parse(str); | ||
335 | return data; | ||
336 | } | ||
337 | |||
![]() |
11.1 | 338 | return result; |
339 | {{/code}} | ||
340 | |||
![]() |
64.2 | 341 | |
![]() |
21.1 | 342 | Click on the **Add** button. |
![]() |
11.1 | 343 | |
344 | |||
![]() |
157.1 | 345 | [[image:mqtt-uplink.png||width="500"]] |
![]() |
11.1 | 346 | |
347 | |||
![]() |
93.1 | 348 | |
349 | You should see that the newly added **MQTT Uplink converter **NB/CB is listed on the **Data Converters** page. | ||
350 | |||
![]() |
157.1 | 351 | |
![]() |
105.1 | 352 | [[image:data-converter-list-showing-uplink-dc.png]] |
![]() |
21.1 | 353 | |
354 | |||
![]() |
176.1 | 355 | = 5. Add Integration = |
![]() |
93.1 | 356 | |
357 | |||
![]() |
21.1 | 358 | In the left navigation, click **Integrations center**, and then click **Integrations**. |
![]() |
11.1 | 359 | |
![]() |
105.1 | 360 | |
361 | [[image:integrations-list-empty.png]] | ||
362 | |||
363 | |||
![]() |
21.1 | 364 | On the **Integrations** page, click on the '**+**' button. |
![]() |
11.1 | 365 | |
366 | |||
![]() |
21.1 | 367 | The **Add integration** window appears. |
![]() |
11.1 | 368 | |
![]() |
24.1 | 369 | In the **Add integration** window, configure the following settings: |
![]() |
11.1 | 370 | |
![]() |
21.1 | 371 | |
![]() |
11.1 | 372 | **Basic settings:** |
373 | |||
![]() |
49.1 | 374 | * **Integration type**: MQTT |
375 | * **Name**: MQTT integration NB/CB | ||
![]() |
105.1 | 376 | * **Enable integration**: YES |
377 | * **Allows create devices or assets**: YES | ||
![]() |
11.1 | 378 | |
379 | Click **Next** button. | ||
380 | |||
![]() |
105.1 | 381 | |
![]() |
16.1 | 382 | [[image:add-integration-basic-settings.png||height="511" width="500"]] |
![]() |
11.1 | 383 | |
384 | |||
![]() |
16.1 | 385 | **Uplink data converter:** |
![]() |
11.1 | 386 | |
![]() |
21.1 | 387 | * Click on the **Select existing** button. |
![]() |
49.1 | 388 | * **Uplink data converter**: Select **MQTT Uplink Converter NB/CB **from the dropdown list. |
![]() |
16.1 | 389 | |
390 | Click **Next** button. | ||
391 | |||
392 | |||
![]() |
105.1 | 393 | [[image:add-integration-uplink-data-converter.png||height="511" width="500"]] |
394 | |||
395 | |||
![]() |
16.1 | 396 | **Downlink data converter:** |
397 | |||
![]() |
172.1 | 398 | Dragino NB/CB devices don't require a downlink data converter to decode their payloads, so you can skip this step. |
![]() |
16.1 | 399 | |
![]() |
172.1 | 400 | * Click on the **Skip **button in the Downlink data converter section. |
![]() |
16.1 | 401 | |
![]() |
172.1 | 402 | Click **Skip** button. |
![]() |
16.1 | 403 | |
![]() |
105.1 | 404 | |
![]() |
172.1 | 405 | [[image:integration-dl-skip.png||height="511" width="500"]] |
![]() |
105.1 | 406 | |
![]() |
172.1 | 407 | |
408 | |||
![]() |
16.1 | 409 | **Connection:** |
410 | |||
![]() |
157.1 | 411 | * **Host**: Cluster URL (Eg. 011731f7xxxxxxxxxxxfbbedfc63f4.s1.eu.hivemq.cloud) |
![]() |
93.1 | 412 | * **Port**: 8883 |
![]() |
49.1 | 413 | * **Credentials**: Basic |
![]() |
93.1 | 414 | * **Enable SSL**: YES |
415 | * **Username**: Username (from your HiveMQ Cloud Cluster with your credentials) | ||
416 | * **Password:** Password (from your HiveMQ Cloud Cluster with your credentials) | ||
![]() |
175.1 | 417 | * **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 S31B-NB.) |
![]() |
93.1 | 418 | * **QoS:** 0-At most once |
![]() |
105.1 | 419 | |
![]() |
175.1 | 420 | |
![]() |
105.1 | 421 | [[image:add-integration-connection.png||height="511" width="500"]] |
422 | |||
423 | |||
424 | Click on the **Advanced settings** button. | ||
425 | |||
![]() |
151.1 | 426 | * **Clean session:** YES |
427 | * **Retained**: YES | ||
![]() |
16.1 | 428 | |
![]() |
105.1 | 429 | [[image:add-integration-connection-advanced-settings.png||height="510" width="500"]] |
430 | |||
431 | |||
![]() |
49.1 | 432 | Click on the **Check connection** button to verify the MQTT connection using the provided parameters. |
![]() |
16.1 | 433 | |
![]() |
49.1 | 434 | |
![]() |
105.1 | 435 | [[image:check-connection.png||height="83" width="300"]] |
436 | |||
437 | |||
![]() |
117.1 | 438 | If the connection is successful, you will see the **Connected** message. If not, check your connection parameters again. |
![]() |
49.1 | 439 | |
![]() |
105.1 | 440 | |
441 | [[image:connection-success.png||height="511" width="500"]] | ||
442 | |||
443 | |||
![]() |
16.1 | 444 | Click on the **Add** button. |
445 | |||
![]() |
59.1 | 446 | You should see that the newly added integration is listed on the **Integrations** page. |
![]() |
49.1 | 447 | |
![]() |
59.1 | 448 | Since we haven't received data from a device yet, the integration **Status** is shown as **Pending.** |
![]() |
49.1 | 449 | |
450 | |||
![]() |
117.1 | 451 | [[image:new-integration-pending.png]] |
452 | |||
453 | |||
![]() |
176.1 | 454 | = 6. Verifying the receipt of data from virtual devices = |
![]() |
49.1 | 455 | |
![]() |
16.1 | 456 | |
![]() |
176.1 | 457 | == 6.1 How does it work? == |
![]() |
64.1 | 458 | |
![]() |
141.1 | 459 | |
![]() |
130.1 | 460 | 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. |
461 | |||
![]() |
159.1 | 462 | The Mosquitto client publishes messages (payloads) on the topic **v1/devices/me/telemetry**. Of course, you can use any topic for testing. |
![]() |
130.1 | 463 | |
![]() |
159.1 | 464 | (% 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. |
![]() |
130.1 | 465 | |
![]() |
64.1 | 466 | {{code language="none"}} |
![]() |
159.1 | 467 | {"IMEI": "S31B-NB", "temperature": 27, ......} |
![]() |
64.1 | 468 | {{/code}} |
469 | |||
![]() |
159.1 | 470 | Once ThingsBoard receives this message, it automatically creates (provisions) the device mentioned in the **IMEI**, for example, S31B-NB. |
![]() |
130.1 | 471 | |
![]() |
159.1 | 472 | |
![]() |
130.1 | 473 | == 5.2 Sending messages == |
474 | |||
475 | |||
![]() |
161.1 | 476 | 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. |
![]() |
130.1 | 477 | |
478 | {{code language="none"}} | ||
![]() |
161.1 | 479 | 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}' |
![]() |
130.1 | 480 | {{/code}} |
481 | |||
![]() |
141.1 | 482 | If the integration was performed without errors, the status of the integration changes to 'Active' after the first telemetry transmission. |
483 | |||
484 | |||
485 | [[image:integration-active.png]] | ||
486 | |||
487 | |||
488 | 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**. | ||
489 | |||
490 | |||
![]() |
161.1 | 491 | [[image:new-device.png]] |
![]() |
141.1 | 492 | |
![]() |
161.1 | 493 | |
![]() |
176.1 | 494 | == 6.3 Viewing messages == |
![]() |
141.1 | 495 | |
496 | |||
![]() |
167.1 | 497 | Go back to the **Integrations** page. |
![]() |
141.1 | 498 | |
![]() |
167.1 | 499 | Click on the **MQTT integration NB/CB** in the **Integrations** page to see its details. |
![]() |
141.1 | 500 | |
![]() |
167.1 | 501 | Click on the **Edit** button (//**pen icon**//). |
![]() |
141.1 | 502 | |
![]() |
167.1 | 503 | Click on the **Disabled** button in the upper-right corner. |
![]() |
141.1 | 504 | |
![]() |
167.1 | 505 | 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. |
![]() |
141.1 | 506 | |
![]() |
167.1 | 507 | Click on the **Apply** button. |
![]() |
141.1 | 508 | |
![]() |
167.1 | 509 | Then click on the **Apply changes** (//**tick icon**//) button. |
![]() |
141.1 | 510 | |
![]() |
167.1 | 511 | |
512 | [[image:Screenshot 2025-03-18 at 09.23.10.png]] | ||
513 | |||
514 | |||
515 | Now go to the **Events** tab. | ||
516 | |||
517 | Select the Event type as **Debug** from the dropdown list. | ||
518 | |||
![]() |
169.1 | 519 | 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. |
![]() |
167.1 | 520 | |
521 | |||
522 | [[image:Screenshot 2025-03-16 at 18.38.59.png]] | ||
523 | |||
524 | |||
525 | Then click on the **three dots (...)** in the **Message** column. You can see the uplink message's **payload** in the **Message** window. | ||
526 | |||
527 | |||
![]() |
164.1 | 528 | [[image:Screenshot 2025-03-16 at 18.39.12.png]] |
![]() |
141.1 | 529 | |
530 | |||
![]() |
164.1 | 531 | 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. |
![]() |
141.1 | 532 | |
533 | |||
![]() |
176.1 | 534 | = 7. Creating a Dashboard = |
![]() |
141.1 | 535 | |
![]() |
145.1 | 536 | 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. |
![]() |
141.1 | 537 | |
538 | |||
![]() |
145.1 | 539 | 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. |
![]() |
141.1 | 540 | |
![]() |
145.1 | 541 | |
![]() |
169.1 | 542 | First simulate a few messages using MQTT. This time, we have added the 'humidity' field to the payload. Eg: |
543 | |||
![]() |
170.1 | 544 | {{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}} |
![]() |
169.1 | 545 | |
546 | |||
![]() |
145.1 | 547 | In **ThingsBoard**, from the left navigation menu, click **Dashboards**. Then, click the **+** button and select **Create new dashboard** from the dropdown menu. |
548 | |||
549 | |||
![]() |
141.1 | 550 | [[image:dashboard-1.png]] |
551 | |||
552 | |||
553 | In the **Title** text box, enter **NB/CB Test Dashboard** as the title of the dashboard. | ||
554 | |||
555 | Click on the **Add** button. | ||
556 | |||
557 | |||
558 | [[image:dashboard-2.png||height="526" width="500"]] | ||
559 | |||
560 | |||
561 | Click on the **Add widget / Add new widget** button. | ||
562 | |||
563 | |||
564 | [[image:dashboard-3.png]] | ||
565 | |||
566 | |||
![]() |
145.1 | 567 | In the **Select widgets bundle** window, click **Charts**. |
![]() |
141.1 | 568 | |
569 | |||
![]() |
145.1 | 570 | [[image:dashboard-4.png||height="537" width="700"]] |
571 | |||
572 | |||
573 | |||
574 | In the **Charts: select widget** window, click **Time series chart**. | ||
575 | |||
576 | |||
577 | [[image:dashboard-5.png||height="525" width="700"]] | ||
578 | |||
579 | |||
580 | Configure the **Time series chart** widget as follows: | ||
581 | |||
![]() |
149.1 | 582 | * **Datasource** - select S31B-NB device you provisioned. |
583 | * **Series**: | ||
![]() |
145.1 | 584 | ** **temperature** - you can see this key by default. |
![]() |
149.1 | 585 | ** **humidity** - Click **Add series** button. Then add the **humidity** for the key and then type **%** as its unit. |
![]() |
145.1 | 586 | * Click on the **Add** button. |
587 | |||
588 | [[image:timeseries-1.png||height="491" width="700"]] | ||
589 | |||
![]() |
146.1 | 590 | |
![]() |
149.1 | 591 | The time-series chart will appear in edit mode. Resize it by clicking and dragging the lower-right corner. |
592 | |||
593 | Click the **Save** button to add the widget to the dashboard. | ||
594 | |||
595 | |||
596 | [[image:timeseries-3.png||height="347" width="700"]] | ||
597 | |||
598 | |||
599 | Now send the following MQTT messages from the terminal to simulate the data. | ||
600 | |||
601 | |||
602 | {{code language="none"}} | ||
![]() |
169.1 | 603 | 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}' |
![]() |
149.1 | 604 | |
![]() |
169.1 | 605 | 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}' |
![]() |
149.1 | 606 | |
![]() |
169.1 | 607 | 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}' |
![]() |
149.1 | 608 | |
609 | {{/code}} | ||
610 | |||
611 | The chart will update with the values in realtime, as shown in the below image. | ||
612 | |||
613 | |||
614 | [[image:timeseries-4.png||height="316" width="700"]] | ||
615 | |||
616 | |||
![]() |
176.1 | 617 | = 8. Configure NB-IoT Sensor = |
![]() |
146.1 | 618 | |
619 | |||
![]() |
172.1 | 620 | Now, let's experiment with sending data to ThingsBoard using a real NB-IoT device. For example, we will use the **TS01-NB**. |
![]() |
146.1 | 621 | |
622 | First, configure the NB-IoT device with the necessary MQTT settings using AT commands. Below is a list of AT commands you can use. | ||
623 | |||
624 | |||
625 | **AT Commands** | ||
626 | |||
![]() |
149.1 | 627 | * **AT+PRO=3,3 **~/~/ Use MQTT to connect to ThingsBoard. Payload Type set to 3. |
![]() |
175.1 | 628 | * **AT+SUBTOPIC=<MQTT subscribe topic> Eg: TS01-NB** |
![]() |
169.1 | 629 | * **AT+PUBTOPIC=<MQTT publish topic> Eg: TS01-NB** |
![]() |
150.1 | 630 | * **AT+CLIENT=null** |
631 | * **AT+UNAME=<MQTT Username>** | ||
632 | * **AT+PWD=<MQTT Password>** | ||
![]() |
152.1 | 633 | * **AT+SERVADDR=<Broker address, Port>** |
![]() |
146.1 | 634 | |
![]() |
150.1 | 635 | Test your uplink by pressing the ACT button for 1 second. |
![]() |
172.1 | 636 | |
![]() |
167.1 | 637 | |
638 | |||
![]() |
169.1 | 639 | 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**. |
![]() |
167.1 | 640 | |
![]() |
172.1 | 641 | {{info}} |
642 | The ThingsBoard uses the device's IMEI number included in the payload to create a device in the Devices section. | ||
643 | {{/info}} | ||
644 | |||
![]() |
169.1 | 645 | [[image:image-4.png]] |
646 | |||
647 | |||
![]() |
167.1 | 648 |