Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.elmax.alarm_control_panel.ElmaxArea Class Reference
Inheritance diagram for homeassistant.components.elmax.alarm_control_panel.ElmaxArea:
[legend]
Collaboration diagram for homeassistant.components.elmax.alarm_control_panel.ElmaxArea:
[legend]

Public Member Functions

None async_alarm_arm_away (self, str|None code=None)
 
- Public Member Functions inherited from homeassistant.components.elmax.entity.ElmaxEntity
None __init__ (self, DeviceEndpoint elmax_device, str panel_version, ElmaxCoordinator coordinator)
 
bool available (self)
 
- Public Member Functions inherited from homeassistant.helpers.update_coordinator.CoordinatorEntity
None __init__ (self, _DataUpdateCoordinatorT coordinator, Any context=None)
 
None async_update (self)
 
- Public Member Functions inherited from homeassistant.components.elmax.coordinator.ElmaxCoordinator
None __init__ (self, HomeAssistant hass, Logger logger, GenericElmax elmax_api_client, PanelEntry panel, str name, timedelta update_interval)
 
None async_shutdown (self)
 
Actuator get_actuator_state (self, str actuator_id)
 
Area get_area_state (self, str area_id)
 
Cover get_cover_state (self, str cover_id)
 
Actuator get_zone_state (self, str zone_id)
 
def http_client (self)
 
def http_client (self, GenericElmax client)
 
PanelEntry panel_entry (self)
 
- 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_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)
 
AlarmControlPanelState|None alarm_state (self)
 
None alarm_trigger (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, strtranslation_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)
 

Static Public Attributes

 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
 

Private Attributes

 _attr_alarm_state
 
 _pending_state
 

Static Private Attributes

bool _attr_code_arm_required = False
 
 _attr_code_format = CodeFormat.NUMBER
 
bool _attr_has_entity_name = True
 
 _attr_supported_features = AlarmControlPanelEntityFeature.ARM_AWAY
 

Additional Inherited Members

- 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
 

Detailed Description

Elmax Area entity implementation.

Definition at line 63 of file alarm_control_panel.py.

Member Function Documentation

◆ async_alarm_arm_away()

None homeassistant.components.elmax.alarm_control_panel.ElmaxArea.async_alarm_arm_away (   self,
str | None   code = None 
)
Send arm away command.

Reimplemented from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 72 of file alarm_control_panel.py.

Member Data Documentation

◆ _attr_alarm_state

homeassistant.components.elmax.alarm_control_panel.ElmaxArea._attr_alarm_state
private

Definition at line 74 of file alarm_control_panel.py.

◆ _attr_code_arm_required

bool homeassistant.components.elmax.alarm_control_panel.ElmaxArea._attr_code_arm_required = False
staticprivate

Definition at line 67 of file alarm_control_panel.py.

◆ _attr_code_format

homeassistant.components.elmax.alarm_control_panel.ElmaxArea._attr_code_format = CodeFormat.NUMBER
staticprivate

Definition at line 66 of file alarm_control_panel.py.

◆ _attr_has_entity_name

bool homeassistant.components.elmax.alarm_control_panel.ElmaxArea._attr_has_entity_name = True
staticprivate

Definition at line 68 of file alarm_control_panel.py.

◆ _attr_supported_features

homeassistant.components.elmax.alarm_control_panel.ElmaxArea._attr_supported_features = AlarmControlPanelEntityFeature.ARM_AWAY
staticprivate

Definition at line 69 of file alarm_control_panel.py.

◆ _pending_state

homeassistant.components.elmax.alarm_control_panel.ElmaxArea._pending_state
private

Definition at line 79 of file alarm_control_panel.py.

◆ None

homeassistant.components.elmax.alarm_control_panel.ElmaxArea.None
static

Definition at line 70 of file alarm_control_panel.py.


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