Skip to content

Commit 0a6cf38

Browse files
MinshengMinsheng
authored
Add Lock BLE API documentation (#13)
* Create lock.md * Add reference to Lock BLE API readme
1 parent 5edca6c commit 0a6cf38

File tree

2 files changed

+43
-0
lines changed

2 files changed

+43
-0
lines changed

‎README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
- [Meter BLE open API](/devicetypes/meter.md)
1010
- [Motion Sensor BLE open API](/devicetypes/motionsensor.md)
1111
- [Plug Mini BLE open API](/devicetypes/plugmini.md)
12+
- [Lock BLE open API](/devicetypes/lock.md)
1213

1314
## Device Types
1415

‎devicetypes/lock.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Lock BLE Open API
2+
3+
## Lock Broadcast Message
4+
The following table is the Service Data of SCAN_RSP.
5+
6+
### ADV AD Structure
7+
8+
| ADV AD Structure | | | | | |
9+
| ---------------- | ---- | --------- | -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
10+
| AD Structure 1 | len | Byte 0 | | 0x02 | |
11+
| | type | Byte 1 | Flags | 0x01 | |
12+
| | data | Byte 2 | | 0x06 | |
13+
| AD Structure 2 | len | Byte 3 | | | |
14+
| | type | Byte 4 | Company ID | 0xff | |
15+
| | data | Byte 5~6 | | 0x0969 | |
16+
| | | Byte 7~13 | MAC Address | Device MAC Address | |
17+
| | | Byte 14 | Sequence Number | [1,255] | 1~255 increases, 256 overflow is 1, and the broadcast packet data automatically increases when it is updated |
18+
| | | Byte 15 | Lock Info | Bit7 Calibration status： 0-Not calibrated 1-Calibrated | |
19+
| | | | | Bit6-4 Lock Status:<br/>000b - Locked<br/>001b - Unlocked<br/>010b - Locking<br/>011b - Unlocking<br/>100b - LockingStop（Stuck）<br/>101b - UnlockingStop（Stuck）<br/>110b - Not fully locked（only for EU Lock Type) | This status is invalid when not calibrated |
20+
| | | | | Bit3 Door status update source:<br/>0-Update from Primary lock<br/>1-Update from Secondary lock<br/>Bit2 Door status:<br/>0-Closed<br/>1-Opened | Only for Double Lock Mode |
21+
| | | | | Bit1-0 Reserve | |
22+
| | | Byte 16 | Double lock control source | Bit7 Double Lock Mode: 0-Off 1-On | Only for Double Lock Mode |
23+
| | | | | Bit6 Reserve | |
24+
| | | | | Bit5 Unclosed door timeout alarm: 0-Off 1-On | |
25+
| | | | | Bit4 Unlocked timeout alarm: 0-Off 1-On | |
26+
| | | | | Bit3-2 Reserve | |
27+
| | | | | Bit1 Pause Automatic Locking Status: 0 inactived; 1: activated | |
28+
| | | | | Bit0 Reserve | |
29+
| | | Byte 17 | Reserve | Reserve |
30+
31+
### SCAN RSP AD Structure
32+
33+
| SCAN RSP AD Structure | | | | | |
34+
| --------------------- | ---- | ------ | ------------ | ----------------------------------------------- | --- |
35+
| AD Structure 1 | len | | | | |
36+
| | type | | Service Data | 0x16 | |
37+
| | data | Byte 0 | Device Type | Bit7 Reserve | |
38+
| | | | | Bit6-0 Device Type<br/>'o' (0x6F)： Normal Mode | |
39+
| | | Byte 1 | Reserve | Reserve | |
40+
| | | Byte 2 | Battery | Bit7 Reserve | |
41+
| | | | | Bit6-0 battery voltage 0~100% | |
42+

0 commit comments

Comments
 (0)