Wiki source code of LWL02 - LoRaWAN Water Leak Sensor User Manual

Version 40.5 by Xiaoling on 2022/08/18 18:10

version	line-number	content
2.2	1	(% style="text-align:center" %)
	2	[[image:1654669760488-506.png\|\|height="510" width="769"]]
1.1	3
	4
	5
36.1	6
	7
	8
	9
	10
	11
	12
33.4	13	Table of Contents:
1.1	14
17.3	15	{{toc/}}
1.1	16
	17
	18
17.3	19
	20
36.2	21
	22
	23
	24
2.2	25	= 1. Introduction =
1.1	26
40.2	27
2.2	28	== 1.1 What is LWL02 LoRaWAN Water Leak Sensor ==
1.1	29
	30
3.2	31	(((
2.2	32	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.
3.2	33	)))
1.1	34
3.2	35	(((
2.2	36	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.
3.2	37	)))
1.2	38
3.2	39	(((
2.2	40	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.
3.2	41	)))
1.2	42
3.2	43	(((
	44	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.
	45	)))
1.2	46
3.2	47	[[image:image-20220608143744-1.png]]
1.2	48
	49
	50
3.3	51	== 1.2 Features ==
1.2	52
40.2	53
1.2	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
40.2	64
	65
3.4	66	== 1.3 Applications ==
	67
40.2	68
1.2	69	* Smart Buildings & Home Automation
	70	* Logistics and Supply Chain Management
	71	* Smart Metering
	72	* Smart Agriculture
	73	* Smart Cities
	74	* Smart Factory
	75
40.2	76
	77
5.2	78	== 1.4 Dimension ==
1.2	79
40.2	80
5.2	81	[[image:image-20220608143952-2.png]]
1.2	82
5.2	83	[[image:1654670405145-346.png]]
1.2	84
5.2	85
	86
	87	== 1.5 Firmware Change log ==
	88
40.2	89
26.8	90	(((
40.2	91	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]]
26.8	92	)))
1.2	93
26.8	94	(((
40.2	95
26.8	96	)))
1.2	97
	98
5.2	99	= 2. Power ON LWL02 =
1.2	100
40.2	101
5.3	102	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.
1.2	103
	104
40.2	105
7.2	106	= 3. How to install LWL02 =
1.2	107
40.2	108
7.4	109	(((
37.5	110	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.
40.2	111
	112
7.4	113	)))
1.2	114
7.2	115	[[image:image-20220608144447-4.png]]
1.2	116
	117
	118
7.2	119	= 4. Operation Mode =
1.2	120
40.2	121
7.2	122	== 4.1 How it works? ==
1.2	123
40.2	124
26.5	125	(((
7.3	126	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.
26.5	127	)))
1.2	128
26.5	129	(((
37.5	130	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.
26.5	131	)))
1.2	132
	133
40.2	134
7.3	135	== 4.2 Example to join LoRaWAN network ==
7.2	136
40.2	137
1.6	138	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.
1.2	139
8.2	140	[[image:1654671007127-335.png]]
1.2	141
	142
9.6	143	(((
1.2	144	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.
9.6	145	)))
1.2	146
9.6	147	* (((
	148	A keep-alive message which send once per day.
	149	)))
	150	* (((
24.9	151	An emergency event message when detect a water leak. ([[Alarm event can be disabled>>\|\|anchor="H7.3CanIdisableuplinkforeacheventtosavebatterylife3F"]])
9.6	152	)))
	153	* (((
	154	A periodically update at every 10 minutes when in water leak.
	155	)))
	156	* (((
17.5	157	A message when switch from water leak to none water leak. ([[Alarm event can be disabled>>\|\|anchor="H7.3CanIdisableuplinkforeacheventtosavebatterylife3F"]])
9.6	158	)))
1.2	159
9.6	160	(((
29.2	161
	162
1.2	163	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:
9.6	164	)))
1.2	165
9.6	166	(((
9.5	167	(% style="color:blue" %)Step 1(%%): Create a device in TTN V3 with the OTAA keys from LWL02.
9.6	168	)))
1.2	169
9.6	170	(((
1.2	171	Each LWL02 is shipped with a sticker with unique device EUI:
9.6	172	)))
1.2	173
9.2	174	[[image:1654671040430-368.png]]
1.2	175
	176
	177	User can enter this key in their LoRaWAN Server portal. Below is TTN V3 screen shot:
	178
40.2	179
14.3	180	Add APP EUI in the application
1.2	181
11.2	182	[[image:1654671794691-956.png]]
1.2	183
	184
11.2	185	[[image:1654671809850-574.png]]
1.2	186
12.2	187	[[image:1654671820156-640.png]]
1.2	188
	189
