Home Assistant Unofficial Reference 2024.12.1
Public Member Functions | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
homeassistant.components.simplisafe.entity.SimpliSafeEntity Class Reference
Inheritance diagram for homeassistant.components.simplisafe.entity.SimpliSafeEntity:
[legend]
Collaboration diagram for homeassistant.components.simplisafe.entity.SimpliSafeEntity:
[legend]

Public Member Functions

None __init__ (self, SimpliSafe simplisafe, SystemType system, *Device|None device=None, Iterable[str]|None additional_websocket_events=None)
 
None async_added_to_hass (self)
 
None async_increment_error_count (self)
 
None async_reset_error_count (self)
 
None async_update_from_rest_api (self)
 
None async_update_from_websocket_event (self, WebsocketEvent event)
 
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.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)
 

Private Member Functions

None _handle_coordinator_update (self)
 
None _handle_websocket_update (self, WebsocketEvent event)
 

Private Attributes

 _attr_device_info
 
 _attr_extra_state_attributes
 
 _attr_unique_id
 
 _device
 
 _error_count
 
 _online
 
 _simplisafe
 
 _system
 
 _websocket_events_to_listen_for
 

Static Private Attributes

bool _attr_has_entity_name = True
 

Additional Inherited Members

- 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
 

Detailed Description

Define a base SimpliSafe entity.

Definition at line 47 of file entity.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.simplisafe.entity.SimpliSafeEntity.__init__ (   self,
SimpliSafe  simplisafe,
SystemType  system,
*Device | None   device = None,
Iterable[str] | None   additional_websocket_events = None 
) 
Initialize.

Definition at line 52 of file entity.py.

Member Function Documentation

◆ _handle_coordinator_update()

None homeassistant.components.simplisafe.entity.SimpliSafeEntity._handle_coordinator_update (   self)
private 
Update the entity with new REST API data.

Definition at line 139 of file entity.py.

◆ _handle_websocket_update()

None homeassistant.components.simplisafe.entity.SimpliSafeEntity._handle_websocket_update (   self,
WebsocketEvent  event 
)
private 
Update the entity with new websocket data.

Definition at line 150 of file entity.py.

◆ async_added_to_hass()

None homeassistant.components.simplisafe.entity.SimpliSafeEntity.async_added_to_hass (   self) 
Register callbacks.

Definition at line 200 of file entity.py.

◆ async_increment_error_count()

None homeassistant.components.simplisafe.entity.SimpliSafeEntity.async_increment_error_count (   self) 
Increment this entity's error count.

Definition at line 215 of file entity.py.

◆ async_reset_error_count()

None homeassistant.components.simplisafe.entity.SimpliSafeEntity.async_reset_error_count (   self) 
Reset this entity's error count.

Definition at line 221 of file entity.py.

◆ async_update_from_rest_api()

None homeassistant.components.simplisafe.entity.SimpliSafeEntity.async_update_from_rest_api (   self) 
Update the entity when new data comes from the REST API.

Reimplemented in homeassistant.components.simplisafe.sensor.SimplisafeFreezeSensor, homeassistant.components.simplisafe.lock.SimpliSafeLock, homeassistant.components.simplisafe.binary_sensor.BatteryBinarySensor, homeassistant.components.simplisafe.binary_sensor.TriggeredBinarySensor, and homeassistant.components.simplisafe.alarm_control_panel.SimpliSafeAlarm.

Definition at line 230 of file entity.py.

◆ async_update_from_websocket_event()

None homeassistant.components.simplisafe.entity.SimpliSafeEntity.async_update_from_websocket_event (   self,
WebsocketEvent  event 
) 
Update the entity when new data comes from the websocket.

Reimplemented in homeassistant.components.simplisafe.lock.SimpliSafeLock, and homeassistant.components.simplisafe.alarm_control_panel.SimpliSafeAlarm.

Definition at line 234 of file entity.py.

◆ available()

bool homeassistant.components.simplisafe.entity.SimpliSafeEntity.available (   self) 
Return whether the entity is available.

Reimplemented from homeassistant.helpers.update_coordinator.CoordinatorEntity.

Definition at line 120 of file entity.py.

Member Data Documentation

◆ _attr_device_info

homeassistant.components.simplisafe.entity.SimpliSafeEntity._attr_device_info
private

Definition at line 96 of file entity.py.

◆ _attr_extra_state_attributes

homeassistant.components.simplisafe.entity.SimpliSafeEntity._attr_extra_state_attributes
private

Definition at line 88 of file entity.py.

◆ _attr_has_entity_name

bool homeassistant.components.simplisafe.entity.SimpliSafeEntity._attr_has_entity_name = True
staticprivate

Definition at line 50 of file entity.py.

◆ _attr_unique_id

homeassistant.components.simplisafe.entity.SimpliSafeEntity._attr_unique_id
private

Definition at line 105 of file entity.py.

◆ _device

homeassistant.components.simplisafe.entity.SimpliSafeEntity._device
private

Definition at line 106 of file entity.py.

◆ _error_count

homeassistant.components.simplisafe.entity.SimpliSafeEntity._error_count
private 
Initialize.
Reset this entity's error count.

Definition at line 68 of file entity.py.

◆ _online

homeassistant.components.simplisafe.entity.SimpliSafeEntity._online
private 
Update the entity with new websocket data.

Definition at line 107 of file entity.py.

◆ _simplisafe

homeassistant.components.simplisafe.entity.SimpliSafeEntity._simplisafe
private

Definition at line 108 of file entity.py.

◆ _system

homeassistant.components.simplisafe.entity.SimpliSafeEntity._system
private

Definition at line 109 of file entity.py.

◆ _websocket_events_to_listen_for

homeassistant.components.simplisafe.entity.SimpliSafeEntity._websocket_events_to_listen_for
private

Definition at line 110 of file entity.py.

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