homeassistant.components.overkiz.alarm_control_panel.OverkizAlarmControlPanel Class Reference

Inheritance diagram for homeassistant.components.overkiz.alarm_control_panel.OverkizAlarmControlPanel:

Collaboration diagram for homeassistant.components.overkiz.alarm_control_panel.OverkizAlarmControlPanel:

Public Member Functions
None	__init__ (self, str device_url, OverkizDataUpdateCoordinator coordinator, EntityDescription description)
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)
None	async_alarm_trigger (self, str|None code=None)
None	async_execute_command (self, str command_name, Any args)
Public Member Functions inherited from homeassistant.components.overkiz.entity.OverkizEntity
None	__init__ (self, str device_url, OverkizDataUpdateCoordinator coordinator)
Device	device (self)
DeviceInfo	generate_device_info (self)
bool	is_sub_device (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.overkiz.coordinator.OverkizDataUpdateCoordinator
None	__init__ (self, HomeAssistant hass, logging.Logger logger, *str name, OverkizClient client, list[Device] devices, Place|None places, timedelta|None update_interval=None, str config_entry_id)
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_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_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)

Private Attributes
	_attr_supported_features

Static Private Attributes
bool	_attr_code_arm_required = False

Additional Inherited Members
Public Attributes inherited from homeassistant.components.overkiz.entity.OverkizDescriptiveEntity
	entity_description
Public Attributes inherited from homeassistant.components.overkiz.entity.OverkizEntity
	base_device_url
	device_url
	executor
	index_device_url
Public Attributes inherited from homeassistant.components.overkiz.coordinator.OverkizDataUpdateCoordinator
	areas
	client
	config_entry_id
	data
	devices
	executions
	is_stateless
	update_interval
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.overkiz.entity.OverkizEntity
	None
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 Overkiz Alarm Control Panel.

Definition at line 233 of file alarm_control_panel.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.overkiz.alarm_control_panel.OverkizAlarmControlPanel.__init__	(		self,
		str	device_url,
		OverkizDataUpdateCoordinator	coordinator,
		EntityDescription	description
	)

Initialize the device.

Reimplemented from homeassistant.components.overkiz.entity.OverkizDescriptiveEntity.

Definition at line 239 of file alarm_control_panel.py.

Member Function Documentation

alarm_state()

AlarmControlPanelState homeassistant.components.overkiz.alarm_control_panel.OverkizAlarmControlPanel.alarm_state

(

self

)

Return the state of the device.

Reimplemented from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 251 of file alarm_control_panel.py.

async_alarm_arm_away()

None homeassistant.components.overkiz.alarm_control_panel.OverkizAlarmControlPanel.async_alarm_arm_away	(		self,
		str | None	code = None
	)

Send arm away command.

Reimplemented from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 279 of file alarm_control_panel.py.

async_alarm_arm_home()

None homeassistant.components.overkiz.alarm_control_panel.OverkizAlarmControlPanel.async_alarm_arm_home	(		self,
		str | None	code = None
	)

Send arm home command.

Reimplemented from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 263 of file alarm_control_panel.py.

async_alarm_arm_night()

None homeassistant.components.overkiz.alarm_control_panel.OverkizAlarmControlPanel.async_alarm_arm_night	(		self,
		str | None	code = None
	)

Send arm night command.

Reimplemented from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 271 of file alarm_control_panel.py.

async_alarm_disarm()

None homeassistant.components.overkiz.alarm_control_panel.OverkizAlarmControlPanel.async_alarm_disarm	(		self,
		str | None	code = None
	)

Send disarm command.

Reimplemented from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 255 of file alarm_control_panel.py.

async_alarm_trigger()

None homeassistant.components.overkiz.alarm_control_panel.OverkizAlarmControlPanel.async_alarm_trigger	(		self,
		str | None	code = None
	)

Send alarm trigger command.

Reimplemented from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 287 of file alarm_control_panel.py.

async_execute_command()

None homeassistant.components.overkiz.alarm_control_panel.OverkizAlarmControlPanel.async_execute_command	(		self,
		str	command_name,
		Any	args
	)

Execute device command in async context.

Definition at line 295 of file alarm_control_panel.py.

Member Data Documentation

_attr_code_arm_required

bool homeassistant.components.overkiz.alarm_control_panel.OverkizAlarmControlPanel._attr_code_arm_required = False

staticprivate

Definition at line 237 of file alarm_control_panel.py.

_attr_supported_features

homeassistant.components.overkiz.alarm_control_panel.OverkizAlarmControlPanel._attr_supported_features

private

Definition at line 248 of file alarm_control_panel.py.

---

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

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