Skip to Content

Changes for page ThingsBoard

Last modified by Dilisi S on 2025/04/23 19:23
From version 177.1
edited by Dilisi S
on 2025/03/26 21:03
Change comment: Mar 26 edits - part 2
To version 59.1
edited by Dilisi S
on 2025/03/06 04:25
Change comment: Mar 5 edits

Summary

Details

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