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

Public Member Functions

None __init__ (self, HomeAssistant hass, str object_id, dict config, str|None unique_id)
 
AlarmControlPanelState|None alarm_state (self)
 
None async_added_to_hass (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_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)
 
- Public Member Functions inherited from homeassistant.components.template.template_entity.TemplateEntity
None __init__ (self, HomeAssistant hass, *Template|None availability_template=None, Template|None icon_template=None, Template|None entity_picture_template=None, dict[str, Template]|None attribute_templates=None, ConfigType|None config=None, str|None fallback_name=None, str|None unique_id=None)
 
None add_template_attribute (self, str attribute, Template template, Callable[[Any], Any]|None validator=None, Callable[[Any], None]|None on_update=None, bool none_on_template_error=False)
 
None async_run_script (self, Script script, *_VarsType|None run_variables=None, Context|None context=None)
 
CALLBACK_TYPE async_start_preview (self, Callable[[str|None, Mapping[str, Any]|None, dict[str, bool|set[str]]|None, str|None,], None,] preview_callback)
 
None async_update (self)
 
str|None referenced_blueprint (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_device_update (self, bool warning=True)
 
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)
 
- 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_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.restore_state.RestoreEntity
ExtraStoredData|None async_get_last_extra_data (self)
 
State|None async_get_last_state (self)
 
None async_internal_added_to_hass (self)
 
None async_internal_will_remove_from_hass (self)
 
ExtraStoredData|None extra_restore_state_data (self)
 

Public Attributes

 entity_id
 
- Public Attributes inherited from homeassistant.components.template.template_entity.TemplateEntity
 entity_id
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 

Private Member Functions

def _async_alarm_arm (self, state, script, code)
 
None _async_setup_templates (self)
 
def _update_state (self, result)
 

Private Attributes

 _arm_away_script
 
 _arm_custom_bypass_script
 
 _arm_home_script
 
 _arm_night_script
 
 _arm_vacation_script
 
 _attr_code_format
 
 _attr_device_info
 
 _attr_supported_features
 
 _disarm_script
 
 _state
 
 _template
 
 _trigger_script
 

Static Private Attributes

bool _attr_should_poll = False
 

Additional Inherited Members

- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 
- Static Public Attributes inherited from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity
 AlarmControlPanelEntityFeature
 
 bool
 
 None
 

Detailed Description

Representation of a templated Alarm Control Panel.

Definition at line 178 of file alarm_control_panel.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.template.alarm_control_panel.AlarmControlPanelTemplate.__init__ (   self,
HomeAssistant  hass,
str  object_id,
dict  config,
str | None  unique_id 
)
Initialize the panel.

Definition at line 183 of file alarm_control_panel.py.

Member Function Documentation

◆ _async_alarm_arm()

def homeassistant.components.template.alarm_control_panel.AlarmControlPanelTemplate._async_alarm_arm (   self,
  state,
  script,
  code 
)
private
Arm the panel to specified state with supplied script.

Definition at line 312 of file alarm_control_panel.py.

◆ _async_setup_templates()

None homeassistant.components.template.alarm_control_panel.AlarmControlPanelTemplate._async_setup_templates (   self)
private
Set up templates.

Reimplemented from homeassistant.components.template.template_entity.TemplateEntity.

Definition at line 304 of file alarm_control_panel.py.

◆ _update_state()

def homeassistant.components.template.alarm_control_panel.AlarmControlPanelTemplate._update_state (   self,
  result 
)
private

Definition at line 284 of file alarm_control_panel.py.

◆ alarm_state()

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

Reimplemented from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 279 of file alarm_control_panel.py.

◆ async_added_to_hass()

None homeassistant.components.template.alarm_control_panel.AlarmControlPanelTemplate.async_added_to_hass (   self)
Restore last state.

Reimplemented from homeassistant.components.template.template_entity.TemplateEntity.

Definition at line 265 of file alarm_control_panel.py.

◆ async_alarm_arm_away()

None homeassistant.components.template.alarm_control_panel.AlarmControlPanelTemplate.async_alarm_arm_away (   self,
str | None   code = None 
)
Arm the panel to Away.

Reimplemented from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 327 of file alarm_control_panel.py.

◆ async_alarm_arm_custom_bypass()

