Inheritance diagram for homeassistant.components.alarm_control_panel.AlarmControlPanelEntity:

Collaboration diagram for homeassistant.components.alarm_control_panel.AlarmControlPanelEntity:

Public Member Functions
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_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)

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)

Static Public Attributes
	AlarmControlPanelEntityFeature

	bool

	None

Static Public Attributes inherited from homeassistant.helpers.entity.Entity
	bool

	EntityPlatform

	HomeAssistant

	None

	StateInfo

	StateType

	str

Private Member Functions
None	_async_read_entity_options (self)

None	_report_deprecated_alarm_state_handling (self)

Private Attributes
	__alarm_legacy_state

	_alarm_control_panel_option_default_code

Additional Inherited Members
Public Attributes inherited from homeassistant.helpers.entity.Entity
	device_entry

	entity_id

	hass

	parallel_updates

	platform

	registry_entry

Detailed Description

An abstract class for alarm control entities.

Definition at line 153 of file __init__.py.

Member Function Documentation

◆ __init_subclass__()

None homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.__init_subclass__	(		cls,
		**Any	kwargs
	)

Post initialisation processing.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 168 of file __init__.py.

◆ setattr()

None homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.__setattr__	(		self,
		str	name,
		Any	value
	)

Set attribute.

Deprecation warning if setting '_attr_state' directly
unless already reported.

Definition at line 176 of file __init__.py.

◆ _async_read_entity_options()

None homeassistant.components.alarm_control_panel.AlarmControlPanelEntity._async_read_entity_options ( self )

private

Read entity options from entity registry.

Called when the entity registry entry has been updated and before the
alarm control panel is added to the state machine.

Definition at line 402 of file __init__.py.

◆ _report_deprecated_alarm_state_handling()

None homeassistant.components.alarm_control_panel.AlarmControlPanelEntity._report_deprecated_alarm_state_handling ( self )

private

Report on deprecated handling of alarm state.

Integrations should implement alarm_state instead of using state directly.

Definition at line 199 of file __init__.py.

◆ add_to_platform_start()

None homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.add_to_platform_start	(		self,
		HomeAssistant	hass,
		EntityPlatform	platform,
		asyncio.Semaphore \| None	parallel_updates
	)

Start adding an entity to a platform.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 187 of file __init__.py.

◆ alarm_arm_away()

None homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.alarm_arm_away	(		self,
		str \| None	code = `None`
	)

Send arm away command.

Definition at line 312 of file __init__.py.

◆ alarm_arm_custom_bypass()

None homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.alarm_arm_custom_bypass	(		self,
		str \| None	code = `None`
	)

Send arm custom bypass command.

Definition at line 361 of file __init__.py.

◆ alarm_arm_home()

None homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.alarm_arm_home	(		self,
		str \| None	code = `None`
	)

Send arm home command.

Definition at line 299 of file __init__.py.

◆ alarm_arm_night()

None homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.alarm_arm_night	(		self,
		str \| None	code = `None`
	)

Send arm night command.

Reimplemented in homeassistant.components.ifttt.alarm_control_panel.IFTTTAlarmPanel, homeassistant.components.canary.alarm_control_panel.CanaryAlarm, and homeassistant.components.alarmdecoder.alarm_control_panel.AlarmDecoderAlarmPanel.

Definition at line 325 of file __init__.py.

◆ alarm_arm_vacation()

None homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.alarm_arm_vacation	(		self,
		str \| None	code = `None`
	)

Send arm vacation command.

Definition at line 338 of file __init__.py.

◆ alarm_disarm()

None homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.alarm_disarm	(		self,
		str \| None	code = `None`
	)

Send disarm command.

Definition at line 286 of file __init__.py.

◆ alarm_state()

AlarmControlPanelState | None homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.alarm_state ( self )

Return the current alarm control panel entity state.

Integrations should overwrite this or use the '_attr_alarm_state'
attribute to set the alarm status using the 'AlarmControlPanelState' enum.

Definition at line 230 of file __init__.py.

◆ alarm_trigger()

None homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.alarm_trigger	(		self,
		str \| None	code = `None`
	)

Send alarm trigger command.

Reimplemented in homeassistant.components.tuya.alarm_control_panel.TuyaAlarmEntity.

Definition at line 346 of file __init__.py.

◆ async_alarm_arm_away()

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

Send arm away command.

Definition at line 316 of file __init__.py.

◆ async_alarm_arm_custom_bypass()

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

Send arm custom bypass command.

Reimplemented in homeassistant.components.template.alarm_control_panel.AlarmControlPanelTemplate, homeassistant.components.risco.alarm_control_panel.RiscoAlarm, homeassistant.components.manual_mqtt.alarm_control_panel.ManualMQTTAlarm, homeassistant.components.manual.alarm_control_panel.ManualAlarm, and homeassistant.components.esphome.alarm_control_panel.EsphomeAlarmControlPanel.

Definition at line 365 of file __init__.py.

◆ async_alarm_arm_home()

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

Send arm home command.

Definition at line 303 of file __init__.py.

◆ async_alarm_arm_night()

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

Send arm night command.

Definition at line 329 of file __init__.py.

◆ async_alarm_arm_vacation()

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

Send arm vacation command.

Reimplemented in homeassistant.components.template.alarm_control_panel.AlarmControlPanelTemplate, homeassistant.components.manual_mqtt.alarm_control_panel.ManualMQTTAlarm, homeassistant.components.manual.alarm_control_panel.ManualAlarm, homeassistant.components.esphome.alarm_control_panel.EsphomeAlarmControlPanel, and homeassistant.components.elkm1.alarm_control_panel.ElkArea.

Definition at line 342 of file __init__.py.

