homeassistant.components.template.alarm_control_panel Namespace Reference

Classes
class	AlarmControlPanelTemplate
class	TemplateCodeFormat

Functions
list[AlarmControlPanelTemplate]	_async_create_entities (HomeAssistant hass, dict[str, Any] config)
None	async_setup_entry (HomeAssistant hass, ConfigEntry config_entry, AddEntitiesCallback async_add_entities)
None	async_setup_platform (HomeAssistant hass, ConfigType config, AddEntitiesCallback async_add_entities, DiscoveryInfoType|None discovery_info=None)

Variables
	_LOGGER = logging.getLogger(__name__)
list	_VALID_STATES
	ALARM_CONTROL_PANEL_CONFIG_SCHEMA
	ALARM_CONTROL_PANEL_SCHEMA
string	CONF_ALARM_CONTROL_PANELS = "panels"
string	CONF_ARM_AWAY_ACTION = "arm_away"
string	CONF_ARM_CUSTOM_BYPASS_ACTION = "arm_custom_bypass"
string	CONF_ARM_HOME_ACTION = "arm_home"
string	CONF_ARM_NIGHT_ACTION = "arm_night"
string	CONF_ARM_VACATION_ACTION = "arm_vacation"
string	CONF_CODE_ARM_REQUIRED = "code_arm_required"
string	CONF_CODE_FORMAT = "code_format"
string	CONF_DISARM_ACTION = "disarm"
string	CONF_TRIGGER_ACTION = "trigger"
	PLATFORM_SCHEMA

Detailed Description

Support for Template alarm control panels.

Function Documentation

_async_create_entities()

list[AlarmControlPanelTemplate] homeassistant.components.template.alarm_control_panel._async_create_entities ( HomeAssistant  hass, dict[str, Any]   config  )

private

Create Template Alarm Control Panels.

Definition at line 125 of file alarm_control_panel.py.

async_setup_entry()

None homeassistant.components.template.alarm_control_panel.async_setup_entry	(	HomeAssistant	hass,
		ConfigEntry	config_entry,
		AddEntitiesCallback	async_add_entities
	)

Initialize config entry.

Definition at line 147 of file alarm_control_panel.py.

async_setup_platform()

None homeassistant.components.template.alarm_control_panel.async_setup_platform	(	HomeAssistant	hass,
		ConfigType	config,
		AddEntitiesCallback	async_add_entities,
		DiscoveryInfoType | None	discovery_info = None
	)

Set up the Template Alarm Control Panels.

Definition at line 168 of file alarm_control_panel.py.

Variable Documentation

_LOGGER

homeassistant.components.template.alarm_control_panel._LOGGER = logging.getLogger(__name__)

private

Definition at line 44 of file alarm_control_panel.py.

_VALID_STATES

list homeassistant.components.template.alarm_control_panel._VALID_STATES

private

Initial value:

=  [
    AlarmControlPanelState.ARMED_AWAY,
    AlarmControlPanelState.ARMED_CUSTOM_BYPASS,
    AlarmControlPanelState.ARMED_HOME,
    AlarmControlPanelState.ARMED_NIGHT,
    AlarmControlPanelState.ARMED_VACATION,
    AlarmControlPanelState.ARMING,
    AlarmControlPanelState.DISARMED,
    AlarmControlPanelState.PENDING,
    AlarmControlPanelState.TRIGGERED,
    STATE_UNAVAILABLE,
]

Definition at line 45 of file alarm_control_panel.py.

ALARM_CONTROL_PANEL_CONFIG_SCHEMA

homeassistant.components.template.alarm_control_panel.ALARM_CONTROL_PANEL_CONFIG_SCHEMA

Initial value:

=  vol.Schema(
    {
        vol.Required(CONF_NAME): cv.template,
        vol.Optional(CONF_VALUE_TEMPLATE): cv.template,
        vol.Optional(CONF_DISARM_ACTION): cv.SCRIPT_SCHEMA,
        vol.Optional(CONF_ARM_AWAY_ACTION): cv.SCRIPT_SCHEMA,
        vol.Optional(CONF_ARM_CUSTOM_BYPASS_ACTION): cv.SCRIPT_SCHEMA,
        vol.Optional(CONF_ARM_HOME_ACTION): cv.SCRIPT_SCHEMA,
        vol.Optional(CONF_ARM_NIGHT_ACTION): cv.SCRIPT_SCHEMA,
        vol.Optional(CONF_ARM_VACATION_ACTION): cv.SCRIPT_SCHEMA,
        vol.Optional(CONF_TRIGGER_ACTION): cv.SCRIPT_SCHEMA,
        vol.Optional(CONF_CODE_ARM_REQUIRED, default=True): cv.boolean,
        vol.Optional(CONF_CODE_FORMAT, default=TemplateCodeFormat.number.name): cv.enum(
            TemplateCodeFormat
        ),
        vol.Optional(CONF_DEVICE_ID): selector.DeviceSelector(),
    }
)

