Namespaces
	alarm_control_panel

	binary_sensor

	button

	config_flow

	const

	diagnostics

	entity

	lock

	sensor

	typing

Classes
class	SimpliSafe

Functions
SystemType	_async_get_system_for_service_call (HomeAssistant hass, ServiceCall call)

None	_async_register_base_station (HomeAssistant hass, ConfigEntry entry, SystemType system)

None	_async_standardize_config_entry (HomeAssistant hass, ConfigEntry entry)

bool	async_setup_entry (HomeAssistant hass, ConfigEntry entry)

bool	async_unload_entry (HomeAssistant hass, ConfigEntry entry)

Variables
string	ATTR_CATEGORY = "category"

string	ATTR_LAST_EVENT_CHANGED_BY = "last_event_changed_by"

string	ATTR_LAST_EVENT_SENSOR_SERIAL = "last_event_sensor_serial"

string	ATTR_LAST_EVENT_TYPE = "last_event_type"

string	ATTR_MESSAGE = "message"

string	ATTR_PIN_LABEL = "label"

string	ATTR_PIN_LABEL_OR_VALUE = "label_or_pin"

string	ATTR_PIN_VALUE = "pin"

string	ATTR_TIMESTAMP = "timestamp"

	DEFAULT_SCAN_INTERVAL = timedelta(seconds=30)

int	DEFAULT_SOCKET_MIN_RETRY = 15

string	EVENT_SIMPLISAFE_EVENT = "SIMPLISAFE_EVENT"

string	EVENT_SIMPLISAFE_NOTIFICATION = "SIMPLISAFE_NOTIFICATION"

list	PLATFORMS

string	SERVICE_NAME_REMOVE_PIN = "remove_pin"

string	SERVICE_NAME_SET_PIN = "set_pin"

string	SERVICE_NAME_SET_SYSTEM_PROPERTIES = "set_system_properties"

	SERVICE_REMOVE_PIN_SCHEMA

	SERVICE_SET_PIN_SCHEMA

	SERVICE_SET_SYSTEM_PROPERTIES_SCHEMA

tuple	SERVICES

dictionary	VOLUME_MAP

list	WEBSOCKET_EVENTS_TO_FIRE_HASS_EVENT

Detailed Description

Support for SimpliSafe alarm systems.

Function Documentation

◆ _async_get_system_for_service_call()

SystemType homeassistant.components.simplisafe._async_get_system_for_service_call	(	HomeAssistant	hass,
		ServiceCall	call
	)

private

Get the SimpliSafe system related to a service call (by device ID).

Definition at line 198 of file __init__.py.

◆ _async_register_base_station()

None homeassistant.components.simplisafe._async_register_base_station	(	HomeAssistant	hass,
		ConfigEntry	entry,
		SystemType	system
	)

private

Register a new bridge.

Definition at line 235 of file __init__.py.

◆ _async_standardize_config_entry()

None homeassistant.components.simplisafe._async_standardize_config_entry	(	HomeAssistant	hass,
		ConfigEntry	entry
	)

private

Bring a config entry up to current standards.

Definition at line 265 of file __init__.py.

◆ async_setup_entry()

bool homeassistant.components.simplisafe.async_setup_entry	(	HomeAssistant	hass,
		ConfigEntry	entry
	)

Set up SimpliSafe as config entry.

Definition at line 289 of file __init__.py.

◆ async_unload_entry()

bool homeassistant.components.simplisafe.async_unload_entry	(	HomeAssistant	hass,
		ConfigEntry	entry
	)

Unload a SimpliSafe config entry.

Definition at line 399 of file __init__.py.

Variable Documentation

◆ ATTR_CATEGORY

string homeassistant.components.simplisafe.ATTR_CATEGORY = "category"

Definition at line 91 of file __init__.py.

◆ ATTR_LAST_EVENT_CHANGED_BY

string homeassistant.components.simplisafe.ATTR_LAST_EVENT_CHANGED_BY = "last_event_changed_by"

Definition at line 92 of file __init__.py.

◆ ATTR_LAST_EVENT_SENSOR_SERIAL

string homeassistant.components.simplisafe.ATTR_LAST_EVENT_SENSOR_SERIAL = "last_event_sensor_serial"

Definition at line 93 of file __init__.py.

◆ ATTR_LAST_EVENT_TYPE

string homeassistant.components.simplisafe.ATTR_LAST_EVENT_TYPE = "last_event_type"

Definition at line 94 of file __init__.py.

◆ ATTR_MESSAGE

string homeassistant.components.simplisafe.ATTR_MESSAGE = "message"

Definition at line 96 of file __init__.py.

◆ ATTR_PIN_LABEL

string homeassistant.components.simplisafe.ATTR_PIN_LABEL = "label"

Definition at line 97 of file __init__.py.

◆ ATTR_PIN_LABEL_OR_VALUE

string homeassistant.components.simplisafe.ATTR_PIN_LABEL_OR_VALUE = "label_or_pin"

Definition at line 98 of file __init__.py.

◆ ATTR_PIN_VALUE

string homeassistant.components.simplisafe.ATTR_PIN_VALUE = "pin"

Definition at line 99 of file __init__.py.

◆ ATTR_TIMESTAMP

string homeassistant.components.simplisafe.ATTR_TIMESTAMP = "timestamp"

Definition at line 100 of file __init__.py.

◆ DEFAULT_SCAN_INTERVAL

homeassistant.components.simplisafe.DEFAULT_SCAN_INTERVAL = timedelta(seconds=30)

Definition at line 102 of file __init__.py.

◆ DEFAULT_SOCKET_MIN_RETRY

