homeassistant.components.sia.entity.SIABaseEntity Class Reference

Inheritance diagram for homeassistant.components.sia.entity.SIABaseEntity:

Collaboration diagram for homeassistant.components.sia.entity.SIABaseEntity:

Public Member Functions
None	__init__ (self, ConfigEntry entry, str account, int zone, SIAEntityDescription entity_description)
None	async_added_to_hass (self)
None	async_create_post_interval_update_cb (self)
None	async_handle_event (self, SIAEvent sia_event)
None	async_post_interval_update (self, _)
None	async_will_remove_from_hass (self)
None	handle_last_state (self, State|None last_state)
bool	update_state (self, SIAEvent sia_event)
Public Member Functions inherited from homeassistant.helpers.restore_state.RestoreEntity
ExtraStoredData|None	async_get_last_extra_data (self)
State|None	async_get_last_state (self)
None	async_internal_added_to_hass (self)
None	async_internal_will_remove_from_hass (self)
ExtraStoredData|None	extra_restore_state_data (self)
Public Member Functions inherited from homeassistant.helpers.entity.Entity
None	__init_subclass__ (cls, **Any kwargs)
str	__repr__ (self)
None	add_to_platform_abort (self)
None	add_to_platform_finish (self)
None	add_to_platform_start (self, HomeAssistant hass, EntityPlatform platform, asyncio.Semaphore|None parallel_updates)
bool	assumed_state (self)
None	async_device_update (self, bool warning=True)
None	async_on_remove (self, CALLBACK_TYPE func)
None	async_registry_entry_updated (self)
None	async_remove (self, *bool force_remove=False)
None	async_removed_from_registry (self)
None	async_schedule_update_ha_state (self, bool force_refresh=False)
None	async_set_context (self, Context context)
None	async_update_ha_state (self, bool force_refresh=False)
None	async_write_ha_state (self)
str|None	attribution (self)
bool	available (self)
dict[str, Any]|None	capability_attributes (self)
str|None	device_class (self)
DeviceInfo|None	device_info (self)
bool	enabled (self)
EntityCategory|None	entity_category (self)
str|None	entity_picture (self)
bool	entity_registry_enabled_default (self)
bool	entity_registry_visible_default (self)
Mapping[str, Any]|None	extra_state_attributes (self)
bool	force_update (self)
HassJobType	get_hassjob_type (self, str function_name)
er.EntityOptionsType|None	get_initial_entity_options (self)
bool	has_entity_name (self)
str|None	icon (self)
str|UndefinedType|None	name (self)
None	schedule_update_ha_state (self, bool force_refresh=False)
bool	should_poll (self)
StateType	state (self)
dict[str, Any]|None	state_attributes (self)
str|None	suggested_object_id (self)
int|None	supported_features (self)
str|None	translation_key (self)
Mapping[str, str]	translation_placeholders (self)
str|None	unique_id (self)
str|None	unit_of_measurement (self)
bool	use_device_name (self)
Public Member Functions inherited from homeassistant.helpers.entity.CachedProperties
None	__init__ (cls, str name, tuple[type,...] bases, dict[Any, Any] namespace, **Any kwargs)
Any	__new__ (mcs, str name, tuple[type,...] bases, dict[Any, Any] namespace, set[str]|None cached_properties=None, **Any kwargs)

Public Attributes
	account
	entity_description
	port
	zone
Public Attributes inherited from homeassistant.helpers.entity.Entity
	device_entry
	entity_id
	hass
	parallel_updates
	platform
	registry_entry

Private Member Functions
None	_cancel_post_interval_update_cb (self)

Private Attributes
	_attr_available
	_attr_device_info
	_attr_extra_state_attributes
	_attr_name
	_attr_should_poll
	_post_interval_update_cb_canceller

Additional Inherited Members
Static Public Attributes inherited from homeassistant.helpers.entity.Entity
	bool
	EntityPlatform
	HomeAssistant
	None
	StateInfo
	StateType
	str

Detailed Description

Base class for SIA entities.

Definition at line 52 of file entity.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.sia.entity.SIABaseEntity.__init__	(		self,
		ConfigEntry	entry,
		str	account,
		int	zone,
		SIAEntityDescription	entity_description
	)

