Use EntityDescription - Vallox (#54891)
Co-authored-by: Joakim Sørensen <hi@ludeeus.dev>pull/55137/head
Andre Richter
GitHub
parent
58f170ba45
commit
a08f42e516
|
|
@ -1,9 +1,15 @@
|
|||
"""Support for Vallox ventilation unit sensors."""
|
||||
from __future__ import annotations
|
||||
|
||||
from dataclasses import dataclass
|
||||
from datetime import datetime, timedelta
|
||||
import logging
|
||||
|
||||
from homeassistant.components.sensor import STATE_CLASS_MEASUREMENT, SensorEntity
|
||||
from homeassistant.components.sensor import (
|
||||
STATE_CLASS_MEASUREMENT,
|
||||
SensorEntity,
|
||||
SensorEntityDescription,
|
||||
)
|
||||
from homeassistant.const import (
|
||||
CONCENTRATION_PARTS_PER_MILLION,
|
||||
DEVICE_CLASS_CO2,
|
||||
|
|
@ -16,175 +22,30 @@ from homeassistant.const import (
|
|||
from homeassistant.core import callback
|
||||
from homeassistant.helpers.dispatcher import async_dispatcher_connect
|
||||
|
||||
from . import DOMAIN, METRIC_KEY_MODE, SIGNAL_VALLOX_STATE_UPDATE
|
||||
from . import DOMAIN, METRIC_KEY_MODE, SIGNAL_VALLOX_STATE_UPDATE, ValloxStateProxy
|
||||
|
||||
_LOGGER = logging.getLogger(__name__)
|
||||
|
||||
|
||||
async def async_setup_platform(hass, config, async_add_entities, discovery_info=None):
|
||||
"""Set up the sensors."""
|
||||
if discovery_info is None:
|
||||
return
|
||||
|
||||
name = hass.data[DOMAIN]["name"]
|
||||
state_proxy = hass.data[DOMAIN]["state_proxy"]
|
||||
|
||||
sensors = [
|
||||
ValloxProfileSensor(
|
||||
name=f"{name} Current Profile",
|
||||
state_proxy=state_proxy,
|
||||
device_class=None,
|
||||
unit_of_measurement=None,
|
||||
icon="mdi:gauge",
|
||||
),
|
||||
ValloxFanSpeedSensor(
|
||||
name=f"{name} Fan Speed",
|
||||
state_proxy=state_proxy,
|
||||
metric_key="A_CYC_FAN_SPEED",
|
||||
device_class=None,
|
||||
unit_of_measurement=PERCENTAGE,
|
||||
icon="mdi:fan",
|
||||
state_class=STATE_CLASS_MEASUREMENT,
|
||||
),
|
||||
ValloxSensor(
|
||||
name=f"{name} Extract Air",
|
||||
state_proxy=state_proxy,
|
||||
metric_key="A_CYC_TEMP_EXTRACT_AIR",
|
||||
device_class=DEVICE_CLASS_TEMPERATURE,
|
||||
unit_of_measurement=TEMP_CELSIUS,
|
||||
icon=None,
|
||||
state_class=STATE_CLASS_MEASUREMENT,
|
||||
),
|
||||
ValloxSensor(
|
||||
name=f"{name} Exhaust Air",
|
||||
state_proxy=state_proxy,
|
||||
metric_key="A_CYC_TEMP_EXHAUST_AIR",
|
||||
device_class=DEVICE_CLASS_TEMPERATURE,
|
||||
unit_of_measurement=TEMP_CELSIUS,
|
||||
icon=None,
|
||||
state_class=STATE_CLASS_MEASUREMENT,
|
||||
),
|
||||
ValloxSensor(
|
||||
name=f"{name} Outdoor Air",
|
||||
state_proxy=state_proxy,
|
||||
metric_key="A_CYC_TEMP_OUTDOOR_AIR",
|
||||
device_class=DEVICE_CLASS_TEMPERATURE,
|
||||
unit_of_measurement=TEMP_CELSIUS,
|
||||
icon=None,
|
||||
state_class=STATE_CLASS_MEASUREMENT,
|
||||
),
|
||||
ValloxSensor(
|
||||
name=f"{name} Supply Air",
|
||||
state_proxy=state_proxy,
|
||||
metric_key="A_CYC_TEMP_SUPPLY_AIR",
|
||||
device_class=DEVICE_CLASS_TEMPERATURE,
|
||||
unit_of_measurement=TEMP_CELSIUS,
|
||||
icon=None,
|
||||
state_class=STATE_CLASS_MEASUREMENT,
|
||||
),
|
||||
ValloxSensor(
|
||||
name=f"{name} Humidity",
|
||||
state_proxy=state_proxy,
|
||||
metric_key="A_CYC_RH_VALUE",
|
||||
device_class=DEVICE_CLASS_HUMIDITY,
|
||||
unit_of_measurement=PERCENTAGE,
|
||||
icon=None,
|
||||
state_class=STATE_CLASS_MEASUREMENT,
|
||||
),
|
||||
ValloxFilterRemainingSensor(
|
||||
name=f"{name} Remaining Time For Filter",
|
||||
state_proxy=state_proxy,
|
||||
metric_key="A_CYC_REMAINING_TIME_FOR_FILTER",
|
||||
device_class=DEVICE_CLASS_TIMESTAMP,
|
||||
unit_of_measurement=None,
|
||||
icon="mdi:filter",
|
||||
),
|
||||
ValloxSensor(
|
||||
name=f"{name} Efficiency",
|
||||
state_proxy=state_proxy,
|
||||
metric_key="A_CYC_EXTRACT_EFFICIENCY",
|
||||
device_class=None,
|
||||
unit_of_measurement=PERCENTAGE,
|
||||
icon="mdi:gauge",
|
||||
state_class=STATE_CLASS_MEASUREMENT,
|
||||
),
|
||||
ValloxSensor(
|
||||
name=f"{name} CO2",
|
||||
state_proxy=state_proxy,
|
||||
metric_key="A_CYC_CO2_VALUE",
|
||||
device_class=DEVICE_CLASS_CO2,
|
||||
unit_of_measurement=CONCENTRATION_PARTS_PER_MILLION,
|
||||
icon=None,
|
||||
state_class=STATE_CLASS_MEASUREMENT,
|
||||
),
|
||||
]
|
||||
|
||||
async_add_entities(sensors, update_before_add=False)
|
||||
|
||||
|
||||
class ValloxSensor(SensorEntity):
|
||||
"""Representation of a Vallox sensor."""
|
||||
|
||||
_attr_should_poll = False
|
||||
entity_description: ValloxSensorEntityDescription
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
name,
|
||||
state_proxy,
|
||||
metric_key,
|
||||
device_class,
|
||||
unit_of_measurement,
|
||||
icon,
|
||||
state_class=None,
|
||||
name: str,
|
||||
state_proxy: ValloxStateProxy,
|
||||
description: ValloxSensorEntityDescription,
|
||||
) -> None:
|
||||
"""Initialize the Vallox sensor."""
|
||||
self._name = name
|
||||
self._state_proxy = state_proxy
|
||||
self._metric_key = metric_key
|
||||
self._device_class = device_class
|
||||
self._state_class = state_class
|
||||
self._unit_of_measurement = unit_of_measurement
|
||||
self._icon = icon
|
||||
self._available = None
|
||||
self._state = None
|
||||
|
||||
@property
|
||||
def should_poll(self):
|
||||
"""Do not poll the device."""
|
||||
return False
|
||||
self.entity_description = description
|
||||
|
||||
@property
|
||||
def name(self):
|
||||
"""Return the name."""
|
||||
return self._name
|
||||
|
||||
@property
|
||||
def native_unit_of_measurement(self):
|
||||
"""Return the unit of measurement."""
|
||||
return self._unit_of_measurement
|
||||
|
||||
@property
|
||||
def device_class(self):
|
||||
"""Return the device class."""
|
||||
return self._device_class
|
||||
|
||||
@property
|
||||
def state_class(self):
|
||||
"""Return the state class."""
|
||||
return self._state_class
|
||||
|
||||
@property
|
||||
def icon(self):
|
||||
"""Return the icon."""
|
||||
return self._icon
|
||||
|
||||
@property
|
||||
def available(self):
|
||||
"""Return true when state is known."""
|
||||
return self._available
|
||||
|
||||
@property
|
||||
def native_value(self):
|
||||
"""Return the state."""
|
||||
return self._state
|
||||
self._attr_name = f"{name} {description.name}"
|
||||
self._attr_available = False
|
||||
|
||||
async def async_added_to_hass(self):
|
||||
"""Call to update."""
|
||||
|
|
@ -202,11 +63,27 @@ class ValloxSensor(SensorEntity):
|
|||
async def async_update(self):
|
||||
"""Fetch state from the ventilation unit."""
|
||||
try:
|
||||
self._state = self._state_proxy.fetch_metric(self._metric_key)
|
||||
self._available = True
|
||||
self._attr_native_value = self._state_proxy.fetch_metric(
|
||||
self.entity_description.metric_key
|
||||
)
|
||||
self._attr_available = True
|
||||
|
||||
except (OSError, KeyError) as err:
|
||||
self._available = False
|
||||
self._attr_available = False
|
||||
_LOGGER.error("Error updating sensor: %s", err)
|
||||
|
||||
|
||||
class ValloxProfileSensor(ValloxSensor):
|
||||
"""Child class for profile reporting."""
|
||||
|
||||
async def async_update(self):
|
||||
"""Fetch state from the ventilation unit."""
|
||||
try:
|
||||
self._attr_native_value = self._state_proxy.get_profile()
|
||||
self._attr_available = True
|
||||
|
||||
except OSError as err:
|
||||
self._attr_available = False
|
||||
_LOGGER.error("Error updating sensor: %s", err)
|
||||
|
||||
|
||||
|
|
@ -228,33 +105,11 @@ class ValloxFanSpeedSensor(ValloxSensor):
|
|||
await super().async_update()
|
||||
else:
|
||||
# Report zero percent otherwise.
|
||||
self._state = 0
|
||||
self._available = True
|
||||
self._attr_native_value = 0
|
||||
self._attr_available = True
|
||||
|
||||
except (OSError, KeyError) as err:
|
||||
self._available = False
|
||||
_LOGGER.error("Error updating sensor: %s", err)
|
||||
|
||||
|
||||
class ValloxProfileSensor(ValloxSensor):
|
||||
"""Child class for profile reporting."""
|
||||
|
||||
def __init__(
|
||||
self, name, state_proxy, device_class, unit_of_measurement, icon
|
||||
) -> None:
|
||||
"""Initialize the Vallox sensor."""
|
||||
super().__init__(
|
||||
name, state_proxy, None, device_class, unit_of_measurement, icon
|
||||
)
|
||||
|
||||
async def async_update(self):
|
||||
"""Fetch state from the ventilation unit."""
|
||||
try:
|
||||
self._state = self._state_proxy.get_profile()
|
||||
self._available = True
|
||||
|
||||
except OSError as err:
|
||||
self._available = False
|
||||
self._attr_available = False
|
||||
_LOGGER.error("Error updating sensor: %s", err)
|
||||
|
||||
|
||||
|
|
@ -264,16 +119,125 @@ class ValloxFilterRemainingSensor(ValloxSensor):
|
|||
async def async_update(self):
|
||||
"""Fetch state from the ventilation unit."""
|
||||
try:
|
||||
days_remaining = int(self._state_proxy.fetch_metric(self._metric_key))
|
||||
days_remaining = int(
|
||||
self._state_proxy.fetch_metric(self.entity_description.metric_key)
|
||||
)
|
||||
days_remaining_delta = timedelta(days=days_remaining)
|
||||
|
||||
# Since only a delta of days is received from the device, fix the
|
||||
# time so the timestamp does not change with every update.
|
||||
now = datetime.utcnow().replace(hour=13, minute=0, second=0, microsecond=0)
|
||||
|
||||
self._state = (now + days_remaining_delta).isoformat()
|
||||
self._available = True
|
||||
self._attr_native_value = (now + days_remaining_delta).isoformat()
|
||||
self._attr_available = True
|
||||
|
||||
except (OSError, KeyError) as err:
|
||||
self._available = False
|
||||
self._attr_available = False
|
||||
_LOGGER.error("Error updating sensor: %s", err)
|
||||
|
||||
|
||||
@dataclass
|
||||
class ValloxSensorEntityDescription(SensorEntityDescription):
|
||||
"""Describes Vallox sensor entity."""
|
||||
|
||||
metric_key: str | None = None
|
||||
sensor_type: type[ValloxSensor] = ValloxSensor
|
||||
|
||||
|
||||
SENSORS: tuple[ValloxSensorEntityDescription, ...] = (
|
||||
ValloxSensorEntityDescription(
|
||||
key="current_profile",
|
||||
name="Current Profile",
|
||||
icon="mdi:gauge",
|
||||
sensor_type=ValloxProfileSensor,
|
||||
),
|
||||
ValloxSensorEntityDescription(
|
||||
key="fan_speed",
|
||||
name="Fan Speed",
|
||||
metric_key="A_CYC_FAN_SPEED",
|
||||
icon="mdi:fan",
|
||||
state_class=STATE_CLASS_MEASUREMENT,
|
||||
native_unit_of_measurement=PERCENTAGE,
|
||||
sensor_type=ValloxFanSpeedSensor,
|
||||
),
|
||||
ValloxSensorEntityDescription(
|
||||
key="remaining_time_for_filter",
|
||||
name="Remaining Time For Filter",
|
||||
metric_key="A_CYC_REMAINING_TIME_FOR_FILTER",
|
||||
device_class=DEVICE_CLASS_TIMESTAMP,
|
||||
sensor_type=ValloxFilterRemainingSensor,
|
||||
),
|
||||
ValloxSensorEntityDescription(
|
||||
key="extract_air",
|
||||
name="Extract Air",
|
||||
metric_key="A_CYC_TEMP_EXTRACT_AIR",
|
||||
device_class=DEVICE_CLASS_TEMPERATURE,
|
||||
state_class=STATE_CLASS_MEASUREMENT,
|
||||
native_unit_of_measurement=TEMP_CELSIUS,
|
||||
),
|
||||
ValloxSensorEntityDescription(
|
||||
key="exhaust_air",
|
||||
name="Exhaust Air",
|
||||
metric_key="A_CYC_TEMP_EXHAUST_AIR",
|
||||
device_class=DEVICE_CLASS_TEMPERATURE,
|
||||
state_class=STATE_CLASS_MEASUREMENT,
|
||||
native_unit_of_measurement=TEMP_CELSIUS,
|
||||
),
|
||||
ValloxSensorEntityDescription(
|
||||
key="outdoor_air",
|
||||
name="Outdoor Air",
|
||||
metric_key="A_CYC_TEMP_OUTDOOR_AIR",
|
||||
device_class=DEVICE_CLASS_TEMPERATURE,
|
||||
state_class=STATE_CLASS_MEASUREMENT,
|
||||
native_unit_of_measurement=TEMP_CELSIUS,
|
||||
),
|
||||
ValloxSensorEntityDescription(
|
||||
key="supply_air",
|
||||
name="Supply Air",
|
||||
metric_key="A_CYC_TEMP_SUPPLY_AIR",
|
||||
device_class=DEVICE_CLASS_TEMPERATURE,
|
||||
state_class=STATE_CLASS_MEASUREMENT,
|
||||
native_unit_of_measurement=TEMP_CELSIUS,
|
||||
),
|
||||
ValloxSensorEntityDescription(
|
||||
key="humidity",
|
||||
name="Humidity",
|
||||
metric_key="A_CYC_RH_VALUE",
|
||||
device_class=DEVICE_CLASS_HUMIDITY,
|
||||
state_class=STATE_CLASS_MEASUREMENT,
|
||||
native_unit_of_measurement=PERCENTAGE,
|
||||
),
|
||||
ValloxSensorEntityDescription(
|
||||
key="efficiency",
|
||||
name="Efficiency",
|
||||
metric_key="A_CYC_EXTRACT_EFFICIENCY",
|
||||
icon="mdi:gauge",
|
||||
state_class=STATE_CLASS_MEASUREMENT,
|
||||
native_unit_of_measurement=PERCENTAGE,
|
||||
),
|
||||
ValloxSensorEntityDescription(
|
||||
key="co2",
|
||||
name="CO2",
|
||||
metric_key="A_CYC_CO2_VALUE",
|
||||
device_class=DEVICE_CLASS_CO2,
|
||||
state_class=STATE_CLASS_MEASUREMENT,
|
||||
native_unit_of_measurement=CONCENTRATION_PARTS_PER_MILLION,
|
||||
),
|
||||
)
|
||||
|
||||
|
||||
async def async_setup_platform(hass, config, async_add_entities, discovery_info=None):
|
||||
"""Set up the sensors."""
|
||||
if discovery_info is None:
|
||||
return
|
||||
|
||||
name = hass.data[DOMAIN]["name"]
|
||||
state_proxy = hass.data[DOMAIN]["state_proxy"]
|
||||
|
||||
async_add_entities(
|
||||
[
|
||||
description.sensor_type(name, state_proxy, description)
|
||||
for description in SENSORS
|
||||
],
|
||||
update_before_add=False,
|
||||
)
|
||||
|
|
|
|||
Loading…
Reference in New Issue