homeassistant.components.manual.alarm_control_panel Namespace Reference

Classes
class	ManualAlarm

Functions
vol.Schema	_state_schema (str state)
dict[str, Any]	_state_validator (dict[AlarmControlPanelState|str, Any] config)
None	async_setup_platform (HomeAssistant hass, ConfigType config, AddEntitiesCallback async_add_entities, DiscoveryInfoType|None discovery_info=None)

Variables
string	ATTR_NEXT_STATE = "next_state"
string	ATTR_PREVIOUS_STATE = "previous_state"
string	CONF_ALARM_ARMED_AWAY = "armed_away"
string	CONF_ALARM_ARMED_CUSTOM_BYPASS = "armed_custom_bypass"
string	CONF_ALARM_ARMED_HOME = "armed_home"
string	CONF_ALARM_ARMED_NIGHT = "armed_night"
string	CONF_ALARM_ARMED_VACATION = "armed_vacation"
string	CONF_ALARM_ARMING = "arming"
string	CONF_ALARM_DISARMED = "disarmed"
string	CONF_ALARM_PENDING = "pending"
string	CONF_ALARM_TRIGGERED = "triggered"
string	CONF_ARMING_STATES = "arming_states"
string	CONF_CODE_ARM_REQUIRED = "code_arm_required"
string	CONF_CODE_TEMPLATE = "code_template"
string	DEFAULT_ALARM_NAME = "HA Alarm"
	DEFAULT_ARMING_TIME = datetime.timedelta(seconds=60)
	DEFAULT_DELAY_TIME = datetime.timedelta(seconds=60)
bool	DEFAULT_DISARM_AFTER_TRIGGER = False
	DEFAULT_TRIGGER_TIME = datetime.timedelta(seconds=120)
string	DOMAIN = "manual"
	PLATFORM_SCHEMA
dictionary	SUPPORTED_ARMING_STATE_TO_FEATURE
list	SUPPORTED_ARMING_STATES
list	SUPPORTED_PRETRIGGER_STATES
list	SUPPORTED_STATES

Detailed Description

Support for manual alarms.

Function Documentation

_state_schema()

vol.Schema homeassistant.components.manual.alarm_control_panel._state_schema ( str  state )

private

Validate the state.

Definition at line 113 of file alarm_control_panel.py.

_state_validator()

dict[str, Any] homeassistant.components.manual.alarm_control_panel._state_validator ( dict[AlarmControlPanelState | str, Any]  config )

private

Validate the state.

Definition at line 94 of file alarm_control_panel.py.

async_setup_platform()

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

Set up the manual alarm platform.

Definition at line 182 of file alarm_control_panel.py.

Variable Documentation

ATTR_NEXT_STATE

string homeassistant.components.manual.alarm_control_panel.ATTR_NEXT_STATE = "next_state"

Definition at line 91 of file alarm_control_panel.py.

ATTR_PREVIOUS_STATE

string homeassistant.components.manual.alarm_control_panel.ATTR_PREVIOUS_STATE = "previous_state"

Definition at line 90 of file alarm_control_panel.py.

CONF_ALARM_ARMED_AWAY

string homeassistant.components.manual.alarm_control_panel.CONF_ALARM_ARMED_AWAY = "armed_away"

Definition at line 42 of file alarm_control_panel.py.

CONF_ALARM_ARMED_CUSTOM_BYPASS

string homeassistant.components.manual.alarm_control_panel.CONF_ALARM_ARMED_CUSTOM_BYPASS = "armed_custom_bypass"

Definition at line 43 of file alarm_control_panel.py.

CONF_ALARM_ARMED_HOME

string homeassistant.components.manual.alarm_control_panel.CONF_ALARM_ARMED_HOME = "armed_home"

Definition at line 44 of file alarm_control_panel.py.

CONF_ALARM_ARMED_NIGHT

string homeassistant.components.manual.alarm_control_panel.CONF_ALARM_ARMED_NIGHT = "armed_night"

Definition at line 45 of file alarm_control_panel.py.

CONF_ALARM_ARMED_VACATION

string homeassistant.components.manual.alarm_control_panel.CONF_ALARM_ARMED_VACATION = "armed_vacation"

Definition at line 46 of file alarm_control_panel.py.

CONF_ALARM_ARMING

string homeassistant.components.manual.alarm_control_panel.CONF_ALARM_ARMING = "arming"

Definition at line 47 of file alarm_control_panel.py.

