Docs
Capabilities

Lock

Domain lock: states, services, device classes and features.

Entity ids in this domain look like lock.<object_id>.

Use in preferences

{ key: 'device', label: 'Device', type: 'entity', domainFilter: 'lock', required: true }

States

getState() returns the raw token. subscribe filters, entity.is() and matchesState() also accept the friendly label the app shows (any case; spaces, hyphens and underscores interchangeable).

Device classunlockedlockedunlockinglocking
anyUnlockedLockedUnlockingLocking
Subscribe and compare
subscribe($g.device, { to: 'unlocked' }, onChange);
subscribe($g.device, { to: 'Unlocked' }, onChange); // same thing, by label
if ($g.device.is('Unlocked')) { /* … */ }

Services

Curated for smart apps (also offered by the wizard action catalog):

ServiceParametersDescription
lock—Lock
toggle—Toggle
unlock—Unlock
Call a service
await $g.device.lock();

Attributes

AttributeTypeDescription
batteryLevelnumberPercent.
isLowbooleanLow-battery flag.
Generated from docs-bundle v0.1.0, novon-platform 9ce3486c (2026-10-09).

On this page