mirror of
https://github.com/home-assistant/core
synced 2024-08-02 23:40:32 +02:00
350 lines
11 KiB
Python
350 lines
11 KiB
Python
"""Support for the Abode Security System."""
|
|
from __future__ import annotations
|
|
|
|
from functools import partial
|
|
|
|
from abodepy import Abode, AbodeAutomation as AbodeAuto
|
|
from abodepy.devices import AbodeDevice as AbodeDev
|
|
from abodepy.exceptions import AbodeAuthenticationException, AbodeException
|
|
import abodepy.helpers.timeline as TIMELINE
|
|
from requests.exceptions import ConnectTimeout, HTTPError
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.config_entries import ConfigEntry
|
|
from homeassistant.const import (
|
|
ATTR_DATE,
|
|
ATTR_DEVICE_ID,
|
|
ATTR_ENTITY_ID,
|
|
ATTR_TIME,
|
|
CONF_PASSWORD,
|
|
CONF_USERNAME,
|
|
EVENT_HOMEASSISTANT_STOP,
|
|
Platform,
|
|
)
|
|
from homeassistant.core import Event, HomeAssistant, ServiceCall
|
|
from homeassistant.exceptions import ConfigEntryAuthFailed, ConfigEntryNotReady
|
|
from homeassistant.helpers import config_validation as cv, entity
|
|
from homeassistant.helpers.dispatcher import dispatcher_send
|
|
|
|
from .const import ATTRIBUTION, CONF_POLLING, DEFAULT_CACHEDB, DOMAIN, LOGGER
|
|
|
|
SERVICE_SETTINGS = "change_setting"
|
|
SERVICE_CAPTURE_IMAGE = "capture_image"
|
|
SERVICE_TRIGGER_AUTOMATION = "trigger_automation"
|
|
|
|
ATTR_DEVICE_NAME = "device_name"
|
|
ATTR_DEVICE_TYPE = "device_type"
|
|
ATTR_EVENT_CODE = "event_code"
|
|
ATTR_EVENT_NAME = "event_name"
|
|
ATTR_EVENT_TYPE = "event_type"
|
|
ATTR_EVENT_UTC = "event_utc"
|
|
ATTR_SETTING = "setting"
|
|
ATTR_USER_NAME = "user_name"
|
|
ATTR_APP_TYPE = "app_type"
|
|
ATTR_EVENT_BY = "event_by"
|
|
ATTR_VALUE = "value"
|
|
|
|
CONFIG_SCHEMA = cv.removed(DOMAIN, raise_if_present=False)
|
|
|
|
CHANGE_SETTING_SCHEMA = vol.Schema(
|
|
{vol.Required(ATTR_SETTING): cv.string, vol.Required(ATTR_VALUE): cv.string}
|
|
)
|
|
|
|
CAPTURE_IMAGE_SCHEMA = vol.Schema({ATTR_ENTITY_ID: cv.entity_ids})
|
|
|
|
AUTOMATION_SCHEMA = vol.Schema({ATTR_ENTITY_ID: cv.entity_ids})
|
|
|
|
PLATFORMS = [
|
|
Platform.ALARM_CONTROL_PANEL,
|
|
Platform.BINARY_SENSOR,
|
|
Platform.LOCK,
|
|
Platform.SWITCH,
|
|
Platform.COVER,
|
|
Platform.CAMERA,
|
|
Platform.LIGHT,
|
|
Platform.SENSOR,
|
|
]
|
|
|
|
|
|
class AbodeSystem:
|
|
"""Abode System class."""
|
|
|
|
def __init__(self, abode: Abode, polling: bool) -> None:
|
|
"""Initialize the system."""
|
|
self.abode = abode
|
|
self.polling = polling
|
|
self.entity_ids: set[str | None] = set()
|
|
self.logout_listener = None
|
|
|
|
|
|
async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
|
|
"""Set up Abode integration from a config entry."""
|
|
username = entry.data[CONF_USERNAME]
|
|
password = entry.data[CONF_PASSWORD]
|
|
polling = entry.data[CONF_POLLING]
|
|
cache = hass.config.path(DEFAULT_CACHEDB)
|
|
|
|
# For previous config entries where unique_id is None
|
|
if entry.unique_id is None:
|
|
hass.config_entries.async_update_entry(
|
|
entry, unique_id=entry.data[CONF_USERNAME]
|
|
)
|
|
|
|
try:
|
|
abode = await hass.async_add_executor_job(
|
|
Abode, username, password, True, True, True, cache
|
|
)
|
|
|
|
except AbodeAuthenticationException as ex:
|
|
raise ConfigEntryAuthFailed(f"Invalid credentials: {ex}") from ex
|
|
|
|
except (AbodeException, ConnectTimeout, HTTPError) as ex:
|
|
raise ConfigEntryNotReady(f"Unable to connect to Abode: {ex}") from ex
|
|
|
|
hass.data[DOMAIN] = AbodeSystem(abode, polling)
|
|
|
|
hass.config_entries.async_setup_platforms(entry, PLATFORMS)
|
|
|
|
await setup_hass_events(hass)
|
|
await hass.async_add_executor_job(setup_hass_services, hass)
|
|
await hass.async_add_executor_job(setup_abode_events, hass)
|
|
|
|
return True
|
|
|
|
|
|
async def async_unload_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
|
|
"""Unload a config entry."""
|
|
hass.services.async_remove(DOMAIN, SERVICE_SETTINGS)
|
|
hass.services.async_remove(DOMAIN, SERVICE_CAPTURE_IMAGE)
|
|
hass.services.async_remove(DOMAIN, SERVICE_TRIGGER_AUTOMATION)
|
|
|
|
unload_ok = await hass.config_entries.async_unload_platforms(entry, PLATFORMS)
|
|
|
|
await hass.async_add_executor_job(hass.data[DOMAIN].abode.events.stop)
|
|
await hass.async_add_executor_job(hass.data[DOMAIN].abode.logout)
|
|
|
|
hass.data[DOMAIN].logout_listener()
|
|
hass.data.pop(DOMAIN)
|
|
|
|
return unload_ok
|
|
|
|
|
|
def setup_hass_services(hass: HomeAssistant) -> None:
|
|
"""Home Assistant services."""
|
|
|
|
def change_setting(call: ServiceCall) -> None:
|
|
"""Change an Abode system setting."""
|
|
setting = call.data[ATTR_SETTING]
|
|
value = call.data[ATTR_VALUE]
|
|
|
|
try:
|
|
hass.data[DOMAIN].abode.set_setting(setting, value)
|
|
except AbodeException as ex:
|
|
LOGGER.warning(ex)
|
|
|
|
def capture_image(call: ServiceCall) -> None:
|
|
"""Capture a new image."""
|
|
entity_ids = call.data[ATTR_ENTITY_ID]
|
|
|
|
target_entities = [
|
|
entity_id
|
|
for entity_id in hass.data[DOMAIN].entity_ids
|
|
if entity_id in entity_ids
|
|
]
|
|
|
|
for entity_id in target_entities:
|
|
signal = f"abode_camera_capture_{entity_id}"
|
|
dispatcher_send(hass, signal)
|
|
|
|
def trigger_automation(call: ServiceCall) -> None:
|
|
"""Trigger an Abode automation."""
|
|
entity_ids = call.data[ATTR_ENTITY_ID]
|
|
|
|
target_entities = [
|
|
entity_id
|
|
for entity_id in hass.data[DOMAIN].entity_ids
|
|
if entity_id in entity_ids
|
|
]
|
|
|
|
for entity_id in target_entities:
|
|
signal = f"abode_trigger_automation_{entity_id}"
|
|
dispatcher_send(hass, signal)
|
|
|
|
hass.services.register(
|
|
DOMAIN, SERVICE_SETTINGS, change_setting, schema=CHANGE_SETTING_SCHEMA
|
|
)
|
|
|
|
hass.services.register(
|
|
DOMAIN, SERVICE_CAPTURE_IMAGE, capture_image, schema=CAPTURE_IMAGE_SCHEMA
|
|
)
|
|
|
|
hass.services.register(
|
|
DOMAIN, SERVICE_TRIGGER_AUTOMATION, trigger_automation, schema=AUTOMATION_SCHEMA
|
|
)
|
|
|
|
|
|
async def setup_hass_events(hass: HomeAssistant) -> None:
|
|
"""Home Assistant start and stop callbacks."""
|
|
|
|
def logout(event: Event) -> None:
|
|
"""Logout of Abode."""
|
|
if not hass.data[DOMAIN].polling:
|
|
hass.data[DOMAIN].abode.events.stop()
|
|
|
|
hass.data[DOMAIN].abode.logout()
|
|
LOGGER.info("Logged out of Abode")
|
|
|
|
if not hass.data[DOMAIN].polling:
|
|
await hass.async_add_executor_job(hass.data[DOMAIN].abode.events.start)
|
|
|
|
hass.data[DOMAIN].logout_listener = hass.bus.async_listen_once(
|
|
EVENT_HOMEASSISTANT_STOP, logout
|
|
)
|
|
|
|
|
|
def setup_abode_events(hass: HomeAssistant) -> None:
|
|
"""Event callbacks."""
|
|
|
|
def event_callback(event: str, event_json: dict[str, str]) -> None:
|
|
"""Handle an event callback from Abode."""
|
|
data = {
|
|
ATTR_DEVICE_ID: event_json.get(ATTR_DEVICE_ID, ""),
|
|
ATTR_DEVICE_NAME: event_json.get(ATTR_DEVICE_NAME, ""),
|
|
ATTR_DEVICE_TYPE: event_json.get(ATTR_DEVICE_TYPE, ""),
|
|
ATTR_EVENT_CODE: event_json.get(ATTR_EVENT_CODE, ""),
|
|
ATTR_EVENT_NAME: event_json.get(ATTR_EVENT_NAME, ""),
|
|
ATTR_EVENT_TYPE: event_json.get(ATTR_EVENT_TYPE, ""),
|
|
ATTR_EVENT_UTC: event_json.get(ATTR_EVENT_UTC, ""),
|
|
ATTR_USER_NAME: event_json.get(ATTR_USER_NAME, ""),
|
|
ATTR_APP_TYPE: event_json.get(ATTR_APP_TYPE, ""),
|
|
ATTR_EVENT_BY: event_json.get(ATTR_EVENT_BY, ""),
|
|
ATTR_DATE: event_json.get(ATTR_DATE, ""),
|
|
ATTR_TIME: event_json.get(ATTR_TIME, ""),
|
|
}
|
|
|
|
hass.bus.fire(event, data)
|
|
|
|
events = [
|
|
TIMELINE.ALARM_GROUP,
|
|
TIMELINE.ALARM_END_GROUP,
|
|
TIMELINE.PANEL_FAULT_GROUP,
|
|
TIMELINE.PANEL_RESTORE_GROUP,
|
|
TIMELINE.AUTOMATION_GROUP,
|
|
TIMELINE.DISARM_GROUP,
|
|
TIMELINE.ARM_GROUP,
|
|
TIMELINE.ARM_FAULT_GROUP,
|
|
TIMELINE.TEST_GROUP,
|
|
TIMELINE.CAPTURE_GROUP,
|
|
TIMELINE.DEVICE_GROUP,
|
|
]
|
|
|
|
for event in events:
|
|
hass.data[DOMAIN].abode.events.add_event_callback(
|
|
event, partial(event_callback, event)
|
|
)
|
|
|
|
|
|
class AbodeEntity(entity.Entity):
|
|
"""Representation of an Abode entity."""
|
|
|
|
_attr_attribution = ATTRIBUTION
|
|
|
|
def __init__(self, data: AbodeSystem) -> None:
|
|
"""Initialize Abode entity."""
|
|
self._data = data
|
|
self._attr_should_poll = data.polling
|
|
|
|
async def async_added_to_hass(self) -> None:
|
|
"""Subscribe to Abode connection status updates."""
|
|
await self.hass.async_add_executor_job(
|
|
self._data.abode.events.add_connection_status_callback,
|
|
self.unique_id,
|
|
self._update_connection_status,
|
|
)
|
|
|
|
self.hass.data[DOMAIN].entity_ids.add(self.entity_id)
|
|
|
|
async def async_will_remove_from_hass(self) -> None:
|
|
"""Unsubscribe from Abode connection status updates."""
|
|
await self.hass.async_add_executor_job(
|
|
self._data.abode.events.remove_connection_status_callback, self.unique_id
|
|
)
|
|
|
|
def _update_connection_status(self) -> None:
|
|
"""Update the entity available property."""
|
|
self._attr_available = self._data.abode.events.connected
|
|
self.schedule_update_ha_state()
|
|
|
|
|
|
class AbodeDevice(AbodeEntity):
|
|
"""Representation of an Abode device."""
|
|
|
|
def __init__(self, data: AbodeSystem, device: AbodeDev) -> None:
|
|
"""Initialize Abode device."""
|
|
super().__init__(data)
|
|
self._device = device
|
|
self._attr_name = device.name
|
|
self._attr_unique_id = device.device_uuid
|
|
|
|
async def async_added_to_hass(self) -> None:
|
|
"""Subscribe to device events."""
|
|
await super().async_added_to_hass()
|
|
await self.hass.async_add_executor_job(
|
|
self._data.abode.events.add_device_callback,
|
|
self._device.device_id,
|
|
self._update_callback,
|
|
)
|
|
|
|
async def async_will_remove_from_hass(self) -> None:
|
|
"""Unsubscribe from device events."""
|
|
await super().async_will_remove_from_hass()
|
|
await self.hass.async_add_executor_job(
|
|
self._data.abode.events.remove_all_device_callbacks, self._device.device_id
|
|
)
|
|
|
|
def update(self) -> None:
|
|
"""Update device state."""
|
|
self._device.refresh()
|
|
|
|
@property
|
|
def extra_state_attributes(self) -> dict[str, str]:
|
|
"""Return the state attributes."""
|
|
return {
|
|
"device_id": self._device.device_id,
|
|
"battery_low": self._device.battery_low,
|
|
"no_response": self._device.no_response,
|
|
"device_type": self._device.type,
|
|
}
|
|
|
|
@property
|
|
def device_info(self) -> entity.DeviceInfo:
|
|
"""Return device registry information for this entity."""
|
|
return entity.DeviceInfo(
|
|
identifiers={(DOMAIN, self._device.device_id)},
|
|
manufacturer="Abode",
|
|
model=self._device.type,
|
|
name=self._device.name,
|
|
)
|
|
|
|
def _update_callback(self, device: AbodeDev) -> None:
|
|
"""Update the device state."""
|
|
self.schedule_update_ha_state()
|
|
|
|
|
|
class AbodeAutomation(AbodeEntity):
|
|
"""Representation of an Abode automation."""
|
|
|
|
def __init__(self, data: AbodeSystem, automation: AbodeAuto) -> None:
|
|
"""Initialize for Abode automation."""
|
|
super().__init__(data)
|
|
self._automation = automation
|
|
self._attr_name = automation.name
|
|
self._attr_unique_id = automation.automation_id
|
|
self._attr_extra_state_attributes = {
|
|
"type": "CUE automation",
|
|
}
|
|
|
|
def update(self) -> None:
|
|
"""Update automation state."""
|
|
self._automation.refresh()
|