mirror of https://github.com/home-assistant/core
365 lines
13 KiB
Python
365 lines
13 KiB
Python
"""This platform provides support for sensor data from RainMachine."""
|
|
from __future__ import annotations
|
|
|
|
from dataclasses import dataclass
|
|
from datetime import datetime, timedelta
|
|
from typing import Any, cast
|
|
|
|
from homeassistant.components.sensor import (
|
|
DOMAIN as SENSOR_DOMAIN,
|
|
RestoreSensor,
|
|
SensorDeviceClass,
|
|
SensorEntity,
|
|
SensorEntityDescription,
|
|
SensorStateClass,
|
|
)
|
|
from homeassistant.config_entries import ConfigEntry
|
|
from homeassistant.const import VOLUME_CUBIC_METERS, VOLUME_LITERS
|
|
from homeassistant.core import HomeAssistant, callback
|
|
from homeassistant.helpers.entity import EntityCategory
|
|
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
|
from homeassistant.util.dt import utc_from_timestamp, utcnow
|
|
|
|
from . import RainMachineData, RainMachineEntity
|
|
from .const import DATA_PROGRAMS, DATA_PROVISION_SETTINGS, DATA_ZONES, DOMAIN
|
|
from .model import (
|
|
RainMachineEntityDescription,
|
|
RainMachineEntityDescriptionMixinDataKey,
|
|
RainMachineEntityDescriptionMixinUid,
|
|
)
|
|
from .util import (
|
|
RUN_STATE_MAP,
|
|
EntityDomainReplacementStrategy,
|
|
RunStates,
|
|
async_finish_entity_domain_replacements,
|
|
key_exists,
|
|
)
|
|
|
|
DEFAULT_ZONE_COMPLETION_TIME_WOBBLE_TOLERANCE = timedelta(seconds=5)
|
|
|
|
TYPE_FLOW_SENSOR_CLICK_M3 = "flow_sensor_clicks_cubic_meter"
|
|
TYPE_FLOW_SENSOR_CONSUMED_LITERS = "flow_sensor_consumed_liters"
|
|
TYPE_FLOW_SENSOR_LEAK_CLICKS = "flow_sensor_leak_clicks"
|
|
TYPE_FLOW_SENSOR_LEAK_VOLUME = "flow_sensor_leak_volume"
|
|
TYPE_FLOW_SENSOR_START_INDEX = "flow_sensor_start_index"
|
|
TYPE_FLOW_SENSOR_WATERING_CLICKS = "flow_sensor_watering_clicks"
|
|
TYPE_LAST_LEAK_DETECTED = "last_leak_detected"
|
|
TYPE_PROGRAM_RUN_COMPLETION_TIME = "program_run_completion_time"
|
|
TYPE_RAIN_SENSOR_RAIN_START = "rain_sensor_rain_start"
|
|
TYPE_ZONE_RUN_COMPLETION_TIME = "zone_run_completion_time"
|
|
|
|
|
|
@dataclass
|
|
class RainMachineSensorDataDescription(
|
|
SensorEntityDescription,
|
|
RainMachineEntityDescription,
|
|
RainMachineEntityDescriptionMixinDataKey,
|
|
):
|
|
"""Describe a RainMachine sensor."""
|
|
|
|
|
|
@dataclass
|
|
class RainMachineSensorCompletionTimerDescription(
|
|
SensorEntityDescription,
|
|
RainMachineEntityDescription,
|
|
RainMachineEntityDescriptionMixinUid,
|
|
):
|
|
"""Describe a RainMachine completion timer sensor."""
|
|
|
|
|
|
SENSOR_DESCRIPTIONS = (
|
|
RainMachineSensorDataDescription(
|
|
key=TYPE_FLOW_SENSOR_CLICK_M3,
|
|
name="Flow sensor clicks per cubic meter",
|
|
icon="mdi:water-pump",
|
|
native_unit_of_measurement=f"clicks/{VOLUME_CUBIC_METERS}",
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
entity_registry_enabled_default=False,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
api_category=DATA_PROVISION_SETTINGS,
|
|
data_key="flowSensorClicksPerCubicMeter",
|
|
),
|
|
RainMachineSensorDataDescription(
|
|
key=TYPE_FLOW_SENSOR_CONSUMED_LITERS,
|
|
name="Flow sensor consumed liters",
|
|
icon="mdi:water-pump",
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
native_unit_of_measurement=VOLUME_LITERS,
|
|
entity_registry_enabled_default=False,
|
|
state_class=SensorStateClass.TOTAL_INCREASING,
|
|
api_category=DATA_PROVISION_SETTINGS,
|
|
data_key="flowSensorWateringClicks",
|
|
),
|
|
RainMachineSensorDataDescription(
|
|
key=TYPE_FLOW_SENSOR_LEAK_CLICKS,
|
|
name="Flow sensor leak clicks",
|
|
icon="mdi:pipe-leak",
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
native_unit_of_measurement="clicks",
|
|
entity_registry_enabled_default=False,
|
|
state_class=SensorStateClass.TOTAL_INCREASING,
|
|
api_category=DATA_PROVISION_SETTINGS,
|
|
data_key="flowSensorLeakClicks",
|
|
),
|
|
RainMachineSensorDataDescription(
|
|
key=TYPE_FLOW_SENSOR_LEAK_VOLUME,
|
|
name="Flow sensor leak volume",
|
|
icon="mdi:pipe-leak",
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
native_unit_of_measurement=VOLUME_LITERS,
|
|
entity_registry_enabled_default=False,
|
|
state_class=SensorStateClass.TOTAL_INCREASING,
|
|
api_category=DATA_PROVISION_SETTINGS,
|
|
data_key="flowSensorLeakClicks",
|
|
),
|
|
RainMachineSensorDataDescription(
|
|
key=TYPE_FLOW_SENSOR_START_INDEX,
|
|
name="Flow sensor start index",
|
|
icon="mdi:water-pump",
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
native_unit_of_measurement="index",
|
|
entity_registry_enabled_default=False,
|
|
api_category=DATA_PROVISION_SETTINGS,
|
|
data_key="flowSensorStartIndex",
|
|
),
|
|
RainMachineSensorDataDescription(
|
|
key=TYPE_FLOW_SENSOR_WATERING_CLICKS,
|
|
name="Flow sensor clicks",
|
|
icon="mdi:water-pump",
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
native_unit_of_measurement="clicks",
|
|
entity_registry_enabled_default=False,
|
|
state_class=SensorStateClass.TOTAL_INCREASING,
|
|
api_category=DATA_PROVISION_SETTINGS,
|
|
data_key="flowSensorWateringClicks",
|
|
),
|
|
RainMachineSensorDataDescription(
|
|
key=TYPE_LAST_LEAK_DETECTED,
|
|
name="Last leak detected",
|
|
icon="mdi:pipe-leak",
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
entity_registry_enabled_default=False,
|
|
device_class=SensorDeviceClass.TIMESTAMP,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
api_category=DATA_PROVISION_SETTINGS,
|
|
data_key="lastLeakDetected",
|
|
),
|
|
RainMachineSensorDataDescription(
|
|
key=TYPE_RAIN_SENSOR_RAIN_START,
|
|
name="Rain sensor rain start",
|
|
icon="mdi:weather-pouring",
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
entity_registry_enabled_default=False,
|
|
device_class=SensorDeviceClass.TIMESTAMP,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
api_category=DATA_PROVISION_SETTINGS,
|
|
data_key="rainSensorRainStart",
|
|
),
|
|
)
|
|
|
|
|
|
async def async_setup_entry(
|
|
hass: HomeAssistant, entry: ConfigEntry, async_add_entities: AddEntitiesCallback
|
|
) -> None:
|
|
"""Set up RainMachine sensors based on a config entry."""
|
|
data: RainMachineData = hass.data[DOMAIN][entry.entry_id]
|
|
|
|
async_finish_entity_domain_replacements(
|
|
hass,
|
|
entry,
|
|
(
|
|
EntityDomainReplacementStrategy(
|
|
SENSOR_DOMAIN,
|
|
f"{data.controller.mac}_freeze_protect_temp",
|
|
f"select.{data.controller.name.lower()}_freeze_protect_temperature",
|
|
breaks_in_ha_version="2022.12.0",
|
|
remove_old_entity=True,
|
|
),
|
|
),
|
|
)
|
|
|
|
api_category_sensor_map = {
|
|
DATA_PROVISION_SETTINGS: ProvisionSettingsSensor,
|
|
}
|
|
|
|
sensors: list[ProvisionSettingsSensor | TimeRemainingSensor] = [
|
|
api_category_sensor_map[description.api_category](entry, data, description)
|
|
for description in SENSOR_DESCRIPTIONS
|
|
if (
|
|
(coordinator := data.coordinators[description.api_category]) is not None
|
|
and coordinator.data
|
|
and key_exists(coordinator.data, description.data_key)
|
|
)
|
|
]
|
|
|
|
program_coordinator = data.coordinators[DATA_PROGRAMS]
|
|
zone_coordinator = data.coordinators[DATA_ZONES]
|
|
|
|
for uid, program in program_coordinator.data.items():
|
|
sensors.append(
|
|
ProgramTimeRemainingSensor(
|
|
entry,
|
|
data,
|
|
RainMachineSensorCompletionTimerDescription(
|
|
key=f"{TYPE_PROGRAM_RUN_COMPLETION_TIME}_{uid}",
|
|
name=f"{program['name']} Run Completion Time",
|
|
device_class=SensorDeviceClass.TIMESTAMP,
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
api_category=DATA_PROGRAMS,
|
|
uid=uid,
|
|
),
|
|
)
|
|
)
|
|
|
|
for uid, zone in zone_coordinator.data.items():
|
|
sensors.append(
|
|
ZoneTimeRemainingSensor(
|
|
entry,
|
|
data,
|
|
RainMachineSensorCompletionTimerDescription(
|
|
key=f"{TYPE_ZONE_RUN_COMPLETION_TIME}_{uid}",
|
|
name=f"{zone['name']} Run Completion Time",
|
|
device_class=SensorDeviceClass.TIMESTAMP,
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
api_category=DATA_ZONES,
|
|
uid=uid,
|
|
),
|
|
)
|
|
)
|
|
|
|
async_add_entities(sensors)
|
|
|
|
|
|
class TimeRemainingSensor(RainMachineEntity, RestoreSensor):
|
|
"""Define a sensor that shows the amount of time remaining for an activity."""
|
|
|
|
entity_description: RainMachineSensorCompletionTimerDescription
|
|
|
|
def __init__(
|
|
self,
|
|
entry: ConfigEntry,
|
|
data: RainMachineData,
|
|
description: RainMachineSensorCompletionTimerDescription,
|
|
) -> None:
|
|
"""Initialize."""
|
|
super().__init__(entry, data, description)
|
|
|
|
self._current_run_state: RunStates | None = None
|
|
self._previous_run_state: RunStates | None = None
|
|
|
|
@property
|
|
def activity_data(self) -> dict[str, Any]:
|
|
"""Return the core data for this entity."""
|
|
return cast(dict[str, Any], self.coordinator.data[self.entity_description.uid])
|
|
|
|
@property
|
|
def status_key(self) -> str:
|
|
"""Return the data key that contains the activity status."""
|
|
return "state"
|
|
|
|
async def async_added_to_hass(self) -> None:
|
|
"""Handle entity which will be added."""
|
|
if restored_data := await self.async_get_last_sensor_data():
|
|
self._attr_native_value = restored_data.native_value
|
|
await super().async_added_to_hass()
|
|
|
|
def calculate_seconds_remaining(self) -> int:
|
|
"""Calculate the number of seconds remaining."""
|
|
raise NotImplementedError
|
|
|
|
@callback
|
|
def update_from_latest_data(self) -> None:
|
|
"""Update the state."""
|
|
self._previous_run_state = self._current_run_state
|
|
self._current_run_state = RUN_STATE_MAP.get(self.activity_data[self.status_key])
|
|
|
|
now = utcnow()
|
|
|
|
if (
|
|
self._current_run_state == RunStates.NOT_RUNNING
|
|
and self._previous_run_state in (RunStates.QUEUED, RunStates.RUNNING)
|
|
):
|
|
# If the activity goes from queued/running to not running, update the
|
|
# state to be right now (i.e., the time the zone stopped running):
|
|
self._attr_native_value = now
|
|
elif self._current_run_state == RunStates.RUNNING:
|
|
seconds_remaining = self.calculate_seconds_remaining()
|
|
new_timestamp = now + timedelta(seconds=seconds_remaining)
|
|
|
|
if (
|
|
isinstance(self._attr_native_value, datetime)
|
|
and new_timestamp - self._attr_native_value
|
|
< DEFAULT_ZONE_COMPLETION_TIME_WOBBLE_TOLERANCE
|
|
):
|
|
# If the deviation between the previous and new timestamps is less
|
|
# than a "wobble tolerance," don't spam the state machine:
|
|
return
|
|
|
|
self._attr_native_value = new_timestamp
|
|
|
|
|
|
class ProgramTimeRemainingSensor(TimeRemainingSensor):
|
|
"""Define a sensor that shows the amount of time remaining for a program."""
|
|
|
|
@property
|
|
def status_key(self) -> str:
|
|
"""Return the data key that contains the activity status."""
|
|
return "status"
|
|
|
|
def calculate_seconds_remaining(self) -> int:
|
|
"""Calculate the number of seconds remaining."""
|
|
return sum(
|
|
self._data.coordinators[DATA_ZONES].data[zone["id"]]["remaining"]
|
|
for zone in [z for z in self.activity_data["wateringTimes"] if z["active"]]
|
|
)
|
|
|
|
|
|
class ProvisionSettingsSensor(RainMachineEntity, SensorEntity):
|
|
"""Define a sensor that handles provisioning data."""
|
|
|
|
entity_description: RainMachineSensorDataDescription
|
|
|
|
@callback
|
|
def update_from_latest_data(self) -> None:
|
|
"""Update the state."""
|
|
system = self.coordinator.data.get("system", {})
|
|
new_value = system.get(self.entity_description.data_key)
|
|
|
|
# Calculate volumetric sensors
|
|
if (
|
|
self.entity_description.key
|
|
in {
|
|
TYPE_FLOW_SENSOR_CONSUMED_LITERS,
|
|
TYPE_FLOW_SENSOR_LEAK_VOLUME,
|
|
}
|
|
and new_value
|
|
):
|
|
if clicks_per_m3 := system.get("flowSensorClicksPerCubicMeter"):
|
|
self._attr_native_value = round((new_value * 1000) / clicks_per_m3, 1)
|
|
return
|
|
|
|
# Convert timestamp sensors to datetime
|
|
if self.entity_description.key in {
|
|
TYPE_LAST_LEAK_DETECTED,
|
|
TYPE_RAIN_SENSOR_RAIN_START,
|
|
}:
|
|
# Timestamp may return 0 instead of null, explicitly set to None
|
|
if new_value:
|
|
self._attr_native_value = utc_from_timestamp(new_value)
|
|
else:
|
|
self._attr_native_value = None
|
|
return
|
|
|
|
# Return all other sensor values or None
|
|
self._attr_native_value = new_value
|
|
|
|
|
|
class ZoneTimeRemainingSensor(TimeRemainingSensor):
|
|
"""Define a sensor that shows the amount of time remaining for a zone."""
|
|
|
|
def calculate_seconds_remaining(self) -> int:
|
|
"""Calculate the number of seconds remaining."""
|
|
return cast(
|
|
int, self.coordinator.data[self.entity_description.uid]["remaining"]
|
|
)
|