homeassistant.components.mqtt.alarm_control_panel Namespace Reference

Classes
class	MqttAlarm

Functions
None	async_setup_entry (HomeAssistant hass, ConfigEntry config_entry, AddEntitiesCallback async_add_entities)

Variables
	_LOGGER = logging.getLogger(__name__)
dictionary	_SUPPORTED_FEATURES
string	CONF_CODE_ARM_REQUIRED = "code_arm_required"
string	CONF_CODE_DISARM_REQUIRED = "code_disarm_required"
string	CONF_CODE_TRIGGER_REQUIRED = "code_trigger_required"
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	CONF_PAYLOAD_TRIGGER = "payload_trigger"
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"
string	DEFAULT_COMMAND_TEMPLATE = "{{action}}"
string	DEFAULT_DISARM = "DISARM"
string	DEFAULT_NAME = "MQTT Alarm"
string	DEFAULT_TRIGGER = "TRIGGER"
	DISCOVERY_SCHEMA = PLATFORM_SCHEMA_MODERN.extend({}, extra=vol.REMOVE_EXTRA)
	MQTT_ALARM_ATTRIBUTES_BLOCKED
int	PARALLEL_UPDATES = 0
	PLATFORM_SCHEMA_MODERN
string	REMOTE_CODE = "REMOTE_CODE"
string	REMOTE_CODE_TEXT = "REMOTE_CODE_TEXT"

Detailed Description

Control a MQTT alarm.

Function Documentation

async_setup_entry()

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

Set up MQTT alarm control panel through YAML and through MQTT discovery.

Definition at line 115 of file alarm_control_panel.py.

Variable Documentation

_LOGGER

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

private

Definition at line 36 of file alarm_control_panel.py.

_SUPPORTED_FEATURES

dictionary homeassistant.components.mqtt.alarm_control_panel._SUPPORTED_FEATURES

private

Initial value:

=  {
    "arm_home": AlarmControlPanelEntityFeature.ARM_HOME,
    "arm_away": AlarmControlPanelEntityFeature.ARM_AWAY,
    "arm_night": AlarmControlPanelEntityFeature.ARM_NIGHT,
    "arm_vacation": AlarmControlPanelEntityFeature.ARM_VACATION,
    "arm_custom_bypass": AlarmControlPanelEntityFeature.ARM_CUSTOM_BYPASS,
    "trigger": AlarmControlPanelEntityFeature.TRIGGER,
}

Definition at line 40 of file alarm_control_panel.py.

CONF_CODE_ARM_REQUIRED

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

Definition at line 49 of file alarm_control_panel.py.

CONF_CODE_DISARM_REQUIRED

string homeassistant.components.mqtt.alarm_control_panel.CONF_CODE_DISARM_REQUIRED = "code_disarm_required"

Definition at line 50 of file alarm_control_panel.py.

CONF_CODE_TRIGGER_REQUIRED

string homeassistant.components.mqtt.alarm_control_panel.CONF_CODE_TRIGGER_REQUIRED = "code_trigger_required"

Definition at line 51 of file alarm_control_panel.py.

CONF_PAYLOAD_ARM_AWAY

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

Definition at line 54 of file alarm_control_panel.py.

CONF_PAYLOAD_ARM_CUSTOM_BYPASS

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

Definition at line 57 of file alarm_control_panel.py.

CONF_PAYLOAD_ARM_HOME

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

Definition at line 53 of file alarm_control_panel.py.

CONF_PAYLOAD_ARM_NIGHT

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

Definition at line 55 of file alarm_control_panel.py.

CONF_PAYLOAD_ARM_VACATION

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

Definition at line 56 of file alarm_control_panel.py.

CONF_PAYLOAD_DISARM

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

Definition at line 52 of file alarm_control_panel.py.

CONF_PAYLOAD_TRIGGER

string homeassistant.components.mqtt.alarm_control_panel.CONF_PAYLOAD_TRIGGER = "payload_trigger"

Definition at line 58 of file alarm_control_panel.py.

DEFAULT_ARM_AWAY

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

Definition at line 71 of file alarm_control_panel.py.

DEFAULT_ARM_CUSTOM_BYPASS

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

Definition at line 73 of file alarm_control_panel.py.

DEFAULT_ARM_HOME

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

Definition at line 72 of file alarm_control_panel.py.

DEFAULT_ARM_NIGHT

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

Definition at line 69 of file alarm_control_panel.py.

DEFAULT_ARM_VACATION

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

Definition at line 70 of file alarm_control_panel.py.

