Inheritance diagram for homeassistant.components.homematicip_cloud.alarm_control_panel.HomematicipAlarmControlPanelEntity:

[legend]

Collaboration diagram for homeassistant.components.homematicip_cloud.alarm_control_panel.HomematicipAlarmControlPanelEntity:

[legend]

Public Member Functions
None	__init__ (self, HomematicipHAP hap)

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

bool	available (self)

DeviceInfo	device_info (self)

str	name (self)

str	unique_id (self)

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

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)

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)

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)

Private Member Functions
None	_async_device_changed (self, args, *kwargs)

SecurityAndAlarmHome	_security_and_alarm (self)

Static Private Attributes
bool	_attr_code_arm_required = False

bool	_attr_should_poll = False

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.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 the HomematicIP alarm control panel.

Definition at line 37 of file alarm_control_panel.py.

Constructor & Destructor Documentation

◆ init()

None homeassistant.components.homematicip_cloud.alarm_control_panel.HomematicipAlarmControlPanelEntity.__init__	(		self,
		HomematicipHAP	hap
	)

Initialize the alarm control panel.

Definition at line 47 of file alarm_control_panel.py.

Member Function Documentation

◆ _async_device_changed()

None homeassistant.components.homematicip_cloud.alarm_control_panel.HomematicipAlarmControlPanelEntity._async_device_changed	(		self,
		*	args,
		**	kwargs
	)

private

Handle entity state changes.

Definition at line 100 of file alarm_control_panel.py.

◆ _security_and_alarm()

SecurityAndAlarmHome homeassistant.components.homematicip_cloud.alarm_control_panel.HomematicipAlarmControlPanelEntity._security_and_alarm ( self )

private

Definition at line 80 of file alarm_control_panel.py.

◆ alarm_state()

AlarmControlPanelState homeassistant.components.homematicip_cloud.alarm_control_panel.HomematicipAlarmControlPanelEntity.alarm_state ( self )

Return the state of the alarm control panel.

Reimplemented from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 63 of file alarm_control_panel.py.

◆ async_added_to_hass()

None homeassistant.components.homematicip_cloud.alarm_control_panel.HomematicipAlarmControlPanelEntity.async_added_to_hass ( self )

Register callbacks.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 95 of file alarm_control_panel.py.

◆ async_alarm_arm_away()

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

Send arm away command.

Reimplemented from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 91 of file alarm_control_panel.py.

◆ async_alarm_arm_home()

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

Send arm home command.

Reimplemented from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 87 of file alarm_control_panel.py.

◆ async_alarm_disarm()

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

Send disarm command.

Reimplemented from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 83 of file alarm_control_panel.py.

◆ available()

bool homeassistant.components.homematicip_cloud.alarm_control_panel.HomematicipAlarmControlPanelEntity.available ( self )

Return if alarm control panel is available.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 124 of file alarm_control_panel.py.

◆ device_info()

DeviceInfo homeassistant.components.homematicip_cloud.alarm_control_panel.HomematicipAlarmControlPanelEntity.device_info ( self )

Return device specific attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 52 of file alarm_control_panel.py.

◆ name()

str homeassistant.components.homematicip_cloud.alarm_control_panel.HomematicipAlarmControlPanelEntity.name ( self )

Return the name of the generic entity.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 116 of file alarm_control_panel.py.

◆ unique_id()

str homeassistant.components.homematicip_cloud.alarm_control_panel.HomematicipAlarmControlPanelEntity.unique_id ( self )

Return a unique ID.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 129 of file alarm_control_panel.py.

Member Data Documentation

◆ _attr_code_arm_required

bool homeassistant.components.homematicip_cloud.alarm_control_panel.HomematicipAlarmControlPanelEntity._attr_code_arm_required = False

staticprivate

Definition at line 45 of file alarm_control_panel.py.

◆ _attr_should_poll

bool homeassistant.components.homematicip_cloud.alarm_control_panel.HomematicipAlarmControlPanelEntity._attr_should_poll = False

staticprivate

Definition at line 40 of file alarm_control_panel.py.

◆ _attr_supported_features

tuple homeassistant.components.homematicip_cloud.alarm_control_panel.HomematicipAlarmControlPanelEntity._attr_supported_features

staticprivate

Initial value:

=  (
        AlarmControlPanelEntityFeature.ARM_HOME
        | AlarmControlPanelEntityFeature.ARM_AWAY
    )

Definition at line 41 of file alarm_control_panel.py.

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

core/homeassistant/components/homematicip_cloud/alarm_control_panel.py

Home Assistant Unofficial Reference 2024.12.1

Public Member Functions

Private Member Functions

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ _async_device_changed()

◆ _security_and_alarm()

◆ alarm_state()

◆ async_added_to_hass()

◆ async_alarm_arm_away()

◆ async_alarm_arm_home()

◆ async_alarm_disarm()

◆ available()

◆ device_info()

◆ name()

◆ unique_id()

Member Data Documentation

◆ _attr_code_arm_required

◆ _attr_should_poll

◆ _attr_supported_features

◆ init()