Show last authors
1 (% style="text-align:center" %)
2 [[image:image-20220927133941-2.png]]
3
4
5
6
7
8
9
10
11 **Table of Contents:**
12
13 {{toc/}}
14
15
16
17
18
19
20
21
22
23 = 1. Introduction =
24
25
26 == 1.1 What is LWL02 LoRaWAN Water Leak Sensor ==
27
28
29 (((
30 The Dragino LWL02 is a (% style="color:#4f81bd" %)**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.
31 )))
32
33 (((
34 LWL02 is powered by (% style="color:#4f81bd" %)**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.
35 )))
36
37 (((
38 The LWL02 will send periodically data every day as well as for each water leak event. It also (% style="color:#4f81bd" %)**counts the water leak times**(%%) and (% style="color:#4f81bd" %)**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.
39 )))
40
41 (((
42 Each LWL02 is (% style="color:#4f81bd" %)**pre-load with a set of unique keys**(%%) for LoRaWAN registration, register these keys to LoRaWAN server and it will auto connect after power on.
43
44
45 )))
46
47 [[image:image-20220927113420-3.png]]
48
49
50
51 == 1.2 Features ==
52
53
54 * LoRaWAN Class A v1.0.3
55 * Frequency Bands: CN470/EU433/KR920/US915/EU868/AS923/AU915/IN865/RU864
56 * SX1262 LoRa Core
57 * Water Leak detect
58 * 2 x AAA LR03 Batteries
59 * AT Commands to change parameters
60 * Uplink on periodically and open/close action
61 * Remote configure parameters via LoRa Downlink
62 * Firmware upgradable via program port
63
64
65 == 1.3 Applications ==
66
67
68 * Smart Buildings & Home Automation
69 * Logistics and Supply Chain Management
70 * Smart Metering
71 * Smart Agriculture
72 * Smart Cities
73 * Smart Factory
74
75
76 == 1.4 Dimension ==
77
78
79 [[image:image-20220608143952-2.png]]
80
81
82 [[image:1654670405145-346.png]]
83
84
85
86 == 1.5 Firmware Change log ==
87
88
89 (((
90 LWL02 use the same firmware as LDS01:  [[https:~~/~~/www.dropbox.com/sh/6ls5i0zsvujvbc8/AABe3V5aQXdy7zSxEdEA3DHOa?dl=0>>https://www.dropbox.com/sh/6ls5i0zsvujvbc8/AABe3V5aQXdy7zSxEdEA3DHOa?dl=0]]
91 )))
92
93 (((
94
95 )))
96
97
98 = 2. Power ON LWL02 =
99
100
101 When receive the LWL02, please open the enclosure and add 2 x AAA batteries to power it. The [[LED>>||anchor="H4.7LEDs"]] will blink when device is powered.
102
103
104
105 = 3. How to install LWL02 =
106
107
108 (((
109 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.
110
111
112 )))
113
114 [[image:image-20220608144447-4.png]]
115
116
117
118 = 4. Operation Mode =
119
120
121 == 4.1 How it works? ==
122
123
124 (((
125 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>>||anchor="H2.PowerONLWL02"]] the LWL02. It will auto join the network via OTAA.
126 )))
127
128 (((
129 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>>||anchor="H6.UseATCommand"]] to set the keys in the devices.
130 )))
131
132
133
134 == 4.2 Example to join LoRaWAN network ==
135
136
137 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. 
138
139 [[image:image-20220927113401-2.png]]
140
141
142 (((
143 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.
144 )))
145
146 * (((
147 A keep-alive message which send once per day.
148 )))
149 * (((
150 An emergency event message when detect a water leak. ([[Alarm event can be disabled>>||anchor="H7.3CanIdisableuplinkforeacheventtosavebatterylife3F"]])
151 )))
152 * (((
153 A periodically update at every 10 minutes when in water leak.
154 )))
155 * (((
156 A message when switch from water leak to none water leak. ([[Alarm event can be disabled>>||anchor="H7.3CanIdisableuplinkforeacheventtosavebatterylife3F"]])
157 )))
158
159 (((
160
161
162 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:
163 )))
164
165 (((
166 (% style="color:blue" %)**Step 1**(%%): Create a device in TTN V3 with the OTAA keys from LWL02.
167 )))
168
169 (((
170 Each LWL02 is shipped with a sticker with unique device EUI:
171 )))
172
173 [[image:1654671040430-368.png]]
174
175
176 User can enter this key in their LoRaWAN Server portal. Below is TTN V3 screen shot:
177
178
179 **Add APP EUI in the application**
180
181 [[image:1654671794691-956.png]]
182
183
184 [[image:1654671809850-574.png]]
185
186 [[image:1654671820156-640.png]]
187
188
189 [[image:1654671832011-696.png]]
190
191
192 **Add APP KEY and DEV EUI**
193
194 [[image:1654671889112-678.png]]
195
196
197
198 (% style="color:blue" %)**Step 2**(%%): **[[Power on>>||anchor="H2.PowerONLWL02"]]** 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.
199
200
201 [[image:1654681465260-713.png]]
202
203
204
205 == 4.3 Uplink Payload ==
206
207
208 Uplink Payload total 10 bytes.
209
210
211 (% border="1.5" cellspacing="5" style="background-color:#ffffcc; color:green; width:500px" %)
212 |=(% scope="row" style="width: 60px;" %)**Size(bytes)**|(% style="width:60px" %)**2**|(% style="width:60px" %)**1**|(% style="width:100px" %)**3**|(% style="width:110px" %)**3**|(% style="width:110px" %)**1**
213 |=**value**|Status&BAT|(((
214 MOD
215 Always:0x02
216 )))|(% style="width:126px" %)Total_water_leak_events|(% style="width:140px" %)(((
217 Last  water leak duration(unit:min)
218 )))|(% style="width:186px" %)(((
219 Alarm status(Only used in
220 LDS02)Always:0x00
221 )))
222
223 **Example:**
224
225 [[image:1654672186477-234.png]]
226
227
228 (((
229 Example Payload Decoder in TTN V3:  [[https:~~/~~/github.com/dragino/dragino-end-node-decoder>>https://github.com/dragino/dragino-end-node-decoder]]
230 )))
231
232
233
234 == 4.4 Downlink Payload ==
235
236
237 (% border="1" cellspacing="10" style="background-color:#ffffcc; color:green; width:410px" %)
238 |=(% style="width: 180px;" %)**Downlink Control Type**|=(% style="width: 80px;" %)**Type Code**|=(% style="width: 150px;" %)**Downlink payload size(bytes)**
239 |(% style="width:180px" %)TDC (Transmit Time Interval—Keep Alive Interval)|(% style="width:80px" %)0x01|(% style="width:150px" %)4
240 |(% style="width:180px" %)RESET|(% style="width:80px" %)0x04|(% style="width:224px" %)2
241 |(% style="width:180px" %)[[Set confirmed mode>>||anchor="HTypeCode0x05"]]|(% style="width:80px" %)0x05|(% style="width:150px" %)2
242 |(% style="width:180px" %)[[Clear Counting>>||anchor="HTypeCode0xA6"]]|(% style="width:80px" %)0xA6|(% style="width:150px" %)2
243 |(% style="width:180px" %)[[Enable/Disable Alarm>>||anchor="HTypeCode0xA7"]]|(% style="width:80px" %)0xA7|(% style="width:150px" %)2
244 |(% style="width:180px" %)[[Control ADR/DR>>||anchor="HTypeCode0xA8"]]|(% style="width:80px" %)0xA8|(% style="width:150px" %)3
245 |(% style="width:180px" %)[[Set Alarm Timeout>>||anchor="HTypeCode0xA9"]]|(% style="width:80px" %)0xA9|(% style="width:150px" %)4
246
247 Example Downlink payload setting in TTN V3:
248
249 [[image:1654673412319-976.png]]
250
251
252 === (% style="color:#037691" %)**Type Code 0x01**(%%) ===
253
254 If the payload=0100003C, means to control the LWL02's Keep Alive interval to 0x00003C=60(S)
255
256
257 === (% style="color:#037691" %)**Type Code 0x04**(%%) ===
258
259 If payload = 0x04FF, it will reset the LWL02.
260
261
262 === (% style="color:#037691" %)**Type Code 0x05**(%%) ===
263
264 0x05 00: Set uplink to LoRaWAN unconfirmed mode
265
266 0x05 01: Set uplink to LoRaWAN confirmed mode
267
268
269 === (% style="color:#037691" %)**Type Code 0xA6**(%%) ===
270
271 Example: 0xA601: Clear Counting
272 For LWL02: reset both count number and time.
273
274
275 === (% style="color:#037691" %)**Type Code 0xA7**(%%) ===
276
277 0xA7 01 : Equal to AT+DISALARM=1
278
279 0xA7 00 : Equal to AT+DISALARM=0
280
281
282 === (% style="color:#037691" %)**Type Code 0xA8**(%%) ===
283
284 Format: 0xA8 aa bb
285
286 aa: 1: Enable ADR; 0: Disable ADR (Same as AT+CADR command)
287
288 bb: set DR (Same as AT+CDATARATE ,only valid after ADR=0)
289
290 Example: 0x A8 00 02 : Set ADR=0 and DR=1
291
292
293 === (% style="color:#037691" %)**Type Code 0xA9**(%%) ===
294
295 See [[Alarm Base Timeout>>||anchor="H4.6AlarmBaseonTimeout"]] for detail.
296
297
298
299 == 4.5 Integrate with Datacake ==
300
301
302 (((
303 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:
304 )))
305
306
307 (% style="color:blue" %)**Step 1**(%%): Be sure that your device is programmed and properly connected to the network at this time.
308
309 (% style="color:blue" %)**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:
310
311
312 [[image:1654674520913-519.png]]
313
314
315 [[image:1654674530910-914.png]]
316
317
318 [[image:1654674543078-401.png]]
319
320
321 (% style="color:blue" %)**Step 3**(%%): Create an account or log in Datacake.
322
323 (% style="color:blue" %)**Step 4**(%%): Search LWL02 and add DevEUI.
324
325 [[image:1654674556510-911.png]]
326
327
328
329 == 4.6 Alarm Base on Timeout ==
330
331
332 (((
333 LWL02 can monitor the timeout for a status change, this feature can be used to monitor some event such as monitoring water leakage duration etc.
334
335 (% style="color:red" %)**(This command is only applicable to LDS02.In lwl02, this command can only open the alarm, but the alarm time is fixed to 10 minutes)**
336 )))
337
338 (((
339 User configure this feature by using:
340 )))
341
342 (((
343
344 )))
345
346 (((
347 (% style="color:blue" %)**AT Command**(%%) to configure:
348 )))
349
350 * (((
351 (% style="color:red" %)**AT+TTRIG=1,30 **(%%) **~-~->** When status change from close to open, and device keep in open
352 )))
353
354 (((
355 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.
356 )))
357
358 * (((
359 (% style="color:red" %)**AT+TTRIG=0,0** (%%) **~-~->**  Default Value, disable timeout Alarm.
360
361
362
363 )))
364
365 (((
366 (% style="color:blue" %)**Downlink Command**(%%) to configure:
367 )))
368
369 (((
370 **Command: 0xA9 aa bb cc**
371 )))
372
373 (((
374 A9: Command Type Code
375 )))
376
377 (((
378 aa: status to be monitor
379 )))
380
381 (((
382 bb cc: timeout.
383 )))
384
385 (((
386
387 )))
388
389 (((
390 If user send 0xA9 01 00 1E: equal to AT+TTRIG=1,30
391 )))
392
393 (((
394 Or
395 )))
396
397 (((
398 0xA9 00 00 00: Equal to AT+TTRIG=0,0. Disable timeout Alarm.
399
400
401
402 )))
403
404 == 4.7 LEDs ==
405
406
407 (% border="1" cellspacing="10" style="background-color:#ffffcc; width:463px" %)
408 |=(% style="width: 184px;" %)**Action**|=(% style="width: 275px;" %)**LED behavior**
409 |(% style="width:184px" %)Power On|(% style="width:275px" %)(% style="color:green" %)**GREEN on 1s, **(% style="color:red" %)**RED on 1s,**(%%)** (% style="color:blue" %)BLUE on 1s(%%)**
410 |(% style="width:184px" %)Joined successful|(% style="width:275px" %)(% style="color:green" %)**GRENN LED **(%%)on 5s
411 |(% style="width:184px" %)Send an uplink message|(% style="width:275px" %)(% style="color:green" %)**GREEN LED**(%%) blinks once
412 |(% style="width:184px" %)Got a downlink message|(% style="width:275px" %)(% style="color:blue" %)**BLUE LED**(%%) blinks once
413
414
415 = 5. Battery & How to replace =
416
417
418 == 5.1 Battery Type and replace ==
419
420
421 (((
422 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:
423 )))
424
425 1. (((
426 The LWL02 doesn't have any screw, use can use nail to open it by the middle.
427 )))
428 1. (((
429 Make sure the direction is correct when install the AAA batteries.
430 )))
431
432 (((
433 (% style="color:red" %)**Important Notice: Make sure use new AAA LR03 battery and the battery doesn't have broken surface.**
434 )))
435
436 (((
437
438 )))
439
440 (((
441 Example of AAA LR03 batter:
442 )))
443
444 [[image:1654675278044-307.png]]
445
446
447
448 == 5.2 Power Consumption Analyze ==
449
450
451 (((
452 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:
453 )))
454
455 (((
456 [[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]]
457 )))
458
459
460
461 = 6. Use AT Command =
462
463
464 == 6.1 Access AT Command ==
465
466
467 LWL02 supports AT Command set. User can use a USB to TTL adapter to configure LWL02 via use AT command, as below.
468
469 [[image:image-20221226104705-1.png||height="572" width="872"]]
470
471
472 (((
473 In PC, User needs to set (% style="color:#037691" %)**serial tool**(%%)(such as [[putty>>url:https://www.chiark.greenend.org.uk/~~sgtatham/putty/latest.html]], SecureCRT) baud rate to (% style="color:green" %)**115200**(%%) to access to access serial console of LWL02. Below is the output for reference:
474 )))
475
476 (((
477 The AT Access password is (% style="color:red" %)**123456**.
478 )))
479
480 [[image:1654675618022-630.png]]
481
482
483 (((
484 Each AT Command need to (% style="color:red" %)**add an ENTER**(%%) at the end before send.
485 )))
486
487 (((
488 When entering the first command, the (% style="color:red" %)**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 (% style="color:red" %)**RED LED**(%%) will be off.
489 )))
490
491 (((
492 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/]]
493 )))
494
495
496
497 = 7. FAQ =
498
499
500 == 7.1 How to upgrade the image? ==
501
502
503 User can upgrade the of LWL02 for bug fix, new features, or change working region. The upgrade instruction is here: [[Firmware Upgrade Instruction>>doc:Main.Firmware Upgrade Instruction for STM32 base products.WebHome]]
504
505
506
507 == 7.2 How to change the LoRa Frequency Bands/Region? ==
508
509
510 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>>||anchor="H7.1Howtoupgradetheimage3F"]]. When download the images, choose the required image file for download.
511
512
513
514 == 7.3 Can I disable uplink for each event to save battery life? ==
515
516
517 Yes, User can use below method to disable this:
518
519
520 (% style="color:blue" %)**via AT Command**:
521
522 (% style="color:red" %)**AT+DISALARM=1**(%%),  End node will only send packet in TDC time.
523
524 (% style="color:red" %)**AT+DISALARM=0**(%%),  End node will send packet in TDC time or status change for door sensor. 
525
526
527 (% style="color:blue" %)**via LoRaWAN downlink Command**:
528
529 (% style="color:red" %)**0xA701** (%%):  Equal to AT+DISALARM=1
530
531 (% style="color:red" %)**0xA700** (%%):  Equal to AT+DISALARM=0
532
533
534
535 = 8. Order Info =
536
537
538 **Part Number: (% style="color:blue" %)LWL02-XXX(%%)**
539
540 (% style="color:blue" %)**XXX:**
541
542 * (% style="color:red" %)**EU433**(%%): frequency  bands EU433
543 * (% style="color:red" %)**EU868**(%%): frequency  bands EU868
544 * (% style="color:red" %)**KR920**(%%): frequency  bands KR920
545 * (% style="color:red" %)**CN470**(%%): frequency bands CN470
546 * (% style="color:red" %)**AS923**(%%): frequency  bands AS923
547 * (% style="color:red" %)**AU915**(%%): frequency bands AU915
548 * (% style="color:red" %)**US915**(%%): frequency bands  US915
549 * (% style="color:red" %)**IN865**(%%):  frequency bands  IN865
550 * (% style="color:red" %)**CN779**(%%): frequency bands CN779
551
552
553 = 9. Packing Info =
554
555
556 **Package Includes**:
557
558 * LWL02 x 1
559
560
561 = 10. Support =
562
563
564 * 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.
565 * 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]].
566
567
Copyright ©2010-2022 Dragino Technology Co., LTD. All rights reserved
Dragino Wiki v2.0