Wiki source code of LDS02 - LoRaWAN Door Sensor User Manual

Version 44.9 by Xiaoling on 2022/06/09 09:06

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

Wiki source code of LDS02 - LoRaWAN Door Sensor User Manual

Applications

Navigation