homeassistant.components.nx584.alarm_control_panel.NX584Alarm Class Reference

Inheritance diagram for homeassistant.components.nx584.alarm_control_panel.NX584Alarm:

Collaboration diagram for homeassistant.components.nx584.alarm_control_panel.NX584Alarm:

Public Member Functions
None	__init__ (self, str name, client.Client alarm_client, str url)
None	alarm_arm_away (self, str|None code=None)
None	alarm_arm_home (self, str|None code=None)
None	alarm_bypass (self, int zone)
None	alarm_disarm (self, str|None code=None)
None	alarm_unbypass (self, int zone)
None	update (self)
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_night (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)
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
	_alarm
	_attr_alarm_state
	_attr_name
	_url

Static Private Attributes
bool	_attr_code_arm_required = False
	_attr_code_format = CodeFormat.NUMBER
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 a NX584-based alarm panel.

Definition at line 87 of file alarm_control_panel.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.nx584.alarm_control_panel.NX584Alarm.__init__	(		self,
		str	name,
		client.Client	alarm_client,
		str	url
	)

Init the nx584 alarm panel.

Definition at line 97 of file alarm_control_panel.py.

Member Function Documentation

alarm_arm_away()

None homeassistant.components.nx584.alarm_control_panel.NX584Alarm.alarm_arm_away	(		self,
		str | None	code = None
	)

Send arm away command.

Reimplemented from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 149 of file alarm_control_panel.py.

alarm_arm_home()

None homeassistant.components.nx584.alarm_control_panel.NX584Alarm.alarm_arm_home	(		self,
		str | None	code = None
	)

Send arm home command.

Reimplemented from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 145 of file alarm_control_panel.py.

alarm_bypass()

None homeassistant.components.nx584.alarm_control_panel.NX584Alarm.alarm_bypass	(		self,
		int	zone
	)

Send bypass command.

Definition at line 153 of file alarm_control_panel.py.

alarm_disarm()

None homeassistant.components.nx584.alarm_control_panel.NX584Alarm.alarm_disarm	(		self,
		str | None	code = None
	)

Send disarm command.

Reimplemented from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 141 of file alarm_control_panel.py.

alarm_unbypass()

None homeassistant.components.nx584.alarm_control_panel.NX584Alarm.alarm_unbypass	(		self,
		int	zone
	)

Send bypass command.

Definition at line 157 of file alarm_control_panel.py.

update()

None homeassistant.components.nx584.alarm_control_panel.NX584Alarm.update

(

self

)

Process new events from panel.

Definition at line 103 of file alarm_control_panel.py.

Member Data Documentation

_alarm

homeassistant.components.nx584.alarm_control_panel.NX584Alarm._alarm

private

Definition at line 100 of file alarm_control_panel.py.

_attr_alarm_state

homeassistant.components.nx584.alarm_control_panel.NX584Alarm._attr_alarm_state

private

Definition at line 113 of file alarm_control_panel.py.

_attr_code_arm_required

bool homeassistant.components.nx584.alarm_control_panel.NX584Alarm._attr_code_arm_required = False

staticprivate

Definition at line 95 of file alarm_control_panel.py.

_attr_code_format

homeassistant.components.nx584.alarm_control_panel.NX584Alarm._attr_code_format = CodeFormat.NUMBER

staticprivate

Definition at line 90 of file alarm_control_panel.py.

_attr_name

homeassistant.components.nx584.alarm_control_panel.NX584Alarm._attr_name

private

Definition at line 99 of file alarm_control_panel.py.

_attr_supported_features

tuple homeassistant.components.nx584.alarm_control_panel.NX584Alarm._attr_supported_features

staticprivate

Initial value:

=  (
        AlarmControlPanelEntityFeature.ARM_HOME
        | AlarmControlPanelEntityFeature.ARM_AWAY
    )

Definition at line 91 of file alarm_control_panel.py.

_url

homeassistant.components.nx584.alarm_control_panel.NX584Alarm._url

private

Definition at line 101 of file alarm_control_panel.py.

---

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

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