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

Version 33.10 by Xiaoling on 2022/06/14 15:28

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

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

Applications

Navigation