Skip to Content

Changes for page ThingsBoard

Last modified by Dilisi S on 2025/04/23 19:23
From version 204.1
edited by Dilisi S
on 2025/04/21 16:49
Change comment: April 21 edits - part 1
To version 67.1
edited by Dilisi S
on 2025/03/08 03:35
Change comment: Deleted image "add-integration-connection.png"

Summary

Details

Page properties
Content
... ... @@ -17,553 +17,369 @@
17 17  The **NB series** devices end with the suffix **-NB**, and the **CB series** devices end with the suffix **-CB**. For example, **S31B-NB** is an **NB device**, and **S31-CB** is a **CB device**.
18 18  
19 19  
20 -= 2. Prerequisites =
20 += 2. Add New Device =
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.
23 +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.
29 29  
30 -== 2.1 ThingsBoard Cloud ==
25 +In the left navigation, click **Entities** and then click **Devices**.
31 31  
27 +[[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**.
30 +On the **Devices **page, click on the ‘**+**’ button, and then click on the **Add new device **from the dropdown menu.
36 36  
32 +[[image:ThingsBoard-add-new-device.png||height="279" width="500"]]
37 37  
38 -[[image:thingsboard-1.png]]
39 39  
35 +The **Add new device** window appears. Name the device, for example '**Virtual NB/CB device**'.
40 40  
41 -Select either the **North America** or **Europe** region. Here, we use the Europe region.
37 +Click on the **Next: Credentials** button.
42 42  
43 -[[image:thingsboard-2.png]]
39 +[[image:new-device-device-details.png||height="529" width="500"]]
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**.
42 +Click the **Access token** button if it is not selected by default.
47 47  
48 -Click on the **Sign up** button.
44 +Copy the **Access token** to a text editor, as you will need it in the section **'Sending data from an MQTT client'**.
49 49  
50 -[[image:thingsboard-3.png||height="651" width="500"]]
46 +Click on the **Add** button.
51 51  
48 +[[image:new-device-access-token.png||height="528" width="500"]]
52 52  
53 -You will be navigated to the following page.
54 54  
55 -[[image:thingsboard-5.png||height="109" width="500"]]
51 +Click on the **MQTT** button.
56 56  
53 +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.
57 57  
58 -simultaneously, you will receive an email to confirm your email address. Click on the **Activate Your Account** button.
55 +Copy the MQTT pub command in the '**Execute the following command**' section.
59 59  
57 +{{code language="none"}}
58 +mosquitto_pub -d -q 1 -h mqtt.eu.thingsboard.cloud -p 1883 -t v1/devices/me/telemetry -u "24vk3w9h7sqdld1me5eh" -m "{temperature:25}"
59 +{{/code}}
60 60  
61 -[[image:thingsboard-4.png||height="249" width="500"]]
61 +Note that the **State** is still shown as **'Inactive'** in the **Latest telemetry** section.
62 62  
63 +[[image:new-device-check-connectivity.png||height="522" width="500"]]
63 63  
64 -Now losing to the account using your credentials:
65 65  
66 +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'**. Of course, you can replace **'me'** with a device name or use the wildcard character **'+'** to match any device name.
66 66  
67 -[[image:thingsboard-6.png||height="244" width="500"]]
68 68  
69 +[[image:mqtt-command-1.png||height="228" width="700"]]
69 69  
70 -== 2.2 HiveMQ Cloud ==
71 71  
72 -=== 2.2.1 HiveMQ Cloud ===
72 +If the command is successful, you can see the telemetry data you sent under the **Latest telemetry** section. Note that the **State** is now **'Active'** in the **Latest telemetry** section.
73 73  
74 74  
75 -Go to [[https:~~/~~/www.hivemq.com>>https://www.hivemq.com]]
75 +[[image:new-device-telemetry-test.png||height="520" width="500"]]
76 76  
77 -Click on the **Start Free** button.
78 78  
79 -[[image:hivwmq-1.png]]
78 +Send the same command again, only changing the **temperature** value, to see how the **Latest telemetry** section updates its data.
80 80  
80 +Once you are done experimenting with this, close the window by clicking the **Close** button.
81 81  
82 -Click on the **Sign Up FREE Now** button in the **HIVEMQ CLOUD** section.
83 83  
84 -[[image:hivemq-2.png]]
83 +[[image:mqtt-command-2.png||height="227" width="700"]]
85 85  
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.
87 +[[image:virtual-device-active.png]]
90 90  
91 -If not, provide your **email address** and a **password** to create an account by clicking on the **Sign Up** button.
92 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 -
168 168  = 3. Data Converters =
169 169  
170 170  
171 171  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.
172 172  
173 -**In this section, you will create a universal uplink data converter for all Dragino NB-IoT devices. The uplink decoder converts any MQTT message coming from a device into key-value pairs that can be used to display and visualize data using various widgets on the dashboard**.
174 174  
175 -
176 176  == 3.1 Uplink ==
177 177  
178 178  
179 179  In the left navigation, click **Integrations center**, and then click **Data converters**.
180 180  
101 +[[image:data-converter-list-page.png]]
181 181  
182 -[[image:data-converters-list-empty.png]]
183 183  
104 +On the **Data converters** page, click on the ‘+’ button, and then click on the **Create new converter** from the dropdown menu.
184 184  
185 -On the **Data converters** page, click on the ‘**+**’ button, and then click on **Create new converter** from the dropdown menu.
106 +[[image:ThingsBoard-new-data-converter.png||height="282" width="500"]]
186 186  
187 187  
109 +The **Add data converter** window will appear. Name it ‘**MQTT Uplink Converter NB/CB**’ and select the Type as **Uplink**.
188 188  
189 -[[image:create-new-converter-menu.png||height="259" width="500"]]
111 +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.
190 190  
191 -
192 -The **Add data converter** window appears.
193 -
194 -Name it ‘**MQTT Uplink Converter**’ and select the Type as **Uplink**.
195 -
196 -Click on the **TBEL** button if it has not been selected by default.
197 -
198 -Replace the default TBEL decoder function with the following universal TBEL decoder function, which decodes MQTT payload from any Dragino NB-IoT device.
199 -
200 -
201 201  {{code language="JavaScript"}}
114 +//Version: 0.1
115 +// decode payload to string
116 +var payloadStr = decodeToString(payload);
117 +
202 202  // decode payload to JSON
203 -var pattern = "yyyy/MM/dd HH:mm:ss";
204 204  var objdata = {};
205 205  var obj1 = {};
206 206  var data = decodeToJson(payload);
207 207  var deviceName = data.IMEI;
208 -data.remove("IMEI");
209 -var modelname = "Dragino "+ data.Model;
123 +delete data.IMEI;
124 +var modelname = "Dragino " + data.Model;
210 210  //var mod = data.mod
211 -data.remove("Model");
126 +delete data.Model;
212 212  //delete data.mod
213 213  var timestamp = new Date().getTime();
214 -foreach (entry: data.entrySet()) {
215 - var key = entry.getKey();
216 - var value = entry.getValue();
217 - //objdata[key] = data[key]
218 - if(key.matches("^-?\\d+$")){ //is number
219 - obj1[key]=data[key];
220 - var index = obj1[key].length-1;
221 - obj1[key][index]=new Date(obj1[key][index],pattern).getTime();
129 +
130 +for (var key in data) {
131 +
132 + if (Number(key)) {
133 + obj1[key] = data[key];
134 + obj1[key][obj1[key].length - 1] = Number(new Date(
135 + obj1[key][obj1[key].length - 1]));
136 +
222 222   }
223 - else if (key==="bat"||key==="BAT"){
224 - objdata["battery"] = data[key];
138 +//Alec submitted25/02/25
139 +//turn old key into new
140 + else if (key === "Reading") {
141 + objdata["reading"] = data[key];
142 + } else if (key === "work mode") {
143 + objdata["work_mode"] = data[key];
144 + } else if (key === "hum") {
145 + objdata["humidity"] = data[key];
146 + }else if (key === "hum2") {
147 + objdata["humidity2"] = data[key];
148 + } else if (key === "hum3") {
149 + objdata["humidity3"] = data[key];
150 + } else if (key === "tem") {
151 + objdata["temperature"] = data[key];
152 + } else if (key === "tem2") {
153 + objdata["temperature2"] = data[key];
154 + } else if (key === "tem3") {
155 + objdata["temperature3"] = data[key];
156 + } else if (key === "DS18B20_Temp") {
157 + objdata["temperature_pro"] = data[key];
158 + } else if (key === "ds18b20_temperature") {
159 + objdata["temperature_pro"] = data[key];
160 + } else if (key === "DS18B20_temperature_pro") {
161 + objdata["temperature_pro"] = data[key];
162 + } else if (key === "tdc send flag") {
163 + objdata["tdc_send_flag"] = data[key];
164 + } else if (key === "trigger mode") {
165 + objdata["trigger_mode"] = data[key];
166 + } else if (key === "soil dielectric constant") {
167 + objdata["soil_dielectric_constant"] = data[key];
168 + } else if (key === "door open num") {
169 + objdata["door_open_num"] = data[key];
170 + } else if (key === "door duration") {
171 + objdata["door_duration"] = data[key];
172 + } else if (key === "count time") {
173 + objdata["count_time"] = data[key];
174 + } else if (key === "last open time2") {
175 + objdata["last_open_time2"] = data[key];
176 + } else if (key === "last open time3") {
177 + objdata["last_open_time3"] = data[key];
225 225   }
226 - else{
227 - objdata[key] = data[key];
228 -}}
229 -var listdata = [{"ts":timestamp,"values":objdata}];
230 -foreach ( entry1: obj1.entrySet()){
231 - var key1 = entry1.getKey();
232 - var value1 = entry1.getValue();
233 - var index = obj1[key1].length-1;
234 - var ts = obj1[key1][index];
235 - if (modelname=="Dragino RS485-NB"){
236 - listdata.push({"ts":ts,"values":{"Payload":obj1[key1][0]}});
179 +//Alec submitted25/02/25
180 + else {
181 + objdata[key] = data[key]
237 237   }
238 - else{
239 - listdata.push({"ts":ts,"values":{"values":obj1[key1]}});
183 +}
184 +var listdata = [{
185 + "ts": timestamp,
186 + "values": objdata
187 +}]
188 +for (var key1 in obj1) {
189 + if (modelname == "Dragino RS485-NB") {
190 + listdata.push({
191 + "ts": obj1[key1][obj1[key1].length - 1],
192 + "values": {
193 + "Payload": obj1[key1][0],
194 + }
195 + })
196 + } else {
197 + listdata.push({
198 + "ts": obj1[key1][obj1[key1].length - 1],
199 + "values": {
200 + "values": obj1[key1]
201 + },
202 + })
240 240   }
241 241  }
242 - var result = {
205 +var result = {
206 +
243 243   deviceName: deviceName,
244 244   deviceType: modelname,
245 245   attributes: {
246 - model: modelname
210 + model: modelname,
247 247   //customerName: "NB-CB",
248 248   //groupName: "NB-CB",
249 249   //integrationName: metadata['integrationName']
214 +
250 250   },
251 251   telemetry: listdata
252 -};
253 -return result;
254 -{{/code}}
217 +}
255 255  
219 +function decodeToString(payload) {
220 + return String.fromCharCode.apply(String, payload);
221 +}
256 256  
257 -Once you modify the decoder function, click on the **Add** button.
223 +function decodeToJson(payload) {
224 + // covert payload to string.
225 + var str = decodeToString(payload);
258 258  
227 + // parse string to JSON
228 + var data = JSON.parse(str);
229 + return data;
230 +}
259 259  
260 -[[image:mqtt-uplink-converter.png||height="498" width="500"]]
232 +return result;
261 261  
234 +{{/code}}
262 262  
263 263  
264 -You should see that the newly added **MQTT Uplink converter **NB/CB is listed on the **Data Converters** page.
265 -
266 -
267 -
268 -[[image:data-converters-list.png]]
269 -
270 -
271 -= 4. Add Integration =
272 -
273 -
274 -In the left navigation, click **Integrations center**, and then click **Integrations**.
275 -
276 -
277 -[[image:integrations-list-empty.png]]
278 -
279 -
280 -On the **Integrations** page, click on the '**+**' button.
281 -
282 -
283 -The **Add integration** window appears.
284 -
285 -In the **Add integration** window, configure the following settings:
286 -
287 -
288 -**Basic settings:**
289 -
290 -* **Integration type**: MQTT
291 -* **Name**: MQTT integration - Device A
292 -* **Enable integration**: YES
293 -* **Allow create devices or assets**: YES
294 -
295 -Click **Next** button.
296 -
297 -
298 -[[image:add-integration-basic-settings.png||height="504" width="500"]]
299 -
300 -
301 -
302 -
303 -**Uplink data converter:**
304 -
305 -* Click on the **Select existing** button.
306 -* **Uplink data converter**: Select **MQTT Uplink Converter NB/CB **from the dropdown list.
307 -
308 -Click **Next** button.
309 -
310 -
311 -[[image:add-integration-ul-data-converter.png||height="505" width="500"]]
312 -
313 -
314 -
315 -**Downlink data converter:**
316 -
317 -Dragino NB/CB devices don't require a downlink data converter to decode their payloads, so you can skip this step.
318 -
319 -* Click on the **Skip **button in the Downlink data converter section.
320 -
321 -Click **Skip** button.
322 -
323 -
324 -[[image:integration-dl-skip.png||height="511" width="500"]]
325 -
326 -
327 -
328 -**Connection:**
329 -
330 -* **Host**: Host URL (Eg. **//011731f7xxxxxxxxxxxfbbedfc63f4.s1.eu.hivemq.cloud//**)
331 -* **Port**: 8883
332 -* **Credentials type**: Basic
333 -* **Username**: Username (from your HiveMQ Cloud Cluster with your credentials)
334 -* **Password:** Password (from your HiveMQ Cloud Cluster with your credentials)
335 -* **Enable SSL**: YES
336 -* **Topic: device/a** (The topic can be anything; you can even use just the device name.)
337 -* **QoS:** 0-At most once
338 -
339 -[[image:add-integartion-connection.png||height="505" width="500"]]
340 -
341 -
342 -Click on the **Advanced settings** button.
343 -
344 -* **Clean session:** YES
345 -* **Retained**: YES
346 -
347 -[[image:add-integration-connection-advanced-settings.png||height="510" width="500"]]
348 -
349 -
350 -Click on the **Check connection** button to verify the MQTT connection using the provided parameters.
351 -
352 -
353 -[[image:check-connection.png||height="83" width="300"]]
354 -
355 -
356 -If the connection is successful, you will see the **Connected** message. If not, check your connection parameters again.
357 -
358 -
359 -[[image:connection-success.png||height="511" width="500"]]
360 -
361 -
362 362  Click on the **Add** button.
363 363  
364 -You should see that the newly added integration is listed on the **Integrations** page.
239 +[[image:uplink-data-converter.png||height="529" width="500"]]
365 365  
366 -Since we haven't received data from a device yet, the integration **Status** is shown as **Pending.**
367 367  
242 +You should see that the newly added **uplink data converter** is listed on the **Data Converters** page.
368 368  
369 -[[image:integration-added.png]]
244 +[[image:data-converter-list-showing-uplink-dc.png]]
370 370  
371 371  
247 +== 3.2 Downlink ==
372 372  
373 -= 5. Verifying the receipt of data from virtual devices =
374 374  
250 +On the **Data converters** page, click on the ‘**+**’ button, and then click on the **Create new converter** from the dropdown menu.
375 375  
376 -== 5.1 How does it work? ==
252 +[[image:ThingsBoard-new-data-converter.png||height="282" width="500"]]
377 377  
378 378  
379 -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.
255 +The **Add data converter** window will appear. Name it ‘**MQTT Downlink Converter NB/CB**’ and select the Type as **Downlink**.
380 380  
381 -The Mosquitto client publishes messages (payloads) on the topic **/device/a**. Of course, you can use any topic for testing.
257 +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.
382 382  
383 -(% id="cke_bm_37386S" style="display:none" %) (%%)The MQTT payload format is as follows:
384 384  
385 -{{code language="none"}}
386 -{"IMEI": "350693903995577", "temperature":25, "humidity":80, "pressure":1005}
387 -{{/code}}
260 +{{code language="JavaScript"}}
261 +function hexToBase64(hexString) {
262 + // 将16进制字符串两个字符转换为一个字节
263 + var bytes = hexString.match(/.{2}/g);
264 + // 对每个字节进行解析，并转换为对应的字符
265 + var binaryString = bytes.map(function(byte) {
266 + return String.fromCharCode(parseInt(byte, 16));
267 + }).join('');
268 +
269 + // 使用btoa进行base64编码
270 + return btoa(binaryString);
271 +}
388 388  
389 -Once ThingsBoard receives this message, it forwards this payload to the matching device through the integration.
273 +// Result object with encoded downlink payload
274 +var result = {
275 + // downlink data content type: JSON, TEXT or BINARY (base64 format)
276 + contentType: "BINARY",
390 390  
278 + // downlink data
279 + data:hexToBase64(metadata.shared_value)
391 391  
392 -== 5.2 Sending messages ==
281 + // Optional metadata object presented in key/value format
282 + //metadata: {}
393 393  
284 +};
394 394  
395 -On your computer's terminal, issue the following MQTT command which simulates the device '**Device A'**. The message payload contains the fields IMEI, temperature, humidity, and pressure, which hold the values 350693903995577, 30, 80, and 1005 respectively. This payload is also (technically) known as telemetry.
396 -
397 -{{code language="none"}}
398 -mosquitto_pub -d -q 1 -h 011731f7928xxxxx.s1.eu.hivemq.cloud -p 8883 -u "xxxxx" -P "xxxxx" -t "device/a" -m '{"IMEI":"350693903995577", "temperature":30, "humidity":80, "pressure":1005}'
286 +return result;
399 399  {{/code}}
400 400  
401 -If the integration was performed without errors, the status of the integration changes to 'Active' after the first telemetry transmission.
402 402  
290 +Click on the **Add** button.
403 403  
404 -[[image:integration-active.png]]
292 +[[image:downlink-data-converter.png||height="530" width="500"]]
405 405  
406 406  
407 -== 5.3 Viewing messages ==
295 +You should see that the newly added **downlink data converter** is listed on the **Data Converters** page.
408 408  
297 +[[image:data-converter-list.png]]
409 409  
410 -Go back to the **Integrations** page.
411 411  
412 -Click on the **MQTT integration NB/CB** in the **Integrations** page to see its details.
300 += 4. Add Integration =
413 413  
414 -Click on the **Edit** button (//**pen icon**//).
415 415  
416 -Click on the **Disabled** button in the upper-right corner.
303 +In the left navigation, click **Integrations center**, and then click **Integrations**.
417 417  
418 -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.
305 +On the **Integrations** page, click on the '**+**' button.
419 419  
420 -Click on the **Apply** button.
307 +[[image:data-converter-list-page.png]]
421 421  
422 -Then click on the **Apply changes** (//**tick icon**//) button.
423 423  
310 +The **Add integration** window appears.
424 424  
425 -[[image:debug-enabled.png||height="301" width="700"]]
312 +In the **Add integration** window, configure the following settings:
426 426  
427 427  
315 +**Basic settings:**
428 428  
317 +* **Integration type**: MQTT
318 +* **Name**: MQTT integration NB/CB
429 429  
430 -Now go to the **Events** tab.
320 +Click **Next** button.
431 431  
432 -Select the **Event type** as **Debug** from the dropdown list.
322 +[[image:add-integration-basic-settings.png||height="511" width="500"]]
433 433  
434 -Publish another message (of course, you can repeat the previous message by pressing the UP arrow on your keyboard and then press Enter key) to your MQTT broker from your terminal, for example:
435 435  
436 -{{code language="none"}}
437 -mosquitto_pub -d -q 1 -h 011731f7928xxxxx.s1.eu.hivemq.cloud -p 8883 -u "xxxxx" -P "xxxxx" -t "device/a" -m '{"IMEI":"350693903995577", "temperature":30, "humidity":80, "pressure":1005}'
438 -{{/code}}
325 +**Uplink data converter:**
439 439  
440 -Now you can see that uplink message in the **Events** tab (Click the **refresh** button if you didn't see any messages in the Events tab). The status should be **OK **if there is no errors in your integration.
327 +* Click on the **Select existing** button.
328 +* **Uplink data converter**: Select **MQTT Uplink Converter NB/CB **from the dropdown list.
441 441  
330 +Click **Next** button.
442 442  
443 -[[image:Screenshot 2025-03-26 at 19.49.31.png]]
332 +[[image:add-integration-uplink-data-converter.png||width="500"]]
444 444  
445 445  
335 +**Downlink data converter:**
446 446  
447 -Then click on the **three dots (...)** in the **Message** column. You can see the uplink message's **payload** in the **Message** window.
337 +* Click on the **Select existing** button.
338 +* **Downlink data converter**: Select **MQTT Downlink Converter NB/CB **from the dropdown list.
448 448  
340 +Click **Next** button.
449 449  
450 -[[image:Screenshot 2025-03-26 at 19.47.52.png]]
342 +[[image:add-integration-downlink-data-converter.png||height="510" width="500"]]
451 451  
452 452  
345 +**Connection:**
453 453  
347 +* **Host**: mqtt.eu.thingsboard.cloud (This is the host name you copied from the device - See section xxxxx for more information)
348 +* **Port**: 1883 (This is the port number you copied from the device - See section xxxxx for more information)
349 +* **Credentials**: Basic
350 +* **Username**: Access token (This is the access token you copied from the device)
351 +* **Password** - Leave it as blank
352 +* **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')
353 +* **QoS** - 0-At most once
454 454  
455 -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.
355 +Click on the **Check connection** button to verify the MQTT connection using the provided parameters.
456 456  
357 +[[image:add-integration-connection.png||width="500"]]
457 457  
458 -= 6. Creating a Dashboard =
459 459  
460 -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.
360 +If the connection is successful, you will see the **Connected** message.
461 461  
462 -
463 -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.
464 -
465 -
466 -First simulate a few messages using MQTT. This time, we have added the 'humidity' field to the payload. Eg:
467 -
468 -{{code language="none"}}mosquitto_pub -d -q 1 -h 011731f7928xxxxx.s1.eu.hivemq.cloud -p 8883 -u "xxxxx" -P "xxxxx" -t "device/a" -m '{"IMEI":"350693903995577", "temperature":22, "humidity":80, "pressure":1005}'{{/code}}
469 -
470 -
471 -In **ThingsBoard**, from the left navigation menu, click **Dashboards**. Then, click the **+** button and select **Create new dashboard** from the dropdown menu.
472 -
473 -
474 -[[image:dashboard-1.png]]
475 -
476 -
477 -In the **Title** text box, enter **NB/CB Test Dashboard** as the title of the dashboard.
478 -
479 479  Click on the **Add** button.
480 480  
364 +[[image:add-connection-success.png||height="511" width="500"]]
481 481  
482 -[[image:dashboard-2.png||height="526" width="500"]]
483 483  
367 +You should see that the newly added integration is listed on the **Integrations** page.
484 484  
485 -Click on the **Add widget / Add new widget** button.
369 +Since we haven't received data from a device yet, the integration **Status** is shown as **Pending.**
486 486  
371 +[[image:integrations-list-added-pending.png]]
487 487  
488 -[[image:dashboard-3.png]]
489 489  
374 += 5. Verifying the receipt of data from the device =
490 490  
491 -In the **Select widgets bundle** window, click **Charts**.
492 492  
377 +On the terminal, issue the following MQTT command which simulates the device S31B-NB.
493 493  
494 -[[image:dashboard-4.png||height="537" width="700"]]
495 -
496 -
497 -
498 -In the **Charts: select widget** window, click **Time series chart**.
499 -
500 -
501 -[[image:dashboard-5.png||height="525" width="700"]]
502 -
503 -
504 -Configure the **Time series chart** widget as follows:
505 -
506 -* **Datasource** - select **Device A** device you provisioned.
507 -* **Series**:
508 -** **temperature** - you can see this key by default.
509 -** **humidity** - Click **Add series** button. Then add the **humidity** for the key and then type **%** as its unit.
510 -* Click on the **Add** button.
511 -
512 -{{info}}
513 -You can add only the relevant fields from the device's payload to display data on a widget. These fields are called 'keys'.
514 -{{/info}}
515 -
516 -[[image:Screenshot 2025-03-31 at 06.51.15.png||height="485" width="700"]]
517 -
518 -
519 -The time-series chart will appear in edit mode. Resize it by clicking and dragging the lower-right corner.
520 -
521 -Click the **Save** button to add the widget to the dashboard.
522 -
523 -
524 -[[image:timeseries-3.png||height="347" width="700"]]
525 -
526 -
527 -Now send the following MQTT messages from the terminal to simulate the data.
528 -
529 -
530 530  {{code language="none"}}
531 -mosquitto_pub -d -q 1 -h 011731f7928xxxxx.s1.eu.hivemq.cloud -p 8883 -u "xxxxx" -P "xxxxx" -t "device/a" -m '{"IMEI":"350693903995577", "temperature":22, "humidity":70, "pressure":1005}'
532 -
533 -mosquitto_pub -d -q 1 -h 011731f7928xxxxx.s1.eu.hivemq.cloud -p 8883 -u "xxxxx" -P "xxxxx" -t "device/a" -m '{"IMEI":"350693903995577", "temperature":27, "humidity":72, "pressure":1005}'
534 -
535 -mosquitto_pub -d -q 1 -h 011731f7928xxxxx.s1.eu.hivemq.cloud -p 8883 -u "xxxxx" -P "xxxxx" -t "device/a" -m '{"IMEI":"350693903995577", "temperature":19, "humidity":80, "pressure":1005}'
380 +mosquitto_pub -d -q 1 -h mqtt.eu.thingsboard.cloud -p 1883 -t v1/devices/S31B-NB/telemetry -u "24vk3w9h7sqdld1me5eh" -m "{temperature:20}"
536 536  {{/code}}
537 537  
538 -The chart will update with the values in realtime, as shown in the below image.
383 +If the integration was performed without errors, after the transmission of the first telemetry, a new device with the name “S31B-NB” will appear in the Devices → All. Also, you can verify the input and output data, respectively, before and after conversion in Data converters → UDP Uplink Converter NB/CB → Events.
539 539  
540 -
541 -[[image:timeseries-4.png||height="316" width="700"]]
542 -
543 -
544 -= 8. Configure Physical NB-IoT Sensor =
545 -
546 -
547 -Now, let's experiment with sending data to ThingsBoard using a real NB-IoT device. For example, we will use the **TS01-NB**.
548 -
549 -First, configure the NB-IoT device with the necessary MQTT settings using AT commands. Below is a list of AT commands you can use.
550 -
551 -
552 -**AT Commands**
553 -
554 -* **AT+PRO=3,3    **~/~/ Use MQTT to connect to ThingsBoard. Payload Type set to 3.
555 -* **AT+SUBTOPIC=<MQTT subscribe topic> Eg: TS01-NB**
556 -* **AT+PUBTOPIC=<MQTT publish topic> Eg: TS01-NB**
557 -* **AT+CLIENT=null**
558 -* **AT+UNAME=<MQTT Username>**
559 -* **AT+PWD=<MQTT Password>**
560 -* **AT+SERVADDR=<Broker address, Port>**
561 -
562 -Test your uplink by pressing the ACT button for 1 second.
563 563  
564 -
565 -
566 -The following image shows the uplink payload of a real Dragino device. The publish topic is '**TS01-NB' that contains fields in the payload, IMEI, IMSI, Model, temperature, etc**. Note that we have created a device named **TS01-NB** in the **Devices** section in advance.
567 -
568 -
569 -[[image:image-4.png]]
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
Screenshot 2025-03-26 at 19.47.52.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -168.4 KB
Content
Screenshot 2025-03-26 at 19.49.31.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -133.0 KB
Content
Screenshot 2025-03-31 at 06.51.15.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -179.5 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-integartion-connection.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -110.3 KB
Content
add-integartion-connetcion.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -146.0 KB
Content
add-integration-basic-settings.png
Size
... ... @@ -1,1 +1,1 @@
1 -123.8 KB
1 +122.5 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
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -158.1 KB
Content
add-integration-ul-data-converter.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -121.2 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 -19.0 KB
Content
debug-enabled.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -196.3 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.1 KB
Content
integration-added.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -196.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-converter.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -75.3 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
ul-data-converter-added.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -189.4 KB
Content
ul-data-converter-device-a.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -168.3 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
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
mqtt-command-2.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
virtual-device-active.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +202.8 KB
Content