Definition at line 105 of file alarm_control_panel.py.

ALARM_CONTROL_PANEL_SCHEMA

homeassistant.components.template.alarm_control_panel.ALARM_CONTROL_PANEL_SCHEMA

Initial value:

=  vol.Schema(
    {
        vol.Optional(CONF_VALUE_TEMPLATE): cv.template,
        vol.Optional(CONF_DISARM_ACTION): cv.SCRIPT_SCHEMA,
        vol.Optional(CONF_ARM_AWAY_ACTION): cv.SCRIPT_SCHEMA,
        vol.Optional(CONF_ARM_CUSTOM_BYPASS_ACTION): cv.SCRIPT_SCHEMA,
        vol.Optional(CONF_ARM_HOME_ACTION): cv.SCRIPT_SCHEMA,
        vol.Optional(CONF_ARM_NIGHT_ACTION): cv.SCRIPT_SCHEMA,
        vol.Optional(CONF_ARM_VACATION_ACTION): cv.SCRIPT_SCHEMA,
        vol.Optional(CONF_TRIGGER_ACTION): cv.SCRIPT_SCHEMA,
        vol.Optional(CONF_CODE_ARM_REQUIRED, default=True): cv.boolean,
        vol.Optional(CONF_CODE_FORMAT, default=TemplateCodeFormat.number.name): cv.enum(
            TemplateCodeFormat
        ),
        vol.Optional(CONF_NAME): cv.string,
        vol.Optional(CONF_UNIQUE_ID): cv.string,
    }
)

Definition at line 78 of file alarm_control_panel.py.

CONF_ALARM_CONTROL_PANELS

string homeassistant.components.template.alarm_control_panel.CONF_ALARM_CONTROL_PANELS = "panels"

Definition at line 65 of file alarm_control_panel.py.

CONF_ARM_AWAY_ACTION

string homeassistant.components.template.alarm_control_panel.CONF_ARM_AWAY_ACTION = "arm_away"

Definition at line 58 of file alarm_control_panel.py.

CONF_ARM_CUSTOM_BYPASS_ACTION

string homeassistant.components.template.alarm_control_panel.CONF_ARM_CUSTOM_BYPASS_ACTION = "arm_custom_bypass"

Definition at line 59 of file alarm_control_panel.py.

CONF_ARM_HOME_ACTION

string homeassistant.components.template.alarm_control_panel.CONF_ARM_HOME_ACTION = "arm_home"

Definition at line 60 of file alarm_control_panel.py.

CONF_ARM_NIGHT_ACTION

string homeassistant.components.template.alarm_control_panel.CONF_ARM_NIGHT_ACTION = "arm_night"

Definition at line 61 of file alarm_control_panel.py.

CONF_ARM_VACATION_ACTION

string homeassistant.components.template.alarm_control_panel.CONF_ARM_VACATION_ACTION = "arm_vacation"

Definition at line 62 of file alarm_control_panel.py.

CONF_CODE_ARM_REQUIRED

string homeassistant.components.template.alarm_control_panel.CONF_CODE_ARM_REQUIRED = "code_arm_required"

Definition at line 66 of file alarm_control_panel.py.

CONF_CODE_FORMAT

string homeassistant.components.template.alarm_control_panel.CONF_CODE_FORMAT = "code_format"

Definition at line 67 of file alarm_control_panel.py.

CONF_DISARM_ACTION

string homeassistant.components.template.alarm_control_panel.CONF_DISARM_ACTION = "disarm"

Definition at line 63 of file alarm_control_panel.py.

CONF_TRIGGER_ACTION

string homeassistant.components.template.alarm_control_panel.CONF_TRIGGER_ACTION = "trigger"

Definition at line 64 of file alarm_control_panel.py.

PLATFORM_SCHEMA

homeassistant.components.template.alarm_control_panel.PLATFORM_SCHEMA

Initial value:

=  ALARM_CONTROL_PANEL_PLATFORM_SCHEMA.extend(
    {
        vol.Required(CONF_ALARM_CONTROL_PANELS): cv.schema_with_slug_keys(
            ALARM_CONTROL_PANEL_SCHEMA
        ),
    }
)

Definition at line 97 of file alarm_control_panel.py.