int homeassistant.components.simplisafe.DEFAULT_SOCKET_MIN_RETRY = 15

Definition at line 103 of file __init__.py.

◆ EVENT_SIMPLISAFE_EVENT

string homeassistant.components.simplisafe.EVENT_SIMPLISAFE_EVENT = "SIMPLISAFE_EVENT"

Definition at line 106 of file __init__.py.

◆ EVENT_SIMPLISAFE_NOTIFICATION

string homeassistant.components.simplisafe.EVENT_SIMPLISAFE_NOTIFICATION = "SIMPLISAFE_NOTIFICATION"

Definition at line 107 of file __init__.py.

◆ PLATFORMS

list homeassistant.components.simplisafe.PLATFORMS

Initial value:

 =  [
     Platform.ALARM_CONTROL_PANEL,
     Platform.BINARY_SENSOR,
     Platform.BUTTON,
     Platform.LOCK,
     Platform.SENSOR,
 ]

Definition at line 109 of file __init__.py.

◆ SERVICE_NAME_REMOVE_PIN

string homeassistant.components.simplisafe.SERVICE_NAME_REMOVE_PIN = "remove_pin"

Definition at line 124 of file __init__.py.

◆ SERVICE_NAME_SET_PIN

string homeassistant.components.simplisafe.SERVICE_NAME_SET_PIN = "set_pin"

Definition at line 125 of file __init__.py.

◆ SERVICE_NAME_SET_SYSTEM_PROPERTIES

string homeassistant.components.simplisafe.SERVICE_NAME_SET_SYSTEM_PROPERTIES = "set_system_properties"

Definition at line 126 of file __init__.py.

◆ SERVICE_REMOVE_PIN_SCHEMA

homeassistant.components.simplisafe.SERVICE_REMOVE_PIN_SCHEMA

Initial value:

 =  vol.Schema(
     {
         vol.Required(ATTR_DEVICE_ID): cv.string,
         vol.Required(ATTR_PIN_LABEL_OR_VALUE): cv.string,
     }
 )

Definition at line 134 of file __init__.py.

◆ SERVICE_SET_PIN_SCHEMA

homeassistant.components.simplisafe.SERVICE_SET_PIN_SCHEMA

Initial value:

 =  vol.Schema(
     {
         vol.Required(ATTR_DEVICE_ID): cv.string,
         vol.Required(ATTR_PIN_LABEL): cv.string,
         vol.Required(ATTR_PIN_VALUE): cv.string,
     },
 )

Definition at line 141 of file __init__.py.

◆ SERVICE_SET_SYSTEM_PROPERTIES_SCHEMA

homeassistant.components.simplisafe.SERVICE_SET_SYSTEM_PROPERTIES_SCHEMA

Definition at line 149 of file __init__.py.

◆ SERVICES

tuple homeassistant.components.simplisafe.SERVICES

Initial value:

 =  (
     SERVICE_NAME_REMOVE_PIN,
     SERVICE_NAME_SET_PIN,
     SERVICE_NAME_SET_SYSTEM_PROPERTIES,
 )

Definition at line 128 of file __init__.py.

◆ VOLUME_MAP

dictionary homeassistant.components.simplisafe.VOLUME_MAP

Initial value:

 =  {
     "high": Volume.HIGH,
     "low": Volume.LOW,
     "medium": Volume.MEDIUM,
     "off": Volume.OFF,
 }

Definition at line 117 of file __init__.py.

◆ WEBSOCKET_EVENTS_TO_FIRE_HASS_EVENT

list homeassistant.components.simplisafe.WEBSOCKET_EVENTS_TO_FIRE_HASS_EVENT

Initial value:

 =  [
     EVENT_AUTOMATIC_TEST,
     EVENT_CAMERA_MOTION_DETECTED,
     EVENT_DOORBELL_DETECTED,
     EVENT_DEVICE_TEST,
     EVENT_SECRET_ALERT_TRIGGERED,
     EVENT_SENSOR_PAIRED_AND_NAMED,
     EVENT_USER_INITIATED_TEST,
 ]

Definition at line 186 of file __init__.py.

Home Assistant Unofficial Reference 2024.12.1

Namespaces

Classes

Functions

Variables

Detailed Description

Function Documentation

◆ _async_get_system_for_service_call()

◆ _async_register_base_station()

◆ _async_standardize_config_entry()

◆ async_setup_entry()

◆ async_unload_entry()

Variable Documentation

◆ ATTR_CATEGORY

◆ ATTR_LAST_EVENT_CHANGED_BY

◆ ATTR_LAST_EVENT_SENSOR_SERIAL

◆ ATTR_LAST_EVENT_TYPE

◆ ATTR_MESSAGE

◆ ATTR_PIN_LABEL

◆ ATTR_PIN_LABEL_OR_VALUE

◆ ATTR_PIN_VALUE

◆ ATTR_TIMESTAMP

◆ DEFAULT_SCAN_INTERVAL

◆ DEFAULT_SOCKET_MIN_RETRY

◆ EVENT_SIMPLISAFE_EVENT

◆ EVENT_SIMPLISAFE_NOTIFICATION

◆ PLATFORMS

◆ SERVICE_NAME_REMOVE_PIN

◆ SERVICE_NAME_SET_PIN

◆ SERVICE_NAME_SET_SYSTEM_PROPERTIES

◆ SERVICE_REMOVE_PIN_SCHEMA

◆ SERVICE_SET_PIN_SCHEMA

◆ SERVICE_SET_SYSTEM_PROPERTIES_SCHEMA

◆ SERVICES

◆ VOLUME_MAP

◆ WEBSOCKET_EVENTS_TO_FIRE_HASS_EVENT