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

Version 43.1 by Xiaoling on 2022/09/27 11:34

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

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

Applications

Navigation