Wiki source code of LDS02 - LoRaWAN Door Sensor User Manual

Version 35.1 by Xiaoling on 2022/06/08 17:28

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

Wiki source code of LDS02 - LoRaWAN Door Sensor User Manual

Applications

Navigation