homeassistant.components.nuki.lock Namespace Reference

Classes
class	NukiDeviceEntity
class	NukiLockEntity
class	NukiOpenerEntity

Functions
None	async_setup_entry (HomeAssistant hass, ConfigEntry entry, AddEntitiesCallback async_add_entities)
bool	available (self)
None	lock (self, **Any kwargs)
None	open (self, **Any kwargs)
str|None	unique_id (self)
None	unlock (self, **Any kwargs)

Variables
bool	_attr_has_entity_name = True
	_attr_name = None
	_attr_supported_features = LockEntityFeature.OPEN
string	_attr_translation_key = "nuki_lock"

Detailed Description

Nuki.io lock platform.

Function Documentation

async_setup_entry()

None homeassistant.components.nuki.lock.async_setup_entry	(	HomeAssistant	hass,
		ConfigEntry	entry,
		AddEntitiesCallback	async_add_entities
	)

Set up the Nuki lock platform.

Definition at line 26 of file lock.py.

available()

bool homeassistant.components.nuki.lock.available

(

self

)

Return True if entity is available.

Definition at line 73 of file lock.py.

lock()

None homeassistant.components.nuki.lock.lock	(		self,
		**Any	kwargs
	)

Lock the device.

Definition at line 78 of file lock.py.

open()

None homeassistant.components.nuki.lock.open	(		self,
		**Any	kwargs
	)

Open the door latch.

Definition at line 86 of file lock.py.

unique_id()

str | None homeassistant.components.nuki.lock.unique_id

(

self

)

Return a unique ID.

Definition at line 68 of file lock.py.

unlock()

None homeassistant.components.nuki.lock.unlock	(		self,
		**Any	kwargs
	)

Unlock the device.

Definition at line 82 of file lock.py.

Variable Documentation

_attr_has_entity_name

bool homeassistant.components.nuki.lock._attr_has_entity_name = True

private

Representation of a Nuki device.

Definition at line 62 of file lock.py.

_attr_name

homeassistant.components.nuki.lock._attr_name = None

private

Definition at line 65 of file lock.py.

_attr_supported_features

homeassistant.components.nuki.lock._attr_supported_features = LockEntityFeature.OPEN

private

Definition at line 63 of file lock.py.

_attr_translation_key

string homeassistant.components.nuki.lock._attr_translation_key = "nuki_lock"

private

Definition at line 64 of file lock.py.