403 lines
14 KiB
Python
403 lines
14 KiB
Python
"""Sensor component that handles additional Tomorrowio data for your location."""
|
|
from __future__ import annotations
|
|
|
|
from abc import abstractmethod
|
|
from collections.abc import Callable
|
|
from dataclasses import dataclass
|
|
from typing import Any
|
|
|
|
from pytomorrowio.const import (
|
|
HealthConcernType,
|
|
PollenIndex,
|
|
PrecipitationType,
|
|
PrimaryPollutantType,
|
|
)
|
|
|
|
from homeassistant.components.sensor import (
|
|
SensorDeviceClass,
|
|
SensorEntity,
|
|
SensorEntityDescription,
|
|
)
|
|
from homeassistant.config_entries import ConfigEntry
|
|
from homeassistant.const import (
|
|
CONCENTRATION_MICROGRAMS_PER_CUBIC_METER,
|
|
CONCENTRATION_PARTS_PER_MILLION,
|
|
CONF_API_KEY,
|
|
CONF_NAME,
|
|
PERCENTAGE,
|
|
UnitOfIrradiance,
|
|
UnitOfLength,
|
|
UnitOfPressure,
|
|
UnitOfSpeed,
|
|
UnitOfTemperature,
|
|
)
|
|
from homeassistant.core import HomeAssistant
|
|
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
|
from homeassistant.util import slugify
|
|
from homeassistant.util.unit_conversion import DistanceConverter, SpeedConverter
|
|
from homeassistant.util.unit_system import US_CUSTOMARY_SYSTEM
|
|
|
|
from . import TomorrowioDataUpdateCoordinator, TomorrowioEntity
|
|
from .const import (
|
|
DOMAIN,
|
|
TMRW_ATTR_CARBON_MONOXIDE,
|
|
TMRW_ATTR_CHINA_AQI,
|
|
TMRW_ATTR_CHINA_HEALTH_CONCERN,
|
|
TMRW_ATTR_CHINA_PRIMARY_POLLUTANT,
|
|
TMRW_ATTR_CLOUD_BASE,
|
|
TMRW_ATTR_CLOUD_CEILING,
|
|
TMRW_ATTR_CLOUD_COVER,
|
|
TMRW_ATTR_DEW_POINT,
|
|
TMRW_ATTR_EPA_AQI,
|
|
TMRW_ATTR_EPA_HEALTH_CONCERN,
|
|
TMRW_ATTR_EPA_PRIMARY_POLLUTANT,
|
|
TMRW_ATTR_FEELS_LIKE,
|
|
TMRW_ATTR_FIRE_INDEX,
|
|
TMRW_ATTR_NITROGEN_DIOXIDE,
|
|
TMRW_ATTR_OZONE,
|
|
TMRW_ATTR_PARTICULATE_MATTER_10,
|
|
TMRW_ATTR_PARTICULATE_MATTER_25,
|
|
TMRW_ATTR_POLLEN_GRASS,
|
|
TMRW_ATTR_POLLEN_TREE,
|
|
TMRW_ATTR_POLLEN_WEED,
|
|
TMRW_ATTR_PRECIPITATION_TYPE,
|
|
TMRW_ATTR_PRESSURE_SURFACE_LEVEL,
|
|
TMRW_ATTR_SOLAR_GHI,
|
|
TMRW_ATTR_SULPHUR_DIOXIDE,
|
|
TMRW_ATTR_WIND_GUST,
|
|
)
|
|
|
|
|
|
@dataclass
|
|
class TomorrowioSensorEntityDescription(SensorEntityDescription):
|
|
"""Describes a Tomorrow.io sensor entity."""
|
|
|
|
unit_imperial: str | None = None
|
|
unit_metric: str | None = None
|
|
multiplication_factor: Callable[[float], float] | float | None = None
|
|
imperial_conversion: Callable[[float], float] | float | None = None
|
|
value_map: Any | None = None
|
|
|
|
def __post_init__(self) -> None:
|
|
"""Handle post init."""
|
|
if (self.unit_imperial is None and self.unit_metric is not None) or (
|
|
self.unit_imperial is not None and self.unit_metric is None
|
|
):
|
|
raise ValueError(
|
|
"Entity descriptions must include both imperial and metric units or "
|
|
"they must both be None"
|
|
)
|
|
|
|
|
|
# From https://cfpub.epa.gov/ncer_abstracts/index.cfm/fuseaction/display.files/fileID/14285
|
|
# x ug/m^3 = y ppb * molecular weight / 24.45
|
|
def convert_ppb_to_ugm3(molecular_weight: int | float) -> Callable[[float], float]:
|
|
"""Return function to convert ppb to ug/m^3."""
|
|
return lambda x: (x * molecular_weight) / 24.45
|
|
|
|
|
|
SENSOR_TYPES = (
|
|
TomorrowioSensorEntityDescription(
|
|
key=TMRW_ATTR_FEELS_LIKE,
|
|
name="Feels Like",
|
|
native_unit_of_measurement=UnitOfTemperature.CELSIUS,
|
|
device_class=SensorDeviceClass.TEMPERATURE,
|
|
),
|
|
TomorrowioSensorEntityDescription(
|
|
key=TMRW_ATTR_DEW_POINT,
|
|
name="Dew Point",
|
|
native_unit_of_measurement=UnitOfTemperature.CELSIUS,
|
|
device_class=SensorDeviceClass.TEMPERATURE,
|
|
),
|
|
# Data comes in as hPa
|
|
TomorrowioSensorEntityDescription(
|
|
key=TMRW_ATTR_PRESSURE_SURFACE_LEVEL,
|
|
name="Pressure (Surface Level)",
|
|
native_unit_of_measurement=UnitOfPressure.HPA,
|
|
device_class=SensorDeviceClass.PRESSURE,
|
|
),
|
|
# Data comes in as W/m^2, convert to BTUs/(hr * ft^2) for imperial
|
|
# https://www.theunitconverter.com/watt-square-meter-to-btu-hour-square-foot-conversion/
|
|
TomorrowioSensorEntityDescription(
|
|
key=TMRW_ATTR_SOLAR_GHI,
|
|
name="Global Horizontal Irradiance",
|
|
unit_imperial=UnitOfIrradiance.BTUS_PER_HOUR_SQUARE_FOOT,
|
|
unit_metric=UnitOfIrradiance.WATTS_PER_SQUARE_METER,
|
|
imperial_conversion=(1 / 3.15459),
|
|
device_class=SensorDeviceClass.IRRADIANCE,
|
|
),
|
|
# Data comes in as km, convert to miles for imperial
|
|
TomorrowioSensorEntityDescription(
|
|
key=TMRW_ATTR_CLOUD_BASE,
|
|
name="Cloud Base",
|
|
unit_imperial=UnitOfLength.MILES,
|
|
unit_metric=UnitOfLength.KILOMETERS,
|
|
imperial_conversion=lambda val: DistanceConverter.convert(
|
|
val,
|
|
UnitOfLength.KILOMETERS,
|
|
UnitOfLength.MILES,
|
|
),
|
|
),
|
|
# Data comes in as km, convert to miles for imperial
|
|
TomorrowioSensorEntityDescription(
|
|
key=TMRW_ATTR_CLOUD_CEILING,
|
|
name="Cloud Ceiling",
|
|
unit_imperial=UnitOfLength.MILES,
|
|
unit_metric=UnitOfLength.KILOMETERS,
|
|
imperial_conversion=lambda val: DistanceConverter.convert(
|
|
val,
|
|
UnitOfLength.KILOMETERS,
|
|
UnitOfLength.MILES,
|
|
),
|
|
),
|
|
TomorrowioSensorEntityDescription(
|
|
key=TMRW_ATTR_CLOUD_COVER,
|
|
name="Cloud Cover",
|
|
native_unit_of_measurement=PERCENTAGE,
|
|
),
|
|
# Data comes in as m/s, convert to mi/h for imperial
|
|
TomorrowioSensorEntityDescription(
|
|
key=TMRW_ATTR_WIND_GUST,
|
|
name="Wind Gust",
|
|
unit_imperial=UnitOfSpeed.MILES_PER_HOUR,
|
|
unit_metric=UnitOfSpeed.METERS_PER_SECOND,
|
|
imperial_conversion=lambda val: SpeedConverter.convert(
|
|
val, UnitOfSpeed.METERS_PER_SECOND, UnitOfSpeed.MILES_PER_HOUR
|
|
),
|
|
),
|
|
TomorrowioSensorEntityDescription(
|
|
key=TMRW_ATTR_PRECIPITATION_TYPE,
|
|
name="Precipitation Type",
|
|
value_map=PrecipitationType,
|
|
device_class=SensorDeviceClass.ENUM,
|
|
options=["freezing_rain", "ice_pellets", "none", "rain", "snow"],
|
|
translation_key="precipitation_type",
|
|
icon="mdi:weather-snowy-rainy",
|
|
),
|
|
# Data comes in as ppb, convert to µg/m^3
|
|
# Molecular weight of Ozone is 48
|
|
TomorrowioSensorEntityDescription(
|
|
key=TMRW_ATTR_OZONE,
|
|
name="Ozone",
|
|
native_unit_of_measurement=CONCENTRATION_MICROGRAMS_PER_CUBIC_METER,
|
|
multiplication_factor=convert_ppb_to_ugm3(48),
|
|
device_class=SensorDeviceClass.OZONE,
|
|
),
|
|
TomorrowioSensorEntityDescription(
|
|
key=TMRW_ATTR_PARTICULATE_MATTER_25,
|
|
name="Particulate Matter < 2.5 μm",
|
|
native_unit_of_measurement=CONCENTRATION_MICROGRAMS_PER_CUBIC_METER,
|
|
device_class=SensorDeviceClass.PM25,
|
|
),
|
|
TomorrowioSensorEntityDescription(
|
|
key=TMRW_ATTR_PARTICULATE_MATTER_10,
|
|
name="Particulate Matter < 10 μm",
|
|
native_unit_of_measurement=CONCENTRATION_MICROGRAMS_PER_CUBIC_METER,
|
|
device_class=SensorDeviceClass.PM10,
|
|
),
|
|
# Data comes in as ppb, convert to µg/m^3
|
|
# Molecular weight of Nitrogen Dioxide is 46.01
|
|
TomorrowioSensorEntityDescription(
|
|
key=TMRW_ATTR_NITROGEN_DIOXIDE,
|
|
name="Nitrogen Dioxide",
|
|
native_unit_of_measurement=CONCENTRATION_MICROGRAMS_PER_CUBIC_METER,
|
|
multiplication_factor=convert_ppb_to_ugm3(46.01),
|
|
device_class=SensorDeviceClass.NITROGEN_DIOXIDE,
|
|
),
|
|
# Data comes in as ppb, convert to ppm
|
|
TomorrowioSensorEntityDescription(
|
|
key=TMRW_ATTR_CARBON_MONOXIDE,
|
|
name="Carbon Monoxide",
|
|
native_unit_of_measurement=CONCENTRATION_PARTS_PER_MILLION,
|
|
multiplication_factor=1 / 1000,
|
|
device_class=SensorDeviceClass.CO,
|
|
),
|
|
# Data comes in as ppb, convert to µg/m^3
|
|
# Molecular weight of Sulphur Dioxide is 64.07
|
|
TomorrowioSensorEntityDescription(
|
|
key=TMRW_ATTR_SULPHUR_DIOXIDE,
|
|
name="Sulphur Dioxide",
|
|
native_unit_of_measurement=CONCENTRATION_MICROGRAMS_PER_CUBIC_METER,
|
|
multiplication_factor=convert_ppb_to_ugm3(64.07),
|
|
device_class=SensorDeviceClass.SULPHUR_DIOXIDE,
|
|
),
|
|
TomorrowioSensorEntityDescription(
|
|
key=TMRW_ATTR_EPA_AQI,
|
|
name="US EPA Air Quality Index",
|
|
device_class=SensorDeviceClass.AQI,
|
|
),
|
|
TomorrowioSensorEntityDescription(
|
|
key=TMRW_ATTR_EPA_PRIMARY_POLLUTANT,
|
|
name="US EPA Primary Pollutant",
|
|
value_map=PrimaryPollutantType,
|
|
),
|
|
TomorrowioSensorEntityDescription(
|
|
key=TMRW_ATTR_EPA_HEALTH_CONCERN,
|
|
name="US EPA Health Concern",
|
|
value_map=HealthConcernType,
|
|
device_class=SensorDeviceClass.ENUM,
|
|
options=[
|
|
"good",
|
|
"hazardous",
|
|
"moderate",
|
|
"unhealthy_for_sensitive_groups",
|
|
"unhealthy",
|
|
"very_unhealthy",
|
|
],
|
|
translation_key="health_concern",
|
|
icon="mdi:hospital",
|
|
),
|
|
TomorrowioSensorEntityDescription(
|
|
key=TMRW_ATTR_CHINA_AQI,
|
|
name="China MEP Air Quality Index",
|
|
device_class=SensorDeviceClass.AQI,
|
|
),
|
|
TomorrowioSensorEntityDescription(
|
|
key=TMRW_ATTR_CHINA_PRIMARY_POLLUTANT,
|
|
name="China MEP Primary Pollutant",
|
|
value_map=PrimaryPollutantType,
|
|
),
|
|
TomorrowioSensorEntityDescription(
|
|
key=TMRW_ATTR_CHINA_HEALTH_CONCERN,
|
|
name="China MEP Health Concern",
|
|
value_map=HealthConcernType,
|
|
device_class=SensorDeviceClass.ENUM,
|
|
options=[
|
|
"good",
|
|
"hazardous",
|
|
"moderate",
|
|
"unhealthy_for_sensitive_groups",
|
|
"unhealthy",
|
|
"very_unhealthy",
|
|
],
|
|
translation_key="health_concern",
|
|
icon="mdi:hospital",
|
|
),
|
|
TomorrowioSensorEntityDescription(
|
|
key=TMRW_ATTR_POLLEN_TREE,
|
|
name="Tree Pollen Index",
|
|
value_map=PollenIndex,
|
|
device_class=SensorDeviceClass.ENUM,
|
|
options=["high", "low", "medium", "none", "very_high", "very_low"],
|
|
translation_key="pollen_index",
|
|
icon="mdi:flower-pollen",
|
|
),
|
|
TomorrowioSensorEntityDescription(
|
|
key=TMRW_ATTR_POLLEN_WEED,
|
|
name="Weed Pollen Index",
|
|
value_map=PollenIndex,
|
|
device_class=SensorDeviceClass.ENUM,
|
|
options=["high", "low", "medium", "none", "very_high", "very_low"],
|
|
translation_key="pollen_index",
|
|
icon="mdi:flower-pollen",
|
|
),
|
|
TomorrowioSensorEntityDescription(
|
|
key=TMRW_ATTR_POLLEN_GRASS,
|
|
name="Grass Pollen Index",
|
|
value_map=PollenIndex,
|
|
device_class=SensorDeviceClass.ENUM,
|
|
options=["high", "low", "medium", "none", "very_high", "very_low"],
|
|
translation_key="pollen_index",
|
|
icon="mdi:flower-pollen",
|
|
),
|
|
TomorrowioSensorEntityDescription(
|
|
TMRW_ATTR_FIRE_INDEX,
|
|
name="Fire Index",
|
|
icon="mdi:fire",
|
|
),
|
|
)
|
|
|
|
|
|
async def async_setup_entry(
|
|
hass: HomeAssistant,
|
|
config_entry: ConfigEntry,
|
|
async_add_entities: AddEntitiesCallback,
|
|
) -> None:
|
|
"""Set up a config entry."""
|
|
coordinator = hass.data[DOMAIN][config_entry.data[CONF_API_KEY]]
|
|
entities = [
|
|
TomorrowioSensorEntity(hass, config_entry, coordinator, 4, description)
|
|
for description in SENSOR_TYPES
|
|
]
|
|
async_add_entities(entities)
|
|
|
|
|
|
def handle_conversion(
|
|
value: float | int, conversion: Callable[[float], float] | float
|
|
) -> float:
|
|
"""Handle conversion of a value based on conversion type."""
|
|
if callable(conversion):
|
|
return round(conversion(float(value)), 2)
|
|
|
|
return round(float(value) * conversion, 2)
|
|
|
|
|
|
class BaseTomorrowioSensorEntity(TomorrowioEntity, SensorEntity):
|
|
"""Base Tomorrow.io sensor entity."""
|
|
|
|
entity_description: TomorrowioSensorEntityDescription
|
|
_attr_entity_registry_enabled_default = False
|
|
|
|
def __init__(
|
|
self,
|
|
hass: HomeAssistant,
|
|
config_entry: ConfigEntry,
|
|
coordinator: TomorrowioDataUpdateCoordinator,
|
|
api_version: int,
|
|
description: TomorrowioSensorEntityDescription,
|
|
) -> None:
|
|
"""Initialize Tomorrow.io Sensor Entity."""
|
|
super().__init__(config_entry, coordinator, api_version)
|
|
self.entity_description = description
|
|
self._attr_name = f"{self._config_entry.data[CONF_NAME]} - {description.name}"
|
|
self._attr_unique_id = (
|
|
f"{self._config_entry.unique_id}_{slugify(description.name)}"
|
|
)
|
|
if self.entity_description.native_unit_of_measurement is None:
|
|
self._attr_native_unit_of_measurement = description.unit_metric
|
|
if hass.config.units is US_CUSTOMARY_SYSTEM:
|
|
self._attr_native_unit_of_measurement = description.unit_imperial
|
|
|
|
@property
|
|
@abstractmethod
|
|
def _state(self) -> int | float | None:
|
|
"""Return the raw state."""
|
|
|
|
@property
|
|
def native_value(self) -> str | int | float | None:
|
|
"""Return the state."""
|
|
state = self._state
|
|
desc = self.entity_description
|
|
|
|
if state is None:
|
|
return state
|
|
|
|
if desc.value_map is not None:
|
|
return desc.value_map(state).name.lower()
|
|
|
|
if desc.multiplication_factor is not None:
|
|
state = handle_conversion(state, desc.multiplication_factor)
|
|
|
|
# If there is an imperial conversion needed and the instance is using imperial,
|
|
# apply the conversion logic.
|
|
if (
|
|
desc.imperial_conversion
|
|
and desc.unit_imperial is not None
|
|
and desc.unit_imperial != desc.unit_metric
|
|
and self.hass.config.units is US_CUSTOMARY_SYSTEM
|
|
):
|
|
return handle_conversion(state, desc.imperial_conversion)
|
|
|
|
return state
|
|
|
|
|
|
class TomorrowioSensorEntity(BaseTomorrowioSensorEntity):
|
|
"""Sensor entity that talks to Tomorrow.io v4 API to retrieve non-weather data."""
|
|
|
|
@property
|
|
def _state(self) -> int | float | None:
|
|
"""Return the raw state."""
|
|
val = self._get_current_property(self.entity_description.key)
|
|
assert not isinstance(val, str)
|
|
return val
|