homeassistant.components.schlage.entity.SchlageEntity Class Reference

Inheritance diagram for homeassistant.components.schlage.entity.SchlageEntity:

Collaboration diagram for homeassistant.components.schlage.entity.SchlageEntity:

Public Member Functions
None	__init__ (self, SchlageDataUpdateCoordinator coordinator, str device_id)
bool	available (self)
Public Member Functions inherited from homeassistant.helpers.update_coordinator.CoordinatorEntity
None	__init__ (self, _DataUpdateCoordinatorT coordinator, Any context=None)
None	async_update (self)
Public Member Functions inherited from homeassistant.components.schlage.coordinator.SchlageDataUpdateCoordinator
None	__init__ (self, HomeAssistant hass, str username, Schlage api)
Public Member Functions inherited from homeassistant.helpers.update_coordinator.DataUpdateCoordinator
None	__init__ (self, HomeAssistant hass, logging.Logger logger, *config_entries.ConfigEntry|None|UndefinedType config_entry=UNDEFINED, str name, timedelta|None update_interval=None, Callable[[], Awaitable[_DataT]]|None update_method=None, Callable[[], Awaitable[None]]|None setup_method=None, Debouncer[Coroutine[Any, Any, None]]|None request_refresh_debouncer=None, bool always_update=True)
Callable[[], None]	async_add_listener (self, CALLBACK_TYPE update_callback, Any context=None)
None	async_config_entry_first_refresh (self)
Generator[Any]	async_contexts (self)
None	async_refresh (self)
None	async_register_shutdown (self)
None	async_request_refresh (self)
None	async_set_update_error (self, Exception err)
None	async_set_updated_data (self, _DataT data)
None	async_shutdown (self)
None	async_update_listeners (self)
timedelta|None	update_interval (self)
None	update_interval (self, timedelta|None value)

Public Attributes
	device_id
Public Attributes inherited from homeassistant.components.schlage.coordinator.SchlageDataUpdateCoordinator
	api
Public Attributes inherited from homeassistant.helpers.update_coordinator.DataUpdateCoordinator
	always_update
	config_entry
	data
	hass
	last_exception
	last_update_success
	logger
	name
	setup_method
	update_interval
	update_method

Private Member Functions
Lock	_lock (self)
LockData	_lock_data (self)

Private Attributes
	_attr_device_info
	_attr_unique_id

Static Private Attributes
bool	_attr_has_entity_name = True

Detailed Description

Base Schlage entity.

Definition at line 12 of file entity.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.schlage.entity.SchlageEntity.__init__	(		self,
		SchlageDataUpdateCoordinator	coordinator,
		str	device_id
	)

Initialize a Schlage entity.

Reimplemented in homeassistant.components.schlage.lock.SchlageLockEntity.

Definition at line 17 of file entity.py.

Member Function Documentation

_lock()

Lock homeassistant.components.schlage.entity.SchlageEntity._lock (   self )

private

Fetch the Schlage lock from our coordinator.

Definition at line 38 of file entity.py.

_lock_data()

LockData homeassistant.components.schlage.entity.SchlageEntity._lock_data (   self )

private

Fetch the LockData from our coordinator.

Definition at line 33 of file entity.py.

available()

bool homeassistant.components.schlage.entity.SchlageEntity.available

(

self

)

Return if entity is available.

Reimplemented from homeassistant.helpers.update_coordinator.CoordinatorEntity.

Definition at line 43 of file entity.py.

Member Data Documentation

_attr_device_info

homeassistant.components.schlage.entity.SchlageEntity._attr_device_info

private

Definition at line 24 of file entity.py.

_attr_has_entity_name

bool homeassistant.components.schlage.entity.SchlageEntity._attr_has_entity_name = True

staticprivate

Definition at line 15 of file entity.py.

_attr_unique_id

homeassistant.components.schlage.entity.SchlageEntity._attr_unique_id

private

Definition at line 23 of file entity.py.

device_id

homeassistant.components.schlage.entity.SchlageEntity.device_id

Definition at line 22 of file entity.py.

---

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

• core/homeassistant/components/schlage/entity.py