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

Version 37.7 by Xiaoling on 2022/06/30 15:06

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

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

Applications

Navigation