Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.ifttt.alarm_control_panel Namespace Reference

Classes

class  IFTTTAlarmPanel
 

Functions

None setup_platform (HomeAssistant hass, ConfigType config, AddEntitiesCallback add_entities, DiscoveryInfoType|None discovery_info=None)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
list ALLOWED_STATES
 
string CONF_CODE_ARM_REQUIRED = "code_arm_required"
 
string CONF_EVENT_AWAY = "event_arm_away"
 
string CONF_EVENT_DISARM = "event_disarm"
 
string CONF_EVENT_HOME = "event_arm_home"
 
string CONF_EVENT_NIGHT = "event_arm_night"
 
string DATA_IFTTT_ALARM = "ifttt_alarm"
 
string DEFAULT_EVENT_AWAY = "alarm_arm_away"
 
string DEFAULT_EVENT_DISARM = "alarm_disarm"
 
string DEFAULT_EVENT_HOME = "alarm_arm_home"
 
string DEFAULT_EVENT_NIGHT = "alarm_arm_night"
 
string DEFAULT_NAME = "Home"
 
 PLATFORM_SCHEMA
 
 PUSH_ALARM_STATE_SERVICE_SCHEMA
 

Detailed Description

Support for alarm control panels that can be controlled through IFTTT.

Function Documentation

◆ setup_platform()

None homeassistant.components.ifttt.alarm_control_panel.setup_platform ( HomeAssistant  hass,
ConfigType  config,
AddEntitiesCallback  add_entities,
DiscoveryInfoType | None   discovery_info = None 
)
Set up a control panel managed through IFTTT.

Definition at line 72 of file alarm_control_panel.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.ifttt.alarm_control_panel._LOGGER = logging.getLogger(__name__)
private

Definition at line 30 of file alarm_control_panel.py.

◆ ALLOWED_STATES

list homeassistant.components.ifttt.alarm_control_panel.ALLOWED_STATES
Initial value:
1 = [
2  AlarmControlPanelState.DISARMED,
3  AlarmControlPanelState.ARMED_NIGHT,
4  AlarmControlPanelState.ARMED_AWAY,
5  AlarmControlPanelState.ARMED_HOME,
6 ]

Definition at line 32 of file alarm_control_panel.py.

◆ CONF_CODE_ARM_REQUIRED

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

Definition at line 52 of file alarm_control_panel.py.

◆ CONF_EVENT_AWAY

string homeassistant.components.ifttt.alarm_control_panel.CONF_EVENT_AWAY = "event_arm_away"

Definition at line 42 of file alarm_control_panel.py.

◆ CONF_EVENT_DISARM

string homeassistant.components.ifttt.alarm_control_panel.CONF_EVENT_DISARM = "event_disarm"

Definition at line 45 of file alarm_control_panel.py.

◆ CONF_EVENT_HOME

string homeassistant.components.ifttt.alarm_control_panel.CONF_EVENT_HOME = "event_arm_home"

Definition at line 43 of file alarm_control_panel.py.

◆ CONF_EVENT_NIGHT

string homeassistant.components.ifttt.alarm_control_panel.CONF_EVENT_NIGHT = "event_arm_night"

Definition at line 44 of file alarm_control_panel.py.

◆ DATA_IFTTT_ALARM

string homeassistant.components.ifttt.alarm_control_panel.DATA_IFTTT_ALARM = "ifttt_alarm"

Definition at line 39 of file alarm_control_panel.py.

◆ DEFAULT_EVENT_AWAY

string homeassistant.components.ifttt.alarm_control_panel.DEFAULT_EVENT_AWAY = "alarm_arm_away"

Definition at line 47 of file alarm_control_panel.py.

◆ DEFAULT_EVENT_DISARM

string homeassistant.components.ifttt.alarm_control_panel.DEFAULT_EVENT_DISARM = "alarm_disarm"

Definition at line 50 of file alarm_control_panel.py.

◆ DEFAULT_EVENT_HOME

string homeassistant.components.ifttt.alarm_control_panel.DEFAULT_EVENT_HOME = "alarm_arm_home"

Definition at line 48 of file alarm_control_panel.py.

◆ DEFAULT_EVENT_NIGHT

string homeassistant.components.ifttt.alarm_control_panel.DEFAULT_EVENT_NIGHT = "alarm_arm_night"

Definition at line 49 of file alarm_control_panel.py.

◆ DEFAULT_NAME

string homeassistant.components.ifttt.alarm_control_panel.DEFAULT_NAME = "Home"

Definition at line 40 of file alarm_control_panel.py.

◆ PLATFORM_SCHEMA

homeassistant.components.ifttt.alarm_control_panel.PLATFORM_SCHEMA
Initial value:
1 = ALARM_CONTROL_PANEL_PLATFORM_SCHEMA.extend(
2  {
3  vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
4  vol.Optional(CONF_CODE): cv.string,
5  vol.Optional(CONF_CODE_ARM_REQUIRED, default=True): cv.boolean,
6  vol.Optional(CONF_EVENT_AWAY, default=DEFAULT_EVENT_AWAY): cv.string,
7  vol.Optional(CONF_EVENT_HOME, default=DEFAULT_EVENT_HOME): cv.string,
8  vol.Optional(CONF_EVENT_NIGHT, default=DEFAULT_EVENT_NIGHT): cv.string,
9  vol.Optional(CONF_EVENT_DISARM, default=DEFAULT_EVENT_DISARM): cv.string,
10  vol.Optional(CONF_OPTIMISTIC, default=False): cv.boolean,
11  }
12 )

Definition at line 54 of file alarm_control_panel.py.

◆ PUSH_ALARM_STATE_SERVICE_SCHEMA

homeassistant.components.ifttt.alarm_control_panel.PUSH_ALARM_STATE_SERVICE_SCHEMA
Initial value:
1 = vol.Schema(
2  {vol.Required(ATTR_ENTITY_ID): cv.entity_ids, vol.Required(ATTR_STATE): cv.string}
3 )

Definition at line 67 of file alarm_control_panel.py.