DEFAULT_COMMAND_TEMPLATE

string homeassistant.components.mqtt.alarm_control_panel.DEFAULT_COMMAND_TEMPLATE = "{{action}}"

Definition at line 68 of file alarm_control_panel.py.

DEFAULT_DISARM

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

Definition at line 74 of file alarm_control_panel.py.

DEFAULT_NAME

string homeassistant.components.mqtt.alarm_control_panel.DEFAULT_NAME = "MQTT Alarm"

Definition at line 76 of file alarm_control_panel.py.

DEFAULT_TRIGGER

string homeassistant.components.mqtt.alarm_control_panel.DEFAULT_TRIGGER = "TRIGGER"

Definition at line 75 of file alarm_control_panel.py.

DISCOVERY_SCHEMA

homeassistant.components.mqtt.alarm_control_panel.DISCOVERY_SCHEMA = PLATFORM_SCHEMA_MODERN.extend({}, extra=vol.REMOVE_EXTRA)

Definition at line 112 of file alarm_control_panel.py.

MQTT_ALARM_ATTRIBUTES_BLOCKED

homeassistant.components.mqtt.alarm_control_panel.MQTT_ALARM_ATTRIBUTES_BLOCKED

Initial value:

=  frozenset(
    {
        alarm.ATTR_CHANGED_BY,
        alarm.ATTR_CODE_ARM_REQUIRED,
        alarm.ATTR_CODE_FORMAT,
    }
)

Definition at line 60 of file alarm_control_panel.py.

PARALLEL_UPDATES

int homeassistant.components.mqtt.alarm_control_panel.PARALLEL_UPDATES = 0

Definition at line 38 of file alarm_control_panel.py.

PLATFORM_SCHEMA_MODERN

homeassistant.components.mqtt.alarm_control_panel.PLATFORM_SCHEMA_MODERN

Initial value:

=  MQTT_BASE_SCHEMA.extend(
    {
        vol.Optional(CONF_SUPPORTED_FEATURES, default=list(_SUPPORTED_FEATURES)): [
            vol.In(_SUPPORTED_FEATURES)
        ],
        vol.Optional(CONF_CODE): cv.string,
        vol.Optional(CONF_CODE_ARM_REQUIRED, default=True): cv.boolean,
        vol.Optional(CONF_CODE_DISARM_REQUIRED, default=True): cv.boolean,
        vol.Optional(CONF_CODE_TRIGGER_REQUIRED, default=True): cv.boolean,
        vol.Optional(
            CONF_COMMAND_TEMPLATE, default=DEFAULT_COMMAND_TEMPLATE
        ): cv.template,
        vol.Required(CONF_COMMAND_TOPIC): valid_publish_topic,
        vol.Optional(CONF_NAME): vol.Any(cv.string, None),
        vol.Optional(CONF_PAYLOAD_ARM_AWAY, default=DEFAULT_ARM_AWAY): cv.string,
        vol.Optional(CONF_PAYLOAD_ARM_HOME, default=DEFAULT_ARM_HOME): cv.string,
        vol.Optional(CONF_PAYLOAD_ARM_NIGHT, default=DEFAULT_ARM_NIGHT): cv.string,
        vol.Optional(
            CONF_PAYLOAD_ARM_VACATION, default=DEFAULT_ARM_VACATION
        ): cv.string,
        vol.Optional(
            CONF_PAYLOAD_ARM_CUSTOM_BYPASS, default=DEFAULT_ARM_CUSTOM_BYPASS
        ): cv.string,
        vol.Optional(CONF_PAYLOAD_DISARM, default=DEFAULT_DISARM): cv.string,
        vol.Optional(CONF_PAYLOAD_TRIGGER, default=DEFAULT_TRIGGER): cv.string,
        vol.Optional(CONF_RETAIN, default=DEFAULT_RETAIN): cv.boolean,
        vol.Required(CONF_STATE_TOPIC): valid_subscribe_topic,
        vol.Optional(CONF_VALUE_TEMPLATE): cv.template,
    }
).extend(MQTT_ENTITY_COMMON_SCHEMA.schema)

Definition at line 81 of file alarm_control_panel.py.

REMOTE_CODE

string homeassistant.components.mqtt.alarm_control_panel.REMOTE_CODE = "REMOTE_CODE"

Definition at line 78 of file alarm_control_panel.py.

REMOTE_CODE_TEXT

string homeassistant.components.mqtt.alarm_control_panel.REMOTE_CODE_TEXT = "REMOTE_CODE_TEXT"

Definition at line 79 of file alarm_control_panel.py.