13.2	190	[[image:1654671832011-696.png]]
1.2	191
	192
14.2	193	Add APP KEY and DEV EUI
1.2	194
32.7	195	[[image:1654671889112-678.png]]
1.2	196
32.7	197
40.2	198
24.10	199	(% 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.
1.2	200
	201
33.2	202	[[image:1654681465260-713.png]]
1.2	203
32.8	204
	205
14.5	206	== 4.3 Uplink Payload ==
	207
26.11	208
1.2	209	Uplink Payload total 9 bytes.
	210
16.2	211	[[image:image-20220608150921-5.png]]
1.2	212
26.10	213
16.2	214	Example:
1.2	215
16.2	216	[[image:1654672186477-234.png]]
1.2	217
	218
16.3	219	(((
40.2	220	Example Payload Decoder in TTN V3: [[https:~~/~~/www.dropbox.com/sh/01rpk03gupwzkg2/AAACzAaN2I4MC-rw7oltfzUta?dl=0>>https://www.dropbox.com/sh/01rpk03gupwzkg2/AAACzAaN2I4MC-rw7oltfzUta?dl=0]]
16.3	221	)))
1.2	222
	223
40.2	224
16.4	225	== 4.4 Downlink Payload ==
1.2	226
26.9	227
16.9	228	(% border="1" cellspacing="10" style="background-color:#ffffcc; color:green; width:410px" %)
16.7	229	\|=(% style="width: 180px;" %)Downlink Control Type\|=(% style="width: 80px;" %)Type Code\|=(% style="width: 150px;" %)Downlink payload size(bytes)
	230	\|(% style="width:180px" %)TDC (Transmit Time Interval—Keep Alive Interval)\|(% style="width:80px" %)0x01\|(% style="width:150px" %)4
	231	\|(% style="width:180px" %)RESET\|(% style="width:80px" %)0x04\|(% style="width:224px" %)2
17.4	232	\|(% style="width:180px" %)[[Set confirmed mode>>\|\|anchor="HTypeCode0x05"]]\|(% style="width:80px" %)0x05\|(% style="width:150px" %)2
	233	\|(% style="width:180px" %)[[Clear Counting>>\|\|anchor="HTypeCode0xA6"]]\|(% style="width:80px" %)0xA6\|(% style="width:150px" %)2
	234	\|(% style="width:180px" %)[[Enable/Disable Alarm>>\|\|anchor="HTypeCode0xA7"]]\|(% style="width:80px" %)0xA7\|(% style="width:150px" %)2
	235	\|(% style="width:180px" %)[[Control ADR/DR>>\|\|anchor="HTypeCode0xA8"]]\|(% style="width:80px" %)0xA8\|(% style="width:150px" %)3
	236	\|(% style="width:180px" %)[[Set Alarm Timeout>>\|\|anchor="HTypeCode0xA9"]]\|(% style="width:80px" %)0xA9\|(% style="width:150px" %)4
1.2	237
	238	Example Downlink payload setting in TTN V3:
	239
17.2	240	[[image:1654673412319-976.png]]
1.2	241
	242
17.3	243	=== (% style="color:#037691" %)Type Code 0x01(%%) ===
1.2	244
37.6	245	If the payload=0100003C, means to control the LWL02's Keep Alive interval to 0x00003C=60(S)
1.2	246
	247
17.3	248	=== (% style="color:#037691" %)Type Code 0x04(%%) ===
1.2	249
	250	If payload = 0x04FF, it will reset the LWL02.
	251
	252
17.3	253	=== (% style="color:#037691" %)Type Code 0x05(%%) ===
1.2	254
	255	0x05 00: Set uplink to LoRaWAN unconfirmed mode
	256
	257	0x05 01: Set uplink to LoRaWAN confirmed mode
	258
	259
17.3	260	=== (% style="color:#037691" %)Type Code 0xA6(%%) ===
1.2	261
	262	Example: 0xA601: Clear Counting
	263	For LWL02: reset both count number and time.
	264
	265
17.3	266	=== (% style="color:#037691" %)Type Code 0xA7(%%) ===
1.2	267
	268	0xA7 01 : Equal to AT+DISALARM=1
	269
	270	0xA7 00 : Equal to AT+DISALARM=0
	271
	272
17.3	273	=== (% style="color:#037691" %)Type Code 0xA8(%%) ===
1.2	274
	275	Format: 0xA8 aa bb
	276
	277	aa: 1: Enable ADR; 0: Disable ADR (Same as AT+CADR command)
	278
	279	bb: set DR (Same as AT+CDATARATE ,only valid after ADR=0)
	280
	281	Example: 0x A8 00 02 : Set ADR=0 and DR=1
	282
	283
17.3	284	=== (% style="color:#037691" %)Type Code 0xA9(%%) ===
1.2	285
17.7	286	See [[Alarm Base Timeout>>\|\|anchor="H4.6AlarmBaseonTimeout"]] for detail.
1.2	287
	288
40.2	289
17.8	290	== 4.5 Integrate with Datacake ==
1.2	291
40.2	292
21.5	293	(((
1.2	294	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:
21.5	295	)))
1.2	296
	297
19.2	298	(% style="color:blue" %)Step 1(%%): Be sure that your device is programmed and properly connected to the network at this time.
1.2	299
19.2	300	(% 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:
1.2	301
	302
19.2	303	[[image:1654674520913-519.png]]
1.2	304
	305
19.2	306	[[image:1654674530910-914.png]]
1.2	307
	308
21.2	309	[[image:1654674543078-401.png]]
1.2	310
	311
21.3	312	(% style="color:blue" %)Step 3(%%): Create an account or log in Datacake.
1.2	313
21.3	314	(% style="color:blue" %)Step 4(%%): Search LWL02 and add DevEUI.
1.2	315
21.2	316	[[image:1654674556510-911.png]]
1.2	317
	318
40.2	319
17.8	320	== 4.6 Alarm Base on Timeout ==
1.2	321
40.2	322
23.4	323	(((
39.1	324	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.
23.4	325	)))
1.2	326
23.4	327	(((
1.2	328	User configure this feature by using:
23.4	329	)))
1.2	330
23.4	331	(((
	332
	333	)))
1.2	334
23.4	335	(((
21.5	336	(% style="color:blue" %)AT Command(%%) to configure:
23.4	337	)))
1.2	338
23.4	339	* (((
40.2	340	(% style="color:red" %)AT+TTRIG=1,30 (%%) ~-~-> When status change from close to open, and device keep in open
23.4	341	)))
1.2	342
23.4	343	(((
1.2	344	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.
23.4	345	)))
1.2	346
23.4	347	* (((
40.2	348	(% style="color:red" %)AT+TTRIG=0,0 (%%) ~-~-> Default Value, disable timeout Alarm.
	349
	350
	351
23.4	352	)))
1.2	353
23.4	354	(((
21.5	355	(% style="color:blue" %)Downlink Command(%%) to configure:
23.4	356	)))
1.2	357
23.4	358	(((
21.6	359	Command: 0xA9 aa bb cc
23.4	360	)))
1.2	361
23.4	362	(((
1.2	363	A9: Command Type Code
23.4	364	)))
1.2	365
23.4	366	(((
1.2	367	aa: status to be monitor
23.4	368	)))
1.2	369
23.4	370	(((
1.2	371	bb cc: timeout.
23.4	372	)))
1.2	373
23.4	374	(((
	375
	376	)))
1.2	377
23.4	378	(((
1.2	379	If user send 0xA9 01 00 1E: equal to AT+TTRIG=1,30
23.4	380	)))
1.2	381
23.4	382	(((
1.2	383	Or
23.4	384	)))
1.2	385
23.4	386	(((
1.2	387	0xA9 00 00 00: Equal to AT+TTRIG=0,0. Disable timeout Alarm.
40.2	388
	389
	390
23.4	391	)))
1.2	392
17.8	393	== 4.7 LEDs ==
1.2	394
25.9	395
21.7	396	(% border="1" cellspacing="10" style="background-color:#ffffcc; width:463px" %)
	397	\|=(% style="width: 184px;" %)Action\|=(% style="width: 275px;" %)LED behavior
	398	\|(% 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(%%)
	399	\|(% style="width:184px" %)Joined successful\|(% style="width:275px" %)(% style="color:green" %)GRENN LED (%%)on 5s
	400	\|(% style="width:184px" %)Send an uplink message\|(% style="width:275px" %)(% style="color:green" %)GREEN LED(%%) blinks once
	401	\|(% style="width:184px" %)Got a downlink message\|(% style="width:275px" %)(% style="color:blue" %)BLUE LED(%%) blinks once
1.2	402
40.2	403
	404
21.8	405	= 5. Battery & How to replace =
	406
40.2	407
21.8	408	== 5.1 Battery Type and replace ==
	409
40.2	410
22.3	411	(((
1.2	412	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:
22.3	413	)))
1.2	414
22.3	415	1. (((
37.6	416	The LWL02 doesn't have any screw, use can use nail to open it by the middle.
22.3	417	)))
	418	1. (((
	419	Make sure the direction is correct when install the AAA batteries.
	420	)))
1.2	421
22.3	422	(((
37.7	423	(% style="color:red" %)Important Notice: Make sure use new AAA LR03 battery and the battery doesn't have broken surface.
22.3	424	)))
1.2	425
22.3	426	(((
	427
	428	)))
1.2	429
22.3	430	(((
1.2	431	Example of AAA LR03 batter:
22.3	432	)))
1.2	433
22.2	434	[[image:1654675278044-307.png]]
1.2	435
	436
40.2	437
22.4	438	== 5.2 Power Consumption Analyze ==
	439
40.2	440
26.6	441	(((
1.2	442	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:
26.6	443	)))
1.2	444
26.6	445	(((
1.2	446	[[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]]
26.6	447	)))
1.2	448
	449
40.2	450
22.4	451	= 6. Use AT Command =
1.2	452
40.2	453
22.4	454	== 6.1 Access AT Command ==
	455
40.2	456
1.2	457	LWL02 supports AT Command set. User can use a USB to TTL adapter to configure LWL02 via use AT command, as below.
	458
40.2	459
23.2	460	[[image:image-20220608160336-1.png]]
1.2	461
	462
23.7	463	(% style="background-color:yellow" %)USB to TTL <- -> LWL02
1.2	464
23.7	465	(% style="background-color:yellow" %)RX <- -> TX
1.2	466
23.7	467	(% style="background-color:yellow" %)TX <- -> RX
	468
	469	(% style="background-color:yellow" %)GND <- -> GND
	470
24.3	471
	472	(((
24.2	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:
24.3	474	)))
1.2	475
24.3	476	(((
24.2	477	The AT Access password is (% style="color:red" %)123456.
24.3	478	)))
1.2	479
24.2	480	[[image:1654675618022-630.png]]
1.2	481
40.2	482
26.7	483	(((
24.4	484	Each AT Command need to (% style="color:red" %)add an ENTER(%%) at the end before send.
26.7	485	)))
1.2	486
26.7	487	(((
40.2	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.
26.7	489	)))
1.2	490
26.7	491	(((
1.2	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/]]
26.7	493	)))
1.2	494
	495
40.2	496
1.5	497	= 7. FAQ =
	498
40.2	499
1.5	500	== 7.1 How to upgrade the image? ==
	501
40.2	502
25.12	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]]
1.2	504
	505
40.2	506
1.5	507	== 7.2 How to change the LoRa Frequency Bands/Region? ==
1.2	508
40.2	509
24.7	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.
1.2	511
	512
40.2	513
1.5	514	== 7.3 Can I disable uplink for each event to save battery life? ==
	515
40.2	516
1.2	517	Yes, User can use below method to disable this:
	518
	519
40.2	520	(% style="color:blue" %)via AT Command:
1.2	521
40.3	522	(% style="color:red" %)AT+DISALARM=1(%%), End node will only send packet in TDC time.
1.2	523
40.3	524	(% style="color:red" %)AT+DISALARM=0(%%), End node will send packet in TDC time or status change for door sensor.
33.9	525
1.2	526
40.2	527	(% style="color:blue" %)via LoRaWAN downlink Command:
1.2	528
40.3	529	(% style="color:red" %)0xA701 (%%): Equal to AT+DISALARM=1
1.2	530
40.3	531	(% style="color:red" %)0xA700 (%%): Equal to AT+DISALARM=0
1.2	532
40.2	533
	534
1.5	535	= 8. Order Info =
1.2	536
40.2	537
1.6	538	Part Number: (% style="color:blue" %)LWL02-XXX(%%)
1.2	539
1.6	540	(% style="color:blue" %)XXX:
1.2	541
1.10	542	* (% style="color:red" %)EU433(%%): frequency bands EU433
	543	* (% style="color:red" %)EU868(%%): frequency bands EU868
	544	* (% style="color:red" %)KR920(%%): frequency bands KR920
1.6	545	* (% style="color:red" %)CN470(%%): frequency bands CN470
1.10	546	* (% style="color:red" %)AS923(%%): frequency bands AS923
1.6	547	* (% style="color:red" %)AU915(%%): frequency bands AU915
1.10	548	* (% style="color:red" %)US915(%%): frequency bands US915
	549	* (% style="color:red" %)IN865(%%): frequency bands IN865
1.6	550	* (% style="color:red" %)CN779(%%): frequency bands CN779
1.2	551
40.2	552
	553
	554
1.4	555	= 9. Packing Info =
	556
40.2	557
1.2	558	Package Includes:
	559
	560	* LWL02 x 1
	561
40.2	562
	563
40.4	564
31.2	565	= 10. Support =
1.2	566
40.2	567
1.2	568	* 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.
	569	* 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]].
	570
33.3	571

Wiki source code of LWL02 - LoRaWAN Water Leak Sensor User Manual

Applications

Navigation