Inheritance diagram for homeassistant.components.canary.alarm_control_panel.CanaryAlarm:

Collaboration diagram for homeassistant.components.canary.alarm_control_panel.CanaryAlarm:

Public Member Functions
None	__init__ (self, CanaryDataUpdateCoordinator coordinator, Location location)

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)

AlarmControlPanelState\|None	alarm_state (self)

dict[str, Any]	extra_state_attributes (self)

Location	location (self)

Public Member Functions inherited from homeassistant.helpers.update_coordinator.CoordinatorEntity
None	__init__ (self, _DataUpdateCoordinatorT coordinator, Any context=None)

None	async_update (self)

bool	available (self)

Public Member Functions inherited from homeassistant.components.canary.coordinator.CanaryDataUpdateCoordinator
None	__init__ (self, HomeAssistant hass, *Api api)

Public Member Functions inherited from homeassistant.helpers.update_coordinator.DataUpdateCoordinator
None	__init__ (self, HomeAssistant hass, logging.Logger logger, *config_entries.ConfigEntry\|None\|UndefinedType config_entry=UNDEFINED, str name, timedelta\|None update_interval=None, Callable[[], Awaitable[_DataT]]\|None update_method=None, Callable[[], Awaitable[None]]\|None setup_method=None, Debouncer[Coroutine[Any, Any, None]]\|None request_refresh_debouncer=None, bool always_update=True)

Callable[[], None]	async_add_listener (self, CALLBACK_TYPE update_callback, Any context=None)

None	async_config_entry_first_refresh (self)

Generator[Any]	async_contexts (self)

None	async_refresh (self)

None	async_register_shutdown (self)

None	async_request_refresh (self)

None	async_set_update_error (self, Exception err)

None	async_set_updated_data (self, _DataT data)

None	async_shutdown (self)

None	async_update_listeners (self)

timedelta\|None	update_interval (self)

None	update_interval (self, timedelta\|None value)

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)

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)

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 Attributes
	_attr_name

	_attr_unique_id

Static Private Attributes
bool	_attr_code_arm_required = False

tuple	_attr_supported_features

Additional Inherited Members
Public Attributes inherited from homeassistant.components.canary.coordinator.CanaryDataUpdateCoordinator
	canary

Public Attributes inherited from homeassistant.helpers.update_coordinator.DataUpdateCoordinator
	always_update

	config_entry

	data

	hass

	last_exception

	last_update_success

	logger

	name

	setup_method

	update_interval

	update_method

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 a Canary alarm control panel.

Definition at line 41 of file alarm_control_panel.py.

Constructor & Destructor Documentation

◆ init()

None homeassistant.components.canary.alarm_control_panel.CanaryAlarm.__init__	(		self,
		CanaryDataUpdateCoordinator	coordinator,
		Location	location
	)

Initialize a Canary security camera.

Definition at line 53 of file alarm_control_panel.py.

Member Function Documentation

◆ alarm_arm_away()

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

Send arm away command.

Reimplemented from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 98 of file alarm_control_panel.py.

◆ alarm_arm_home()

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

Send arm home command.

Reimplemented from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 94 of file alarm_control_panel.py.

◆ alarm_arm_night()

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

Send arm night command.

Reimplemented from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 102 of file alarm_control_panel.py.

◆ alarm_disarm()

None homeassistant.components.canary.alarm_control_panel.CanaryAlarm.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.

◆ alarm_state()

AlarmControlPanelState | None homeassistant.components.canary.alarm_control_panel.CanaryAlarm.alarm_state ( self )

Return the state of the device.

Reimplemented from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 68 of file alarm_control_panel.py.

◆ extra_state_attributes()

dict[str, Any] homeassistant.components.canary.alarm_control_panel.CanaryAlarm.extra_state_attributes ( self )

Return the state attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 84 of file alarm_control_panel.py.

◆ location()

Location homeassistant.components.canary.alarm_control_panel.CanaryAlarm.location ( self )

Return information about the location.

Definition at line 63 of file alarm_control_panel.py.

Member Data Documentation

◆ _attr_code_arm_required

bool homeassistant.components.canary.alarm_control_panel.CanaryAlarm._attr_code_arm_required = False

staticprivate

Definition at line 51 of file alarm_control_panel.py.

◆ _attr_name

homeassistant.components.canary.alarm_control_panel.CanaryAlarm._attr_name

private

Definition at line 59 of file alarm_control_panel.py.

◆ _attr_supported_features

tuple homeassistant.components.canary.alarm_control_panel.CanaryAlarm._attr_supported_features

staticprivate

Initial value:

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

Definition at line 46 of file alarm_control_panel.py.

◆ _attr_unique_id

homeassistant.components.canary.alarm_control_panel.CanaryAlarm._attr_unique_id

private

Definition at line 60 of file alarm_control_panel.py.

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

core/homeassistant/components/canary/alarm_control_panel.py

Home Assistant Unofficial Reference 2024.12.1

Public Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ alarm_arm_away()

◆ alarm_arm_home()

◆ alarm_arm_night()

◆ alarm_disarm()

◆ alarm_state()

◆ extra_state_attributes()

◆ location()

Member Data Documentation

◆ _attr_code_arm_required

◆ _attr_name

◆ _attr_supported_features

◆ _attr_unique_id

◆ init()