Create SIABaseEntity object.

Definition at line 57 of file entity.py.

Member Function Documentation

_cancel_post_interval_update_cb()

None homeassistant.components.sia.entity.SIABaseEntity._cancel_post_interval_update_cb (   self )

private

Cancel the callback.

Definition at line 170 of file entity.py.

async_added_to_hass()

None homeassistant.components.sia.entity.SIABaseEntity.async_added_to_hass

(

self

)

Run when entity about to be added to hass.

Overridden from Entity.

1. register the dispatcher and add the callback to on_remove
2. get previous state from storage and pass to entity specific function
3. if available: create availability cb

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 88 of file entity.py.

async_create_post_interval_update_cb()

None homeassistant.components.sia.entity.SIABaseEntity.async_create_post_interval_update_cb

(

self

)

Create a port interval update cb and store the callback.

Definition at line 155 of file entity.py.

async_handle_event()

None homeassistant.components.sia.entity.SIABaseEntity.async_handle_event	(		self,
		SIAEvent	sia_event
	)

Listen to dispatcher events for this port and account and update state and attributes.

If the event is for either the zone or the 0 zone (hub zone),
then handle it further.

If the event had a code that was relevant for the entity,
then update the attributes.
If the event had a code that was relevant or it was a availability event
then update the availability and schedule the next unavailability check.

Definition at line 120 of file entity.py.

async_post_interval_update()

None homeassistant.components.sia.entity.SIABaseEntity.async_post_interval_update	(		self,
			_
	)

Set unavailable after a ping interval.

Reimplemented in homeassistant.components.sia.binary_sensor.SIABinarySensorConnectivity.

Definition at line 164 of file entity.py.

async_will_remove_from_hass()

None homeassistant.components.sia.entity.SIABaseEntity.async_will_remove_from_hass

(

self

)

Run when entity will be removed from hass.

Overridden from Entity.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 112 of file entity.py.

handle_last_state()

None homeassistant.components.sia.entity.SIABaseEntity.handle_last_state	(		self,
		State | None	last_state
	)

Handle the last state.

Reimplemented in homeassistant.components.sia.binary_sensor.SIABinarySensor, and homeassistant.components.sia.alarm_control_panel.SIAAlarmControlPanel.

Definition at line 109 of file entity.py.

update_state()

bool homeassistant.components.sia.entity.SIABaseEntity.update_state	(		self,
		SIAEvent	sia_event
	)

Do the entity specific state updates.

Return True if the event was relevant for this entity.

Reimplemented in homeassistant.components.sia.binary_sensor.SIABinarySensor, and homeassistant.components.sia.alarm_control_panel.SIAAlarmControlPanel.

Definition at line 148 of file entity.py.

Member Data Documentation

_attr_available

homeassistant.components.sia.entity.SIABaseEntity._attr_available

private

Definition at line 141 of file entity.py.

_attr_device_info

homeassistant.components.sia.entity.SIABaseEntity._attr_device_info

private

Definition at line 78 of file entity.py.

_attr_extra_state_attributes

homeassistant.components.sia.entity.SIABaseEntity._attr_extra_state_attributes

private

Definition at line 85 of file entity.py.

_attr_name

homeassistant.components.sia.entity.SIABaseEntity._attr_name

private

Definition at line 75 of file entity.py.

_attr_should_poll

homeassistant.components.sia.entity.SIABaseEntity._attr_should_poll

private

Definition at line 86 of file entity.py.

_post_interval_update_cb_canceller

homeassistant.components.sia.entity.SIABaseEntity._post_interval_update_cb_canceller

private

Definition at line 157 of file entity.py.

account

homeassistant.components.sia.entity.SIABaseEntity.account

Definition at line 66 of file entity.py.

entity_description

homeassistant.components.sia.entity.SIABaseEntity.entity_description

Definition at line 68 of file entity.py.

port

homeassistant.components.sia.entity.SIABaseEntity.port

Definition at line 65 of file entity.py.

zone

homeassistant.components.sia.entity.SIABaseEntity.zone

Definition at line 67 of file entity.py.

---

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

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