homeassistant.components.elkm1.alarm_control_panel.ElkArea Class Reference

Inheritance diagram for homeassistant.components.elkm1.alarm_control_panel.ElkArea:

Collaboration diagram for homeassistant.components.elkm1.alarm_control_panel.ElkArea:

Public Member Functions
None	__init__ (self, Element element, Elk elk, ELKM1Data elk_data)
AlarmControlPanelState|None	alarm_state (self)
None	async_added_to_hass (self)
None	async_alarm_arm_away (self, str|None code=None)
None	async_alarm_arm_home (self, str|None code=None)
None	async_alarm_arm_home_instant (self, str|None code=None)
None	async_alarm_arm_night (self, str|None code=None)
None	async_alarm_arm_night_instant (self, str|None code=None)
None	async_alarm_arm_vacation (self, str|None code=None)
None	async_alarm_disarm (self, str|None code=None)
None	async_bypass (self, str|None code=None)
None	async_clear_bypass (self, str|None code=None)
None	async_display_message (self, int clear, bool beep, int timeout, str line1, str line2)
str|None	changed_by (self)
CodeFormat|None	code_format (self)
dict[str, Any]	extra_state_attributes (self)
Public Member Functions inherited from homeassistant.components.elkm1.entity.ElkAttachedEntity
DeviceInfo	device_info (self)
Public Member Functions inherited from homeassistant.components.elkm1.entity.ElkEntity
bool	available (self)
dict[str, Any]	initial_attrs (self)
str	unique_id (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_device_update (self, bool warning=True)
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)
dict[str, Any]|None	capability_attributes (self)
str|None	device_class (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)
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	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 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)
None	alarm_trigger (self, str|None code=None)
None	async_alarm_arm_custom_bypass (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	check_code_arm_required (self, str|None code)
bool	code_arm_required (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.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)

Private Member Functions
None	_element_changed (self, Element element, dict[str, Any] changeset)
bool	_entry_exit_timer_is_running (self)
None	_watch_area (self, Element area, dict[str, Any] changeset)
None	_watch_keypad (self, Element keypad, dict[str, Any] changeset)

Private Attributes
	_changed_by
	_changed_by_id
	_changed_by_keypad
	_changed_by_time
	_elk
	_state

Static Private Attributes
tuple	_attr_supported_features

Additional Inherited Members
Public Attributes inherited from homeassistant.helpers.entity.Entity
	device_entry
	entity_id
	hass
	parallel_updates
	platform
	registry_entry
Static Public Attributes inherited from homeassistant.helpers.entity.Entity
	bool
	EntityPlatform
	HomeAssistant
	None
	StateInfo
	StateType
	str
Static Public Attributes inherited from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity
	AlarmControlPanelEntityFeature
	bool
	None

Detailed Description

Representation of an Area / Partition within the ElkM1 alarm panel.

Definition at line 102 of file alarm_control_panel.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.elkm1.alarm_control_panel.ElkArea.__init__	(		self,
		Element	element,
		Elk	elk,
		ELKM1Data	elk_data
	)

Initialize Area as Alarm Control Panel.

Reimplemented from homeassistant.components.elkm1.entity.ElkEntity.

Definition at line 112 of file alarm_control_panel.py.

Member Function Documentation

_element_changed()

None homeassistant.components.elkm1.alarm_control_panel.ElkArea._element_changed (   self, Element  element, dict[str, Any]  changeset  )

private

Reimplemented from homeassistant.components.elkm1.entity.ElkEntity.

Definition at line 200 of file alarm_control_panel.py.

_entry_exit_timer_is_running()

bool homeassistant.components.elkm1.alarm_control_panel.ElkArea._entry_exit_timer_is_running (   self )

private

Definition at line 227 of file alarm_control_panel.py.

_watch_area()

None homeassistant.components.elkm1.alarm_control_panel.ElkArea._watch_area (   self, Element  area, dict[str, Any]  changeset  )

private

Definition at line 154 of file alarm_control_panel.py.

_watch_keypad()

None homeassistant.components.elkm1.alarm_control_panel.ElkArea._watch_keypad (   self, Element  keypad, dict[str, Any]  changeset  )

private

Definition at line 143 of file alarm_control_panel.py.

alarm_state()

AlarmControlPanelState | None homeassistant.components.elkm1.alarm_control_panel.ElkArea.alarm_state

(

self

)

Return the state of the element.

Reimplemented from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 172 of file alarm_control_panel.py.

async_added_to_hass()

None homeassistant.components.elkm1.alarm_control_panel.ElkArea.async_added_to_hass

(

self

)

Register callback for ElkM1 changes.

Reimplemented from homeassistant.components.elkm1.entity.ElkEntity.

Definition at line 122 of file alarm_control_panel.py.

async_alarm_arm_away()

None homeassistant.components.elkm1.alarm_control_panel.ElkArea.async_alarm_arm_away	(		self,
		str | None	code = None
	)

Send arm away command.

Reimplemented from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 240 of file alarm_control_panel.py.

async_alarm_arm_home()

None homeassistant.components.elkm1.alarm_control_panel.ElkArea.async_alarm_arm_home	(		self,
		str | None	code = None
	)

Send arm home command.

Reimplemented from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 235 of file alarm_control_panel.py.

async_alarm_arm_home_instant()

None homeassistant.components.elkm1.alarm_control_panel.ElkArea.async_alarm_arm_home_instant	(		self,
		str | None	code = None
	)

Send arm stay instant command.

Definition at line 250 of file alarm_control_panel.py.

async_alarm_arm_night()

None homeassistant.components.elkm1.alarm_control_panel.ElkArea.async_alarm_arm_night	(		self,
		str | None	code = None
	)

Send arm night command.

Reimplemented from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 245 of file alarm_control_panel.py.

async_alarm_arm_night_instant()

None homeassistant.components.elkm1.alarm_control_panel.ElkArea.async_alarm_arm_night_instant	(		self,
		str | None	code = None
	)

Send arm night instant command.

Definition at line 255 of file alarm_control_panel.py.

async_alarm_arm_vacation()

None homeassistant.components.elkm1.alarm_control_panel.ElkArea.async_alarm_arm_vacation	(		self,
		str | None	code = None
	)

Send arm vacation command.

Reimplemented from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 260 of file alarm_control_panel.py.

async_alarm_disarm()

None homeassistant.components.elkm1.alarm_control_panel.ElkArea.async_alarm_disarm	(		self,
		str | None	code = None
	)

Send disarm command.

Reimplemented from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 230 of file alarm_control_panel.py.

async_bypass()

None homeassistant.components.elkm1.alarm_control_panel.ElkArea.async_bypass	(		self,
		str | None	code = None
	)

Bypass all zones in area.

Definition at line 271 of file alarm_control_panel.py.

async_clear_bypass()

None homeassistant.components.elkm1.alarm_control_panel.ElkArea.async_clear_bypass	(		self,
		str | None	code = None
	)

Clear bypass for all zones in area.

Definition at line 276 of file alarm_control_panel.py.

async_display_message()

None homeassistant.components.elkm1.alarm_control_panel.ElkArea.async_display_message	(		self,
		int	clear,
		bool	beep,
		int	timeout,
		str	line1,
		str	line2
	)

Display a message on all keypads for the area.

Definition at line 265 of file alarm_control_panel.py.

changed_by()

str | None homeassistant.components.elkm1.alarm_control_panel.ElkArea.changed_by

(

self

)

Last change triggered by.

Reimplemented from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 196 of file alarm_control_panel.py.

code_format()

CodeFormat | None homeassistant.components.elkm1.alarm_control_panel.ElkArea.code_format

(

self

)

Return the alarm code format.

Reimplemented from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 167 of file alarm_control_panel.py.

extra_state_attributes()

dict[str, Any] homeassistant.components.elkm1.alarm_control_panel.ElkArea.extra_state_attributes

(

self

)

Attributes of the area.

Reimplemented from homeassistant.components.elkm1.entity.ElkEntity.

Definition at line 177 of file alarm_control_panel.py.

Member Data Documentation

_attr_supported_features

tuple homeassistant.components.elkm1.alarm_control_panel.ElkArea._attr_supported_features

staticprivate

Initial value:

=  (
        AlarmControlPanelEntityFeature.ARM_HOME
        | AlarmControlPanelEntityFeature.ARM_AWAY
        | AlarmControlPanelEntityFeature.ARM_NIGHT
    )

Definition at line 105 of file alarm_control_panel.py.

_changed_by

homeassistant.components.elkm1.alarm_control_panel.ElkArea._changed_by

private

Definition at line 141 of file alarm_control_panel.py.

_changed_by_id

homeassistant.components.elkm1.alarm_control_panel.ElkArea._changed_by_id

private

Definition at line 139 of file alarm_control_panel.py.

_changed_by_keypad

homeassistant.components.elkm1.alarm_control_panel.ElkArea._changed_by_keypad

private

Definition at line 135 of file alarm_control_panel.py.

_changed_by_time

homeassistant.components.elkm1.alarm_control_panel.ElkArea._changed_by_time

private

Definition at line 137 of file alarm_control_panel.py.

_elk

homeassistant.components.elkm1.alarm_control_panel.ElkArea._elk

private

Definition at line 115 of file alarm_control_panel.py.

_state

homeassistant.components.elkm1.alarm_control_panel.ElkArea._state

private

Definition at line 212 of file alarm_control_panel.py.

---

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

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