"""This component provides support for RainMachine programs and zones.""" from __future__ import annotations import asyncio from collections.abc import Coroutine from dataclasses import dataclass from datetime import datetime from typing import Any from regenmaschine.controller import Controller from regenmaschine.errors import RequestError import voluptuous as vol from homeassistant.components.switch import SwitchEntity, SwitchEntityDescription from homeassistant.config_entries import ConfigEntry from homeassistant.const import ATTR_ID from homeassistant.core import HomeAssistant, callback from homeassistant.exceptions import HomeAssistantError from homeassistant.helpers import config_validation as cv, entity_platform from homeassistant.helpers.entity import EntityCategory from homeassistant.helpers.entity_platform import AddEntitiesCallback from homeassistant.helpers.update_coordinator import DataUpdateCoordinator from . import RainMachineEntity, async_update_programs_and_zones from .const import ( CONF_ZONE_RUN_TIME, DATA_CONTROLLER, DATA_COORDINATOR, DATA_PROGRAMS, DATA_ZONES, DEFAULT_ZONE_RUN, DOMAIN, RUN_STATE_MAP, ) from .model import RainMachineDescriptionMixinUid ATTR_AREA = "area" ATTR_CS_ON = "cs_on" ATTR_CURRENT_CYCLE = "current_cycle" ATTR_CYCLES = "cycles" ATTR_DELAY = "delay" ATTR_DELAY_ON = "delay_on" ATTR_FIELD_CAPACITY = "field_capacity" ATTR_NEXT_RUN = "next_run" ATTR_NO_CYCLES = "number_of_cycles" ATTR_PRECIP_RATE = "sprinkler_head_precipitation_rate" ATTR_RESTRICTIONS = "restrictions" ATTR_SLOPE = "slope" ATTR_SOAK = "soak" ATTR_SOIL_TYPE = "soil_type" ATTR_SPRINKLER_TYPE = "sprinkler_head_type" ATTR_STATUS = "status" ATTR_SUN_EXPOSURE = "sun_exposure" ATTR_VEGETATION_TYPE = "vegetation_type" ATTR_ZONES = "zones" DAYS = ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"] SOIL_TYPE_MAP = { 0: "Not Set", 1: "Clay Loam", 2: "Silty Clay", 3: "Clay", 4: "Loam", 5: "Sandy Loam", 6: "Loamy Sand", 7: "Sand", 8: "Sandy Clay", 9: "Silt Loam", 10: "Silt", 99: "Other", } SLOPE_TYPE_MAP = { 0: "Not Set", 1: "Flat", 2: "Moderate", 3: "High", 4: "Very High", 99: "Other", } SPRINKLER_TYPE_MAP = { 0: "Not Set", 1: "Popup Spray", 2: "Rotors Low Rate", 3: "Surface Drip", 4: "Bubblers Drip", 5: "Rotors High Rate", 99: "Other", } SUN_EXPOSURE_MAP = {0: "Not Set", 1: "Full Sun", 2: "Partial Shade", 3: "Full Shade"} VEGETATION_MAP = { 0: "Not Set", 1: "Not Set", 2: "Cool Season Grass", 3: "Fruit Trees", 4: "Flowers", 5: "Vegetables", 6: "Citrus", 7: "Bushes", 9: "Drought Tolerant Plants", 10: "Warm Season Grass", 11: "Trees", 99: "Other", } @dataclass class RainMachineSwitchDescription( SwitchEntityDescription, RainMachineDescriptionMixinUid ): """Describe a RainMachine switch.""" async def async_setup_entry( hass: HomeAssistant, entry: ConfigEntry, async_add_entities: AddEntitiesCallback ) -> None: """Set up RainMachine switches based on a config entry.""" platform = entity_platform.async_get_current_platform() for service_name, schema, method in ( ("start_program", {}, "async_start_program"), ( "start_zone", { vol.Optional( CONF_ZONE_RUN_TIME, default=DEFAULT_ZONE_RUN ): cv.positive_int }, "async_start_zone", ), ("stop_program", {}, "async_stop_program"), ("stop_zone", {}, "async_stop_zone"), ): platform.async_register_entity_service(service_name, schema, method) data = hass.data[DOMAIN][entry.entry_id] controller = data[DATA_CONTROLLER] program_coordinator = data[DATA_COORDINATOR][DATA_PROGRAMS] zone_coordinator = data[DATA_COORDINATOR][DATA_ZONES] entities: list[RainMachineActivitySwitch | RainMachineEnabledSwitch] = [] for kind, coordinator, switch_class, switch_enabled_class in ( ("program", program_coordinator, RainMachineProgram, RainMachineProgramEnabled), ("zone", zone_coordinator, RainMachineZone, RainMachineZoneEnabled), ): for uid, data in coordinator.data.items(): # Add a switch to start/stop the program or zone: entities.append( switch_class( entry, coordinator, controller, RainMachineSwitchDescription( key=f"{kind}_{uid}", name=data["name"], icon="mdi:water", uid=uid, ), ) ) # Add a switch to enabled/disable the program or zone: entities.append( switch_enabled_class( entry, coordinator, controller, RainMachineSwitchDescription( key=f"{kind}_{uid}_enabled", name=f"{data['name']} Enabled", entity_category=EntityCategory.CONFIG, icon="mdi:cog", uid=uid, ), ) ) async_add_entities(entities) class RainMachineBaseSwitch(RainMachineEntity, SwitchEntity): """Define a base RainMachine switch.""" entity_description: RainMachineSwitchDescription def __init__( self, entry: ConfigEntry, coordinator: DataUpdateCoordinator, controller: Controller, description: RainMachineSwitchDescription, ) -> None: """Initialize.""" super().__init__(entry, coordinator, controller, description) self._attr_is_on = False self._entry = entry async def _async_run_api_coroutine(self, api_coro: Coroutine) -> None: """Await an API coroutine, handle any errors, and update as appropriate.""" try: resp = await api_coro except RequestError as err: raise HomeAssistantError( f'Error while executing {api_coro.__name__} on "{self.name}": {err}', ) from err if resp["statusCode"] != 0: raise HomeAssistantError( f'Error while executing {api_coro.__name__} on "{self.name}": {resp["message"]}', ) # Because of how inextricably linked programs and zones are, anytime one is # toggled, we make sure to update the data of both coordinators: self.hass.async_create_task( async_update_programs_and_zones(self.hass, self._entry) ) async def async_start_program(self) -> None: """Execute the start_program entity service.""" raise NotImplementedError("Service not implemented for this entity") async def async_start_zone(self, *, zone_run_time: int) -> None: """Execute the start_zone entity service.""" raise NotImplementedError("Service not implemented for this entity") async def async_stop_program(self) -> None: """Execute the stop_program entity service.""" raise NotImplementedError("Service not implemented for this entity") async def async_stop_zone(self) -> None: """Execute the stop_zone entity service.""" raise NotImplementedError("Service not implemented for this entity") class RainMachineActivitySwitch(RainMachineBaseSwitch): """Define a RainMachine switch to start/stop an activity (program or zone).""" async def async_turn_off(self, **kwargs: Any) -> None: """Turn the switch off. The only way this could occur is if someone rapidly turns a disabled activity off right after turning it on. """ if not self.coordinator.data[self.entity_description.uid]["active"]: raise HomeAssistantError( f"Cannot turn off an inactive program/zone: {self.name}" ) await self.async_turn_off_when_active(**kwargs) async def async_turn_off_when_active(self, **kwargs: Any) -> None: """Turn the switch off when its associated activity is active.""" raise NotImplementedError async def async_turn_on(self, **kwargs: Any) -> None: """Turn the switch on.""" if not self.coordinator.data[self.entity_description.uid]["active"]: self._attr_is_on = False self.async_write_ha_state() raise HomeAssistantError( f"Cannot turn on an inactive program/zone: {self.name}" ) await self.async_turn_on_when_active(**kwargs) async def async_turn_on_when_active(self, **kwargs: Any) -> None: """Turn the switch on when its associated activity is active.""" raise NotImplementedError class RainMachineEnabledSwitch(RainMachineBaseSwitch): """Define a RainMachine switch to enable/disable an activity (program or zone).""" @callback def update_from_latest_data(self) -> None: """Update the entity when new data is received.""" self._attr_is_on = self.coordinator.data[self.entity_description.uid]["active"] class RainMachineProgram(RainMachineActivitySwitch): """Define a RainMachine program.""" async def async_start_program(self) -> None: """Start the program.""" await self.async_turn_on() async def async_stop_program(self) -> None: """Stop the program.""" await self.async_turn_off() async def async_turn_off_when_active(self, **kwargs: Any) -> None: """Turn the switch off when its associated activity is active.""" await self._async_run_api_coroutine( self._controller.programs.stop(self.entity_description.uid) ) async def async_turn_on_when_active(self, **kwargs: Any) -> None: """Turn the switch on when its associated activity is active.""" await self._async_run_api_coroutine( self._controller.programs.start(self.entity_description.uid) ) @callback def update_from_latest_data(self) -> None: """Update the entity when new data is received.""" data = self.coordinator.data[self.entity_description.uid] self._attr_is_on = bool(data["status"]) next_run: str | None if data.get("nextRun") is None: next_run = None else: next_run = datetime.strptime( f"{data['nextRun']} {data['startTime']}", "%Y-%m-%d %H:%M", ).isoformat() self._attr_extra_state_attributes.update( { ATTR_ID: self.entity_description.uid, ATTR_NEXT_RUN: next_run, ATTR_SOAK: data.get("soak"), ATTR_STATUS: RUN_STATE_MAP[data["status"]], ATTR_ZONES: [z for z in data["wateringTimes"] if z["active"]], } ) class RainMachineProgramEnabled(RainMachineEnabledSwitch): """Define a switch to enable/disable a RainMachine program.""" async def async_turn_off(self, **kwargs: Any) -> None: """Disable the program.""" tasks = [ self._async_run_api_coroutine( self._controller.programs.stop(self.entity_description.uid) ), self._async_run_api_coroutine( self._controller.programs.disable(self.entity_description.uid) ), ] await asyncio.gather(*tasks) async def async_turn_on(self, **kwargs: Any) -> None: """Enable the program.""" await self._async_run_api_coroutine( self._controller.programs.enable(self.entity_description.uid) ) class RainMachineZone(RainMachineActivitySwitch): """Define a RainMachine zone.""" async def async_start_zone(self, *, zone_run_time: int) -> None: """Start a particular zone for a certain amount of time.""" await self.async_turn_on(duration=zone_run_time) async def async_stop_zone(self) -> None: """Stop a zone.""" await self.async_turn_off() async def async_turn_off_when_active(self, **kwargs: Any) -> None: """Turn the switch off when its associated activity is active.""" await self._async_run_api_coroutine( self._controller.zones.stop(self.entity_description.uid) ) async def async_turn_on_when_active(self, **kwargs: Any) -> None: """Turn the switch on when its associated activity is active.""" await self._async_run_api_coroutine( self._controller.zones.start( self.entity_description.uid, kwargs.get("duration", self._entry.options[CONF_ZONE_RUN_TIME]), ) ) @callback def update_from_latest_data(self) -> None: """Update the entity when new data is received.""" data = self.coordinator.data[self.entity_description.uid] self._attr_is_on = bool(data["state"]) attrs = { ATTR_CURRENT_CYCLE: data["cycle"], ATTR_ID: data["uid"], ATTR_NO_CYCLES: data["noOfCycles"], ATTR_RESTRICTIONS: data["restriction"], ATTR_SLOPE: SLOPE_TYPE_MAP.get(data["slope"], 99), ATTR_SOIL_TYPE: SOIL_TYPE_MAP.get(data["soil"], 99), ATTR_SPRINKLER_TYPE: SPRINKLER_TYPE_MAP.get(data["group_id"], 99), ATTR_STATUS: RUN_STATE_MAP[data["state"]], ATTR_SUN_EXPOSURE: SUN_EXPOSURE_MAP.get(data.get("sun")), ATTR_VEGETATION_TYPE: VEGETATION_MAP.get(data["type"], 99), } if "waterSense" in data: if "area" in data["waterSense"]: attrs[ATTR_AREA] = round(data["waterSense"]["area"], 2) if "fieldCapacity" in data["waterSense"]: attrs[ATTR_FIELD_CAPACITY] = round( data["waterSense"]["fieldCapacity"], 2 ) if "precipitationRate" in data["waterSense"]: attrs[ATTR_PRECIP_RATE] = round( data["waterSense"]["precipitationRate"], 2 ) self._attr_extra_state_attributes.update(attrs) class RainMachineZoneEnabled(RainMachineEnabledSwitch): """Define a switch to enable/disable a RainMachine zone.""" async def async_turn_off(self, **kwargs: Any) -> None: """Disable the zone.""" tasks = [ self._async_run_api_coroutine( self._controller.zones.stop(self.entity_description.uid) ), self._async_run_api_coroutine( self._controller.zones.disable(self.entity_description.uid) ), ] await asyncio.gather(*tasks) async def async_turn_on(self, **kwargs: Any) -> None: """Enable the zone.""" await self._async_run_api_coroutine( self._controller.zones.enable(self.entity_description.uid) )