Skip to Content

Changes for page ThingsBoard

Last modified by Dilisi S on 2025/04/23 19:23
From version 94.1
edited by Dilisi S
on 2025/03/08 04:04
Change comment: There is no comment for this version
To version 61.1
edited by Dilisi S
on 2025/03/06 13:08
Change comment: Mar 6 edits - part 1

Summary

Details

Page properties
Content
... ... @@ -6,135 +6,276 @@
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.
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 += Data Converters =
85 +
86 +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.
87 +
88 +
89 +== Uplink ==
90 +
91 +In the left navigation, click **Integrations center**, and then click **Data converters**.
92 +
93 +
94 +[[image:data-converter-list-page.png]]
95 +
96 +
97 +On the **Data converters** page, click on the ‘+’ button, and then click on the **Create new converter** from the dropdown menu.
98 +
99 +
100 +[[image:ThingsBoard-new-data-converter.png||height="282" width="500"]]
101 +
102 +
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.
105 +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 -
108 +//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';
113 +var objdata = {};
114 +var obj1 = {};
115 +var data = decodeToJson(payload);
116 +var deviceName = data.IMEI;
117 +delete data.IMEI;
118 +var modelname = "Dragino " + data.Model;
119 +//var mod = data.mod
120 +delete data.Model;
121 +//delete data.mod
122 +var timestamp = new Date().getTime();
60 60  
61 -// Result object with device attributes/telemetry data
124 +for (var key in data) {
125 +
126 + if (Number(key)) {
127 + obj1[key] = data[key];
128 + obj1[key][obj1[key].length - 1] = Number(new Date(
129 + obj1[key][obj1[key].length - 1]));
130 +
131 + }
132 +//Alec submitted25/02/25
133 +//turn old key into new
134 + else if (key === "Reading") {
135 + objdata["reading"] = data[key];
136 + } else if (key === "work mode") {
137 + objdata["work_mode"] = data[key];
138 + } else if (key === "hum") {
139 + objdata["humidity"] = data[key];
140 + }else if (key === "hum2") {
141 + objdata["humidity2"] = data[key];
142 + } else if (key === "hum3") {
143 + objdata["humidity3"] = data[key];
144 + } else if (key === "tem") {
145 + objdata["temperature"] = data[key];
146 + } else if (key === "tem2") {
147 + objdata["temperature2"] = data[key];
148 + } else if (key === "tem3") {
149 + objdata["temperature3"] = data[key];
150 + } else if (key === "DS18B20_Temp") {
151 + objdata["temperature_pro"] = data[key];
152 + } else if (key === "ds18b20_temperature") {
153 + objdata["temperature_pro"] = data[key];
154 + } else if (key === "DS18B20_temperature_pro") {
155 + objdata["temperature_pro"] = data[key];
156 + } else if (key === "tdc send flag") {
157 + objdata["tdc_send_flag"] = data[key];
158 + } else if (key === "trigger mode") {
159 + objdata["trigger_mode"] = data[key];
160 + } else if (key === "soil dielectric constant") {
161 + objdata["soil_dielectric_constant"] = data[key];
162 + } else if (key === "door open num") {
163 + objdata["door_open_num"] = data[key];
164 + } else if (key === "door duration") {
165 + objdata["door_duration"] = data[key];
166 + } else if (key === "count time") {
167 + objdata["count_time"] = data[key];
168 + } else if (key === "last open time2") {
169 + objdata["last_open_time2"] = data[key];
170 + } else if (key === "last open time3") {
171 + objdata["last_open_time3"] = data[key];
172 + }
173 +//Alec submitted25/02/25
174 + else {
175 + objdata[key] = data[key]
176 + }
177 +}
178 +var listdata = [{
179 + "ts": timestamp,
180 + "values": objdata
181 +}]
182 +for (var key1 in obj1) {
183 + if (modelname == "Dragino RS485-NB") {
184 + listdata.push({
185 + "ts": obj1[key1][obj1[key1].length - 1],
186 + "values": {
187 + "Payload": obj1[key1][0],
188 + }
189 + })
190 + } else {
191 + listdata.push({
192 + "ts": obj1[key1][obj1[key1].length - 1],
193 + "values": {
194 + "values": obj1[key1]
195 + },
196 + })
197 + }
198 +}
62 62  var result = {
200 +
63 63   deviceName: deviceName,
64 - deviceType: deviceType,
202 + deviceType: modelname,
65 65   attributes: {
66 - integrationName: metadata['integrationName'],
204 + model: modelname,
205 + //customerName: "NB-CB",
206 + //groupName: "NB-CB",
207 + //integrationName: metadata['integrationName']
208 +
67 67   },
68 - telemetry: {
69 - temperature: data.temperature,
70 - humidity: data.humidity,
71 - }
72 -};
210 + telemetry: listdata
211 +}
73 73  
74 -/** Helper functions 'decodeToString' and 'decodeToJson' are already built-in **/
213 +function decodeToString(payload) {
214 + return String.fromCharCode.apply(String, payload);
215 +}
75 75  
217 +function decodeToJson(payload) {
218 + // covert payload to string.
219 + var str = decodeToString(payload);
220 +
221 + // parse string to JSON
222 + var data = JSON.parse(str);
223 + return data;
224 +}
225 +
76 76  return result;
227 +
77 77  {{/code}}
78 78  
79 -
80 80  Click on the **Add** button.
81 81  
82 82  
233 +[[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.
237 +You should see that the newly added **uplink data converter** is listed on the **Data Converters** page.
88 88  
89 89  
240 +[[image:data-converter-list-showing-uplink-dc.png]]
90 90  
91 -[[image:create-new-converter-menu.png||width="500"]]
92 92  
93 -== 3.2 Downlink ==
243 +== Downlink ==
94 94  
95 -
96 96  On the **Data converters** page, click on the ‘**+**’ button, and then click on the **Create new converter** from the dropdown menu.
97 97  
247 +
98 98  [[image:ThingsBoard-new-data-converter.png||height="282" width="500"]]
99 99  
100 100  
101 101  The **Add data converter** window will appear. Name it ‘**MQTT Downlink Converter NB/CB**’ and select the Type as **Downlink**.
102 102  
103 -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.
253 +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.
104 104  
105 105  
106 106  {{code language="JavaScript"}}
107 -// Encode downlink data from incoming Rule Engine message
257 +function hexToBase64(hexString) {
258 + // 将16进制字符串两个字符转换为一个字节
259 + var bytes = hexString.match(/.{2}/g);
260 + // 对每个字节进行解析，并转换为对应的字符
261 + var binaryString = bytes.map(function(byte) {
262 + return String.fromCharCode(parseInt(byte, 16));
263 + }).join('');
264 +
265 + // 使用btoa进行base64编码
266 + return btoa(binaryString);
267 +}
108 108  
109 -// msg - JSON message payload downlink message json
110 -// msgType - type of message, for ex. 'ATTRIBUTES_UPDATED', 'POST_TELEMETRY_REQUEST', etc.
111 -// metadata - list of key-value pairs with additional data about the message
112 -// integrationMetadata - list of key-value pairs with additional data defined in Integration executing this converter
113 -
114 -/** Encoder **/
115 -
116 -var data = {};
117 -
118 -// Process data from incoming message and metadata
119 -
120 -data.tempFreq = msg.temperatureUploadFrequency;
121 -data.humFreq = msg.humidityUploadFrequency;
122 -
123 -data.devSerialNumber = metadata['ss_serialNumber'];
124 -
125 125  // Result object with encoded downlink payload
126 126  var result = {
127 -
128 128   // downlink data content type: JSON, TEXT or BINARY (base64 format)
129 - contentType: "JSON",
272 + contentType: "BINARY",
130 130  
131 131   // downlink data
132 - data: JSON.stringify(data),
275 + data:hexToBase64(metadata.shared_value)
133 133  
134 134   // Optional metadata object presented in key/value format
135 - metadata: {
136 - topic: metadata['deviceType']+'/'+metadata['deviceName']+'/upload'
137 - }
278 + //metadata: {}
138 138  
139 139  };
140 140  
... ... @@ -145,23 +145,23 @@
145 145  Click on the **Add** button.
146 146  
147 147  
289 +[[image:downlink-data-converter.png||height="530" width="500"]]
148 148  
149 -[[image:add-downlink-data-converter.png||height="529" width="500"]]
150 150  
151 151  
152 -You should see that the newly added **MQTT Downlink** Converter NB/CB is listed on the **Data Converters** page.
293 +You should see that the newly added **downlink data converter** is listed on the **Data Converters** page.
153 153  
154 154  
296 +[[image:data-converter-list.png]]
155 155  
156 -[[image:data-converters-list.png]]
157 157  
158 -= 3. Add Integration =
299 += Add Integration =
159 159  
160 -
161 161  In the left navigation, click **Integrations center**, and then click **Integrations**.
162 162  
163 163  On the **Integrations** page, click on the '**+**' button.
164 164  
305 +
165 165  [[image:data-converter-list-page.png]]
166 166  
167 167  
... ... @@ -177,9 +177,11 @@
177 177  
178 178  Click **Next** button.
179 179  
321 +
180 180  [[image:add-integration-basic-settings.png||height="511" width="500"]]
181 181  
182 182  
325 +
183 183  **Uplink data converter:**
184 184  
185 185  * Click on the **Select existing** button.
... ... @@ -187,9 +187,11 @@
187 187  
188 188  Click **Next** button.
189 189  
333 +
190 190  [[image:add-integration-uplink-data-converter.png||width="500"]]
191 191  
192 192  
337 +
193 193  **Downlink data converter:**
194 194  
195 195  * Click on the **Select existing** button.
... ... @@ -197,24 +197,24 @@
197 197  
198 198  Click **Next** button.
199 199  
345 +
200 200  [[image:add-integration-downlink-data-converter.png||height="510" width="500"]]
201 201  
202 202  
349 +
203 203  **Connection:**
204 204  
205 -* **Host**: Cluster URL (Eg. 011731f7928541588a6cdfbbedfc63f4.s1.eu.hivemq.cloud)
206 -* **Port**: 8883
352 +* **Host**: mqtt.eu.thingsboard.cloud (This is the host name you copied from the device - See section xxxxx for more information)
353 +* **Port**: 1883 (This is the port number you copied from the device - See section xxxxx for more information)
207 207  * **Credentials**: Basic
208 -* **Enable SSL**: YES
209 -* **Username**: Username (from your HiveMQ Cloud Cluster with your credentials)
210 -* **Password:** Password (from your HiveMQ Cloud Cluster with your credentials)
211 -* **Topic:** tb/mqtt-integration-tutorial/sensors/+/telemetry (the + replaces any 'device name' and creates devices in the Entities -> Devices)
212 -* **QoS:** 0-At most once
213 -* **Clean session:** NO
214 -* **Retained**: NO
355 +* **Username**: Access token (This is the access token you copied from the device)
356 +* **Password** - Leave it as blank
357 +* **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')
358 +* **QoS** - 0-At most once
215 215  
216 216  Click on the **Check connection** button to verify the MQTT connection using the provided parameters.
217 217  
362 +
218 218  [[image:add-integration-connection.png||width="500"]]
219 219  
220 220  
... ... @@ -222,6 +222,7 @@
222 222  
223 223  Click on the **Add** button.
224 224  
370 +
225 225  [[image:add-connection-success.png||height="511" width="500"]]
226 226  
227 227  
... ... @@ -229,17 +229,11 @@
229 229  
230 230  Since we haven't received data from a device yet, the integration **Status** is shown as **Pending.**
231 231  
232 -[[image:integrations-list-added-pending.png]]
233 233  
234 234  
235 -= 5. Verifying the receipt of data from the device =
380 +[[image:integrations-list-added-pending.png]]
236 236  
237 237  
238 -On the terminal, issue the following MQTT command which simulates the device S31B-NB.
383 += Verifying the receipt of data from the device =
239 239  
240 -{{code language="none"}}
241 -mosquitto_pub -d -q 1 -h mqtt.eu.thingsboard.cloud -p 1883 -t v1/devices/S31B-NB/telemetry -u "24vk3w9h7sqdld1me5eh" -m "{temperature:20}"
242 -{{/code}}
243 -
244 -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.
245 -
385 +Connect **S31B-NB** to transfer information. If the integration was performed without errors, after the transmission of the first telemetry, a new device with the name “xxxxx” will appear in the Devices → All. Also, you can verify the input and output data, respectively, before and after conversion in Data converters → UDP Uplink Converter NB/CB → Events.
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