homeassistant.components.homekit_controller.alarm_control_panel.HomeKitAlarmControlPanelEntity Class Reference

Inheritance diagram for homeassistant.components.homekit_controller.alarm_control_panel.HomeKitAlarmControlPanelEntity:

Collaboration diagram for homeassistant.components.homekit_controller.alarm_control_panel.HomeKitAlarmControlPanelEntity:

Public Member Functions
AlarmControlPanelState	alarm_state (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_night (self, str|None code=None)
None	async_alarm_disarm (self, str|None code=None)
dict[str, Any]|None	extra_state_attributes (self)
list[str]	get_characteristic_types (self)
None	set_alarm_state (self, AlarmControlPanelState state, str|None code=None)
Public Member Functions inherited from homeassistant.components.homekit_controller.entity.HomeKitEntity
None	__init__ (self, HKDevice accessory, ConfigType devinfo)
None	async_added_to_hass (self)
None	async_put_characteristics (self, dict[str, Any] characteristics)
None	async_setup (self)
None	async_update (self)
None	async_will_remove_from_hass (self)
bool	available (self)
str|None	default_name (self)
DeviceInfo	device_info (self)
str|None	name (self)
str	old_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_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_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)
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_alarm_arm_custom_bypass (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)

Static Private Attributes
tuple	_attr_supported_features

Additional Inherited Members
Public Attributes inherited from homeassistant.components.homekit_controller.entity.HomeKitEntity
	accessory
	accessory_info
	all_characteristics
	all_iids
	pollable_characteristics
	service
	watchable_characteristics
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 a Homekit Alarm Control Panel.

Definition at line 64 of file alarm_control_panel.py.

Member Function Documentation

alarm_state()

AlarmControlPanelState homeassistant.components.homekit_controller.alarm_control_panel.HomeKitAlarmControlPanelEntity.alarm_state

(

self

)

Return the state of the device.

Reimplemented from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 82 of file alarm_control_panel.py.

async_alarm_arm_away()

None homeassistant.components.homekit_controller.alarm_control_panel.HomeKitAlarmControlPanelEntity.async_alarm_arm_away	(		self,
		str | None	code = None
	)

Send arm command.

Reimplemented from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 92 of file alarm_control_panel.py.

async_alarm_arm_home()

None homeassistant.components.homekit_controller.alarm_control_panel.HomeKitAlarmControlPanelEntity.async_alarm_arm_home	(		self,
		str | None	code = None
	)

Send stay command.

Reimplemented from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 96 of file alarm_control_panel.py.

async_alarm_arm_night()

None homeassistant.components.homekit_controller.alarm_control_panel.HomeKitAlarmControlPanelEntity.async_alarm_arm_night	(		self,
		str | None	code = None
	)

Send night command.

Reimplemented from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 100 of file alarm_control_panel.py.

async_alarm_disarm()

None homeassistant.components.homekit_controller.alarm_control_panel.HomeKitAlarmControlPanelEntity.async_alarm_disarm	(		self,
		str | None	code = None
	)

Send disarm command.

Reimplemented from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 88 of file alarm_control_panel.py.

extra_state_attributes()

dict[str, Any] | None homeassistant.components.homekit_controller.alarm_control_panel.HomeKitAlarmControlPanelEntity.extra_state_attributes

(

self

)

Return the optional state attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 113 of file alarm_control_panel.py.

get_characteristic_types()

list[str] homeassistant.components.homekit_controller.alarm_control_panel.HomeKitAlarmControlPanelEntity.get_characteristic_types

(

self

)

Define the homekit characteristics the entity cares about.

Reimplemented from homeassistant.components.homekit_controller.entity.HomeKitEntity.

Definition at line 73 of file alarm_control_panel.py.

set_alarm_state()

None homeassistant.components.homekit_controller.alarm_control_panel.HomeKitAlarmControlPanelEntity.set_alarm_state	(		self,
		AlarmControlPanelState	state,
		str | None	code = None
	)

Send state command.

Definition at line 104 of file alarm_control_panel.py.

Member Data Documentation

_attr_supported_features

tuple homeassistant.components.homekit_controller.alarm_control_panel.HomeKitAlarmControlPanelEntity._attr_supported_features

staticprivate

Initial value:

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

Definition at line 67 of file alarm_control_panel.py.

---

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

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