Lock — lock v1
Capabilities
Declared in the driver manifest under [[proxy]] capabilities. Anything not declared takes the default below.
| Capability | Type | Default | Meaning |
|---|---|---|---|
has_battery | bool | false | |
has_jam_detection | bool | false | |
has_user_codes | bool | false | |
max_user_codes | u32 | 0 | |
reports_who | bool | false | Reports which user code operated the lock |
supports_auto_lock | bool | false |
Commands
lock
No parameters.
set_auto_lock
Only present when
supports_auto_lockis declared true.
| Parameter | Type | Notes |
|---|---|---|
seconds | u32 0–3600 |
unlock
No parameters.
Notifications
battery_changed
Only present when
has_batteryis declared true.
| Parameter | Type | Notes |
|---|---|---|
percent | u8 0–100 |
jammed
Only present when
has_jam_detectionis declared true.
No parameters.
lock_changed
| Parameter | Type | Notes |
|---|---|---|
locked | bool | |
source | one of manual · remote · code · auto · unknown (optional) | |
user | string (optional) |
online_changed
| Parameter | Type | Notes |
|---|---|---|
online | bool |
State
Last-known values core keeps for a binding of this proxy.
| Key | Type | Meaning |
|---|---|---|
battery | u8 | |
locked | bool | |
online | bool |