Version 1.2 by Xiaoling on 2022/06/08 14:06

Show last authors
1
2
3
4
5
6 [[image:file:///C:/Users/93456/AppData/Local/Temp/msohtmlclip1/01/clip_image001.png]]
7
8
9
10 **LWL02 – LoRaWAN Water Leak Sensor User Manual**
11
12 Document Version: 1.3
13
14 Image Version: v1.3
15
16
17 |**Version**|**Description**|**Date**
18 |1.0|Release|2021-May-16
19 |1.1|Fix payload description error|2021-Jun-3
20 |1.2|Add More Battery Description|2021-Jul-1
21 |1.3|Update Photo|2022-Jan-8
22 | | |
23
24
25
26
27
28 [[1.       Introduction. 4>>path:#_Toc92533484]]
29
30 [[1.1     What is LWL02 LoRaWAN Door Sensor 4>>path:#_Toc92533485]]
31
32 [[1.2     Features. 5>>path:#_Toc92533486]]
33
34 [[1.3     Applications. 5>>path:#_Toc92533487]]
35
36 [[1.4     Dimension. 5>>path:#_Toc92533488]]
37
38 [[1.5     Firmware Change log. 5>>path:#_Toc92533489]]
39
40 [[2.       Power ON LWL02. 6>>path:#_Toc92533490]]
41
42 [[3.       How to install LWL02. 6>>path:#_Toc92533491]]
43
44 [[4.       Operation Mode. 7>>path:#_Toc92533492]]
45
46 [[4.1     How it works?. 7>>path:#_Toc92533502]]
47
48 [[4.2     Example to join LoRaWAN network. 7>>path:#_Toc92533503]]
49
50 [[4.3     Uplink Payload. 11>>path:#_Toc92533504]]
51
52 [[4.4     Downlink Payload. 12>>path:#_Toc92533505]]
53
54 [[4.5     Integrate with Datacake. 15>>path:#_Toc92533506]]
55
56 [[4.6     Alarm Base on Timeout 18>>path:#_Toc92533507]]
57
58 [[4.7     LEDs. 19>>path:#_Toc92533508]]
59
60 [[5.       Battery & How to replace. 20>>path:#_Toc92533509]]
61
62 [[5.1     Battery Type and replace. 20>>path:#_Toc92533510]]
63
64 [[5.2     Power Consumption Analyze. 20>>path:#_Toc92533511]]
65
66 [[6.       Use AT Command. 21>>path:#_Toc92533512]]
67
68 [[6.1     Access AT Command. 21>>path:#_Toc92533513]]
69
70 [[7.       FAQ.. 22>>path:#_Toc92533514]]
71
72 [[7.1     How to upgrade the image?. 22>>path:#_Toc92533515]]
73
74 [[7.2     How to change the LoRa Frequency Bands/Region?. 22>>path:#_Toc92533516]]
75
76 [[7.3     Can I disable uplink for each event to save battery life?. 22>>path:#_Toc92533517]]
77
78 [[8.       Order Info. 23>>path:#_Toc92533518]]
79
80 [[9.       Packing Info. 23>>path:#_Toc92533519]]
81
82 [[10.          Support. 23>>path:#_Toc92533520]]
83
84
85
86
87
88
89 1. Introduction
90 11. What is LWL02 LoRaWAN Water Leak Sensor
91
92
93 The Dragino LWL02 is a LoRaWAN Water Sensor. When there is water between the two metal probes, LWL02 indicates a water leak event and uplink to IoT server via LoRaWAN network.
94
95
96 LWL02 is powered by 2 x AAA batteries and target for long time use, these two batteries can provide about 16,000 ~~ 70,000 uplink packets, which result in 2 ~~ 10 years battery life. After battery running out, user can easily open the enclosure and replace with 2 common AAA batteries.
97
98
99 The LWL02 will send periodically data every day as well as for each water leak event. It also counts the water leak times and calculate last water leak duration. User can also disable the uplink for each water leak event, instead, device can count each event and uplink periodically.
100
101
102 Each LWL02 is pre-load with a set of unique keys for LoRaWAN registration, register these keys to
103
104 LoRaWAN server and it will auto connect after power on. [[image:file:///C:/Users/93456/AppData/Local/Temp/msohtmlclip1/01/clip_image002.png]]
105
106
107
108
109 *
110 *1. Features
111 * LoRaWAN Class A v1.0.3
112 * Frequency Bands: CN470/EU433/KR920/US915/EU868/AS923/AU915/IN865/RU864
113 * SX1262 LoRa Core
114 * Water Leak detect
115 * 2 x AAA LR03 Batteries
116 * AT Commands to change parameters
117 * Uplink on periodically and open/close action
118 * Remote configure parameters via LoRa Downlink
119 * Firmware upgradable via program port
120
121
122 *
123 *1. Applications
124 * Smart Buildings & Home Automation
125 * Logistics and Supply Chain Management
126 * Smart Metering
127 * Smart Agriculture
128 * Smart Cities
129 * Smart Factory
130
131
132 1.
133 11. Dimension
134
135
136 [[image:file:///C:/Users/93456/AppData/Local/Temp/msohtmlclip1/01/clip_image003.png]]
137
138 [[image:file:///C:/Users/93456/AppData/Local/Temp/msohtmlclip1/01/clip_image004.png]]
139
140
141 1.
142 11. Firmware Change log
143
144
145 LWL02 use the same firmware as LDS01.
146
147 [[LWL02 Image files – Download link>>url:http://www.dragino.com/downloads/index.php?dir=LoRa_End_Node/LDS01/Firmware/]]
148
149
150
151
152 1. Power ON LWL02
153
154
155 When receive the LWL02, please open the enclosure and add 2 x AAA batteries to power it. The [[LED>>path:#LED]] will blink when device is powered.
156
157
158
159 1. How to install LWL02
160
161 When install the LWL02 on wall. Please install as below so the water leak probe will be soak in water for water detect purpose. The LWL02 main body is not water proof. Please don’t let water go inside the LWL02 main body.
162
163
164 |(((
165 50cm
166
167
168 )))
169
170 [[image:file:///C:/Users/93456/AppData/Local/Temp/msohtmlclip1/01/clip_image005.png]]
171
172
173
174
175
176
177 1. Operation Mode
178 11. How it works?
179
180 The LWL02 is configured as LoRaWAN OTAA Class A mode by default. It has OTAA keys to join network. To connect a local LoRaWAN network, user just need to input the OTAA keys in the network server and [[power on>>path:#Power_on]] the LWL02. It will auto join the network via OTAA.
181
182
183 In case user can’t set the OTAA keys in the network server and has to use the existing keys from server. User can [[use AT Command>>path:#AT_Command]] to set the keys in the devices.
184
185
186 1.
187 11. Example to join LoRaWAN network
188
189 Here shows an example for how to join the [[TTN V3 Network>>url:https://eu1.cloud.thethings.network/]]. Below is the network structure, we use [[LG308>>url:http://www.dragino.com/products/lora-lorawan-gateway/item/140-lg308.html]] as LoRaWAN gateway here.
190
191 [[image:file:///C:/Users/93456/AppData/Local/Temp/msohtmlclip1/01/clip_image006.png]]
192
193
194
195 The LWL02 has water leak detect probe as above. When there is water between these two detect probe, they will be short and generate the water leak event. and send the status to LoRaWAN server. The LWL02 will uplink two type of messages to the server.
196
197 * A keep-alive message which send once per day.
198 * An emergency event message when detect a water leak. ([[Alarm event can be disabled>>path:#Alarm]])
199 * A periodically update at every 10 minutes when in water leak.
200 * A message when switch from water leak to none water leak. ([[Alarm event can be disabled>>path:#Alarm]])
201
202
203
204
205 The LG308 is already set to connect to [[TTN V3 network >>url:https://eu1.cloud.thethings.network/]]. What we need to now is only configure the TTN V3:
206
207 **Step 1**: Create a device in TTN V3 with the OTAA keys from LWL02.
208
209 Each LWL02 is shipped with a sticker with unique device EUI:
210
211 [[image:file:///C:/Users/93456/AppData/Local/Temp/msohtmlclip1/01/clip_image007.png]]
212
213
214
215
216 User can enter this key in their LoRaWAN Server portal. Below is TTN V3 screen shot:
217
218 Add APP EUI in the application.
219
220 [[image:file:///C:/Users/93456/AppData/Local/Temp/msohtmlclip1/01/clip_image008.png]]
221
222
223 [[image:file:///C:/Users/93456/AppData/Local/Temp/msohtmlclip1/01/clip_image009.png]]
224
225 [[image:file:///C:/Users/93456/AppData/Local/Temp/msohtmlclip1/01/clip_image010.png]]
226
227
228 [[image:file:///C:/Users/93456/AppData/Local/Temp/msohtmlclip1/01/clip_image011.png]]
229
230
231
232
233
234
235
236 Add APP KEY and DEV EUI
237
238 [[image:file:///C:/Users/93456/AppData/Local/Temp/msohtmlclip1/01/clip_image012.png]]
239
240 **Step 2**: [[Power on>>path:#Power_on]] LWL02 and it will auto join to the TTN V3 network. After join success, it will start to upload message to TTN V3 and user can see in the panel.
241
242 [[image:file:///C:/Users/93456/AppData/Local/Temp/msohtmlclip1/01/clip_image013.png]]
243
244
245 1.
246 11. Uplink Payload
247
248
249 Uplink Payload total 9 bytes.
250
251
252 |**Size(bytes)**|**2**|**1**|**3**|**3**
253 |value|Status&BAT|(((
254 MOD
255
256 Always:0x02
257 )))|Total water leak events|(((
258 Last water leak
259
260 duration (unit: min)
261 )))
262
263
264 Example:
265
266 [[image:file:///C:/Users/93456/AppData/Local/Temp/msohtmlclip1/01/clip_image014.png]]
267
268
269 Example Payload Decoder in TTN V3:
270
271 [[http:~~/~~/www.dragino.com/downloads/index.php?dir=LoRa_End_Node/LDS01/Payload/>>url:http://www.dragino.com/downloads/index.php?dir=LoRa_End_Node/LDS01/Payload/]]
272
273
274
275
276 1.
277 11. Downlink Payload
278
279
280 |**Downlink Control Type**|**Type Code**|**Downlink payload size(bytes)**
281 |TDC (Transmit Time Interval—Keep Alive Interval)|0x01|4
282 |RESET|0x04|2
283 |[[Set confirmed mode>>path:#code05]]|0x05|2
284 |[[Clear Counting>>path:#codeA6]]|0xA6|2
285 |[[Enable/Disable Alarm>>path:#code70]]|0xA7|2
286 |[[Control ADR/DR>>path:#codeA8]]|0xA8|3
287 |[[Set Alarm Timeout>>path:#Alarm_Timeout]]|0xA9|4
288
289
290
291
292
293 Example Downlink payload setting in TTN V3:
294
295 [[image:file:///C:/Users/93456/AppData/Local/Temp/msohtmlclip1/01/clip_image015.png]]
296
297
298 **Type Code 0x01**
299
300 If the payload=0100003C, means to control the LWL02’s Keep Alive interval to 0x00003C=60(S)
301
302
303 **Type Code 0x04**
304
305 If payload = 0x04FF, it will reset the LWL02.
306
307
308 **Type Code 0x05**
309
310 0x05 00: Set uplink to LoRaWAN unconfirmed mode
311
312 0x05 01: Set uplink to LoRaWAN confirmed mode
313
314
315 **Type Code 0xA6**
316
317 Example: 0xA601: Clear Counting
318 For LWL02: reset both count number and time.
319
320
321 **Type Code 0xA7**
322
323 0xA7 01 : Equal to AT+DISALARM=1
324
325 0xA7 00 : Equal to AT+DISALARM=0
326
327
328 **Type Code 0xA8**
329
330 Format: 0xA8 aa bb
331
332 aa: 1: Enable ADR; 0: Disable ADR (Same as AT+CADR command)
333
334 bb: set DR (Same as AT+CDATARATE ,only valid after ADR=0)
335
336 Example: 0x A8 00 02 : Set ADR=0 and DR=1
337
338
339 **Type Code 0xA9**
340
341 See [[Alarm Base Timeout>>path:#Alarm_Timeout]] for detail.
342
343
344
345 1.
346 11. Integrate with Datacake
347
348
349 Datacake provides a human friendly interface to show the sensor data, once we have data in TTN V3, we can use Datacake to connect to TTN V3 and see the data in Datacake. Below are the steps:
350
351
352 Step 1: Be sure that your device is programmed and properly connected to the network at this time.
353
354 Step 2: To configure the Application to forward data to Datacake you will need to add integration. To add the Datacake integration, perform the following steps:
355
356
357 [[image:file:///C:/Users/93456/AppData/Local/Temp/msohtmlclip1/01/clip_image016.png]]
358
359
360 [[image:file:///C:/Users/93456/AppData/Local/Temp/msohtmlclip1/01/clip_image017.png]]
361
362
363 [[image:file:///C:/Users/93456/AppData/Local/Temp/msohtmlclip1/01/clip_image018.png]]
364
365
366
367 Step 3: Create an account or log in Datacake.
368
369 Step 4: Search LWL02 and add DevEUI.
370
371 [[image:file:///C:/Users/93456/AppData/Local/Temp/msohtmlclip1/01/clip_image019.png]]
372
373
374 1.
375 11. Alarm Base on Timeout
376
377
378 LWL02 can monitor the timeout for a status change, this feature can be used to monitor some event such as open fridge too long etc.
379
380
381 User configure this feature by using:
382
383
384 **AT Command** to configure:
385
386 * AT+TTRIG=1,30   à When status change from close to open, and device keep in open
387
388 status for more than 30 seconds. LWL02 will send an uplink packet, the Alarm bit (the lowest bit of 10^^th^^ byte of payload) on this uplink packet is set to 1.
389
390 * AT+TTIG=0,0 à Default Value, disable timeout Alarm.
391
392
393 **Downlink Command** to configure:
394
395 Command: 0xA9 aa bb cc
396
397 A9: Command Type Code
398
399 aa: status to be monitor
400
401 bb cc: timeout.
402
403
404 If user send 0xA9 01 00 1E: equal to AT+TTRIG=1,30
405
406 Or
407
408 0xA9 00 00 00: Equal to AT+TTRIG=0,0. Disable timeout Alarm.
409
410
411
412
413 1.
414 11. LEDs
415
416
417 |**Action**|**LED behavior**
418 |Power On|**GREEN on 1s, RED on 1s, BLUE on 1s**
419 |Joined successful|**GRENN LED **on 5s
420 |Send an uplink message|**GREEN LED** blinks once
421 |Got a downlink message|**BLUE LED** blinks once
422
423
424
425
426
427 1. Battery & How to replace
428 11. Battery Type and replace
429
430 LWL02 is equipped with 2 x AAA LR03 batteries. If the batteries running low(see 2.1v in the platform). User can buy generic AAA battery and replace it. Note:
431
432 1. The LWL02 doesn’t have any screw, use can use nail to open it by the middle.
433 1. Make sure the direction is correct when install the AAA batteries.
434
435
436
437 **Important Notice: Make sure use new AAA LR03 battery and the battery doesn’t have broken surface.**
438
439
440 Example of AAA LR03 batter:
441
442 [[image:file:///C:/Users/93456/AppData/Local/Temp/msohtmlclip1/01/clip_image020.png]]
443
444
445
446
447 1.
448 11. Power Consumption Analyze
449
450 Dragino battery powered products are all run in Low Power mode. User can check the guideline from this link to calculate the estimate battery life:
451
452 [[https:~~/~~/www.dragino.com/downloads/downloads/LoRa_End_Node/Battery_Analyze/DRAGINO_Battery_Life_Guide.pdf>>url:https://www.dragino.com/downloads/downloads/LoRa_End_Node/Battery_Analyze/DRAGINO_Battery_Life_Guide.pdf]]
453
454
455
456 1. Use AT Command
457 11. Access AT Command
458
459 LWL02 supports AT Command set. User can use a USB to TTL adapter to configure LWL02 via use AT command, as below.
460
461 [[image:file:///C:/Users/93456/AppData/Local/Temp/msohtmlclip1/01/clip_image021.png]]
462
463 USB to TTL <- -> LWL02
464
465 RX <- -> TX
466
467 TX <- -> RX
468
469 GND <- -> GND
470
471
472 In PC, User needs to set **serial tool**(such as [[putty>>url:https://www.chiark.greenend.org.uk/~~sgtatham/putty/latest.html]], SecureCRT) baud rate to **115200** to access to access serial console of LWL02. Below is the output for reference:
473
474 The AT Access password is **123456**.
475
476 [[image:file:///C:/Users/93456/AppData/Local/Temp/msohtmlclip1/01/clip_image022.png]]
477
478 Each AT Command need to add an ENTER at the end before send.
479
480
481 When entering the first command, the RED LED will on and user can now input AT Commands. After input all needed AT Commands, please input AT+CLPM=1 to set the device to work in Low Power mode and RED LED will be off.
482
483
484 More detail AT Command manual can be found at [[AT Command Manual>>url:http://www.dragino.com/downloads/index.php?dir=LoRa_End_Node/LDS01/]]
485
486
487 1. FAQ
488 11. How to upgrade the image?
489
490 User can upgrade the firmware of LWL02 for bug fix, new features, or change working region. The upgrade instruction is here: [[http:~~/~~/wiki.dragino.com/index.php?title=Firmware_Upgrade_Instruction>>url:http://wiki.dragino.com/index.php?title=Firmware_Upgrade_Instruction]]
491
492
493
494
495 1.
496 11. How to change the LoRa Frequency Bands/Region?
497
498 If user has for example US915 frequency and want to change it to AS923 frequency. User can follow the introduction for [[how to upgrade image>>path:#upgrade_image]]. When download the images, choose the required image file for download.
499
500
501 1.
502 11. Can I disable uplink for each event to save battery life?
503
504 Yes, User can use below method to disable this:
505
506 **via AT Command**:
507
508 AT+DISALARM=1, End node will only send packet in TDC time.
509
510 AT+DISALARM=0, End node will send packet in TDC time or status change for door sensor.
511
512 **via LoRaWAN downlink Command**:
513
514 0xA701 : Equal to AT+DISALARM=1
515
516 0xA700 : Equal to AT+DISALARM=0
517
518
519
520
521
522 1. Order Info
523
524
525 **Part Number: LWL02-XXX**
526
527 **XXX:**
528
529 * **EU433**: frequency bands EU433
530 * **EU868**: frequency bands EU868
531 * **KR920**: frequency bands KR920
532 * **CN470**: frequency bands CN470
533 * **AS923**: frequency bands AS923
534 * **AU915**: frequency bands AU915
535 * **US915**: frequency bands US915
536 * **IN865**: frequency bands IN865
537 * **CN779**: frequency bands CN779
538
539
540 1. Packing Info
541
542 **Package Includes**:
543
544 * LWL02 x 1
545
546
547
548 = 10.Support =
549
550 * Support is provided Monday to Friday, from 09:00 to 18:00 GMT+8. Due to different timezones we cannot offer live support. However, your questions will be answered as soon as possible in the before-mentioned schedule.
551 * Provide as much information as possible regarding your enquiry (product models, accurately describe your problem and steps to replicate it etc) and send a mail to [[support@dragino.com>>url:file:///D:/市场资料/说明书/LoRa/LT系列/support@dragino.com]].
552
553
554