428 lines
14 KiB
Python
428 lines
14 KiB
Python
"""Support the ElkM1 Gold and ElkM1 EZ8 alarm/integration panels."""
|
|
|
|
from __future__ import annotations
|
|
|
|
import asyncio
|
|
import logging
|
|
import re
|
|
from types import MappingProxyType
|
|
from typing import Any
|
|
|
|
from elkm1_lib.elements import Element
|
|
from elkm1_lib.elk import Elk, Panel
|
|
from elkm1_lib.util import parse_url
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.config_entries import SOURCE_IMPORT, ConfigEntry
|
|
from homeassistant.const import (
|
|
CONF_ENABLED,
|
|
CONF_EXCLUDE,
|
|
CONF_HOST,
|
|
CONF_INCLUDE,
|
|
CONF_PASSWORD,
|
|
CONF_PREFIX,
|
|
CONF_TEMPERATURE_UNIT,
|
|
CONF_USERNAME,
|
|
CONF_ZONE,
|
|
Platform,
|
|
UnitOfTemperature,
|
|
)
|
|
from homeassistant.core import HomeAssistant, ServiceCall, callback
|
|
from homeassistant.exceptions import ConfigEntryNotReady, HomeAssistantError
|
|
from homeassistant.helpers import config_validation as cv
|
|
from homeassistant.helpers.event import async_track_time_interval
|
|
from homeassistant.helpers.typing import ConfigType
|
|
from homeassistant.util import dt as dt_util
|
|
from homeassistant.util.network import is_ip_address
|
|
|
|
from .const import (
|
|
ATTR_KEY,
|
|
ATTR_KEY_NAME,
|
|
ATTR_KEYPAD_ID,
|
|
ATTR_KEYPAD_NAME,
|
|
CONF_AREA,
|
|
CONF_AUTO_CONFIGURE,
|
|
CONF_COUNTER,
|
|
CONF_KEYPAD,
|
|
CONF_OUTPUT,
|
|
CONF_PLC,
|
|
CONF_SETTING,
|
|
CONF_TASK,
|
|
CONF_THERMOSTAT,
|
|
DISCOVER_SCAN_TIMEOUT,
|
|
DISCOVERY_INTERVAL,
|
|
DOMAIN,
|
|
ELK_ELEMENTS,
|
|
EVENT_ELKM1_KEYPAD_KEY_PRESSED,
|
|
LOGIN_TIMEOUT,
|
|
)
|
|
from .discovery import (
|
|
async_discover_device,
|
|
async_discover_devices,
|
|
async_trigger_discovery,
|
|
async_update_entry_from_discovery,
|
|
)
|
|
from .models import ELKM1Data
|
|
|
|
type ElkM1ConfigEntry = ConfigEntry[ELKM1Data]
|
|
|
|
SYNC_TIMEOUT = 120
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
PLATFORMS = [
|
|
Platform.ALARM_CONTROL_PANEL,
|
|
Platform.BINARY_SENSOR,
|
|
Platform.CLIMATE,
|
|
Platform.LIGHT,
|
|
Platform.SCENE,
|
|
Platform.SENSOR,
|
|
Platform.SWITCH,
|
|
]
|
|
|
|
SPEAK_SERVICE_SCHEMA = vol.Schema(
|
|
{
|
|
vol.Required("number"): vol.All(vol.Coerce(int), vol.Range(min=0, max=999)),
|
|
vol.Optional("prefix", default=""): cv.string,
|
|
}
|
|
)
|
|
|
|
SET_TIME_SERVICE_SCHEMA = vol.Schema(
|
|
{
|
|
vol.Optional("prefix", default=""): cv.string,
|
|
}
|
|
)
|
|
|
|
|
|
def hostname_from_url(url: str) -> str:
|
|
"""Return the hostname from a url."""
|
|
return parse_url(url)[1]
|
|
|
|
|
|
def _host_validator(config: dict[str, str]) -> dict[str, str]:
|
|
"""Validate that a host is properly configured."""
|
|
if config[CONF_HOST].startswith("elks://"):
|
|
if CONF_USERNAME not in config or CONF_PASSWORD not in config:
|
|
raise vol.Invalid("Specify username and password for elks://")
|
|
elif not config[CONF_HOST].startswith("elk://") and not config[
|
|
CONF_HOST
|
|
].startswith("serial://"):
|
|
raise vol.Invalid("Invalid host URL")
|
|
return config
|
|
|
|
|
|
def _elk_range_validator(rng: str) -> tuple[int, int]:
|
|
def _housecode_to_int(val: str) -> int:
|
|
match = re.search(r"^([a-p])(0[1-9]|1[0-6]|[1-9])$", val.lower())
|
|
if match:
|
|
return (ord(match.group(1)) - ord("a")) * 16 + int(match.group(2))
|
|
raise vol.Invalid("Invalid range")
|
|
|
|
def _elk_value(val: str) -> int:
|
|
return int(val) if val.isdigit() else _housecode_to_int(val)
|
|
|
|
vals = [s.strip() for s in str(rng).split("-")]
|
|
start = _elk_value(vals[0])
|
|
end = start if len(vals) == 1 else _elk_value(vals[1])
|
|
return (start, end)
|
|
|
|
|
|
def _has_all_unique_prefixes(value: list[dict[str, str]]) -> list[dict[str, str]]:
|
|
"""Validate that each m1 configured has a unique prefix.
|
|
|
|
Uniqueness is determined case-independently.
|
|
"""
|
|
prefixes = [device[CONF_PREFIX] for device in value]
|
|
schema = vol.Schema(vol.Unique())
|
|
schema(prefixes)
|
|
return value
|
|
|
|
|
|
DEVICE_SCHEMA_SUBDOMAIN = vol.Schema(
|
|
{
|
|
vol.Optional(CONF_ENABLED, default=True): cv.boolean,
|
|
vol.Optional(CONF_INCLUDE, default=[]): [_elk_range_validator],
|
|
vol.Optional(CONF_EXCLUDE, default=[]): [_elk_range_validator],
|
|
}
|
|
)
|
|
|
|
DEVICE_SCHEMA = vol.All(
|
|
cv.deprecated(CONF_TEMPERATURE_UNIT),
|
|
vol.Schema(
|
|
{
|
|
vol.Required(CONF_HOST): cv.string,
|
|
vol.Optional(CONF_PREFIX, default=""): vol.All(cv.string, vol.Lower),
|
|
vol.Optional(CONF_USERNAME, default=""): cv.string,
|
|
vol.Optional(CONF_PASSWORD, default=""): cv.string,
|
|
vol.Optional(CONF_AUTO_CONFIGURE, default=False): cv.boolean,
|
|
vol.Optional(CONF_TEMPERATURE_UNIT, default="F"): cv.temperature_unit,
|
|
vol.Optional(CONF_AREA, default={}): DEVICE_SCHEMA_SUBDOMAIN,
|
|
vol.Optional(CONF_COUNTER, default={}): DEVICE_SCHEMA_SUBDOMAIN,
|
|
vol.Optional(CONF_KEYPAD, default={}): DEVICE_SCHEMA_SUBDOMAIN,
|
|
vol.Optional(CONF_OUTPUT, default={}): DEVICE_SCHEMA_SUBDOMAIN,
|
|
vol.Optional(CONF_PLC, default={}): DEVICE_SCHEMA_SUBDOMAIN,
|
|
vol.Optional(CONF_SETTING, default={}): DEVICE_SCHEMA_SUBDOMAIN,
|
|
vol.Optional(CONF_TASK, default={}): DEVICE_SCHEMA_SUBDOMAIN,
|
|
vol.Optional(CONF_THERMOSTAT, default={}): DEVICE_SCHEMA_SUBDOMAIN,
|
|
vol.Optional(CONF_ZONE, default={}): DEVICE_SCHEMA_SUBDOMAIN,
|
|
},
|
|
),
|
|
_host_validator,
|
|
)
|
|
|
|
CONFIG_SCHEMA = vol.Schema(
|
|
{DOMAIN: vol.All(cv.ensure_list, [DEVICE_SCHEMA], _has_all_unique_prefixes)},
|
|
extra=vol.ALLOW_EXTRA,
|
|
)
|
|
|
|
|
|
async def async_setup(hass: HomeAssistant, hass_config: ConfigType) -> bool:
|
|
"""Set up the Elk M1 platform."""
|
|
_create_elk_services(hass)
|
|
|
|
async def _async_discovery(*_: Any) -> None:
|
|
async_trigger_discovery(
|
|
hass, await async_discover_devices(hass, DISCOVER_SCAN_TIMEOUT)
|
|
)
|
|
|
|
hass.async_create_background_task(_async_discovery(), "elkm1 setup discovery")
|
|
async_track_time_interval(
|
|
hass, _async_discovery, DISCOVERY_INTERVAL, cancel_on_shutdown=True
|
|
)
|
|
|
|
if DOMAIN not in hass_config:
|
|
return True
|
|
|
|
for index, conf in enumerate(hass_config[DOMAIN]):
|
|
_LOGGER.debug("Importing elkm1 #%d - %s", index, conf[CONF_HOST])
|
|
|
|
# The update of the config entry is done in async_setup
|
|
# to ensure the entry if updated before async_setup_entry
|
|
# is called to avoid a situation where the user has to restart
|
|
# twice for the changes to take effect
|
|
current_config_entry = _async_find_matching_config_entry(
|
|
hass, conf[CONF_PREFIX]
|
|
)
|
|
if current_config_entry:
|
|
# If they alter the yaml config we import the changes
|
|
# since there currently is no practical way to do an options flow
|
|
# with the large amount of include/exclude/enabled options that elkm1 has.
|
|
hass.config_entries.async_update_entry(current_config_entry, data=conf)
|
|
continue
|
|
|
|
hass.async_create_task(
|
|
hass.config_entries.flow.async_init(
|
|
DOMAIN,
|
|
context={"source": SOURCE_IMPORT},
|
|
data=conf,
|
|
)
|
|
)
|
|
|
|
return True
|
|
|
|
|
|
@callback
|
|
def _async_find_matching_config_entry(
|
|
hass: HomeAssistant, prefix: str
|
|
) -> ConfigEntry | None:
|
|
for entry in hass.config_entries.async_entries(DOMAIN):
|
|
if entry.unique_id == prefix:
|
|
return entry
|
|
return None
|
|
|
|
|
|
async def async_setup_entry(hass: HomeAssistant, entry: ElkM1ConfigEntry) -> bool:
|
|
"""Set up Elk-M1 Control from a config entry."""
|
|
conf: MappingProxyType[str, Any] = entry.data
|
|
|
|
host = hostname_from_url(entry.data[CONF_HOST])
|
|
|
|
_LOGGER.debug("Setting up elkm1 %s", conf["host"])
|
|
|
|
if (not entry.unique_id or ":" not in entry.unique_id) and is_ip_address(host):
|
|
_LOGGER.debug(
|
|
"Unique id for %s is missing during setup, trying to fill from discovery",
|
|
host,
|
|
)
|
|
if device := await async_discover_device(hass, host):
|
|
async_update_entry_from_discovery(hass, entry, device)
|
|
|
|
config: dict[str, Any] = {}
|
|
|
|
if not conf[CONF_AUTO_CONFIGURE]:
|
|
# With elkm1-lib==0.7.16 and later auto configure is available
|
|
config["panel"] = {"enabled": True, "included": [True]}
|
|
for item, max_ in ELK_ELEMENTS.items():
|
|
config[item] = {
|
|
"enabled": conf[item][CONF_ENABLED],
|
|
"included": [not conf[item]["include"]] * max_,
|
|
}
|
|
try:
|
|
_included(conf[item]["include"], True, config[item]["included"])
|
|
_included(conf[item]["exclude"], False, config[item]["included"])
|
|
except (ValueError, vol.Invalid) as err:
|
|
_LOGGER.error("Config item: %s; %s", item, err)
|
|
return False
|
|
|
|
elk = Elk(
|
|
{
|
|
"url": conf[CONF_HOST],
|
|
"userid": conf[CONF_USERNAME],
|
|
"password": conf[CONF_PASSWORD],
|
|
}
|
|
)
|
|
elk.connect()
|
|
|
|
def _keypad_changed(keypad: Element, changeset: dict[str, Any]) -> None:
|
|
if (keypress := changeset.get("last_keypress")) is None:
|
|
return
|
|
|
|
hass.bus.async_fire(
|
|
EVENT_ELKM1_KEYPAD_KEY_PRESSED,
|
|
{
|
|
ATTR_KEYPAD_NAME: keypad.name,
|
|
ATTR_KEYPAD_ID: keypad.index + 1,
|
|
ATTR_KEY_NAME: keypress[0],
|
|
ATTR_KEY: keypress[1],
|
|
},
|
|
)
|
|
|
|
for keypad in elk.keypads:
|
|
keypad.add_callback(_keypad_changed)
|
|
|
|
try:
|
|
if not await async_wait_for_elk_to_sync(elk, LOGIN_TIMEOUT, SYNC_TIMEOUT):
|
|
return False
|
|
except TimeoutError as exc:
|
|
raise ConfigEntryNotReady(f"Timed out connecting to {conf[CONF_HOST]}") from exc
|
|
|
|
elk_temp_unit = elk.panel.temperature_units
|
|
if elk_temp_unit == "C":
|
|
temperature_unit = UnitOfTemperature.CELSIUS
|
|
else:
|
|
temperature_unit = UnitOfTemperature.FAHRENHEIT
|
|
config["temperature_unit"] = temperature_unit
|
|
prefix: str = conf[CONF_PREFIX]
|
|
auto_configure: bool = conf[CONF_AUTO_CONFIGURE]
|
|
entry.runtime_data = ELKM1Data(
|
|
elk=elk,
|
|
prefix=prefix,
|
|
mac=entry.unique_id,
|
|
auto_configure=auto_configure,
|
|
config=config,
|
|
keypads={},
|
|
)
|
|
|
|
await hass.config_entries.async_forward_entry_setups(entry, PLATFORMS)
|
|
|
|
return True
|
|
|
|
|
|
def _included(ranges: list[tuple[int, int]], set_to: bool, values: list[bool]) -> None:
|
|
for rng in ranges:
|
|
if not rng[0] <= rng[1] <= len(values):
|
|
raise vol.Invalid(f"Invalid range {rng}")
|
|
values[rng[0] - 1 : rng[1]] = [set_to] * (rng[1] - rng[0] + 1)
|
|
|
|
|
|
def _find_elk_by_prefix(hass: HomeAssistant, prefix: str) -> Elk | None:
|
|
"""Search all config entries for a given prefix."""
|
|
for entry in hass.config_entries.async_entries(DOMAIN):
|
|
if not entry.runtime_data:
|
|
continue
|
|
elk_data: ELKM1Data = entry.runtime_data
|
|
if elk_data.prefix == prefix:
|
|
return elk_data.elk
|
|
return None
|
|
|
|
|
|
async def async_unload_entry(hass: HomeAssistant, entry: ElkM1ConfigEntry) -> bool:
|
|
"""Unload a config entry."""
|
|
unload_ok = await hass.config_entries.async_unload_platforms(entry, PLATFORMS)
|
|
# disconnect cleanly
|
|
entry.runtime_data.elk.disconnect()
|
|
return unload_ok
|
|
|
|
|
|
async def async_wait_for_elk_to_sync(
|
|
elk: Elk,
|
|
login_timeout: int,
|
|
sync_timeout: int,
|
|
) -> bool:
|
|
"""Wait until the elk has finished sync. Can fail login or timeout."""
|
|
|
|
sync_event = asyncio.Event()
|
|
login_event = asyncio.Event()
|
|
|
|
success = True
|
|
|
|
def login_status(succeeded: bool) -> None:
|
|
nonlocal success
|
|
|
|
success = succeeded
|
|
if succeeded:
|
|
_LOGGER.debug("ElkM1 login succeeded")
|
|
login_event.set()
|
|
else:
|
|
elk.disconnect()
|
|
_LOGGER.error("ElkM1 login failed; invalid username or password")
|
|
login_event.set()
|
|
sync_event.set()
|
|
|
|
def sync_complete() -> None:
|
|
sync_event.set()
|
|
|
|
elk.add_handler("login", login_status)
|
|
elk.add_handler("sync_complete", sync_complete)
|
|
for name, event, timeout in (
|
|
("login", login_event, login_timeout),
|
|
("sync_complete", sync_event, sync_timeout),
|
|
):
|
|
_LOGGER.debug("Waiting for %s event for %s seconds", name, timeout)
|
|
try:
|
|
async with asyncio.timeout(timeout):
|
|
await event.wait()
|
|
except TimeoutError:
|
|
_LOGGER.debug("Timed out waiting for %s event", name)
|
|
elk.disconnect()
|
|
raise
|
|
_LOGGER.debug("Received %s event", name)
|
|
|
|
return success
|
|
|
|
|
|
@callback
|
|
def _async_get_elk_panel(hass: HomeAssistant, service: ServiceCall) -> Panel:
|
|
"""Get the ElkM1 panel from a service call."""
|
|
prefix = service.data["prefix"]
|
|
elk = _find_elk_by_prefix(hass, prefix)
|
|
if elk is None:
|
|
raise HomeAssistantError(f"No ElkM1 with prefix '{prefix}' found")
|
|
return elk.panel
|
|
|
|
|
|
def _create_elk_services(hass: HomeAssistant) -> None:
|
|
"""Create ElkM1 services."""
|
|
|
|
@callback
|
|
def _speak_word_service(service: ServiceCall) -> None:
|
|
_async_get_elk_panel(hass, service).speak_word(service.data["number"])
|
|
|
|
@callback
|
|
def _speak_phrase_service(service: ServiceCall) -> None:
|
|
_async_get_elk_panel(hass, service).speak_phrase(service.data["number"])
|
|
|
|
@callback
|
|
def _set_time_service(service: ServiceCall) -> None:
|
|
_async_get_elk_panel(hass, service).set_time(dt_util.now())
|
|
|
|
hass.services.async_register(
|
|
DOMAIN, "speak_word", _speak_word_service, SPEAK_SERVICE_SCHEMA
|
|
)
|
|
hass.services.async_register(
|
|
DOMAIN, "speak_phrase", _speak_phrase_service, SPEAK_SERVICE_SCHEMA
|
|
)
|
|
hass.services.async_register(
|
|
DOMAIN, "set_time", _set_time_service, SET_TIME_SERVICE_SCHEMA
|
|
)
|