Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.nuki.lock.NukiLockEntity Class Reference
Inheritance diagram for homeassistant.components.nuki.lock.NukiLockEntity:
[legend]
Collaboration diagram for homeassistant.components.nuki.lock.NukiLockEntity:
[legend]

Public Member Functions

bool is_locked (self)
 
None lock (self, **Any kwargs)
 
None lock_n_go (self, bool unlatch)
 
None open (self, **Any kwargs)
 
None unlock (self, **Any kwargs)
 

Detailed Description

Representation of a Nuki lock.

Definition at line 90 of file lock.py.

Member Function Documentation

◆ is_locked()

bool homeassistant.components.nuki.lock.NukiLockEntity.is_locked (   self)
Return true if lock is locked.

Definition at line 94 of file lock.py.

◆ lock()

None homeassistant.components.nuki.lock.NukiLockEntity.lock (   self,
**Any  kwargs 
)
Lock the device.

Definition at line 98 of file lock.py.

◆ lock_n_go()

None homeassistant.components.nuki.lock.NukiLockEntity.lock_n_go (   self,
bool  unlatch 
)
Lock and go.

This will first unlock the door, then wait for 20 seconds (or another
amount of time depending on the lock settings) and relock.

Definition at line 119 of file lock.py.

◆ open()

None homeassistant.components.nuki.lock.NukiLockEntity.open (   self,
**Any  kwargs 
)
Open the door latch.

Definition at line 112 of file lock.py.

◆ unlock()

None homeassistant.components.nuki.lock.NukiLockEntity.unlock (   self,
**Any  kwargs 
)
Unlock the device.

Definition at line 105 of file lock.py.


The documentation for this class was generated from the following file: