homeassistant.components.manual_mqtt.alarm_control_panel Namespace Reference

Classes
class	ManualMQTTAlarm

Functions
def	_state_schema (state)
def	_state_validator (config)
None	async_setup_platform (HomeAssistant hass, ConfigType config, AddEntitiesCallback add_entities, DiscoveryInfoType|None discovery_info=None)

Variables
	_LOGGER = logging.getLogger(__name__)
string	ATTR_POST_PENDING_STATE = "post_pending_state"
string	ATTR_PRE_PENDING_STATE = "pre_pending_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_DISARMED = "disarmed"
string	CONF_ALARM_PENDING = "pending"
string	CONF_ALARM_TRIGGERED = "triggered"
string	CONF_CODE_ARM_REQUIRED = "code_arm_required"
string	CONF_CODE_TEMPLATE = "code_template"
string	CONF_PAYLOAD_ARM_AWAY = "payload_arm_away"
string	CONF_PAYLOAD_ARM_CUSTOM_BYPASS = "payload_arm_custom_bypass"
string	CONF_PAYLOAD_ARM_HOME = "payload_arm_home"
string	CONF_PAYLOAD_ARM_NIGHT = "payload_arm_night"
string	CONF_PAYLOAD_ARM_VACATION = "payload_arm_vacation"
string	CONF_PAYLOAD_DISARM = "payload_disarm"
string	DEFAULT_ALARM_NAME = "HA Alarm"
string	DEFAULT_ARM_AWAY = "ARM_AWAY"
string	DEFAULT_ARM_CUSTOM_BYPASS = "ARM_CUSTOM_BYPASS"
string	DEFAULT_ARM_HOME = "ARM_HOME"
string	DEFAULT_ARM_NIGHT = "ARM_NIGHT"
string	DEFAULT_ARM_VACATION = "ARM_VACATION"
	DEFAULT_DELAY_TIME = datetime.timedelta(seconds=0)
string	DEFAULT_DISARM = "DISARM"
bool	DEFAULT_DISARM_AFTER_TRIGGER = False
	DEFAULT_PENDING_TIME = datetime.timedelta(seconds=60)
	DEFAULT_TRIGGER_TIME = datetime.timedelta(seconds=120)
	PLATFORM_SCHEMA
list	SUPPORTED_PENDING_STATES
list	SUPPORTED_PRETRIGGER_STATES
list	SUPPORTED_STATES

Detailed Description

Support for manual alarms controllable via MQTT.

Function Documentation

_state_schema()

def homeassistant.components.manual_mqtt.alarm_control_panel._state_schema (   state )

private

Validate the state.

Definition at line 111 of file alarm_control_panel.py.

_state_validator()

def homeassistant.components.manual_mqtt.alarm_control_panel._state_validator (   config )

private

Validate the state.

Definition at line 93 of file alarm_control_panel.py.

async_setup_platform()

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

Set up the manual MQTT alarm platform.

Definition at line 195 of file alarm_control_panel.py.

Variable Documentation

_LOGGER

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

private

Definition at line 38 of file alarm_control_panel.py.

ATTR_POST_PENDING_STATE

string homeassistant.components.manual_mqtt.alarm_control_panel.ATTR_POST_PENDING_STATE = "post_pending_state"

Definition at line 90 of file alarm_control_panel.py.

ATTR_PRE_PENDING_STATE

string homeassistant.components.manual_mqtt.alarm_control_panel.ATTR_PRE_PENDING_STATE = "pre_pending_state"

Definition at line 89 of file alarm_control_panel.py.

CONF_ALARM_ARMED_AWAY

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

Definition at line 50 of file alarm_control_panel.py.

CONF_ALARM_ARMED_CUSTOM_BYPASS

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

Definition at line 51 of file alarm_control_panel.py.

CONF_ALARM_ARMED_HOME

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

Definition at line 52 of file alarm_control_panel.py.

CONF_ALARM_ARMED_NIGHT

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

Definition at line 53 of file alarm_control_panel.py.

CONF_ALARM_ARMED_VACATION

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

Definition at line 54 of file alarm_control_panel.py.

CONF_ALARM_DISARMED

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

Definition at line 55 of file alarm_control_panel.py.

CONF_ALARM_PENDING

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

Definition at line 56 of file alarm_control_panel.py.

CONF_ALARM_TRIGGERED

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

Definition at line 57 of file alarm_control_panel.py.

CONF_CODE_ARM_REQUIRED

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

Definition at line 41 of file alarm_control_panel.py.

CONF_CODE_TEMPLATE

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

Definition at line 40 of file alarm_control_panel.py.

CONF_PAYLOAD_ARM_AWAY

string homeassistant.components.manual_mqtt.alarm_control_panel.CONF_PAYLOAD_ARM_AWAY = "payload_arm_away"

Definition at line 45 of file alarm_control_panel.py.

CONF_PAYLOAD_ARM_CUSTOM_BYPASS

string homeassistant.components.manual_mqtt.alarm_control_panel.CONF_PAYLOAD_ARM_CUSTOM_BYPASS = "payload_arm_custom_bypass"

Definition at line 48 of file alarm_control_panel.py.

CONF_PAYLOAD_ARM_HOME

string homeassistant.components.manual_mqtt.alarm_control_panel.CONF_PAYLOAD_ARM_HOME = "payload_arm_home"

Definition at line 44 of file alarm_control_panel.py.

CONF_PAYLOAD_ARM_NIGHT

string homeassistant.components.manual_mqtt.alarm_control_panel.CONF_PAYLOAD_ARM_NIGHT = "payload_arm_night"

Definition at line 46 of file alarm_control_panel.py.

CONF_PAYLOAD_ARM_VACATION

string homeassistant.components.manual_mqtt.alarm_control_panel.CONF_PAYLOAD_ARM_VACATION = "payload_arm_vacation"

Definition at line 47 of file alarm_control_panel.py.

CONF_PAYLOAD_DISARM

string homeassistant.components.manual_mqtt.alarm_control_panel.CONF_PAYLOAD_DISARM = "payload_disarm"

Definition at line 43 of file alarm_control_panel.py.

DEFAULT_ALARM_NAME

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

Definition at line 59 of file alarm_control_panel.py.

DEFAULT_ARM_AWAY

string homeassistant.components.manual_mqtt.alarm_control_panel.DEFAULT_ARM_AWAY = "ARM_AWAY"

Definition at line 64 of file alarm_control_panel.py.

DEFAULT_ARM_CUSTOM_BYPASS

string homeassistant.components.manual_mqtt.alarm_control_panel.DEFAULT_ARM_CUSTOM_BYPASS = "ARM_CUSTOM_BYPASS"

Definition at line 68 of file alarm_control_panel.py.

DEFAULT_ARM_HOME

string homeassistant.components.manual_mqtt.alarm_control_panel.DEFAULT_ARM_HOME = "ARM_HOME"

Definition at line 65 of file alarm_control_panel.py.

DEFAULT_ARM_NIGHT

string homeassistant.components.manual_mqtt.alarm_control_panel.DEFAULT_ARM_NIGHT = "ARM_NIGHT"

Definition at line 66 of file alarm_control_panel.py.

DEFAULT_ARM_VACATION

string homeassistant.components.manual_mqtt.alarm_control_panel.DEFAULT_ARM_VACATION = "ARM_VACATION"

Definition at line 67 of file alarm_control_panel.py.

DEFAULT_DELAY_TIME

homeassistant.components.manual_mqtt.alarm_control_panel.DEFAULT_DELAY_TIME = datetime.timedelta(seconds=0)

Definition at line 60 of file alarm_control_panel.py.

DEFAULT_DISARM

string homeassistant.components.manual_mqtt.alarm_control_panel.DEFAULT_DISARM = "DISARM"

Definition at line 69 of file alarm_control_panel.py.

DEFAULT_DISARM_AFTER_TRIGGER

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

Definition at line 63 of file alarm_control_panel.py.

DEFAULT_PENDING_TIME

homeassistant.components.manual_mqtt.alarm_control_panel.DEFAULT_PENDING_TIME = datetime.timedelta(seconds=60)

Definition at line 61 of file alarm_control_panel.py.

DEFAULT_TRIGGER_TIME

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

Definition at line 62 of file alarm_control_panel.py.

PLATFORM_SCHEMA

homeassistant.components.manual_mqtt.alarm_control_panel.PLATFORM_SCHEMA

Definition at line 128 of file alarm_control_panel.py.

SUPPORTED_PENDING_STATES

list homeassistant.components.manual_mqtt.alarm_control_panel.SUPPORTED_PENDING_STATES

Initial value:

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

Definition at line 85 of file alarm_control_panel.py.

SUPPORTED_PRETRIGGER_STATES

list homeassistant.components.manual_mqtt.alarm_control_panel.SUPPORTED_PRETRIGGER_STATES

Initial value:

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

Definition at line 81 of file alarm_control_panel.py.

SUPPORTED_STATES

list homeassistant.components.manual_mqtt.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 71 of file alarm_control_panel.py.