Skip to Content

Changes for page ThingsBoard

Last modified by Dilisi S on 2025/04/23 19:23
From version 90.1
edited by Dilisi S
on 2025/03/08 03:47
Change comment: Uploaded new attachment "add-uplink-data-converter.png", version {1}
To version 121.1
edited by Dilisi S
on 2025/03/08 20:30
Change comment: Mar 8 edits - part 2

Summary

Details

Page properties
Content
... ... @@ -17,76 +17,96 @@
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. Add New Device =
20 += 2. Prerequisites =
21 21  
22 +To complete this tutorial, you need to have the following:
22 22  
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.
24 +* ThingsBoard cloud account
25 +* HiveMQ Cloud account
24 24  
25 -In the left navigation, click **Entities** and then click **Devices**.
26 26  
27 -[[image:device-list-empty.png]]
28 +== 2.1 ThingsBoard Cloud ==
28 28  
29 29  
30 -On the **Devices **page, click on the ‘**+**’ button, and then click on the **Add new device **from the dropdown menu.
31 +Add details here
31 31  
32 -[[image:ThingsBoard-add-new-device.png||height="279" width="500"]]
33 +== 2.2 HiveMQ Cloud ==
33 33  
34 34  
35 -The **Add new device** window appears. Name the device, for example '**Virtual NB/CB device**'.
36 +Go to [[https:~~/~~/www.hivemq.com>>https://www.hivemq.com]]
36 36  
37 -Click on the **Next: Credentials** button.
38 +Click on the **Start Free** button.
38 38  
39 -[[image:new-device-device-details.png||height="529" width="500"]]
40 +[[image:hivwmq-1.png]]
40 40  
41 41  
42 -Click the **Access token** button if it is not selected by default.
43 +Click on the **Sign Up FREE Now** button in the **HIVEMQ CLOUD** section.
43 43  
44 -Copy the **Access token** to a text editor, as you will need it in the section **'Sending data from an MQTT client'**.
45 +[[image:hivemq-2.png]]
45 45  
46 -Click on the **Add** button.
47 47  
48 -[[image:new-device-access-token.png||height="528" width="500"]]
48 +Click on the **Sign Up** button.
49 49  
50 +You can sign up with HiveMQ using your **GitHub**, **Google**, or **LinkedIn** account.
50 50  
51 -Click on the **MQTT** button.
52 +If not, provide your **email address** and a **password** to create an account by clicking on the **Sign Up** button.
52 52  
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.
54 54  
55 -Copy the MQTT pub command in the '**Execute the following command**' section.
55 +[[image:hivemq-3.png]]
56 56  
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 -Note that the **State** is still shown as **'Inactive'** in the **Latest telemetry** section.
58 +You will receive an email to verify your email address. Click on the **Confirm my account** button.
62 62  
63 -[[image:new-device-check-connectivity.png||height="522" width="500"]]
64 64  
61 +[[image:hivemq-4.jpg||height="889" width="400"]]
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.
67 67  
64 +You will be redirected to a page asking you to complete your profile. Once done, click the **Continue** button.
68 68  
69 -[[image:mqtt-command-1.png||height="228" width="700"]]
70 70  
67 +[[image:hivemq-5.png||height="655" width="700"]]
71 71  
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  
70 +Select the CloudMQ Cloud plan you need. For testing purposes, select the **Serverless FREE** plan by clicking on the **Create Serverless Cluster** button.
74 74  
75 -[[image:new-device-telemetry-test.png||height="520" width="500"]]
76 76  
73 +[[image:hivemq-6.png]]
77 77  
78 -Send the same command again, only changing the **temperature** value, to see how the **Latest telemetry** section updates its data.
79 79  
80 -Once you are done experimenting with this, close the window by clicking the **Close** button.
76 +You will be navigated to the **Your Clusters** page. Click on the **Manage Cluster** button.
81 81  
78 +[[image:hivemq-7.png]]
82 82  
83 -[[image:mqtt-command-2.png||height="227" width="700"]]
84 84  
81 +In your cluster page, you can find some useful parameters you need to create a MQTT connection.
85 85  
83 +**URL**: This is the host name. Click on the copy button to copy it.
86 86  
87 -[[image:virtual-device-active.png]]
85 +**Port**: 8883
88 88  
89 89  
88 +Click on the **Getting Started** tab to setup the username and the password as the connection credentials.
89 +
90 +
91 +[[image:hivemq-8.png]]
92 +
93 +
94 +In the '**Create Connection Credentials**' section, provide a **username** and **password**, then click the **Add** button.
95 +
96 +
97 +[[image:hivemq-9.png]]
98 +
99 +
100 +
101 +If everything is successful, you will see the following message.
102 +
103 +
104 +[[image:hivemq-10.png||height="206" width="500"]]
105 +
106 +
107 +You will need these MQTT connection parameters when configuring the MQTT integration in the '**Add Integration**' section.
108 +
109 +
90 90  = 3. Data Converters =
91 91  
92 92  
... ... @@ -98,188 +98,112 @@
98 98  
99 99  In the left navigation, click **Integrations center**, and then click **Data converters**.
100 100  
101 -[[image:data-converter-list-page.png]]
102 102  
103 103  
104 -On the **Data converters** page, click on the ‘+’ button, and then click on the **Create new converter** from the dropdown menu.
123 +[[image:data-converters-list-empty.png]]
105 105  
106 -[[image:ThingsBoard-new-data-converter.png||height="282" width="500"]]
107 107  
126 +On the **Data converters** page, click on the ‘**+**’ button, and then click on the **Create new converter** from the dropdown menu.
108 108  
128 +
129 +
130 +[[image:create-new-converter-menu.png||height="259" width="500"]]
131 +
132 +
109 109  The **Add data converter** window will appear. Name it ‘**MQTT Uplink Converter NB/CB**’ and select the Type as **Uplink**.
110 110  
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.
135 +Click on the **TBEL** button if not selected it by default. Delete the existing decoder function in the code editor. Now copy and paste the following decoder function written in **TBEL (ThingsBoard Expression Language)** in to the **code editor**. This decoder function is compatible for both NB and CB series devices.
112 112  
113 113  {{code language="JavaScript"}}
114 -//Version: 0.1
138 +/** Decoder **/
139 +
115 115  // decode payload to string
116 116  var payloadStr = decodeToString(payload);
142 +var data = JSON.parse(payloadStr);
117 117  
144 +var deviceName = metadata.topic.split("/")[3];
118 118  // decode payload to JSON
119 -var objdata = {};
120 -var obj1 = {};
121 -var data = decodeToJson(payload);
122 -var deviceName = data.IMEI;
123 -delete data.IMEI;
124 -var modelname = "Dragino " + data.Model;
125 -//var mod = data.mod
126 -delete data.Model;
127 -//delete data.mod
128 -var timestamp = new Date().getTime();
146 +var deviceType = 'sensor';
129 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 -
137 - }
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];
178 - }
179 -//Alec submitted25/02/25
180 - else {
181 - objdata[key] = data[key]
182 - }
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 - })
203 - }
204 -}
148 +// Result object with device attributes/telemetry data
205 205  var result = {
206 -
207 207   deviceName: deviceName,
208 - deviceType: modelname,
151 + deviceType: deviceType,
209 209   attributes: {
210 - model: modelname,
211 - //customerName: "NB-CB",
212 - //groupName: "NB-CB",
213 - //integrationName: metadata['integrationName']
214 -
153 + integrationName: metadata['integrationName'],
215 215   },
216 - telemetry: listdata
217 -}
155 + telemetry: {
156 + temperature: data.temperature,
157 + humidity: data.humidity,
158 + }
159 +};
218 218  
219 -function decodeToString(payload) {
220 - return String.fromCharCode.apply(String, payload);
221 -}
161 +/** Helper functions 'decodeToString' and 'decodeToJson' are already built-in **/
222 222  
223 -function decodeToJson(payload) {
224 - // covert payload to string.
225 - var str = decodeToString(payload);
226 -
227 - // parse string to JSON
228 - var data = JSON.parse(str);
229 - return data;
230 -}
231 -
232 232  return result;
233 -
234 234  {{/code}}
235 235  
236 236  
237 237  Click on the **Add** button.
238 238  
239 -[[image:uplink-data-converter.png||height="529" width="500"]]
240 240  
241 241  
242 -You should see that the newly added **uplink data converter** is listed on the **Data Converters** page.
171 +[[image:add-uplink-data-converter.png||height="529" width="500"]]
243 243  
173 +
174 +You should see that the newly added **MQTT Uplink converter **NB/CB is listed on the **Data Converters** page.
175 +
244 244  [[image:data-converter-list-showing-uplink-dc.png]]
245 245  
246 246  
179 +
247 247  == 3.2 Downlink ==
248 248  
249 249  
250 250  On the **Data converters** page, click on the ‘**+**’ button, and then click on the **Create new converter** from the dropdown menu.
251 251  
252 -[[image:ThingsBoard-new-data-converter.png||height="282" width="500"]]
253 253  
186 +[[image:create-new-converter-menu.png||width="500"]]
254 254  
188 +
189 +
255 255  The **Add data converter** window will appear. Name it ‘**MQTT Downlink Converter NB/CB**’ and select the Type as **Downlink**.
256 256  
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.
192 +Click on the **TBEL** button if not selected it by default. Now copy and paste the following encoder function written in **TBEL (ThingsBoard Expression Language)** in to the **code editor**. This encoder function is compatible for both NB and CB series devices.
258 258  
259 259  
260 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 -}
196 +// Encode downlink data from incoming Rule Engine message
272 272  
198 +// msg - JSON message payload downlink message json
199 +// msgType - type of message, for ex. 'ATTRIBUTES_UPDATED', 'POST_TELEMETRY_REQUEST', etc.
200 +// metadata - list of key-value pairs with additional data about the message
201 +// integrationMetadata - list of key-value pairs with additional data defined in Integration executing this converter
202 +
203 +/** Encoder **/
204 +
205 +var data = {};
206 +
207 +// Process data from incoming message and metadata
208 +
209 +data.tempFreq = msg.temperatureUploadFrequency;
210 +data.humFreq = msg.humidityUploadFrequency;
211 +
212 +data.devSerialNumber = metadata['ss_serialNumber'];
213 +
273 273  // Result object with encoded downlink payload
274 274  var result = {
216 +
275 275   // downlink data content type: JSON, TEXT or BINARY (base64 format)
276 - contentType: "BINARY",
218 + contentType: "JSON",
277 277  
278 278   // downlink data
279 - data:hexToBase64(metadata.shared_value)
221 + data: JSON.stringify(data),
280 280  
281 281   // Optional metadata object presented in key/value format
282 - //metadata: {}
224 + metadata: {
225 + topic: metadata['deviceType']+'/'+metadata['deviceName']+'/upload'
226 + }
283 283  
284 284  };
285 285  
... ... @@ -289,24 +289,30 @@
289 289  
290 290  Click on the **Add** button.
291 291  
292 -[[image:downlink-data-converter.png||height="530" width="500"]]
293 293  
294 294  
295 -You should see that the newly added **downlink data converter** is listed on the **Data Converters** page.
238 +[[image:add-downlink-data-converter.png||height="529" width="500"]]
296 296  
297 -[[image:data-converter-list.png]]
298 298  
241 +You should see that the newly added **MQTT Downlink** Converter NB/CB is listed on the **Data Converters** page.
299 299  
243 +
244 +[[image:data-converters-list.png]]
245 +
246 +
247 +
300 300  = 4. Add Integration =
301 301  
302 302  
303 303  In the left navigation, click **Integrations center**, and then click **Integrations**.
304 304  
305 -On the **Integrations** page, click on the '**+**' button.
306 306  
307 -[[image:data-converter-list-page.png]]
254 +[[image:integrations-list-empty.png]]
308 308  
309 309  
257 +On the **Integrations** page, click on the '**+**' button.
258 +
259 +
310 310  The **Add integration** window appears.
311 311  
312 312  In the **Add integration** window, configure the following settings:
... ... @@ -316,9 +316,13 @@
316 316  
317 317  * **Integration type**: MQTT
318 318  * **Name**: MQTT integration NB/CB
269 +* **Enable integration**: YES
270 +* **Allows create devices or assets**: YES
319 319  
320 320  Click **Next** button.
321 321  
274 +
275 +
322 322  [[image:add-integration-basic-settings.png||height="511" width="500"]]
323 323  
324 324  
... ... @@ -329,9 +329,11 @@
329 329  
330 330  Click **Next** button.
331 331  
332 -[[image:add-integration-uplink-data-converter.png||width="500"]]
333 333  
334 334  
288 +[[image:add-integration-uplink-data-converter.png||height="511" width="500"]]
289 +
290 +
335 335  **Downlink data converter:**
336 336  
337 337  * Click on the **Select existing** button.
... ... @@ -339,38 +339,56 @@
339 339  
340 340  Click **Next** button.
341 341  
342 -[[image:add-integration-downlink-data-converter.png||height="510" width="500"]]
343 343  
344 344  
300 +[[image:add-integration-downlink-data-converter.png||height="511" width="500"]]
301 +
302 +
345 345  **Connection:**
346 346  
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)
305 +* **Host**: Cluster URL (Eg. 011731f7928541588a6cdfbbedfc63f4.s1.eu.hivemq.cloud)
306 +* **Port**: 8883
349 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
308 +* **Enable SSL**: YES
309 +* **Username**: Username (from your HiveMQ Cloud Cluster with your credentials)
310 +* **Password:** Password (from your HiveMQ Cloud Cluster with your credentials)
311 +* **Topic:** tb/mqtt-integration-tutorial/sensors/+/telemetry (the + replaces any 'device name' and creates devices in the Entities -> Devices)
312 +* **QoS:** 0-At most once
354 354  
314 +[[image:add-integration-connection.png||height="511" width="500"]]
315 +
316 +
317 +Click on the **Advanced settings** button.
318 +
319 +* **Clean session:** NO
320 +* **Retained**: NO
321 +
322 +[[image:add-integration-connection-advanced-settings.png||height="510" width="500"]]
323 +
324 +
355 355  Click on the **Check connection** button to verify the MQTT connection using the provided parameters.
356 356  
357 -[[image:add-integration-connection.png||width="500"]]
358 358  
328 +[[image:check-connection.png||height="83" width="300"]]
359 359  
360 -If the connection is successful, you will see the **Connected** message.
361 361  
362 -Click on the **Add** button.
331 +If the connection is successful, you will see the **Connected** message. If not, check your connection parameters again.
363 363  
364 -[[image:add-connection-success.png||height="511" width="500"]]
365 365  
334 +[[image:connection-success.png||height="511" width="500"]]
366 366  
336 +
337 +Click on the **Add** button.
338 +
367 367  You should see that the newly added integration is listed on the **Integrations** page.
368 368  
369 369  Since we haven't received data from a device yet, the integration **Status** is shown as **Pending.**
370 370  
371 -[[image:integrations-list-added-pending.png]]
372 372  
373 373  
345 +[[image:new-integration-pending.png]]
346 +
347 +
374 374  = 5. Verifying the receipt of data from the device =
375 375  
376 376  
... ... @@ -381,5 +381,3 @@
381 381  {{/code}}
382 382  
383 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.
384 -
385 -
add-downlink-data-converter.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +175.2 KB
Content
add-integration-basic-settings.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +122.5 KB
Content
add-integration-connection-advanced-settings.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +155.2 KB
Content
add-integration-connection.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +124.4 KB
Content
add-integration-downlink-data-converter.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +123.0 KB
Content
add-integration-uplink-data-converter.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +120.7 KB
Content
check-connection.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +14.7 KB
Content
connection-success.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +90.0 KB
Content
data-converter-list-showing-uplink-dc.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +194.9 KB
Content
data-converters-list.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +212.2 KB
Content
hivemq-10.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +82.7 KB
Content
hivemq-2.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +300.7 KB
Content
hivemq-3.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +535.2 KB
Content
hivemq-4.jpg
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +309.8 KB
Content
hivemq-5.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +115.0 KB
Content
hivemq-6.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +321.0 KB
Content
hivemq-7.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +203.5 KB
Content
hivemq-8.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +268.7 KB
Content
hivemq-9.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +303.7 KB
Content
hivwmq-1.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +380.3 KB
Content
integrations-list-empty.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +264.5 KB
Content
new-integration-pending.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +199.7 KB
Content