CONF_ALARM_DISARMED

string homeassistant.components.manual.alarm_control_panel.CONF_ALARM_DISARMED = "disarmed"

Definition at line 48 of file alarm_control_panel.py.

CONF_ALARM_PENDING

string homeassistant.components.manual.alarm_control_panel.CONF_ALARM_PENDING = "pending"

Definition at line 49 of file alarm_control_panel.py.

CONF_ALARM_TRIGGERED

string homeassistant.components.manual.alarm_control_panel.CONF_ALARM_TRIGGERED = "triggered"

Definition at line 50 of file alarm_control_panel.py.

CONF_ARMING_STATES

string homeassistant.components.manual.alarm_control_panel.CONF_ARMING_STATES = "arming_states"

Definition at line 38 of file alarm_control_panel.py.

CONF_CODE_ARM_REQUIRED

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

Definition at line 40 of file alarm_control_panel.py.

CONF_CODE_TEMPLATE

string homeassistant.components.manual.alarm_control_panel.CONF_CODE_TEMPLATE = "code_template"

Definition at line 39 of file alarm_control_panel.py.

DEFAULT_ALARM_NAME

string homeassistant.components.manual.alarm_control_panel.DEFAULT_ALARM_NAME = "HA Alarm"

Definition at line 52 of file alarm_control_panel.py.

DEFAULT_ARMING_TIME

homeassistant.components.manual.alarm_control_panel.DEFAULT_ARMING_TIME = datetime.timedelta(seconds=60)

Definition at line 54 of file alarm_control_panel.py.

DEFAULT_DELAY_TIME

homeassistant.components.manual.alarm_control_panel.DEFAULT_DELAY_TIME = datetime.timedelta(seconds=60)

Definition at line 53 of file alarm_control_panel.py.

DEFAULT_DISARM_AFTER_TRIGGER

bool homeassistant.components.manual.alarm_control_panel.DEFAULT_DISARM_AFTER_TRIGGER = False

Definition at line 56 of file alarm_control_panel.py.

DEFAULT_TRIGGER_TIME

homeassistant.components.manual.alarm_control_panel.DEFAULT_TRIGGER_TIME = datetime.timedelta(seconds=120)

Definition at line 55 of file alarm_control_panel.py.

DOMAIN

string homeassistant.components.manual.alarm_control_panel.DOMAIN = "manual"

Definition at line 36 of file alarm_control_panel.py.

PLATFORM_SCHEMA

homeassistant.components.manual.alarm_control_panel.PLATFORM_SCHEMA

Definition at line 130 of file alarm_control_panel.py.

SUPPORTED_ARMING_STATE_TO_FEATURE

dictionary homeassistant.components.manual.alarm_control_panel.SUPPORTED_ARMING_STATE_TO_FEATURE

Initial value:

=  {
    AlarmControlPanelState.ARMED_AWAY: AlarmControlPanelEntityFeature.ARM_AWAY,
    AlarmControlPanelState.ARMED_HOME: AlarmControlPanelEntityFeature.ARM_HOME,
    AlarmControlPanelState.ARMED_NIGHT: AlarmControlPanelEntityFeature.ARM_NIGHT,
    AlarmControlPanelState.ARMED_VACATION: AlarmControlPanelEntityFeature.ARM_VACATION,
    AlarmControlPanelState.ARMED_CUSTOM_BYPASS: AlarmControlPanelEntityFeature.ARM_CUSTOM_BYPASS,
}

Definition at line 82 of file alarm_control_panel.py.

SUPPORTED_ARMING_STATES

list homeassistant.components.manual.alarm_control_panel.SUPPORTED_ARMING_STATES

Initial value:

=  [
    state
    for state in SUPPORTED_STATES
    if state
    not in (
        AlarmControlPanelState.DISARMED,
        AlarmControlPanelState.TRIGGERED,
    )
]

Definition at line 72 of file alarm_control_panel.py.

SUPPORTED_PRETRIGGER_STATES

list homeassistant.components.manual.alarm_control_panel.SUPPORTED_PRETRIGGER_STATES

Initial value:

=  [
    state for state in SUPPORTED_STATES if state != AlarmControlPanelState.TRIGGERED
]

Definition at line 68 of file alarm_control_panel.py.

SUPPORTED_STATES

list homeassistant.components.manual.alarm_control_panel.SUPPORTED_STATES

Initial value:

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

Definition at line 58 of file alarm_control_panel.py.