Changes for page ThingsBoard

Last modified by Dilisi S on 2025/04/15 23:13
<
From version < 154.1 >
edited by Dilisi S
on 2025/03/17 00:15
To version < 159.1 >
edited by Dilisi S
on 2025/03/18 03:49
>
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -22,7 +22,10 @@
22 22  To complete this tutorial, you need to have the following:
23 23  
24 24  * ThingsBoard cloud account
25 -* HiveMQ Cloud account
25 +* MQTT Broker (public or private) such as,
26 +** **[[HiveMQ Cloud>>https://www.hivemq.com]] - You can create a free account to try it or subscribe for a paid account. - We use HiveMQ Cloud as the MQTT broker to build example in this tutorial.**
27 +** [[emqx>>https://www.emqx.com/zh/mqtt/public-mqtt5-broker]] - The public MQTT server is only used for MOTT learning and testing, and should not be used in the production environment.
28 +** [[lns1.thingseye.io>>http://lns1.thingseye.io/]] - This is Dragino's MQTT broker, which requires a CA certificate to use.
26 26  
27 27  == 2.1 ThingsBoard Cloud ==
28 28  
... ... @@ -66,7 +66,9 @@
66 66  
67 67  == 2.2 HiveMQ Cloud ==
68 68  
72 +=== 2.2.1 HiveMQ Cloud ===
69 69  
74 +
70 70  Go to [[https:~~/~~/www.hivemq.com>>https://www.hivemq.com]]
71 71  
72 72  Click on the **Start Free** button.
... ... @@ -141,6 +141,24 @@
141 141  You will need these MQTT connection parameters when configuring the MQTT integration in the '**Add Integration**' section.
142 142  
143 143  
149 +=== 2.2.2 emqx ===
150 +
151 +
152 +The [[emqx>>https://www.emqx.com/zh/mqtt/public-mqtt5-broker]] public MQTT server is only used for MOTT learning and testing, and should not be used in the production environment.
153 +
154 +
155 +[[image:emqx.png||height="420" width="500"]]
156 +
157 +
158 +=== 2.2.3 Ins1.thingseye.io ===
159 +
160 +[[lns1.thingseye.io>>http://lns1.thingseye.io/]] is the Dragino's MQTT broker, which requires a CA certificate file, Certificate file, and the Private key file to use.
161 +
162 +If customers need to use this MQTT connection with ThingsBoard, they need to contact the TE team to obtain three license files.
163 +
164 +[[image:ins1.png||height="310" width="500"]]
165 +
166 +
144 144  = 3. Data Converters =
145 145  
146 146  
... ... @@ -153,7 +153,6 @@
153 153  In the left navigation, click **Integrations center**, and then click **Data converters**.
154 154  
155 155  
156 -
157 157  [[image:data-converters-list-empty.png]]
158 158  
159 159  
... ... @@ -166,34 +166,130 @@
166 166  
167 167  The **Add data converter** window will appear. Name it ‘**MQTT Uplink Converter NB/CB**’ and select the Type as **Uplink**.
168 168  
169 -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.
191 +Click on the **JavaScript** button.
170 170  
171 -{{code language="JavaScript"}}
172 -/** Decoder **/
193 +Delete the default decoder function in the code editor. Now copy and paste the following decoder function written in **JavaScript** in to the **code editor**. This decoder function is compatible for both NB and CB series devices.
173 173  
195 +
196 +{{code language="JavaScript"}}
197 +//Version: 0.1
174 174  // decode payload to string
175 175  var payloadStr = decodeToString(payload);
176 -var data = JSON.parse(payloadStr);
177 177  
178 -var deviceName = metadata.topic.split("/")[3];
179 179  // decode payload to JSON
180 -var deviceType = 'sensor';
202 +var objdata = {};
203 +var obj1 = {};
204 +var data = decodeToJson(payload);
205 +var deviceName = data.IMEI;
206 +delete data.IMEI;
207 +var modelname = "Dragino " + data.Model;
208 +//var mod = data.mod
209 +delete data.Model;
210 +//delete data.mod
211 +var timestamp = new Date().getTime();
181 181  
182 -// Result object with device attributes/telemetry data
213 +for (var key in data) {
214 +
215 + if (Number(key)) {
216 + obj1[key] = data[key];
217 + obj1[key][obj1[key].length - 1] = Number(new Date(
218 + obj1[key][obj1[key].length - 1]));
219 +
220 + }
221 +//Alec submitted25/02/25
222 +//turn old key into new
223 + else if (key === "Reading") {
224 + objdata["reading"] = data[key];
225 + } else if (key === "work mode") {
226 + objdata["work_mode"] = data[key];
227 + } else if (key === "hum") {
228 + objdata["humidity"] = data[key];
229 + }else if (key === "hum2") {
230 + objdata["humidity2"] = data[key];
231 + } else if (key === "hum3") {
232 + objdata["humidity3"] = data[key];
233 + } else if (key === "tem") {
234 + objdata["temperature"] = data[key];
235 + } else if (key === "tem2") {
236 + objdata["temperature2"] = data[key];
237 + } else if (key === "tem3") {
238 + objdata["temperature3"] = data[key];
239 + } else if (key === "DS18B20_Temp") {
240 + objdata["temperature_pro"] = data[key];
241 + } else if (key === "ds18b20_temperature") {
242 + objdata["temperature_pro"] = data[key];
243 + } else if (key === "DS18B20_temperature_pro") {
244 + objdata["temperature_pro"] = data[key];
245 + } else if (key === "tdc send flag") {
246 + objdata["tdc_send_flag"] = data[key];
247 + } else if (key === "trigger mode") {
248 + objdata["trigger_mode"] = data[key];
249 + } else if (key === "soil dielectric constant") {
250 + objdata["soil_dielectric_constant"] = data[key];
251 + } else if (key === "door open num") {
252 + objdata["door_open_num"] = data[key];
253 + } else if (key === "door duration") {
254 + objdata["door_duration"] = data[key];
255 + } else if (key === "count time") {
256 + objdata["count_time"] = data[key];
257 + } else if (key === "last open time2") {
258 + objdata["last_open_time2"] = data[key];
259 + } else if (key === "last open time3") {
260 + objdata["last_open_time3"] = data[key];
261 + }
262 +//Alec submitted25/02/25
263 + else {
264 + objdata[key] = data[key]
265 + }
266 +}
267 +var listdata = [{
268 + "ts": timestamp,
269 + "values": objdata
270 +}]
271 +for (var key1 in obj1) {
272 + if (modelname == "Dragino RS485-NB") {
273 + listdata.push({
274 + "ts": obj1[key1][obj1[key1].length - 1],
275 + "values": {
276 + "Payload": obj1[key1][0],
277 + }
278 + })
279 + } else {
280 + listdata.push({
281 + "ts": obj1[key1][obj1[key1].length - 1],
282 + "values": {
283 + "values": obj1[key1]
284 + },
285 + })
286 + }
287 +}
183 183  var result = {
289 +
184 184   deviceName: deviceName,
185 - deviceType: deviceType,
291 + deviceType: modelname,
186 186   attributes: {
187 - integrationName: metadata['integrationName'],
293 + model: modelname,
294 + //customerName: "NB-CB",
295 + //groupName: "NB-CB",
296 + //integrationName: metadata['integrationName']
297 +
188 188   },
189 - telemetry: {
190 - temperature: data.temperature,
191 - humidity: data.humidity,
192 - }
193 -};
299 + telemetry: listdata
300 +}
194 194  
195 -/** Helper functions 'decodeToString' and 'decodeToJson' are already built-in **/
302 +function decodeToString(payload) {
303 + return String.fromCharCode.apply(String, payload);
304 +}
196 196  
306 +function decodeToJson(payload) {
307 + // covert payload to string.
308 + var str = decodeToString(payload);
309 +
310 + // parse string to JSON
311 + var data = JSON.parse(str);
312 + return data;
313 +}
314 +
197 197  return result;
198 198  {{/code}}
199 199  
... ... @@ -201,16 +201,16 @@
201 201  Click on the **Add** button.
202 202  
203 203  
322 +[[image:mqtt-uplink.png||width="500"]]
204 204  
205 -[[image:add-uplink-data-converter.png||height="529" width="500"]]
206 206  
207 207  
208 208  You should see that the newly added **MQTT Uplink converter **NB/CB is listed on the **Data Converters** page.
209 209  
328 +
210 210  [[image:data-converter-list-showing-uplink-dc.png]]
211 211  
212 212  
213 -
214 214  == 3.2 Downlink ==
215 215  
216 216  
... ... @@ -268,7 +268,6 @@
268 268  Click on the **Add** button.
269 269  
270 270  
271 -
272 272  [[image:add-downlink-data-converter.png||height="529" width="500"]]
273 273  
274 274  
... ... @@ -278,7 +278,6 @@
278 278  [[image:data-converters-list.png]]
279 279  
280 280  
281 -
282 282  = 4. Add Integration =
283 283  
284 284  
... ... @@ -306,7 +306,6 @@
306 306  Click **Next** button.
307 307  
308 308  
309 -
310 310  [[image:add-integration-basic-settings.png||height="511" width="500"]]
311 311  
312 312  
... ... @@ -318,7 +318,6 @@
318 318  Click **Next** button.
319 319  
320 320  
321 -
322 322  [[image:add-integration-uplink-data-converter.png||height="511" width="500"]]
323 323  
324 324  
... ... @@ -330,21 +330,22 @@
330 330  Click **Next** button.
331 331  
332 332  
333 -
334 334  [[image:add-integration-downlink-data-converter.png||height="511" width="500"]]
335 335  
336 336  
337 337  **Connection:**
338 338  
339 -* **Host**: Cluster URL (Eg. 011731f7928541588a6cdfbbedfc63f4.s1.eu.hivemq.cloud)
452 +* **Host**: Cluster URL (Eg. 011731f7xxxxxxxxxxxfbbedfc63f4.s1.eu.hivemq.cloud)
340 340  * **Port**: 8883
341 341  * **Credentials**: Basic
342 342  * **Enable SSL**: YES
343 343  * **Username**: Username (from your HiveMQ Cloud Cluster with your credentials)
344 344  * **Password:** Password (from your HiveMQ Cloud Cluster with your credentials)
345 -* **Topic:** tb/mqtt-integration-tutorial/sensors/+/telemetry (the + replaces any 'device name' and creates devices in the Entities -> Devices)
458 +* **Topic: v1/devices/+/telemetry** (the + replaces any 'device name' will create a device in the Entities -> Devices)
346 346  * **QoS:** 0-At most once
347 347  
461 +
462 +
348 348  [[image:add-integration-connection.png||height="511" width="500"]]
349 349  
350 350  
... ... @@ -387,29 +387,17 @@
387 387  
388 388  We use the Mosquitto MQTT client to simulate MQTT messages, acting as a virtual device. First, install the Mosquitto client on your computer from [[this link>>url:https://mosquitto.org/download/]]. The Mosquitto client publishes messages to the MQTT broker (HiveMQ) on a specified MQTT topic. ThingsBoard subscribes to these messages using the same topic.
389 389  
390 -The Mosquitto client publishes messages on the topic v1/devices/[device_name]/telemetry. The [device_name]placeholder can be replaced with any device name, for example, 'S31B-NB'. Then, the MQTT topic would be v1/devices/S31B-NB/telemetry.
505 +The Mosquitto client publishes messages (payloads) on the topic **v1/devices/me/telemetry**. Of course, you can use any topic for testing.
391 391  
392 -On the ThingsBoard side, we configure the MQTT topic subscription as v1/devices/+/telemetry. The + wildcard represents any device name and allows ThingsBoard to automatically create (provision) a device with that name, such as S31B-NB, for example.
507 +(% id="cke_bm_37386S" style="display:none" %) (%%)The MQTT payload format is as follows, which is common for all **~-~-NB** and **~-~-CB** series devices. The **IMEI** field is mandatory and is used to provision a new device with the name assigned to it in ThingsBoard.
393 393  
394 -
395 -**The new device is created the first time the MQTT topic is received. For subsequent MQTT topics with the same device name, no duplicate devices will be created.**
396 -
397 -
398 -For example, if you send two MQTT messages with different device names in the topic:
399 -
400 -1. v1/devices/**S31B-NB**/telemetry
401 -1. v1/devices/**LDS25-NB**/telemetry
402 -
403 -ThingsBoard will create two devices named **S31B-NB** and **LDS25-NB** in the **//Devices//** section.
404 -
405 -
406 -The MQTT payload format is as follows, which is common for all ~-~-NB and ~-~-CB series devices:
407 -
408 408  {{code language="none"}}
409 -{"temperature":10.4, "humidity":85}
510 +{"IMEI": "S31B-NB", "temperature": 27, ......}
410 410  {{/code}}
411 411  
513 +Once ThingsBoard receives this message, it automatically creates (provisions) the device mentioned in the **IMEI**, for example, S31B-NB.
412 412  
515 +
413 413  == 5.2 Sending messages ==
414 414  
415 415  
add-integration-connection.png
Size
... ... @@ -1,1 +1,1 @@
1 -124.4 KB
1 +153.2 KB
Content
mqtt-uplink.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +175.1 KB
Content

Applications

Navigation

Copyright ©2010-2024 Dragino Technology Co., LTD. All rights reserved
Dragino Wiki v2.0