Inheritance diagram for homeassistant.components.esphome.alarm_control_panel.EsphomeAlarmControlPanel:

Collaboration diagram for homeassistant.components.esphome.alarm_control_panel.EsphomeAlarmControlPanel:

Public Member Functions
AlarmControlPanelState\|None	alarm_state (self)

None	async_alarm_arm_away (self, str\|None code=None)

None	async_alarm_arm_custom_bypass (self, str\|None code=None)

None	async_alarm_arm_home (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_disarm (self, str\|None code=None)

None	async_alarm_trigger (self, str\|None code=None)

Public Member Functions inherited from homeassistant.components.esphome.entity.EsphomeEntity
None	__init__ (self, RuntimeEntryData entry_data, str domain, EntityInfo entity_info, type[_StateT] state_type)

None	async_added_to_hass (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_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)

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_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)

Private Member Functions
None	_on_static_info_update (self, EntityInfo static_info)

Private Attributes
	_attr_code_arm_required

	_attr_code_format

	_attr_supported_features

Additional Inherited Members
Public Attributes inherited from homeassistant.components.esphome.entity.EsphomeEntity
	entity_id

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

An Alarm Control Panel implementation for ESPHome.

Definition at line 61 of file alarm_control_panel.py.

Member Function Documentation

◆ _on_static_info_update()

None homeassistant.components.esphome.alarm_control_panel.EsphomeAlarmControlPanel._on_static_info_update	(		self,
		EntityInfo	static_info
	)

private

Set attrs from static info.

Reimplemented from homeassistant.components.esphome.entity.EsphomeEntity.

Definition at line 68 of file alarm_control_panel.py.

◆ alarm_state()

AlarmControlPanelState | None homeassistant.components.esphome.alarm_control_panel.EsphomeAlarmControlPanel.alarm_state ( self )

Return the state of the device.

Reimplemented from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 93 of file alarm_control_panel.py.

◆ async_alarm_arm_away()

None homeassistant.components.esphome.alarm_control_panel.EsphomeAlarmControlPanel.async_alarm_arm_away	(		self,
		str \| None	code = `None`
	)

Send arm away command.

Reimplemented from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 112 of file alarm_control_panel.py.

◆ async_alarm_arm_custom_bypass()

None homeassistant.components.esphome.alarm_control_panel.EsphomeAlarmControlPanel.async_alarm_arm_custom_bypass	(		self,
		str \| None	code = `None`
	)

Send arm away command.

Reimplemented from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 126 of file alarm_control_panel.py.

◆ async_alarm_arm_home()

None homeassistant.components.esphome.alarm_control_panel.EsphomeAlarmControlPanel.async_alarm_arm_home	(		self,
		str \| None	code = `None`
	)

Send arm home command.

Reimplemented from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 105 of file alarm_control_panel.py.

◆ async_alarm_arm_night()

None homeassistant.components.esphome.alarm_control_panel.EsphomeAlarmControlPanel.async_alarm_arm_night	(		self,
		str \| None	code = `None`
	)

Send arm away command.

Reimplemented from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 119 of file alarm_control_panel.py.

◆ async_alarm_arm_vacation()

None homeassistant.components.esphome.alarm_control_panel.EsphomeAlarmControlPanel.async_alarm_arm_vacation	(		self,
		str \| None	code = `None`
	)

Send arm away command.

Reimplemented from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 133 of file alarm_control_panel.py.

◆ async_alarm_disarm()

None homeassistant.components.esphome.alarm_control_panel.EsphomeAlarmControlPanel.async_alarm_disarm	(		self,
		str \| None	code = `None`
	)

Send disarm command.

Reimplemented from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 98 of file alarm_control_panel.py.

◆ async_alarm_trigger()

None homeassistant.components.esphome.alarm_control_panel.EsphomeAlarmControlPanel.async_alarm_trigger	(		self,
		str \| None	code = `None`
	)

Send alarm trigger command.

Reimplemented from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 140 of file alarm_control_panel.py.

Member Data Documentation

◆ _attr_code_arm_required

homeassistant.components.esphome.alarm_control_panel.EsphomeAlarmControlPanel._attr_code_arm_required

private

Definition at line 89 of file alarm_control_panel.py.

◆ _attr_code_format

homeassistant.components.esphome.alarm_control_panel.EsphomeAlarmControlPanel._attr_code_format

private

Definition at line 86 of file alarm_control_panel.py.

◆ _attr_supported_features

homeassistant.components.esphome.alarm_control_panel.EsphomeAlarmControlPanel._attr_supported_features

private

Definition at line 85 of file alarm_control_panel.py.

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

core/homeassistant/components/esphome/alarm_control_panel.py

Home Assistant Unofficial Reference 2024.12.1

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ _on_static_info_update()

◆ alarm_state()

◆ async_alarm_arm_away()

◆ async_alarm_arm_custom_bypass()

◆ async_alarm_arm_home()

◆ async_alarm_arm_night()

◆ async_alarm_arm_vacation()

◆ async_alarm_disarm()

◆ async_alarm_trigger()

Member Data Documentation

◆ _attr_code_arm_required

◆ _attr_code_format

◆ _attr_supported_features