Wiki source code of LDS02 - LoRaWAN Door Sensor User Manual

Version 37.4 by Xiaoling on 2022/06/08 17:31

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

Wiki source code of LDS02 - LoRaWAN Door Sensor User Manual

Applications

Navigation