evlli/hass-core
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add entity services to the Hydrawise integration (#120883)

Browse source 
* Add services to the Hydrawise integration

* Add validation of duration ranges

* Remove clamping test

* Fix duration type in test

* Changes requested during review

* Add back the HydrawiseZoneBinarySensor class
This commit is contained in:
David Knowles 2024-07-26 11:25:56 -04:00 • committed by GitHub
parent 49e2bfae31
commit 7820bcf218
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
6 changed files with 210 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

49
homeassistant/components/hydrawise/binary_sensor.py
View file

@ -4,6 +4,10 @@ from __future__ import annotations
from collections.abc import Callable
from dataclasses import dataclass
from datetime import datetime
from pydrawise import Zone
import voluptuous as vol
from homeassistant.components.binary_sensor import (
BinarySensorDeviceClass,
@ -12,9 +16,11 @@ from homeassistant.components.binary_sensor import (
)
from homeassistant.config_entries import ConfigEntry
from homeassistant.core import HomeAssistant
from homeassistant.helpers import config_validation as cv, entity_platform
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.helpers.typing import VolDictType
from .const import DOMAIN
from .const import DOMAIN, SERVICE_RESUME, SERVICE_START_WATERING, SERVICE_SUSPEND
from .coordinator import HydrawiseDataUpdateCoordinator
from .entity import HydrawiseEntity
@ -61,6 +67,13 @@ ZONE_BINARY_SENSORS: tuple[HydrawiseBinarySensorEntityDescription, ...] = (
),
)
SCHEMA_START_WATERING: VolDictType = {
vol.Optional("duration"): vol.All(vol.Coerce(int), vol.Range(min=0, max=90)),
}
SCHEMA_SUSPEND: VolDictType = {
vol.Required("until"): cv.datetime,
}
async def async_setup_entry(
hass: HomeAssistant,
@ -89,11 +102,19 @@ async def async_setup_entry(
if "rain sensor" in sensor.model.name.lower()
)
entities.extend(
HydrawiseBinarySensor(coordinator, description, controller, zone_id=zone.id)
HydrawiseZoneBinarySensor(
coordinator, description, controller, zone_id=zone.id
)
for zone in controller.zones
for description in ZONE_BINARY_SENSORS
)
async_add_entities(entities)
platform = entity_platform.async_get_current_platform()
platform.async_register_entity_service(SERVICE_RESUME, {}, "resume")
platform.async_register_entity_service(
SERVICE_START_WATERING, SCHEMA_START_WATERING, "start_watering"
)
platform.async_register_entity_service(SERVICE_SUSPEND, SCHEMA_SUSPEND, "suspend")
class HydrawiseBinarySensor(HydrawiseEntity, BinarySensorEntity):
@ -111,3 +132,27 @@ class HydrawiseBinarySensor(HydrawiseEntity, BinarySensorEntity):
if self.entity_description.always_available:
return True
return super().available
class HydrawiseZoneBinarySensor(HydrawiseBinarySensor):
"""A binary sensor for a Hydrawise irrigation zone.
This is only used for irrigation zones, as they have special methods for
service actions that don't apply to other binary sensors.
"""
zone: Zone
async def start_watering(self, duration: int | None = None) -> None:
"""Start watering in the irrigation zone."""
await self.coordinator.api.start_zone(
self.zone, custom_run_duration=int((duration or 0) * 60)
)
async def suspend(self, until: datetime) -> None:
"""Suspend automatic watering in the irrigation zone."""
await self.coordinator.api.suspend_zone(self.zone, until=until)
async def resume(self) -> None:
"""Resume automatic watering in the irrigation zone."""
await self.coordinator.api.resume_zone(self.zone)