homeassistant.components.risco.alarm_control_panel.RiscoAlarm Class Reference

Inheritance diagram for homeassistant.components.risco.alarm_control_panel.RiscoAlarm:

Collaboration diagram for homeassistant.components.risco.alarm_control_panel.RiscoAlarm:

Public Member Functions
None	__init__ (self, *int partition_id, Partition partition, str code, dict[str, Any] options, **Any kwargs)
AlarmControlPanelState|None	alarm_state (self)
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_disarm (self, str|None code=None)
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_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_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
None	_arm (self, AlarmControlPanelState mode, str|None code)
None	_call_alarm_method (self, str method, *Any args)
bool	_validate_code (self, str|None code)

Private Attributes
	_attr_code_arm_required
	_code
	_code_disarm_required
	_ha_to_risco
	_partition
	_partition_id
	_risco_to_ha

Static Private Attributes
	_attr_code_format = CodeFormat.NUMBER
bool	_attr_has_entity_name = True
	_attr_name = None

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 a Risco cloud partition.

Definition at line 82 of file alarm_control_panel.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.risco.alarm_control_panel.RiscoAlarm.__init__	(		self,
		*int	partition_id,
		Partition	partition,
		str	code,
		dict[str, Any]	options,
		**Any	kwargs
	)

Init the partition.

Definition at line 89 of file alarm_control_panel.py.

Member Function Documentation

_arm()

None homeassistant.components.risco.alarm_control_panel.RiscoAlarm._arm (   self, AlarmControlPanelState  mode, str | None  code  )

private

Definition at line 157 of file alarm_control_panel.py.

_call_alarm_method()

None homeassistant.components.risco.alarm_control_panel.RiscoAlarm._call_alarm_method (   self, str  method, *Any  args  )

private

Reimplemented in homeassistant.components.risco.alarm_control_panel.RiscoLocalAlarm, and homeassistant.components.risco.alarm_control_panel.RiscoCloudAlarm.

Definition at line 171 of file alarm_control_panel.py.

_validate_code()

bool homeassistant.components.risco.alarm_control_panel.RiscoAlarm._validate_code (   self, str | None  code  )

private

Validate given code.

Definition at line 130 of file alarm_control_panel.py.

alarm_state()

AlarmControlPanelState | None homeassistant.components.risco.alarm_control_panel.RiscoAlarm.alarm_state

(

self

)

Return the state of the device.

Reimplemented from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 111 of file alarm_control_panel.py.

async_alarm_arm_away()

None homeassistant.components.risco.alarm_control_panel.RiscoAlarm.async_alarm_arm_away	(		self,
		str | None	code = None
	)

Send arm away command.

Reimplemented from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 145 of file alarm_control_panel.py.

async_alarm_arm_custom_bypass()

None homeassistant.components.risco.alarm_control_panel.RiscoAlarm.async_alarm_arm_custom_bypass	(		self,
		str | None	code = None
	)

Send arm custom bypass command.

Reimplemented from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 153 of file alarm_control_panel.py.

async_alarm_arm_home()

None homeassistant.components.risco.alarm_control_panel.RiscoAlarm.async_alarm_arm_home	(		self,
		str | None	code = None
	)

Send arm home command.

Reimplemented from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 141 of file alarm_control_panel.py.

async_alarm_arm_night()

None homeassistant.components.risco.alarm_control_panel.RiscoAlarm.async_alarm_arm_night	(		self,
		str | None	code = None
	)

Send arm night command.

Reimplemented from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 149 of file alarm_control_panel.py.

async_alarm_disarm()

None homeassistant.components.risco.alarm_control_panel.RiscoAlarm.async_alarm_disarm	(		self,
		str | None	code = None
	)

Send disarm command.

Reimplemented from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 134 of file alarm_control_panel.py.

Member Data Documentation

_attr_code_arm_required

homeassistant.components.risco.alarm_control_panel.RiscoAlarm._attr_code_arm_required

private

Definition at line 103 of file alarm_control_panel.py.

_attr_code_format

homeassistant.components.risco.alarm_control_panel.RiscoAlarm._attr_code_format = CodeFormat.NUMBER

staticprivate

Definition at line 85 of file alarm_control_panel.py.

_attr_has_entity_name

bool homeassistant.components.risco.alarm_control_panel.RiscoAlarm._attr_has_entity_name = True

staticprivate

Definition at line 86 of file alarm_control_panel.py.

_attr_name

homeassistant.components.risco.alarm_control_panel.RiscoAlarm._attr_name = None

staticprivate

Definition at line 87 of file alarm_control_panel.py.

_code

homeassistant.components.risco.alarm_control_panel.RiscoAlarm._code

private

Definition at line 102 of file alarm_control_panel.py.

_code_disarm_required

homeassistant.components.risco.alarm_control_panel.RiscoAlarm._code_disarm_required

private

Definition at line 104 of file alarm_control_panel.py.

_ha_to_risco

homeassistant.components.risco.alarm_control_panel.RiscoAlarm._ha_to_risco

private

Definition at line 106 of file alarm_control_panel.py.

_partition

homeassistant.components.risco.alarm_control_panel.RiscoAlarm._partition

private

Definition at line 101 of file alarm_control_panel.py.

_partition_id

homeassistant.components.risco.alarm_control_panel.RiscoAlarm._partition_id

private

Definition at line 100 of file alarm_control_panel.py.

_risco_to_ha

homeassistant.components.risco.alarm_control_panel.RiscoAlarm._risco_to_ha

private

Definition at line 105 of file alarm_control_panel.py.

---

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

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