homeassistant.components.ifttt.alarm_control_panel.IFTTTAlarmPanel Class Reference

Inheritance diagram for homeassistant.components.ifttt.alarm_control_panel.IFTTTAlarmPanel:

Collaboration diagram for homeassistant.components.ifttt.alarm_control_panel.IFTTTAlarmPanel:

Public Member Functions
None	__init__ (self, str name, str|None code, bool code_arm_required, str event_away, str event_home, str event_night, str event_disarm, bool optimistic)
None	alarm_arm_away (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_disarm (self, str|None code=None)
CodeFormat|None	code_format (self)
None	push_alarm_state (self, str value)
None	set_alarm_state (self, str event, AlarmControlPanelState state)
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_custom_bypass (self, str|None code=None)
None	alarm_arm_vacation (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)
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
bool	_check_code (self, str|None code)

Private Attributes
	_attr_alarm_state
	_attr_name
	_code
	_code_arm_required
	_event_away
	_event_disarm
	_event_home
	_event_night
	_optimistic

Static Private Attributes
bool	_attr_assumed_state = True
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 an alarm control panel controlled through IFTTT.

Definition at line 124 of file alarm_control_panel.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.ifttt.alarm_control_panel.IFTTTAlarmPanel.__init__	(		self,
		str	name,
		str | None	code,
		bool	code_arm_required,
		str	event_away,
		str	event_home,
		str	event_night,
		str	event_disarm,
		bool	optimistic
	)

Initialize the alarm control panel.

Definition at line 134 of file alarm_control_panel.py.

Member Function Documentation

_check_code()

bool homeassistant.components.ifttt.alarm_control_panel.IFTTTAlarmPanel._check_code (   self, str | None  code  )

private

Definition at line 204 of file alarm_control_panel.py.

alarm_arm_away()

None homeassistant.components.ifttt.alarm_control_panel.IFTTTAlarmPanel.alarm_arm_away	(		self,
		str | None	code = None
	)

Send arm away command.

Reimplemented from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 170 of file alarm_control_panel.py.

alarm_arm_home()

None homeassistant.components.ifttt.alarm_control_panel.IFTTTAlarmPanel.alarm_arm_home	(		self,
		str | None	code = None
	)

Send arm home command.

Reimplemented from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 176 of file alarm_control_panel.py.

alarm_arm_night()

None homeassistant.components.ifttt.alarm_control_panel.IFTTTAlarmPanel.alarm_arm_night	(		self,
		str | None	code = None
	)

Send arm night command.

Reimplemented from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 182 of file alarm_control_panel.py.

alarm_disarm()

None homeassistant.components.ifttt.alarm_control_panel.IFTTTAlarmPanel.alarm_disarm	(		self,
		str | None	code = None
	)

Send disarm command.

Reimplemented from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 164 of file alarm_control_panel.py.

code_format()

CodeFormat | None homeassistant.components.ifttt.alarm_control_panel.IFTTTAlarmPanel.code_format

(

self

)

Return one or more digits/characters.

Reimplemented from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 156 of file alarm_control_panel.py.

push_alarm_state()

None homeassistant.components.ifttt.alarm_control_panel.IFTTTAlarmPanel.push_alarm_state	(		self,
		str	value
	)

Push the alarm state to the given value.

Definition at line 197 of file alarm_control_panel.py.

set_alarm_state()

None homeassistant.components.ifttt.alarm_control_panel.IFTTTAlarmPanel.set_alarm_state	(		self,
		str	event,
		AlarmControlPanelState	state
	)

Call the IFTTT trigger service to change the alarm state.

Definition at line 188 of file alarm_control_panel.py.

Member Data Documentation

_attr_alarm_state

homeassistant.components.ifttt.alarm_control_panel.IFTTTAlarmPanel._attr_alarm_state

private

Definition at line 195 of file alarm_control_panel.py.

_attr_assumed_state

bool homeassistant.components.ifttt.alarm_control_panel.IFTTTAlarmPanel._attr_assumed_state = True

staticprivate

Definition at line 127 of file alarm_control_panel.py.

_attr_name

homeassistant.components.ifttt.alarm_control_panel.IFTTTAlarmPanel._attr_name

private

Definition at line 146 of file alarm_control_panel.py.

_attr_supported_features

tuple homeassistant.components.ifttt.alarm_control_panel.IFTTTAlarmPanel._attr_supported_features

staticprivate

Initial value:

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

Definition at line 128 of file alarm_control_panel.py.

_code

homeassistant.components.ifttt.alarm_control_panel.IFTTTAlarmPanel._code

private

Definition at line 147 of file alarm_control_panel.py.

_code_arm_required

homeassistant.components.ifttt.alarm_control_panel.IFTTTAlarmPanel._code_arm_required

private

Definition at line 148 of file alarm_control_panel.py.

_event_away

homeassistant.components.ifttt.alarm_control_panel.IFTTTAlarmPanel._event_away

private

Definition at line 149 of file alarm_control_panel.py.

_event_disarm

homeassistant.components.ifttt.alarm_control_panel.IFTTTAlarmPanel._event_disarm

private

Definition at line 152 of file alarm_control_panel.py.

_event_home

homeassistant.components.ifttt.alarm_control_panel.IFTTTAlarmPanel._event_home

private

Definition at line 150 of file alarm_control_panel.py.

_event_night

homeassistant.components.ifttt.alarm_control_panel.IFTTTAlarmPanel._event_night

private

Definition at line 151 of file alarm_control_panel.py.

_optimistic

homeassistant.components.ifttt.alarm_control_panel.IFTTTAlarmPanel._optimistic

private

Definition at line 153 of file alarm_control_panel.py.

---

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

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