Skip to Content

Changes for page ThingsBoard

Last modified by Dilisi S on 2025/04/23 19:23
From version 106.1
edited by Dilisi S
on 2025/03/08 18:59
Change comment: Uploaded new attachment "new-integration-pending.png", version {1}
To version 91.1
edited by Dilisi S
on 2025/03/08 03:54
Change comment: Uploaded new attachment "add-downlink-data-converter.png", version {1}

Summary

Details

Page properties
Content
... ... @@ -17,126 +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. Add New Device =
20 20  
21 21  
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.
22 22  
23 -= 2. Data Converters =
25 +In the left navigation, click **Entities** and then click **Devices**.
24 24  
27 +[[image:device-list-empty.png]]
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  
30 +On the **Devices **page, click on the ‘**+**’ button, and then click on the **Add new device **from the dropdown menu.
28 28  
29 -== 2.1 Uplink ==
32 +[[image:ThingsBoard-add-new-device.png||height="279" width="500"]]
30 30  
31 31  
32 -In the left navigation, click **Integrations center**, and then click **Data converters**.
35 +The **Add new device** window appears. Name the device, for example '**Virtual NB/CB device**'.
33 33  
37 +Click on the **Next: Credentials** button.
34 34  
39 +[[image:new-device-device-details.png||height="529" width="500"]]
35 35  
36 -[[image:data-converters-list-empty.png]]
37 37  
42 +Click the **Access token** button if it is not selected by default.
38 38  
39 -On the **Data converters** page, click on the ‘**+**’ button, and then click on the **Create new converter** from the dropdown menu.
44 +Copy the **Access token** to a text editor, as you will need it in the section **'Sending data from an MQTT client'**.
40 40  
46 +Click on the **Add** button.
41 41  
48 +[[image:new-device-access-token.png||height="528" width="500"]]
42 42  
43 -[[image:create-new-converter-menu.png||height="259" width="500"]]
44 44  
51 +Click on the **MQTT** button.
45 45  
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 +
55 +Copy the MQTT pub command in the '**Execute the following command**' section.
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 +
61 +Note that the **State** is still shown as **'Inactive'** in the **Latest telemetry** section.
62 +
63 +[[image:new-device-check-connectivity.png||height="522" width="500"]]
64 +
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 +
68 +
69 +[[image:mqtt-command-1.png||height="228" width="700"]]
70 +
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 +
74 +
75 +[[image:new-device-telemetry-test.png||height="520" width="500"]]
76 +
77 +
78 +Send the same command again, only changing the **temperature** value, to see how the **Latest telemetry** section updates its data.
79 +
80 +Once you are done experimenting with this, close the window by clicking the **Close** button.
81 +
82 +
83 +[[image:mqtt-command-2.png||height="227" width="700"]]
84 +
85 +
86 +
87 +[[image:virtual-device-active.png]]
88 +
89 +
90 += 3. Data Converters =
91 +
92 +
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 +
95 +
96 +== 3.1 Uplink ==
97 +
98 +
99 +In the left navigation, click **Integrations center**, and then click **Data converters**.
100 +
101 +[[image:data-converter-list-page.png]]
102 +
103 +
104 +On the **Data converters** page, click on the ‘+’ button, and then click on the **Create new converter** from the dropdown menu.
105 +
106 +[[image:ThingsBoard-new-data-converter.png||height="282" width="500"]]
107 +
108 +
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.
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.
49 49  
50 50  {{code language="JavaScript"}}
51 -/** Decoder **/
52 -
114 +//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';
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();
60 60  
61 -// 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 +}
62 62  var result = {
206 +
63 63   deviceName: deviceName,
64 - deviceType: deviceType,
208 + deviceType: modelname,
65 65   attributes: {
66 - integrationName: metadata['integrationName'],
210 + model: modelname,
211 + //customerName: "NB-CB",
212 + //groupName: "NB-CB",
213 + //integrationName: metadata['integrationName']
214 +
67 67   },
68 - telemetry: {
69 - temperature: data.temperature,
70 - humidity: data.humidity,
71 - }
72 -};
216 + telemetry: listdata
217 +}
73 73  
74 -/** Helper functions 'decodeToString' and 'decodeToJson' are already built-in **/
219 +function decodeToString(payload) {
220 + return String.fromCharCode.apply(String, payload);
221 +}
75 75  
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 +
76 76  return result;
233 +
77 77  {{/code}}
78 78  
79 79  
80 80  Click on the **Add** button.
81 81  
239 +[[image:uplink-data-converter.png||height="529" width="500"]]
82 82  
83 83  
84 -[[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.
85 85  
86 -
87 -You should see that the newly added **MQTT Uplink converter **NB/CB is listed on the **Data Converters** page.
88 -
89 89  [[image:data-converter-list-showing-uplink-dc.png]]
90 90  
91 91  
92 -
93 93  == 3.2 Downlink ==
94 94  
95 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  
252 +[[image:ThingsBoard-new-data-converter.png||height="282" width="500"]]
98 98  
99 -[[image:create-new-converter-menu.png||width="500"]]
100 100  
101 -
102 -
103 103  The **Add data converter** window will appear. Name it ‘**MQTT Downlink Converter NB/CB**’ and select the Type as **Downlink**.
104 104  
105 -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.
106 106  
107 107  
108 108  {{code language="JavaScript"}}
109 -// 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 +}
110 110  
111 -// msg - JSON message payload downlink message json
112 -// msgType - type of message, for ex. 'ATTRIBUTES_UPDATED', 'POST_TELEMETRY_REQUEST', etc.
113 -// metadata - list of key-value pairs with additional data about the message
114 -// integrationMetadata - list of key-value pairs with additional data defined in Integration executing this converter
115 -
116 -/** Encoder **/
117 -
118 -var data = {};
119 -
120 -// Process data from incoming message and metadata
121 -
122 -data.tempFreq = msg.temperatureUploadFrequency;
123 -data.humFreq = msg.humidityUploadFrequency;
124 -
125 -data.devSerialNumber = metadata['ss_serialNumber'];
126 -
127 127  // Result object with encoded downlink payload
128 128  var result = {
129 -
130 130   // downlink data content type: JSON, TEXT or BINARY (base64 format)
131 - contentType: "JSON",
276 + contentType: "BINARY",
132 132  
133 133   // downlink data
134 - data: JSON.stringify(data),
279 + data:hexToBase64(metadata.shared_value)
135 135  
136 136   // Optional metadata object presented in key/value format
137 - metadata: {
138 - topic: metadata['deviceType']+'/'+metadata['deviceName']+'/upload'
139 - }
282 + //metadata: {}
140 140  
141 141  };
142 142  
... ... @@ -146,31 +146,24 @@
146 146  
147 147  Click on the **Add** button.
148 148  
292 +[[image:downlink-data-converter.png||height="530" width="500"]]
149 149  
150 150  
151 -[[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.
152 152  
297 +[[image:data-converter-list.png]]
153 153  
154 -You should see that the newly added **MQTT Downlink** Converter NB/CB is listed on the **Data Converters** page.
155 155  
300 += 4. Add Integration =
156 156  
157 -[[image:data-converters-list.png]]
158 158  
159 -(% class="wikigeneratedid" %)
160 -
161 -
162 -= 3. Add Integration =
163 -
164 -
165 165  In the left navigation, click **Integrations center**, and then click **Integrations**.
166 166  
167 -
168 -[[image:integrations-list-empty.png]]
169 -
170 -
171 171  On the **Integrations** page, click on the '**+**' button.
172 172  
307 +[[image:data-converter-list-page.png]]
173 173  
309 +
174 174  The **Add integration** window appears.
175 175  
176 176  In the **Add integration** window, configure the following settings:
... ... @@ -180,13 +180,9 @@
180 180  
181 181  * **Integration type**: MQTT
182 182  * **Name**: MQTT integration NB/CB
183 -* **Enable integration**: YES
184 -* **Allows create devices or assets**: YES
185 185  
186 186  Click **Next** button.
187 187  
188 -
189 -
190 190  [[image:add-integration-basic-settings.png||height="511" width="500"]]
191 191  
192 192  
... ... @@ -197,11 +197,9 @@
197 197  
198 198  Click **Next** button.
199 199  
332 +[[image:add-integration-uplink-data-converter.png||width="500"]]
200 200  
201 201  
202 -[[image:add-integration-uplink-data-converter.png||height="511" width="500"]]
203 -
204 -
205 205  **Downlink data converter:**
206 206  
207 207  * Click on the **Select existing** button.
... ... @@ -209,49 +209,29 @@
209 209  
210 210  Click **Next** button.
211 211  
342 +[[image:add-integration-downlink-data-converter.png||height="510" width="500"]]
212 212  
213 213  
214 -[[image:add-integration-downlink-data-converter.png||height="511" width="500"]]
215 -
216 -
217 217  **Connection:**
218 218  
219 -* **Host**: Cluster URL (Eg. 011731f7928541588a6cdfbbedfc63f4.s1.eu.hivemq.cloud)
220 -* **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)
221 221  * **Credentials**: Basic
222 -* **Enable SSL**: YES
223 -* **Username**: Username (from your HiveMQ Cloud Cluster with your credentials)
224 -* **Password:** Password (from your HiveMQ Cloud Cluster with your credentials)
225 -* **Topic:** tb/mqtt-integration-tutorial/sensors/+/telemetry (the + replaces any 'device name' and creates devices in the Entities -> Devices)
226 -* **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
227 227  
228 -
229 -[[image:add-integration-connection.png||height="511" width="500"]]
230 -
231 -
232 -Click on the **Advanced settings** button.
233 -
234 -* **Clean session:** NO
235 -* **Retained**: NO
236 -
237 -[[image:add-integration-connection-advanced-settings.png||height="510" width="500"]]
238 -
239 -
240 240  Click on the **Check connection** button to verify the MQTT connection using the provided parameters.
241 241  
357 +[[image:add-integration-connection.png||width="500"]]
242 242  
243 243  
244 -[[image:check-connection.png||height="83" width="300"]]
245 -
246 -
247 247  If the connection is successful, you will see the **Connected** message.
248 248  
249 -
250 -[[image:connection-success.png||height="511" width="500"]]
251 -
252 -
253 253  Click on the **Add** button.
254 254  
364 +[[image:add-connection-success.png||height="511" width="500"]]
255 255  
256 256  
257 257  You should see that the newly added integration is listed on the **Integrations** page.
... ... @@ -271,3 +271,5 @@
271 271  {{/code}}
272 272  
273 273  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-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
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
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.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -212.2 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