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

Version 39.1 by Bei Jinggeng on 2022/08/16 11:27

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

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

Applications

Navigation