◆ async_alarm_disarm()

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

Send disarm command.

Definition at line 290 of file __init__.py.

◆ async_alarm_trigger()

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

Send alarm trigger command.

Definition at line 350 of file __init__.py.

◆ async_handle_alarm_arm_away()

None homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.async_handle_alarm_arm_away	(		self,
		str \| None	code = `None`
	)

Add default code and arm away.

Definition at line 308 of file __init__.py.

◆ async_handle_alarm_arm_custom_bypass()

None homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.async_handle_alarm_arm_custom_bypass	(		self,
		str \| None	code = `None`
	)

Add default code and arm custom bypass.

Definition at line 355 of file __init__.py.

◆ async_handle_alarm_arm_home()

None homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.async_handle_alarm_arm_home	(		self,
		str \| None	code = `None`
	)

Add default code and arm home.

Definition at line 295 of file __init__.py.

◆ async_handle_alarm_arm_night()

None homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.async_handle_alarm_arm_night	(		self,
		str \| None	code = `None`
	)

Add default code and arm night.

Definition at line 321 of file __init__.py.

◆ async_handle_alarm_arm_vacation()

None homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.async_handle_alarm_arm_vacation	(		self,
		str \| None	code = `None`
	)

Add default code and arm vacation.

Definition at line 334 of file __init__.py.

◆ async_handle_alarm_disarm()

None homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.async_handle_alarm_disarm	(		self,
		str \| None	code = `None`
	)

Add default code and disarm.

Definition at line 282 of file __init__.py.

◆ async_internal_added_to_hass()

None homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.async_internal_added_to_hass ( self )

Call when the alarm control panel entity is added to hass.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 389 of file __init__.py.

◆ async_registry_entry_updated()

None homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.async_registry_entry_updated ( self )

Run when the entity registry entry has been updated.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 397 of file __init__.py.

◆ changed_by()

str | None homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.changed_by ( self )

Last change triggered by.

Reimplemented in homeassistant.components.spc.alarm_control_panel.SpcAlarm, and homeassistant.components.elkm1.alarm_control_panel.ElkArea.

Definition at line 258 of file __init__.py.

◆ check_code_arm_required()

str \| None homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.check_code_arm_required	(		self,
		str \| None	code
	)

Check if arm code is required, raise if no code is given.

Definition at line 269 of file __init__.py.

◆ code_arm_required()

bool homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.code_arm_required ( self )

Whether the code is required for arm actions.

Reimplemented in homeassistant.components.zha.alarm_control_panel.ZHAAlarmControlPanel.

Definition at line 263 of file __init__.py.

◆ code_format()

CodeFormat | None homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.code_format ( self )

Code format or None if no code is required.

Reimplemented in homeassistant.components.manual_mqtt.alarm_control_panel.ManualMQTTAlarm, homeassistant.components.manual.alarm_control_panel.ManualAlarm, homeassistant.components.ifttt.alarm_control_panel.IFTTTAlarmPanel, and homeassistant.components.elkm1.alarm_control_panel.ElkArea.

Definition at line 253 of file __init__.py.

◆ code_or_default_code()

str \| None homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.code_or_default_code	(		self,
		str \| None	code
	)

Return code to use for a service call.

If the passed in code is not None, it will be returned. Otherwise return the
default code, if set, or None if not set, is returned.

Definition at line 240 of file __init__.py.

◆ state()

str | None homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.state ( self )

Return the current state.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 217 of file __init__.py.

◆ state_attributes()

dict[str, Any] | None homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.state_attributes ( self )

Return the state attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 381 of file __init__.py.

◆ supported_features()

AlarmControlPanelEntityFeature homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.supported_features ( self )

Return the list of supported features.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 370 of file __init__.py.

Member Data Documentation

◆ __alarm_legacy_state

homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.__alarm_legacy_state

private

Definition at line 174 of file __init__.py.

◆ _alarm_control_panel_option_default_code

homeassistant.components.alarm_control_panel.AlarmControlPanelEntity._alarm_control_panel_option_default_code

private

Definition at line 412 of file __init__.py.

◆ AlarmControlPanelEntityFeature

homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.AlarmControlPanelEntityFeature

static

Definition at line 161 of file __init__.py.

◆ bool

homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.bool

static

Definition at line 159 of file __init__.py.

◆ None

homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.None

static

Definition at line 157 of file __init__.py.

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

core/homeassistant/components/alarm_control_panel/__init__.py

Home Assistant Unofficial Reference 2024.12.1

Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ __init_subclass__()

◆ __setattr__()

◆ _async_read_entity_options()

◆ _report_deprecated_alarm_state_handling()

◆ add_to_platform_start()

◆ alarm_arm_away()

◆ alarm_arm_custom_bypass()

◆ alarm_arm_home()

◆ alarm_arm_night()

◆ alarm_arm_vacation()

◆ alarm_disarm()

◆ alarm_state()

◆ alarm_trigger()

◆ 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()

◆ async_handle_alarm_arm_away()

◆ async_handle_alarm_arm_custom_bypass()

◆ async_handle_alarm_arm_home()

◆ async_handle_alarm_arm_night()

◆ async_handle_alarm_arm_vacation()

◆ async_handle_alarm_disarm()

◆ async_internal_added_to_hass()

◆ async_registry_entry_updated()

◆ changed_by()

◆ check_code_arm_required()

◆ code_arm_required()

◆ code_format()

◆ code_or_default_code()

◆ state()

◆ state_attributes()

◆ supported_features()

Member Data Documentation

◆ __alarm_legacy_state

◆ _alarm_control_panel_option_default_code

◆ AlarmControlPanelEntityFeature

◆ bool

◆ None

◆ setattr()