mirror of https://github.com/home-assistant/core
529 lines
18 KiB
Python
529 lines
18 KiB
Python
"""Support for RainMachine devices."""
|
|
|
|
from __future__ import annotations
|
|
|
|
from collections.abc import Callable, Coroutine
|
|
from dataclasses import dataclass
|
|
from datetime import timedelta
|
|
from functools import partial, wraps
|
|
from typing import Any, cast
|
|
|
|
from regenmaschine import Client
|
|
from regenmaschine.controller import Controller
|
|
from regenmaschine.errors import RainMachineError, UnknownAPICallError
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.config_entries import ConfigEntry, ConfigEntryState
|
|
from homeassistant.const import (
|
|
CONF_DEVICE_ID,
|
|
CONF_IP_ADDRESS,
|
|
CONF_PASSWORD,
|
|
CONF_PORT,
|
|
CONF_SSL,
|
|
CONF_UNIT_OF_MEASUREMENT,
|
|
Platform,
|
|
)
|
|
from homeassistant.core import HomeAssistant, ServiceCall, callback
|
|
from homeassistant.exceptions import ConfigEntryNotReady, HomeAssistantError
|
|
from homeassistant.helpers import (
|
|
aiohttp_client,
|
|
config_validation as cv,
|
|
device_registry as dr,
|
|
entity_registry as er,
|
|
)
|
|
from homeassistant.helpers.update_coordinator import UpdateFailed
|
|
from homeassistant.util.dt import as_timestamp, utcnow
|
|
from homeassistant.util.network import is_ip_address
|
|
|
|
from .config_flow import get_client_controller
|
|
from .const import (
|
|
CONF_ALLOW_INACTIVE_ZONES_TO_RUN,
|
|
CONF_DEFAULT_ZONE_RUN_TIME,
|
|
CONF_DURATION,
|
|
CONF_USE_APP_RUN_TIMES,
|
|
DATA_API_VERSIONS,
|
|
DATA_MACHINE_FIRMWARE_UPDATE_STATUS,
|
|
DATA_PROGRAMS,
|
|
DATA_PROVISION_SETTINGS,
|
|
DATA_RESTRICTIONS_CURRENT,
|
|
DATA_RESTRICTIONS_UNIVERSAL,
|
|
DATA_ZONES,
|
|
DEFAULT_ZONE_RUN,
|
|
DOMAIN,
|
|
LOGGER,
|
|
)
|
|
from .coordinator import RainMachineDataUpdateCoordinator
|
|
|
|
DEFAULT_SSL = True
|
|
|
|
|
|
PLATFORMS = [
|
|
Platform.BINARY_SENSOR,
|
|
Platform.BUTTON,
|
|
Platform.SELECT,
|
|
Platform.SENSOR,
|
|
Platform.SWITCH,
|
|
Platform.UPDATE,
|
|
]
|
|
|
|
CONF_CONDITION = "condition"
|
|
CONF_DEWPOINT = "dewpoint"
|
|
CONF_ET = "et"
|
|
CONF_MAXRH = "maxrh"
|
|
CONF_MAXTEMP = "maxtemp"
|
|
CONF_MINRH = "minrh"
|
|
CONF_MINTEMP = "mintemp"
|
|
CONF_PRESSURE = "pressure"
|
|
CONF_QPF = "qpf"
|
|
CONF_RAIN = "rain"
|
|
CONF_SECONDS = "seconds"
|
|
CONF_SOLARRAD = "solarrad"
|
|
CONF_TEMPERATURE = "temperature"
|
|
CONF_TIMESTAMP = "timestamp"
|
|
CONF_UNITS = "units"
|
|
CONF_VALUE = "value"
|
|
CONF_WEATHER = "weather"
|
|
CONF_WIND = "wind"
|
|
|
|
# Config Validator for Flow Meter Data
|
|
CV_FLOW_METER_VALID_UNITS = {
|
|
"clicks",
|
|
"gal",
|
|
"litre",
|
|
"m3",
|
|
}
|
|
|
|
# Config Validators for Weather Service Data
|
|
CV_WX_DATA_VALID_PERCENTAGE = vol.All(vol.Coerce(int), vol.Range(min=0, max=100))
|
|
CV_WX_DATA_VALID_TEMP_RANGE = vol.All(vol.Coerce(float), vol.Range(min=-40.0, max=40.0))
|
|
CV_WX_DATA_VALID_RAIN_RANGE = vol.All(vol.Coerce(float), vol.Range(min=0.0, max=1000.0))
|
|
CV_WX_DATA_VALID_WIND_SPEED = vol.All(vol.Coerce(float), vol.Range(min=0.0, max=65.0))
|
|
CV_WX_DATA_VALID_PRESSURE = vol.All(vol.Coerce(float), vol.Range(min=60.0, max=110.0))
|
|
CV_WX_DATA_VALID_SOLARRAD = vol.All(vol.Coerce(float), vol.Range(min=0.0, max=5.0))
|
|
|
|
SERVICE_NAME_PAUSE_WATERING = "pause_watering"
|
|
SERVICE_NAME_PUSH_FLOW_METER_DATA = "push_flow_meter_data"
|
|
SERVICE_NAME_PUSH_WEATHER_DATA = "push_weather_data"
|
|
SERVICE_NAME_RESTRICT_WATERING = "restrict_watering"
|
|
SERVICE_NAME_STOP_ALL = "stop_all"
|
|
SERVICE_NAME_UNPAUSE_WATERING = "unpause_watering"
|
|
SERVICE_NAME_UNRESTRICT_WATERING = "unrestrict_watering"
|
|
|
|
SERVICE_SCHEMA = vol.Schema(
|
|
{
|
|
vol.Required(CONF_DEVICE_ID): cv.string,
|
|
}
|
|
)
|
|
|
|
SERVICE_PAUSE_WATERING_SCHEMA = SERVICE_SCHEMA.extend(
|
|
{
|
|
vol.Required(CONF_SECONDS): cv.positive_int,
|
|
}
|
|
)
|
|
|
|
SERVICE_PUSH_FLOW_METER_DATA_SCHEMA = SERVICE_SCHEMA.extend(
|
|
{
|
|
vol.Required(CONF_VALUE): cv.positive_float,
|
|
vol.Optional(CONF_UNIT_OF_MEASUREMENT): vol.All(
|
|
cv.string, vol.In(CV_FLOW_METER_VALID_UNITS)
|
|
),
|
|
}
|
|
)
|
|
|
|
SERVICE_PUSH_WEATHER_DATA_SCHEMA = SERVICE_SCHEMA.extend(
|
|
{
|
|
vol.Optional(CONF_TIMESTAMP): cv.positive_float,
|
|
vol.Optional(CONF_MINTEMP): CV_WX_DATA_VALID_TEMP_RANGE,
|
|
vol.Optional(CONF_MAXTEMP): CV_WX_DATA_VALID_TEMP_RANGE,
|
|
vol.Optional(CONF_TEMPERATURE): CV_WX_DATA_VALID_TEMP_RANGE,
|
|
vol.Optional(CONF_WIND): CV_WX_DATA_VALID_WIND_SPEED,
|
|
vol.Optional(CONF_SOLARRAD): CV_WX_DATA_VALID_SOLARRAD,
|
|
vol.Optional(CONF_QPF): CV_WX_DATA_VALID_RAIN_RANGE,
|
|
vol.Optional(CONF_RAIN): CV_WX_DATA_VALID_RAIN_RANGE,
|
|
vol.Optional(CONF_ET): CV_WX_DATA_VALID_RAIN_RANGE,
|
|
vol.Optional(CONF_MINRH): CV_WX_DATA_VALID_PERCENTAGE,
|
|
vol.Optional(CONF_MAXRH): CV_WX_DATA_VALID_PERCENTAGE,
|
|
vol.Optional(CONF_CONDITION): cv.string,
|
|
vol.Optional(CONF_PRESSURE): CV_WX_DATA_VALID_PRESSURE,
|
|
vol.Optional(CONF_DEWPOINT): CV_WX_DATA_VALID_TEMP_RANGE,
|
|
}
|
|
)
|
|
|
|
SERVICE_RESTRICT_WATERING_SCHEMA = SERVICE_SCHEMA.extend(
|
|
{
|
|
vol.Required(CONF_DURATION): cv.time_period,
|
|
}
|
|
)
|
|
|
|
COORDINATOR_UPDATE_INTERVAL_MAP = {
|
|
DATA_API_VERSIONS: timedelta(minutes=1),
|
|
DATA_MACHINE_FIRMWARE_UPDATE_STATUS: timedelta(seconds=15),
|
|
DATA_PROGRAMS: timedelta(seconds=30),
|
|
DATA_PROVISION_SETTINGS: timedelta(minutes=1),
|
|
DATA_RESTRICTIONS_CURRENT: timedelta(minutes=1),
|
|
DATA_RESTRICTIONS_UNIVERSAL: timedelta(minutes=1),
|
|
DATA_ZONES: timedelta(seconds=15),
|
|
}
|
|
|
|
|
|
type RainMachineConfigEntry = ConfigEntry[RainMachineData]
|
|
|
|
|
|
@dataclass
|
|
class RainMachineData:
|
|
"""Define an object to be stored in `entry.runtime_data`."""
|
|
|
|
controller: Controller
|
|
coordinators: dict[str, RainMachineDataUpdateCoordinator]
|
|
|
|
|
|
@callback
|
|
def async_get_entry_for_service_call(
|
|
hass: HomeAssistant, call: ServiceCall
|
|
) -> RainMachineConfigEntry:
|
|
"""Get the controller related to a service call (by device ID)."""
|
|
device_id = call.data[CONF_DEVICE_ID]
|
|
device_registry = dr.async_get(hass)
|
|
|
|
if (device_entry := device_registry.async_get(device_id)) is None:
|
|
raise ValueError(f"Invalid RainMachine device ID: {device_id}")
|
|
|
|
for entry_id in device_entry.config_entries:
|
|
if (entry := hass.config_entries.async_get_entry(entry_id)) is None:
|
|
continue
|
|
if entry.domain == DOMAIN:
|
|
return cast(RainMachineConfigEntry, entry)
|
|
|
|
raise ValueError(f"No controller for device ID: {device_id}")
|
|
|
|
|
|
async def async_update_programs_and_zones(
|
|
hass: HomeAssistant, entry: RainMachineConfigEntry
|
|
) -> None:
|
|
"""Update program and zone DataUpdateCoordinators.
|
|
|
|
Program and zone updates always go together because of how linked they are:
|
|
programs affect zones and certain combinations of zones affect programs.
|
|
"""
|
|
data = entry.runtime_data
|
|
# No gather here to allow http keep-alive to reuse
|
|
# the connection for each coordinator.
|
|
await data.coordinators[DATA_PROGRAMS].async_refresh()
|
|
await data.coordinators[DATA_ZONES].async_refresh()
|
|
|
|
|
|
async def async_setup_entry( # noqa: C901
|
|
hass: HomeAssistant, entry: RainMachineConfigEntry
|
|
) -> bool:
|
|
"""Set up RainMachine as config entry."""
|
|
websession = aiohttp_client.async_get_clientsession(hass)
|
|
client = Client(session=websession)
|
|
ip_address = entry.data[CONF_IP_ADDRESS]
|
|
|
|
try:
|
|
await client.load_local(
|
|
ip_address,
|
|
entry.data[CONF_PASSWORD],
|
|
port=entry.data[CONF_PORT],
|
|
use_ssl=entry.data.get(CONF_SSL, DEFAULT_SSL),
|
|
)
|
|
except RainMachineError as err:
|
|
raise ConfigEntryNotReady from err
|
|
|
|
# regenmaschine can load multiple controllers at once, but we only grab the one
|
|
# we loaded above:
|
|
controller = get_client_controller(client)
|
|
|
|
entry_updates: dict[str, Any] = {}
|
|
if not entry.unique_id or is_ip_address(entry.unique_id):
|
|
# If the config entry doesn't already have a unique ID, set one:
|
|
entry_updates["unique_id"] = controller.mac
|
|
|
|
if CONF_DEFAULT_ZONE_RUN_TIME in entry.data:
|
|
# If a zone run time exists in the config entry's data, pop it and move it to
|
|
# options:
|
|
data = {**entry.data}
|
|
entry_updates["data"] = data
|
|
entry_updates["options"] = {
|
|
**entry.options,
|
|
CONF_DEFAULT_ZONE_RUN_TIME: data.pop(CONF_DEFAULT_ZONE_RUN_TIME),
|
|
}
|
|
entry_updates["options"] = {**entry.options}
|
|
if CONF_USE_APP_RUN_TIMES not in entry.options:
|
|
entry_updates["options"][CONF_USE_APP_RUN_TIMES] = False
|
|
if CONF_DEFAULT_ZONE_RUN_TIME not in entry.options:
|
|
entry_updates["options"][CONF_DEFAULT_ZONE_RUN_TIME] = DEFAULT_ZONE_RUN
|
|
if CONF_ALLOW_INACTIVE_ZONES_TO_RUN not in entry.options:
|
|
entry_updates["options"][CONF_ALLOW_INACTIVE_ZONES_TO_RUN] = False
|
|
if entry_updates:
|
|
hass.config_entries.async_update_entry(entry, **entry_updates)
|
|
|
|
if entry.unique_id and controller.mac != entry.unique_id:
|
|
# If the mac address of the device does not match the unique_id
|
|
# of the config entry, it likely means the DHCP lease has expired
|
|
# and the device has been assigned a new IP address. We need to
|
|
# wait for the next discovery to find the device at its new address
|
|
# and update the config entry so we do not mix up devices.
|
|
raise ConfigEntryNotReady(
|
|
f"Unexpected device found at {ip_address}; expected {entry.unique_id}, "
|
|
f"found {controller.mac}"
|
|
)
|
|
|
|
async def async_update(api_category: str) -> dict:
|
|
"""Update the appropriate API data based on a category."""
|
|
data: dict = {}
|
|
|
|
try:
|
|
if api_category == DATA_API_VERSIONS:
|
|
data = await controller.api.versions()
|
|
elif api_category == DATA_MACHINE_FIRMWARE_UPDATE_STATUS:
|
|
data = await controller.machine.get_firmware_update_status()
|
|
elif api_category == DATA_PROGRAMS:
|
|
data = await controller.programs.all(include_inactive=True)
|
|
elif api_category == DATA_PROVISION_SETTINGS:
|
|
data = await controller.provisioning.settings()
|
|
elif api_category == DATA_RESTRICTIONS_CURRENT:
|
|
data = await controller.restrictions.current()
|
|
elif api_category == DATA_RESTRICTIONS_UNIVERSAL:
|
|
data = await controller.restrictions.universal()
|
|
else:
|
|
data = await controller.zones.all(details=True, include_inactive=True)
|
|
except UnknownAPICallError:
|
|
LOGGER.warning(
|
|
"Skipping unsupported API call for controller %s: %s",
|
|
controller.name,
|
|
api_category,
|
|
)
|
|
except RainMachineError as err:
|
|
raise UpdateFailed(err) from err
|
|
|
|
return data
|
|
|
|
coordinators = {}
|
|
for api_category, update_interval in COORDINATOR_UPDATE_INTERVAL_MAP.items():
|
|
coordinator = coordinators[api_category] = RainMachineDataUpdateCoordinator(
|
|
hass,
|
|
entry=entry,
|
|
name=f'{controller.name} ("{api_category}")',
|
|
api_category=api_category,
|
|
update_interval=update_interval,
|
|
update_method=partial(async_update, api_category),
|
|
)
|
|
coordinator.async_initialize()
|
|
# Its generally faster not to gather here so we can
|
|
# reuse the connection instead of creating a new
|
|
# connection for each coordinator.
|
|
await coordinator.async_config_entry_first_refresh()
|
|
|
|
entry.runtime_data = RainMachineData(
|
|
controller=controller, coordinators=coordinators
|
|
)
|
|
|
|
await hass.config_entries.async_forward_entry_setups(entry, PLATFORMS)
|
|
|
|
entry.async_on_unload(entry.add_update_listener(async_reload_entry))
|
|
|
|
def call_with_controller(
|
|
update_programs_and_zones: bool = True,
|
|
) -> Callable[
|
|
[Callable[[ServiceCall, Controller], Coroutine[Any, Any, None]]],
|
|
Callable[[ServiceCall], Coroutine[Any, Any, None]],
|
|
]:
|
|
"""Hydrate a service call with the appropriate controller."""
|
|
|
|
def decorator(
|
|
func: Callable[[ServiceCall, Controller], Coroutine[Any, Any, None]],
|
|
) -> Callable[[ServiceCall], Coroutine[Any, Any, None]]:
|
|
"""Define the decorator."""
|
|
|
|
@wraps(func)
|
|
async def wrapper(call: ServiceCall) -> None:
|
|
"""Wrap the service function."""
|
|
entry = async_get_entry_for_service_call(hass, call)
|
|
data = entry.runtime_data
|
|
|
|
try:
|
|
await func(call, data.controller)
|
|
except RainMachineError as err:
|
|
raise HomeAssistantError(
|
|
f"Error while executing {func.__name__}: {err}"
|
|
) from err
|
|
|
|
if update_programs_and_zones:
|
|
await async_update_programs_and_zones(hass, entry)
|
|
|
|
return wrapper
|
|
|
|
return decorator
|
|
|
|
@call_with_controller()
|
|
async def async_pause_watering(call: ServiceCall, controller: Controller) -> None:
|
|
"""Pause watering for a set number of seconds."""
|
|
await controller.watering.pause_all(call.data[CONF_SECONDS])
|
|
|
|
@call_with_controller(update_programs_and_zones=False)
|
|
async def async_push_flow_meter_data(
|
|
call: ServiceCall, controller: Controller
|
|
) -> None:
|
|
"""Push flow meter data to the device."""
|
|
value = call.data[CONF_VALUE]
|
|
if units := call.data.get(CONF_UNIT_OF_MEASUREMENT):
|
|
await controller.watering.post_flowmeter(value=value, units=units)
|
|
else:
|
|
await controller.watering.post_flowmeter(value=value)
|
|
|
|
@call_with_controller(update_programs_and_zones=False)
|
|
async def async_push_weather_data(
|
|
call: ServiceCall, controller: Controller
|
|
) -> None:
|
|
"""Push weather data to the device."""
|
|
await controller.parsers.post_data(
|
|
{
|
|
CONF_WEATHER: [
|
|
{
|
|
key: value
|
|
for key, value in call.data.items()
|
|
if key != CONF_DEVICE_ID
|
|
}
|
|
]
|
|
}
|
|
)
|
|
|
|
@call_with_controller()
|
|
async def async_restrict_watering(
|
|
call: ServiceCall, controller: Controller
|
|
) -> None:
|
|
"""Restrict watering for a time period."""
|
|
duration = call.data[CONF_DURATION]
|
|
await controller.restrictions.set_universal(
|
|
{
|
|
"rainDelayStartTime": round(as_timestamp(utcnow())),
|
|
"rainDelayDuration": duration.total_seconds(),
|
|
},
|
|
)
|
|
|
|
@call_with_controller()
|
|
async def async_stop_all(call: ServiceCall, controller: Controller) -> None:
|
|
"""Stop all watering."""
|
|
await controller.watering.stop_all()
|
|
|
|
@call_with_controller()
|
|
async def async_unpause_watering(call: ServiceCall, controller: Controller) -> None:
|
|
"""Unpause watering."""
|
|
await controller.watering.unpause_all()
|
|
|
|
@call_with_controller()
|
|
async def async_unrestrict_watering(
|
|
call: ServiceCall, controller: Controller
|
|
) -> None:
|
|
"""Unrestrict watering."""
|
|
await controller.restrictions.set_universal(
|
|
{
|
|
"rainDelayStartTime": round(as_timestamp(utcnow())),
|
|
"rainDelayDuration": 0,
|
|
},
|
|
)
|
|
|
|
for service_name, schema, method in (
|
|
(
|
|
SERVICE_NAME_PAUSE_WATERING,
|
|
SERVICE_PAUSE_WATERING_SCHEMA,
|
|
async_pause_watering,
|
|
),
|
|
(
|
|
SERVICE_NAME_PUSH_FLOW_METER_DATA,
|
|
SERVICE_PUSH_FLOW_METER_DATA_SCHEMA,
|
|
async_push_flow_meter_data,
|
|
),
|
|
(
|
|
SERVICE_NAME_PUSH_WEATHER_DATA,
|
|
SERVICE_PUSH_WEATHER_DATA_SCHEMA,
|
|
async_push_weather_data,
|
|
),
|
|
(
|
|
SERVICE_NAME_RESTRICT_WATERING,
|
|
SERVICE_RESTRICT_WATERING_SCHEMA,
|
|
async_restrict_watering,
|
|
),
|
|
(SERVICE_NAME_STOP_ALL, SERVICE_SCHEMA, async_stop_all),
|
|
(SERVICE_NAME_UNPAUSE_WATERING, SERVICE_SCHEMA, async_unpause_watering),
|
|
(
|
|
SERVICE_NAME_UNRESTRICT_WATERING,
|
|
SERVICE_SCHEMA,
|
|
async_unrestrict_watering,
|
|
),
|
|
):
|
|
if hass.services.has_service(DOMAIN, service_name):
|
|
continue
|
|
hass.services.async_register(DOMAIN, service_name, method, schema=schema)
|
|
|
|
return True
|
|
|
|
|
|
async def async_unload_entry(
|
|
hass: HomeAssistant, entry: RainMachineConfigEntry
|
|
) -> bool:
|
|
"""Unload an RainMachine config entry."""
|
|
unload_ok = await hass.config_entries.async_unload_platforms(entry, PLATFORMS)
|
|
loaded_entries = [
|
|
entry
|
|
for entry in hass.config_entries.async_entries(DOMAIN)
|
|
if entry.state is ConfigEntryState.LOADED
|
|
]
|
|
if len(loaded_entries) == 1:
|
|
# If this is the last loaded instance of RainMachine, deregister any services
|
|
# defined during integration setup:
|
|
for service_name in (
|
|
SERVICE_NAME_PAUSE_WATERING,
|
|
SERVICE_NAME_PUSH_FLOW_METER_DATA,
|
|
SERVICE_NAME_PUSH_WEATHER_DATA,
|
|
SERVICE_NAME_RESTRICT_WATERING,
|
|
SERVICE_NAME_STOP_ALL,
|
|
SERVICE_NAME_UNPAUSE_WATERING,
|
|
SERVICE_NAME_UNRESTRICT_WATERING,
|
|
):
|
|
hass.services.async_remove(DOMAIN, service_name)
|
|
|
|
return unload_ok
|
|
|
|
|
|
async def async_migrate_entry(
|
|
hass: HomeAssistant, entry: RainMachineConfigEntry
|
|
) -> bool:
|
|
"""Migrate an old config entry."""
|
|
version = entry.version
|
|
|
|
LOGGER.debug("Migrating from version %s", version)
|
|
|
|
# 1 -> 2: Update unique IDs to be consistent across platform (including removing
|
|
# the silly removal of colons in the MAC address that was added originally):
|
|
if version == 1:
|
|
version = 2
|
|
hass.config_entries.async_update_entry(entry, version=version)
|
|
|
|
@callback
|
|
def migrate_unique_id(entity_entry: er.RegistryEntry) -> dict[str, Any]:
|
|
"""Migrate the unique ID to a new format."""
|
|
unique_id_pieces = entity_entry.unique_id.split("_")
|
|
old_mac = unique_id_pieces[0]
|
|
new_mac = ":".join(old_mac[i : i + 2] for i in range(0, len(old_mac), 2))
|
|
unique_id_pieces[0] = new_mac
|
|
|
|
if entity_entry.entity_id.startswith("switch"):
|
|
unique_id_pieces[1] = unique_id_pieces[1][11:].lower()
|
|
|
|
return {"new_unique_id": "_".join(unique_id_pieces)}
|
|
|
|
await er.async_migrate_entries(hass, entry.entry_id, migrate_unique_id)
|
|
|
|
LOGGER.debug("Migration to version %s successful", version)
|
|
|
|
return True
|
|
|
|
|
|
async def async_reload_entry(
|
|
hass: HomeAssistant, entry: RainMachineConfigEntry
|
|
) -> None:
|
|
"""Handle an options update."""
|
|
await hass.config_entries.async_reload(entry.entry_id)
|