homeassistant.components.simplisafe.alarm_control_panel.SimpliSafeAlarm Class Reference

Inheritance diagram for homeassistant.components.simplisafe.alarm_control_panel.SimpliSafeAlarm:

Collaboration diagram for homeassistant.components.simplisafe.alarm_control_panel.SimpliSafeAlarm:

Public Member Functions
None	__init__ (self, SimpliSafe simplisafe, SystemType system)
None	async_alarm_arm_away (self, str|None code=None)
None	async_alarm_arm_home (self, str|None code=None)
None	async_alarm_disarm (self, str|None code=None)
None	async_update_from_rest_api (self)
None	async_update_from_websocket_event (self, WebsocketEvent event)
Public Member Functions inherited from homeassistant.components.simplisafe.entity.SimpliSafeEntity
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)
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)
Public Member Functions inherited from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity
None	__init_subclass__ (cls, **Any kwargs)
None	__setattr__ (self, str name, Any value)
None	add_to_platform_start (self, HomeAssistant hass, EntityPlatform platform, asyncio.Semaphore|None parallel_updates)
None	alarm_arm_away (self, str|None code=None)
None	alarm_arm_custom_bypass (self, str|None code=None)
None	alarm_arm_home (self, str|None code=None)
None	alarm_arm_night (self, str|None code=None)
None	alarm_arm_vacation (self, str|None code=None)
None	alarm_disarm (self, str|None code=None)
AlarmControlPanelState|None	alarm_state (self)
None	alarm_trigger (self, str|None code=None)
None	async_alarm_arm_custom_bypass (self, str|None code=None)
None	async_alarm_arm_night (self, str|None code=None)
None	async_alarm_arm_vacation (self, str|None code=None)
None	async_alarm_trigger (self, str|None code=None)
None	async_handle_alarm_arm_away (self, str|None code=None)
None	async_handle_alarm_arm_custom_bypass (self, str|None code=None)
None	async_handle_alarm_arm_home (self, str|None code=None)
None	async_handle_alarm_arm_night (self, str|None code=None)
None	async_handle_alarm_arm_vacation (self, str|None code=None)
None	async_handle_alarm_disarm (self, str|None code=None)
None	async_internal_added_to_hass (self)
None	async_registry_entry_updated (self)
str|None	changed_by (self)
str|None	check_code_arm_required (self, str|None code)
bool	code_arm_required (self)
CodeFormat|None	code_format (self)
str|None	code_or_default_code (self, str|None code)
str|None	state (self)
dict[str, Any]|None	state_attributes (self)
AlarmControlPanelEntityFeature	supported_features (self)
Public Member Functions inherited from homeassistant.helpers.entity.Entity
str	__repr__ (self)
None	add_to_platform_abort (self)
None	add_to_platform_finish (self)
bool	assumed_state (self)
None	async_added_to_hass (self)
None	async_device_update (self, bool warning=True)
None	async_internal_will_remove_from_hass (self)
None	async_on_remove (self, CALLBACK_TYPE func)
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_will_remove_from_hass (self)
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)
str|None	suggested_object_id (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)

Private Member Functions
None	_set_state_from_system_data (self)

Private Attributes
	_attr_alarm_state
	_attr_changed_by
	_last_event

Static Private Attributes
bool	_attr_code_arm_required = False
	_attr_name = None
tuple	_attr_supported_features

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
Public Attributes inherited from homeassistant.helpers.entity.Entity
	device_entry
	entity_id
	hass
	parallel_updates
	platform
	registry_entry
Static Public Attributes inherited from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity
	AlarmControlPanelEntityFeature
	bool
	None
Static Public Attributes inherited from homeassistant.helpers.entity.Entity
	bool
	EntityPlatform
	HomeAssistant
	None
	StateInfo
	StateType
	str

Detailed Description

Representation of a SimpliSafe alarm.

Definition at line 116 of file alarm_control_panel.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.simplisafe.alarm_control_panel.SimpliSafeAlarm.__init__	(		self,
		SimpliSafe	simplisafe,
		SystemType	system
	)

Initialize the SimpliSafe alarm.

Definition at line 126 of file alarm_control_panel.py.

Member Function Documentation

_set_state_from_system_data()

None homeassistant.components.simplisafe.alarm_control_panel.SimpliSafeAlarm._set_state_from_system_data (   self )

private

Set the state based on the latest REST API data.

Definition at line 138 of file alarm_control_panel.py.

async_alarm_arm_away()

None homeassistant.components.simplisafe.alarm_control_panel.SimpliSafeAlarm.async_alarm_arm_away	(		self,
		str | None	code = None
	)

Send arm away command.

Reimplemented from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 173 of file alarm_control_panel.py.

async_alarm_arm_home()

None homeassistant.components.simplisafe.alarm_control_panel.SimpliSafeAlarm.async_alarm_arm_home	(		self,
		str | None	code = None
	)

Send arm home command.

Reimplemented from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 161 of file alarm_control_panel.py.

async_alarm_disarm()

None homeassistant.components.simplisafe.alarm_control_panel.SimpliSafeAlarm.async_alarm_disarm	(		self,
		str | None	code = None
	)

Send disarm command.

Reimplemented from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 149 of file alarm_control_panel.py.

async_update_from_rest_api()

None homeassistant.components.simplisafe.alarm_control_panel.SimpliSafeAlarm.async_update_from_rest_api

(

self

)

Update the entity with the provided REST API data.

Reimplemented from homeassistant.components.simplisafe.entity.SimpliSafeEntity.

Definition at line 186 of file alarm_control_panel.py.

async_update_from_websocket_event()

None homeassistant.components.simplisafe.alarm_control_panel.SimpliSafeAlarm.async_update_from_websocket_event	(		self,
		WebsocketEvent	event
	)

Update the entity when new data comes from the websocket.

Reimplemented from homeassistant.components.simplisafe.entity.SimpliSafeEntity.

Definition at line 219 of file alarm_control_panel.py.

Member Data Documentation

_attr_alarm_state

homeassistant.components.simplisafe.alarm_control_panel.SimpliSafeAlarm._attr_alarm_state

private

Definition at line 141 of file alarm_control_panel.py.

_attr_changed_by

homeassistant.components.simplisafe.alarm_control_panel.SimpliSafeAlarm._attr_changed_by

private

Definition at line 221 of file alarm_control_panel.py.

_attr_code_arm_required

bool homeassistant.components.simplisafe.alarm_control_panel.SimpliSafeAlarm._attr_code_arm_required = False

staticprivate

Definition at line 119 of file alarm_control_panel.py.

_attr_name

homeassistant.components.simplisafe.alarm_control_panel.SimpliSafeAlarm._attr_name = None

staticprivate

Definition at line 120 of file alarm_control_panel.py.

_attr_supported_features

tuple homeassistant.components.simplisafe.alarm_control_panel.SimpliSafeAlarm._attr_supported_features

staticprivate

Initial value:

=  (
        AlarmControlPanelEntityFeature.ARM_HOME
        | AlarmControlPanelEntityFeature.ARM_AWAY
    )

Definition at line 121 of file alarm_control_panel.py.

_last_event

homeassistant.components.simplisafe.alarm_control_panel.SimpliSafeAlarm._last_event

private

Definition at line 134 of file alarm_control_panel.py.

---

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

• core/homeassistant/components/simplisafe/alarm_control_panel.py