Skip to Content

Changes for page ThingsBoard

Last modified by Dilisi S on 2025/04/23 19:23
From version 93.1
edited by Dilisi S
on 2025/03/08 03:59
Change comment: Mar 7 edits -part 1
To version 64.1
edited by Dilisi S
on 2025/03/07 00:17
Change comment: Mar 6 edits - part 2

Summary

Details

Page properties
Content
... ... @@ -6,134 +6,280 @@
6 6  Draft Document
7 7  {{/warning}}
8 8  
9 += Introduction =
9 9  
11 +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.
10 10  
13 +The **NB series** devices end with the suffix **-NB**, and the **CB series** devices end with the suffix **-CB**. For example, **S31B-NB** is an **NB device**, and **S31-CB** is a **CB device**.
11 11  
12 -= 1. Introduction =
13 13  
16 += Add New Device =
14 14  
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.
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.
16 16  
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**.
20 +In the left navigation, click **Entities** and then click **Devices**.
18 18  
19 19  
23 +[[image:device-list-empty.png]]
20 20  
21 21  
26 +On the **Devices **page, click on the ‘**+**’ button, and then click on the **Add new device **from the dropdown menu.
22 22  
23 -= 2. Data Converters =
24 24  
29 +[[image:ThingsBoard-add-new-device.png||height="279" width="500"]]
25 25  
26 -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.
27 27  
32 +The **Add new device** window appears. Name the device, for example '**Virtual NB/CB device**'.
28 28  
29 -== 2.1 Uplink ==
34 +Click on the **Next: Credentials** button.
30 30  
31 31  
32 -In the left navigation, click **Integrations center**, and then click **Data converters**.
37 +[[image:new-device-device-details.png||height="529" width="500"]]
33 33  
34 34  
40 +Click the **Access token** button if it is not selected by default.
35 35  
36 -[[image:data-converters-list-empty.png]]
42 +Copy the **Access token** to a text editor, as you will need it in the section **'Sending data from an MQTT client'**.
37 37  
44 +Click on the **Add** button.
38 38  
39 -On the **Data converters** page, click on the ‘**+**’ button, and then click on the **Create new converter** from the dropdown menu.
46 +[[image:new-device-access-token.png||height="528" width="500"]]
40 40  
41 41  
49 +Click on the **MQTT** button.
42 42  
43 -[[image:create-new-converter-menu.png||height="259" width="500"]]
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.
44 44  
53 +Copy the MQTT pub command in the '**Execute the following command**' section.
45 45  
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}}
58 +
59 +Note that the **State** is still shown as **'Inactive'** in the **Latest telemetry** section.
60 +
61 +[[image:new-device-check-connectivity.png||height="522" width="500"]]
62 +
63 +
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'**. Of course, you can replace **'me'** with a device name or use the wildcard character **'+'** to match any device name.
65 +
66 +
67 +[[image:mqtt-command-1.png||height="228" width="700"]]
68 +
69 +
70 +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.
71 +
72 +
73 +[[image:new-device-telemetry-test.png||height="520" width="500"]]
74 +
75 +
76 +Send the same command again, only changing the **temperature** value, to see how the **Latest telemetry** section updates its data.
77 +
78 +Once you are done experimenting with this, close the window by clicking the **Close** button.
79 +
80 +
81 +[[image:mqtt-command-2.png||height="227" width="700"]]
82 +
83 +
84 +
85 +[[image:virtual-device-active.png]]
86 +
87 +
88 += Data Converters =
89 +
90 +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.
91 +
92 +
93 +== Uplink ==
94 +
95 +In the left navigation, click **Integrations center**, and then click **Data converters**.
96 +
97 +
98 +[[image:data-converter-list-page.png]]
99 +
100 +
101 +On the **Data converters** page, click on the ‘+’ button, and then click on the **Create new converter** from the dropdown menu.
102 +
103 +
104 +[[image:ThingsBoard-new-data-converter.png||height="282" width="500"]]
105 +
106 +
46 46  The **Add data converter** window will appear. Name it ‘**MQTT Uplink Converter NB/CB**’ and select the Type as **Uplink**.
47 47  
48 -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.
109 +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.
49 49  
50 50  {{code language="JavaScript"}}
51 -/** Decoder **/
52 -
112 +//Version: 0.1
53 53  // decode payload to string
54 54  var payloadStr = decodeToString(payload);
55 -var data = JSON.parse(payloadStr);
56 56  
57 -var deviceName = metadata.topic.split("/")[3];
58 58  // decode payload to JSON
59 -var deviceType = 'sensor';
117 +var objdata = {};
118 +var obj1 = {};
119 +var data = decodeToJson(payload);
120 +var deviceName = data.IMEI;
121 +delete data.IMEI;
122 +var modelname = "Dragino " + data.Model;
123 +//var mod = data.mod
124 +delete data.Model;
125 +//delete data.mod
126 +var timestamp = new Date().getTime();
60 60  
61 -// Result object with device attributes/telemetry data
128 +for (var key in data) {
129 +
130 + if (Number(key)) {
131 + obj1[key] = data[key];
132 + obj1[key][obj1[key].length - 1] = Number(new Date(
133 + obj1[key][obj1[key].length - 1]));
134 +
135 + }
136 +//Alec submitted25/02/25
137 +//turn old key into new
138 + else if (key === "Reading") {
139 + objdata["reading"] = data[key];
140 + } else if (key === "work mode") {
141 + objdata["work_mode"] = data[key];
142 + } else if (key === "hum") {
143 + objdata["humidity"] = data[key];
144 + }else if (key === "hum2") {
145 + objdata["humidity2"] = data[key];
146 + } else if (key === "hum3") {
147 + objdata["humidity3"] = data[key];
148 + } else if (key === "tem") {
149 + objdata["temperature"] = data[key];
150 + } else if (key === "tem2") {
151 + objdata["temperature2"] = data[key];
152 + } else if (key === "tem3") {
153 + objdata["temperature3"] = data[key];
154 + } else if (key === "DS18B20_Temp") {
155 + objdata["temperature_pro"] = data[key];
156 + } else if (key === "ds18b20_temperature") {
157 + objdata["temperature_pro"] = data[key];
158 + } else if (key === "DS18B20_temperature_pro") {
159 + objdata["temperature_pro"] = data[key];
160 + } else if (key === "tdc send flag") {
161 + objdata["tdc_send_flag"] = data[key];
162 + } else if (key === "trigger mode") {
163 + objdata["trigger_mode"] = data[key];
164 + } else if (key === "soil dielectric constant") {
165 + objdata["soil_dielectric_constant"] = data[key];
166 + } else if (key === "door open num") {
167 + objdata["door_open_num"] = data[key];
168 + } else if (key === "door duration") {
169 + objdata["door_duration"] = data[key];
170 + } else if (key === "count time") {
171 + objdata["count_time"] = data[key];
172 + } else if (key === "last open time2") {
173 + objdata["last_open_time2"] = data[key];
174 + } else if (key === "last open time3") {
175 + objdata["last_open_time3"] = data[key];
176 + }
177 +//Alec submitted25/02/25
178 + else {
179 + objdata[key] = data[key]
180 + }
181 +}
182 +var listdata = [{
183 + "ts": timestamp,
184 + "values": objdata
185 +}]
186 +for (var key1 in obj1) {
187 + if (modelname == "Dragino RS485-NB") {
188 + listdata.push({
189 + "ts": obj1[key1][obj1[key1].length - 1],
190 + "values": {
191 + "Payload": obj1[key1][0],
192 + }
193 + })
194 + } else {
195 + listdata.push({
196 + "ts": obj1[key1][obj1[key1].length - 1],
197 + "values": {
198 + "values": obj1[key1]
199 + },
200 + })
201 + }
202 +}
62 62  var result = {
204 +
63 63   deviceName: deviceName,
64 - deviceType: deviceType,
206 + deviceType: modelname,
65 65   attributes: {
66 - integrationName: metadata['integrationName'],
208 + model: modelname,
209 + //customerName: "NB-CB",
210 + //groupName: "NB-CB",
211 + //integrationName: metadata['integrationName']
212 +
67 67   },
68 - telemetry: {
69 - temperature: data.temperature,
70 - humidity: data.humidity,
71 - }
72 -};
214 + telemetry: listdata
215 +}
73 73  
74 -/** Helper functions 'decodeToString' and 'decodeToJson' are already built-in **/
217 +function decodeToString(payload) {
218 + return String.fromCharCode.apply(String, payload);
219 +}
75 75  
221 +function decodeToJson(payload) {
222 + // covert payload to string.
223 + var str = decodeToString(payload);
224 +
225 + // parse string to JSON
226 + var data = JSON.parse(str);
227 + return data;
228 +}
229 +
76 76  return result;
231 +
77 77  {{/code}}
78 78  
79 -
80 80  Click on the **Add** button.
81 81  
82 82  
237 +[[image:uplink-data-converter.png||height="529" width="500"]]
83 83  
84 -[[image:add-uplink-data-converter.png||height="529" width="500"]]
85 85  
86 86  
87 -You should see that the newly added **MQTT Uplink converter **NB/CB is listed on the **Data Converters** page.
241 +You should see that the newly added **uplink data converter** is listed on the **Data Converters** page.
88 88  
243 +
89 89  [[image:data-converter-list-showing-uplink-dc.png]]
90 90  
91 91  
92 -== 3.2 Downlink ==
247 +== Downlink ==
93 93  
94 -
95 95  On the **Data converters** page, click on the ‘**+**’ button, and then click on the **Create new converter** from the dropdown menu.
96 96  
251 +
97 97  [[image:ThingsBoard-new-data-converter.png||height="282" width="500"]]
98 98  
99 99  
100 100  The **Add data converter** window will appear. Name it ‘**MQTT Downlink Converter NB/CB**’ and select the Type as **Downlink**.
101 101  
102 -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.
103 103  
104 104  
105 105  {{code language="JavaScript"}}
106 -// 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 +}
107 107  
108 -// msg - JSON message payload downlink message json
109 -// msgType - type of message, for ex. 'ATTRIBUTES_UPDATED', 'POST_TELEMETRY_REQUEST', etc.
110 -// metadata - list of key-value pairs with additional data about the message
111 -// integrationMetadata - list of key-value pairs with additional data defined in Integration executing this converter
112 -
113 -/** Encoder **/
114 -
115 -var data = {};
116 -
117 -// Process data from incoming message and metadata
118 -
119 -data.tempFreq = msg.temperatureUploadFrequency;
120 -data.humFreq = msg.humidityUploadFrequency;
121 -
122 -data.devSerialNumber = metadata['ss_serialNumber'];
123 -
124 124  // Result object with encoded downlink payload
125 125  var result = {
126 -
127 127   // downlink data content type: JSON, TEXT or BINARY (base64 format)
128 - contentType: "JSON",
276 + contentType: "BINARY",
129 129  
130 130   // downlink data
131 - data: JSON.stringify(data),
279 + data:hexToBase64(metadata.shared_value)
132 132  
133 133   // Optional metadata object presented in key/value format
134 - metadata: {
135 - topic: metadata['deviceType']+'/'+metadata['deviceName']+'/upload'
136 - }
282 + //metadata: {}
137 137  
138 138  };
139 139  
... ... @@ -144,23 +144,23 @@
144 144  Click on the **Add** button.
145 145  
146 146  
293 +[[image:downlink-data-converter.png||height="530" width="500"]]
147 147  
148 -[[image:add-downlink-data-converter.png||height="529" width="500"]]
149 149  
150 150  
151 -You should see that the newly added **MQTT Downlink** Converter NB/CB is listed on the **Data Converters** page.
297 +You should see that the newly added **downlink data converter** is listed on the **Data Converters** page.
152 152  
153 153  
300 +[[image:data-converter-list.png]]
154 154  
155 -[[image:data-converters-list.png]]
156 156  
157 -= 3. Add Integration =
303 += Add Integration =
158 158  
159 -
160 160  In the left navigation, click **Integrations center**, and then click **Integrations**.
161 161  
162 162  On the **Integrations** page, click on the '**+**' button.
163 163  
309 +
164 164  [[image:data-converter-list-page.png]]
165 165  
166 166  
... ... @@ -176,9 +176,11 @@
176 176  
177 177  Click **Next** button.
178 178  
325 +
179 179  [[image:add-integration-basic-settings.png||height="511" width="500"]]
180 180  
181 181  
329 +
182 182  **Uplink data converter:**
183 183  
184 184  * Click on the **Select existing** button.
... ... @@ -186,9 +186,11 @@
186 186  
187 187  Click **Next** button.
188 188  
337 +
189 189  [[image:add-integration-uplink-data-converter.png||width="500"]]
190 190  
191 191  
341 +
192 192  **Downlink data converter:**
193 193  
194 194  * Click on the **Select existing** button.
... ... @@ -196,24 +196,24 @@
196 196  
197 197  Click **Next** button.
198 198  
349 +
199 199  [[image:add-integration-downlink-data-converter.png||height="510" width="500"]]
200 200  
201 201  
353 +
202 202  **Connection:**
203 203  
204 -* **Host**: Cluster URL (Eg. 011731f7928541588a6cdfbbedfc63f4.s1.eu.hivemq.cloud)
205 -* **Port**: 8883
356 +* **Host**: mqtt.eu.thingsboard.cloud (This is the host name you copied from the device - See section xxxxx for more information)
357 +* **Port**: 1883 (This is the port number you copied from the device - See section xxxxx for more information)
206 206  * **Credentials**: Basic
207 -* **Enable SSL**: YES
208 -* **Username**: Username (from your HiveMQ Cloud Cluster with your credentials)
209 -* **Password:** Password (from your HiveMQ Cloud Cluster with your credentials)
210 -* **Topic:** tb/mqtt-integration-tutorial/sensors/+/telemetry (the + replaces any 'device name' and creates devices in the Entities -> Devices)
211 -* **QoS:** 0-At most once
212 -* **Clean session:** NO
213 -* **Retained**: NO
359 +* **Username**: Access token (This is the access token you copied from the device)
360 +* **Password** - Leave it as blank
361 +* **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')
362 +* **QoS** - 0-At most once
214 214  
215 215  Click on the **Check connection** button to verify the MQTT connection using the provided parameters.
216 216  
366 +
217 217  [[image:add-integration-connection.png||width="500"]]
218 218  
219 219  
... ... @@ -221,6 +221,7 @@
221 221  
222 222  Click on the **Add** button.
223 223  
374 +
224 224  [[image:add-connection-success.png||height="511" width="500"]]
225 225  
226 226  
... ... @@ -228,18 +228,18 @@
228 228  
229 229  Since we haven't received data from a device yet, the integration **Status** is shown as **Pending.**
230 230  
231 -[[image:integrations-list-added-pending.png]]
232 232  
233 233  
234 -= 5. Verifying the receipt of data from the device =
384 +[[image:integrations-list-added-pending.png]]
235 235  
236 236  
387 += Verifying the receipt of data from the device =
388 +
237 237  On the terminal, issue the following MQTT command which simulates the device S31B-NB.
238 238  
391 +
239 239  {{code language="none"}}
240 240  mosquitto_pub -d -q 1 -h mqtt.eu.thingsboard.cloud -p 1883 -t v1/devices/S31B-NB/telemetry -u "24vk3w9h7sqdld1me5eh" -m "{temperature:20}"
241 241  {{/code}}
242 242  
243 243  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.
244 -
245 -
add-downlink-data-converter.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -175.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
create-new-converter-menu.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -31.5 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
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
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.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
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-showing-uplink-dc.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +194.9 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