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

Version 35.1 by Xiaoling on 2022/06/25 17:32

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

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

Applications

Navigation