core/homeassistant/components/venstar/sensor.py

136 lines
3.9 KiB
Python

"""Representation of Venstar sensors."""
from __future__ import annotations
from dataclasses import dataclass
from homeassistant.components.sensor import (
DEVICE_CLASS_HUMIDITY,
DEVICE_CLASS_TEMPERATURE,
STATE_CLASS_MEASUREMENT,
SensorEntity,
SensorEntityDescription,
)
from homeassistant.config_entries import ConfigEntry
from homeassistant.const import PERCENTAGE, TEMP_CELSIUS, TEMP_FAHRENHEIT
from homeassistant.helpers.entity import Entity
from . import VenstarDataUpdateCoordinator, VenstarEntity
from .const import DOMAIN
@dataclass
class VenstarSensorTypeMixin:
"""Mixin for sensor required keys."""
cls: type[VenstarSensor]
stype: str
@dataclass
class VenstarSensorEntityDescription(SensorEntityDescription, VenstarSensorTypeMixin):
"""Base description of a Sensor entity."""
async def async_setup_entry(hass, config_entry, async_add_entities) -> None:
"""Set up Vensar device binary_sensors based on a config entry."""
coordinator = hass.data[DOMAIN][config_entry.entry_id]
entities: list[Entity] = []
sensors = coordinator.client.get_sensor_list()
if not sensors:
return
entities = []
for sensor_name in sensors:
entities.extend(
[
description.cls(coordinator, config_entry, description, sensor_name)
for description in SENSOR_ENTITIES
if coordinator.client.get_sensor(sensor_name, description.stype)
is not None
]
)
async_add_entities(entities)
class VenstarSensor(VenstarEntity, SensorEntity):
"""Base class for a Venstar sensor."""
entity_description: VenstarSensorEntityDescription
def __init__(
self,
coordinator: VenstarDataUpdateCoordinator,
config: ConfigEntry,
entity_description: VenstarSensorEntityDescription,
sensor_name: str,
) -> None:
"""Initialize the sensor."""
super().__init__(coordinator, config)
self.entity_description = entity_description
self.sensor_name = sensor_name
self._config = config
@property
def unique_id(self):
"""Return the unique id."""
return f"{self._config.entry_id}_{self.sensor_name.replace(' ', '_')}_{self.entity_description.key}"
class VenstarHumiditySensor(VenstarSensor):
"""Represent a Venstar humidity sensor."""
@property
def name(self):
"""Return the name of the device."""
return f"{self._client.name} {self.sensor_name} Humidity"
@property
def native_value(self) -> int:
"""Return state of the sensor."""
return self._client.get_sensor(self.sensor_name, "hum")
class VenstarTemperatureSensor(VenstarSensor):
"""Represent a Venstar temperature sensor."""
@property
def name(self):
"""Return the name of the device."""
return (
f"{self._client.name} {self.sensor_name.replace(' Temp', '')} Temperature"
)
@property
def native_unit_of_measurement(self) -> str:
"""Return unit of measurement the value is expressed in."""
if self._client.tempunits == self._client.TEMPUNITS_F:
return TEMP_FAHRENHEIT
return TEMP_CELSIUS
@property
def native_value(self) -> float:
"""Return state of the sensor."""
return round(float(self._client.get_sensor(self.sensor_name, "temp")), 1)
SENSOR_ENTITIES: tuple[VenstarSensorEntityDescription, ...] = (
VenstarSensorEntityDescription(
key="humidity",
device_class=DEVICE_CLASS_HUMIDITY,
state_class=STATE_CLASS_MEASUREMENT,
native_unit_of_measurement=PERCENTAGE,
cls=VenstarHumiditySensor,
stype="hum",
),
VenstarSensorEntityDescription(
key="temperature",
device_class=DEVICE_CLASS_TEMPERATURE,
state_class=STATE_CLASS_MEASUREMENT,
cls=VenstarTemperatureSensor,
stype="temp",
),
)