Skip to Content

Changes for page ThingsBoard

Last modified by Dilisi S on 2025/04/23 19:23
From version 117.1
edited by Dilisi S
on 2025/03/08 20:16
Change comment: Mar 8 edits - part 1
To version 87.1
edited by Dilisi S
on 2025/03/08 03:36
Change comment: Deleted image "virtual-device-active.png"

Summary

Details

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