None homeassistant.components.template.alarm_control_panel.AlarmControlPanelTemplate.async_alarm_arm_custom_bypass (   self,
str | None   code = None 
)
Arm the panel to Custom Bypass.

Reimplemented from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 359 of file alarm_control_panel.py.

◆ async_alarm_arm_home()

None homeassistant.components.template.alarm_control_panel.AlarmControlPanelTemplate.async_alarm_arm_home (   self,
str | None   code = None 
)
Arm the panel to Home.

Reimplemented from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 335 of file alarm_control_panel.py.

◆ async_alarm_arm_night()

None homeassistant.components.template.alarm_control_panel.AlarmControlPanelTemplate.async_alarm_arm_night (   self,
str | None   code = None 
)
Arm the panel to Night.

Reimplemented from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 343 of file alarm_control_panel.py.

◆ async_alarm_arm_vacation()

None homeassistant.components.template.alarm_control_panel.AlarmControlPanelTemplate.async_alarm_arm_vacation (   self,
str | None   code = None 
)
Arm the panel to Vacation.

Reimplemented from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 351 of file alarm_control_panel.py.

◆ async_alarm_disarm()

None homeassistant.components.template.alarm_control_panel.AlarmControlPanelTemplate.async_alarm_disarm (   self,
str | None   code = None 
)
Disarm the panel.

Reimplemented from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 367 of file alarm_control_panel.py.

◆ async_alarm_trigger()

None homeassistant.components.template.alarm_control_panel.AlarmControlPanelTemplate.async_alarm_trigger (   self,
str | None   code = None 
)
Trigger the panel.

Reimplemented from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 373 of file alarm_control_panel.py.

Member Data Documentation

◆ _arm_away_script

homeassistant.components.template.alarm_control_panel.AlarmControlPanelTemplate._arm_away_script
private

Definition at line 205 of file alarm_control_panel.py.

◆ _arm_custom_bypass_script

homeassistant.components.template.alarm_control_panel.AlarmControlPanelTemplate._arm_custom_bypass_script
private

Definition at line 217 of file alarm_control_panel.py.

◆ _arm_home_script

homeassistant.components.template.alarm_control_panel.AlarmControlPanelTemplate._arm_home_script
private

Definition at line 208 of file alarm_control_panel.py.

◆ _arm_night_script

homeassistant.components.template.alarm_control_panel.AlarmControlPanelTemplate._arm_night_script
private

Definition at line 211 of file alarm_control_panel.py.

◆ _arm_vacation_script

homeassistant.components.template.alarm_control_panel.AlarmControlPanelTemplate._arm_vacation_script
private

Definition at line 214 of file alarm_control_panel.py.

◆ _attr_code_format

homeassistant.components.template.alarm_control_panel.AlarmControlPanelTemplate._attr_code_format
private

Definition at line 202 of file alarm_control_panel.py.

◆ _attr_device_info

homeassistant.components.template.alarm_control_panel.AlarmControlPanelTemplate._attr_device_info
private

Definition at line 229 of file alarm_control_panel.py.

◆ _attr_should_poll

bool homeassistant.components.template.alarm_control_panel.AlarmControlPanelTemplate._attr_should_poll = False
staticprivate

Definition at line 181 of file alarm_control_panel.py.

◆ _attr_supported_features

homeassistant.components.template.alarm_control_panel.AlarmControlPanelTemplate._attr_supported_features
private

Definition at line 263 of file alarm_control_panel.py.

◆ _disarm_script

homeassistant.components.template.alarm_control_panel.AlarmControlPanelTemplate._disarm_script
private

Definition at line 200 of file alarm_control_panel.py.

◆ _state

homeassistant.components.template.alarm_control_panel.AlarmControlPanelTemplate._state
private

Definition at line 276 of file alarm_control_panel.py.

◆ _template

homeassistant.components.template.alarm_control_panel.AlarmControlPanelTemplate._template
private

Definition at line 199 of file alarm_control_panel.py.

◆ _trigger_script

homeassistant.components.template.alarm_control_panel.AlarmControlPanelTemplate._trigger_script
private

Definition at line 224 of file alarm_control_panel.py.

◆ entity_id

homeassistant.components.template.alarm_control_panel.AlarmControlPanelTemplate.entity_id

Definition at line 194 of file alarm_control_panel.py.


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