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

Version 32.8 by Xiaoling on 2022/06/08 17:44

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

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

Applications

Navigation