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

Public Member Functions

None __init__ (self, TotalConnectDataUpdateCoordinator coordinator, TotalConnectLocation location, int partition_id, bool require_code)
 
AlarmControlPanelState|None alarm_state (self)
 
None async_alarm_arm_away (self, str|None code=None)
 
None async_alarm_arm_away_instant (self)
 
None async_alarm_arm_home (self, str|None code=None)
 
None async_alarm_arm_home_instant (self)
 
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.totalconnect.entity.TotalConnectLocationEntity
None __init__ (self, TotalConnectDataUpdateCoordinator coordinator, TotalConnectLocation location)
 
- 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.totalconnect.coordinator.TotalConnectDataUpdateCoordinator
None __init__ (self, HomeAssistant hass, TotalConnectClient client)
 
None sync_update_data (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_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_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)
 

Private Member Functions

None _arm_away (self)
 
def _arm_away_instant (self)
 
None _arm_home (self)
 
def _arm_home_instant (self)
 
None _arm_night (self)
 
def _check_usercode (self, code)
 
None _disarm (self)
 

Private Attributes

 _attr_code_arm_required
 
 _attr_code_format
 
 _attr_extra_state_attributes
 
 _attr_name
 
 _attr_translation_key
 
 _attr_translation_placeholders
 
 _attr_unique_id
 
 _partition
 
 _partition_id
 

Static Private Attributes

tuple _attr_supported_features
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.components.totalconnect.entity.TotalConnectLocationEntity
 device
 
- Public Attributes inherited from homeassistant.components.totalconnect.coordinator.TotalConnectDataUpdateCoordinator
 client
 
- 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

Represent a TotalConnect alarm panel.

Definition at line 58 of file alarm_control_panel.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.totalconnect.alarm_control_panel.TotalConnectAlarm.__init__ (   self,
TotalConnectDataUpdateCoordinator  coordinator,
TotalConnectLocation  location,
int  partition_id,
bool  require_code 
)
Initialize the TotalConnect status.

Definition at line 67 of file alarm_control_panel.py.

Member Function Documentation

◆ _arm_away()

None homeassistant.components.totalconnect.alarm_control_panel.TotalConnectAlarm._arm_away (   self)
private
Arm away synchronous.

Definition at line 209 of file alarm_control_panel.py.

◆ _arm_away_instant()

def homeassistant.components.totalconnect.alarm_control_panel.TotalConnectAlarm._arm_away_instant (   self)
private
Arm away instant synchronous.

Definition at line 276 of file alarm_control_panel.py.

◆ _arm_home()

None homeassistant.components.totalconnect.alarm_control_panel.TotalConnectAlarm._arm_home (   self)
private
Arm home synchronous.

Definition at line 186 of file alarm_control_panel.py.

◆ _arm_home_instant()

def homeassistant.components.totalconnect.alarm_control_panel.TotalConnectAlarm._arm_home_instant (   self)
private
Arm home instant synchronous.

Definition at line 254 of file alarm_control_panel.py.

◆ _arm_night()

None homeassistant.components.totalconnect.alarm_control_panel.TotalConnectAlarm._arm_night (   self)
private
Arm night synchronous.

Definition at line 232 of file alarm_control_panel.py.

◆ _check_usercode()

def homeassistant.components.totalconnect.alarm_control_panel.TotalConnectAlarm._check_usercode (   self,
  code 
)
private
Check if the run-time entered code matches configured code.

Definition at line 280 of file alarm_control_panel.py.

◆ _disarm()

None homeassistant.components.totalconnect.alarm_control_panel.TotalConnectAlarm._disarm (   self)
private
Disarm synchronous.

Definition at line 163 of file alarm_control_panel.py.

◆ alarm_state()

AlarmControlPanelState | None homeassistant.components.totalconnect.alarm_control_panel.TotalConnectAlarm.alarm_state (   self)
Return the state of the device.

Reimplemented from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 97 of file alarm_control_panel.py.

◆ async_alarm_arm_away()

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

Reimplemented from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 190 of file alarm_control_panel.py.

◆ async_alarm_arm_away_instant()

None homeassistant.components.totalconnect.alarm_control_panel.TotalConnectAlarm.async_alarm_arm_away_instant (   self)
Send arm away instant command.

Definition at line 258 of file alarm_control_panel.py.

◆ async_alarm_arm_home()

None homeassistant.components.totalconnect.alarm_control_panel.TotalConnectAlarm.async_alarm_arm_home (   self,
str | None   code = None 
)
Send arm home command.

Reimplemented from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 167 of file alarm_control_panel.py.

◆ async_alarm_arm_home_instant()

None homeassistant.components.totalconnect.alarm_control_panel.TotalConnectAlarm.async_alarm_arm_home_instant (   self)
Send arm home instant command.

Definition at line 236 of file alarm_control_panel.py.

◆ async_alarm_arm_night()

None homeassistant.components.totalconnect.alarm_control_panel.TotalConnectAlarm.async_alarm_arm_night (   self,
str | None   code = None 
)
Send arm night command.

Reimplemented from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 213 of file alarm_control_panel.py.

◆ async_alarm_disarm()

None homeassistant.components.totalconnect.alarm_control_panel.TotalConnectAlarm.async_alarm_disarm (   self,
str | None   code = None 
)
Send disarm command.

Reimplemented from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 144 of file alarm_control_panel.py.

Member Data Documentation

◆ _attr_code_arm_required

homeassistant.components.totalconnect.alarm_control_panel.TotalConnectAlarm._attr_code_arm_required
private

Definition at line 92 of file alarm_control_panel.py.

◆ _attr_code_format

homeassistant.components.totalconnect.alarm_control_panel.TotalConnectAlarm._attr_code_format
private

Definition at line 94 of file alarm_control_panel.py.

◆ _attr_extra_state_attributes

homeassistant.components.totalconnect.alarm_control_panel.TotalConnectAlarm._attr_extra_state_attributes
private

Definition at line 140 of file alarm_control_panel.py.

◆ _attr_name

homeassistant.components.totalconnect.alarm_control_panel.TotalConnectAlarm._attr_name
private

Definition at line 85 of file alarm_control_panel.py.

◆ _attr_supported_features

tuple homeassistant.components.totalconnect.alarm_control_panel.TotalConnectAlarm._attr_supported_features
staticprivate
Initial value:
= (
AlarmControlPanelEntityFeature.ARM_HOME
| AlarmControlPanelEntityFeature.ARM_AWAY
| AlarmControlPanelEntityFeature.ARM_NIGHT
)

Definition at line 61 of file alarm_control_panel.py.

◆ _attr_translation_key

homeassistant.components.totalconnect.alarm_control_panel.TotalConnectAlarm._attr_translation_key
private

Definition at line 88 of file alarm_control_panel.py.

◆ _attr_translation_placeholders

homeassistant.components.totalconnect.alarm_control_panel.TotalConnectAlarm._attr_translation_placeholders
private

Definition at line 89 of file alarm_control_panel.py.

◆ _attr_unique_id

homeassistant.components.totalconnect.alarm_control_panel.TotalConnectAlarm._attr_unique_id
private

Definition at line 86 of file alarm_control_panel.py.

◆ _partition

homeassistant.components.totalconnect.alarm_control_panel.TotalConnectAlarm._partition
private

Definition at line 77 of file alarm_control_panel.py.

◆ _partition_id

homeassistant.components.totalconnect.alarm_control_panel.TotalConnectAlarm._partition_id
private

Definition at line 76 of file alarm_control_panel.py.


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