Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.abode Namespace Reference

Namespaces

 alarm_control_panel
 
 binary_sensor
 
 camera
 
 config_flow
 
 const
 
 cover
 
 entity
 
 light
 
 lock
 
 sensor
 
 switch
 

Classes

class  AbodeSystem
 

Functions

bool async_setup (HomeAssistant hass, ConfigType config)
 
bool async_setup_entry (HomeAssistant hass, ConfigEntry entry)
 
bool async_unload_entry (HomeAssistant hass, ConfigEntry entry)
 
None setup_abode_events (HomeAssistant hass)
 
None setup_hass_events (HomeAssistant hass)
 
None setup_hass_services (HomeAssistant hass)
 

Variables

string ATTR_APP_TYPE = "app_type"
 
string ATTR_DEVICE_NAME = "device_name"
 
string ATTR_DEVICE_TYPE = "device_type"
 
string ATTR_EVENT_BY = "event_by"
 
string ATTR_EVENT_CODE = "event_code"
 
string ATTR_EVENT_NAME = "event_name"
 
string ATTR_EVENT_TYPE = "event_type"
 
string ATTR_EVENT_UTC = "event_utc"
 
string ATTR_SETTING = "setting"
 
string ATTR_USER_NAME = "user_name"
 
string ATTR_VALUE = "value"
 
 AUTOMATION_SCHEMA = vol.Schema({ATTR_ENTITY_ID: cv.entity_ids})
 
 CAPTURE_IMAGE_SCHEMA = vol.Schema({ATTR_ENTITY_ID: cv.entity_ids})
 
 CHANGE_SETTING_SCHEMA
 
 CONFIG_SCHEMA = cv.removed(DOMAIN, raise_if_present=False)
 
list PLATFORMS
 
string SERVICE_CAPTURE_IMAGE = "capture_image"
 
string SERVICE_SETTINGS = "change_setting"
 
string SERVICE_TRIGGER_AUTOMATION = "trigger_automation"
 

Detailed Description

Support for the Abode Security System.

Function Documentation

◆ async_setup()

bool homeassistant.components.abode.async_setup ( HomeAssistant  hass,
ConfigType  config 
)
Set up the Abode component.

Definition at line 86 of file __init__.py.

◆ async_setup_entry()

bool homeassistant.components.abode.async_setup_entry ( HomeAssistant  hass,
ConfigEntry  entry 
)
Set up Abode integration from a config entry.

Definition at line 92 of file __init__.py.

◆ async_unload_entry()

bool homeassistant.components.abode.async_unload_entry ( HomeAssistant  hass,
ConfigEntry  entry 
)
Unload a config entry.

Definition at line 128 of file __init__.py.

◆ setup_abode_events()

None homeassistant.components.abode.setup_abode_events ( HomeAssistant  hass)
Event callbacks.

Definition at line 214 of file __init__.py.

◆ setup_hass_events()

None homeassistant.components.abode.setup_hass_events ( HomeAssistant  hass)
Home Assistant start and stop callbacks.

Definition at line 195 of file __init__.py.

◆ setup_hass_services()

None homeassistant.components.abode.setup_hass_services ( HomeAssistant  hass)
Home Assistant services.

Definition at line 141 of file __init__.py.

Variable Documentation

◆ ATTR_APP_TYPE

string homeassistant.components.abode.ATTR_APP_TYPE = "app_type"

Definition at line 50 of file __init__.py.

◆ ATTR_DEVICE_NAME

string homeassistant.components.abode.ATTR_DEVICE_NAME = "device_name"

Definition at line 42 of file __init__.py.

◆ ATTR_DEVICE_TYPE

string homeassistant.components.abode.ATTR_DEVICE_TYPE = "device_type"

Definition at line 43 of file __init__.py.

◆ ATTR_EVENT_BY

string homeassistant.components.abode.ATTR_EVENT_BY = "event_by"

Definition at line 51 of file __init__.py.

◆ ATTR_EVENT_CODE

string homeassistant.components.abode.ATTR_EVENT_CODE = "event_code"

Definition at line 44 of file __init__.py.

◆ ATTR_EVENT_NAME

string homeassistant.components.abode.ATTR_EVENT_NAME = "event_name"

Definition at line 45 of file __init__.py.

◆ ATTR_EVENT_TYPE

string homeassistant.components.abode.ATTR_EVENT_TYPE = "event_type"

Definition at line 46 of file __init__.py.

◆ ATTR_EVENT_UTC

string homeassistant.components.abode.ATTR_EVENT_UTC = "event_utc"

Definition at line 47 of file __init__.py.

◆ ATTR_SETTING

string homeassistant.components.abode.ATTR_SETTING = "setting"

Definition at line 48 of file __init__.py.

◆ ATTR_USER_NAME

string homeassistant.components.abode.ATTR_USER_NAME = "user_name"

Definition at line 49 of file __init__.py.

◆ ATTR_VALUE

string homeassistant.components.abode.ATTR_VALUE = "value"

Definition at line 52 of file __init__.py.

◆ AUTOMATION_SCHEMA

homeassistant.components.abode.AUTOMATION_SCHEMA = vol.Schema({ATTR_ENTITY_ID: cv.entity_ids})

Definition at line 62 of file __init__.py.

◆ CAPTURE_IMAGE_SCHEMA

homeassistant.components.abode.CAPTURE_IMAGE_SCHEMA = vol.Schema({ATTR_ENTITY_ID: cv.entity_ids})

Definition at line 60 of file __init__.py.

◆ CHANGE_SETTING_SCHEMA

homeassistant.components.abode.CHANGE_SETTING_SCHEMA
Initial value:
1 = vol.Schema(
2  {vol.Required(ATTR_SETTING): cv.string, vol.Required(ATTR_VALUE): cv.string}
3 )

Definition at line 56 of file __init__.py.

◆ CONFIG_SCHEMA

homeassistant.components.abode.CONFIG_SCHEMA = cv.removed(DOMAIN, raise_if_present=False)

Definition at line 54 of file __init__.py.

◆ PLATFORMS

list homeassistant.components.abode.PLATFORMS
Initial value:
1 = [
2  Platform.ALARM_CONTROL_PANEL,
3  Platform.BINARY_SENSOR,
4  Platform.CAMERA,
5  Platform.COVER,
6  Platform.LIGHT,
7  Platform.LOCK,
8  Platform.SENSOR,
9  Platform.SWITCH,
10 ]

Definition at line 64 of file __init__.py.

◆ SERVICE_CAPTURE_IMAGE

string homeassistant.components.abode.SERVICE_CAPTURE_IMAGE = "capture_image"

Definition at line 39 of file __init__.py.

◆ SERVICE_SETTINGS

string homeassistant.components.abode.SERVICE_SETTINGS = "change_setting"

Definition at line 38 of file __init__.py.

◆ SERVICE_TRIGGER_AUTOMATION

string homeassistant.components.abode.SERVICE_TRIGGER_AUTOMATION = "trigger_automation"

Definition at line 40 of file __init__.py.