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

Classes

class  SimpliSafeAlarm
 

Functions

None async_setup_entry (HomeAssistant hass, ConfigEntry entry, AddEntitiesCallback async_add_entities)
 

Variables

string ATTR_BATTERY_BACKUP_POWER_LEVEL = "battery_backup_power_level"
 
string ATTR_GSM_STRENGTH = "gsm_strength"
 
string ATTR_PIN_NAME = "pin_name"
 
string ATTR_RF_JAMMING = "rf_jamming"
 
string ATTR_WALL_POWER_LEVEL = "wall_power_level"
 
string ATTR_WIFI_STRENGTH = "wifi_strength"
 
dictionary STATE_MAP_FROM_REST_API
 
dictionary STATE_MAP_FROM_WEBSOCKET_EVENT
 
tuple WEBSOCKET_EVENTS_TO_LISTEN_FOR
 

Detailed Description

Support for SimpliSafe alarm control panels.

Function Documentation

◆ async_setup_entry()

None homeassistant.components.simplisafe.alarm_control_panel.async_setup_entry ( HomeAssistant  hass,
ConfigEntry  entry,
AddEntitiesCallback   async_add_entities 
)
Set up a SimpliSafe alarm control panel based on a config entry.

Definition at line 105 of file alarm_control_panel.py.

Variable Documentation

◆ ATTR_BATTERY_BACKUP_POWER_LEVEL

string homeassistant.components.simplisafe.alarm_control_panel.ATTR_BATTERY_BACKUP_POWER_LEVEL = "battery_backup_power_level"

Definition at line 53 of file alarm_control_panel.py.

◆ ATTR_GSM_STRENGTH

string homeassistant.components.simplisafe.alarm_control_panel.ATTR_GSM_STRENGTH = "gsm_strength"

Definition at line 54 of file alarm_control_panel.py.

◆ ATTR_PIN_NAME

string homeassistant.components.simplisafe.alarm_control_panel.ATTR_PIN_NAME = "pin_name"

Definition at line 55 of file alarm_control_panel.py.

◆ ATTR_RF_JAMMING

string homeassistant.components.simplisafe.alarm_control_panel.ATTR_RF_JAMMING = "rf_jamming"

Definition at line 56 of file alarm_control_panel.py.

◆ ATTR_WALL_POWER_LEVEL

string homeassistant.components.simplisafe.alarm_control_panel.ATTR_WALL_POWER_LEVEL = "wall_power_level"

Definition at line 57 of file alarm_control_panel.py.

◆ ATTR_WIFI_STRENGTH

string homeassistant.components.simplisafe.alarm_control_panel.ATTR_WIFI_STRENGTH = "wifi_strength"

Definition at line 58 of file alarm_control_panel.py.

◆ STATE_MAP_FROM_REST_API

dictionary homeassistant.components.simplisafe.alarm_control_panel.STATE_MAP_FROM_REST_API
Initial value:
1 = {
2  SystemStates.ALARM: AlarmControlPanelState.TRIGGERED,
3  SystemStates.ALARM_COUNT: AlarmControlPanelState.PENDING,
4  SystemStates.AWAY: AlarmControlPanelState.ARMED_AWAY,
5  SystemStates.AWAY_COUNT: AlarmControlPanelState.ARMING,
6  SystemStates.ENTRY_DELAY: AlarmControlPanelState.PENDING,
7  SystemStates.EXIT_DELAY: AlarmControlPanelState.ARMING,
8  SystemStates.HOME: AlarmControlPanelState.ARMED_HOME,
9  SystemStates.HOME_COUNT: AlarmControlPanelState.ARMING,
10  SystemStates.OFF: AlarmControlPanelState.DISARMED,
11  SystemStates.TEST: AlarmControlPanelState.DISARMED,
12 }

Definition at line 60 of file alarm_control_panel.py.

◆ STATE_MAP_FROM_WEBSOCKET_EVENT

dictionary homeassistant.components.simplisafe.alarm_control_panel.STATE_MAP_FROM_WEBSOCKET_EVENT
Initial value:
1 = {
2  EVENT_ALARM_CANCELED: AlarmControlPanelState.DISARMED,
3  EVENT_ALARM_TRIGGERED: AlarmControlPanelState.TRIGGERED,
4  EVENT_ARMED_AWAY: AlarmControlPanelState.ARMED_AWAY,
5  EVENT_ARMED_AWAY_BY_KEYPAD: AlarmControlPanelState.ARMED_AWAY,
6  EVENT_ARMED_AWAY_BY_REMOTE: AlarmControlPanelState.ARMED_AWAY,
7  EVENT_ARMED_HOME: AlarmControlPanelState.ARMED_HOME,
8  EVENT_AWAY_EXIT_DELAY_BY_KEYPAD: AlarmControlPanelState.ARMING,
9  EVENT_AWAY_EXIT_DELAY_BY_REMOTE: AlarmControlPanelState.ARMING,
10  EVENT_DISARMED_BY_KEYPAD: AlarmControlPanelState.DISARMED,
11  EVENT_DISARMED_BY_REMOTE: AlarmControlPanelState.DISARMED,
12  EVENT_ENTRY_DELAY: AlarmControlPanelState.PENDING,
13  EVENT_HOME_EXIT_DELAY: AlarmControlPanelState.ARMING,
14  EVENT_SECRET_ALERT_TRIGGERED: AlarmControlPanelState.TRIGGERED,
15  EVENT_USER_INITIATED_TEST: AlarmControlPanelState.DISARMED,
16 }

Definition at line 73 of file alarm_control_panel.py.

◆ WEBSOCKET_EVENTS_TO_LISTEN_FOR

tuple homeassistant.components.simplisafe.alarm_control_panel.WEBSOCKET_EVENTS_TO_LISTEN_FOR
Initial value:
1 = (
2  EVENT_ALARM_CANCELED,
3  EVENT_ALARM_TRIGGERED,
4  EVENT_ARMED_AWAY,
5  EVENT_ARMED_AWAY_BY_KEYPAD,
6  EVENT_ARMED_AWAY_BY_REMOTE,
7  EVENT_ARMED_HOME,
8  EVENT_AWAY_EXIT_DELAY_BY_KEYPAD,
9  EVENT_AWAY_EXIT_DELAY_BY_REMOTE,
10  EVENT_DISARMED_BY_KEYPAD,
11  EVENT_DISARMED_BY_REMOTE,
12  EVENT_HOME_EXIT_DELAY,
13 )

Definition at line 90 of file alarm_control_panel.py.