mirror of
https://github.com/home-assistant/core.git
synced 2026-08-16 02:02:56 +01:00
369 lines
14 KiB
Python
369 lines
14 KiB
Python
"""Support for Ecowitt Weather Stations."""
|
|
|
|
import dataclasses
|
|
from datetime import datetime
|
|
import logging
|
|
from typing import Final, override
|
|
|
|
from aioecowitt import EcoWittSensor, EcoWittSensorTypes
|
|
|
|
from homeassistant.components.sensor import (
|
|
SensorDeviceClass,
|
|
SensorEntity,
|
|
SensorEntityDescription,
|
|
SensorStateClass,
|
|
)
|
|
from homeassistant.const import (
|
|
DEGREE,
|
|
LIGHT_LUX,
|
|
UV_INDEX,
|
|
EntityCategory,
|
|
UnitOfConductivity,
|
|
UnitOfDensity,
|
|
UnitOfElectricPotential,
|
|
UnitOfIrradiance,
|
|
UnitOfLength,
|
|
UnitOfPrecipitationDepth,
|
|
UnitOfPressure,
|
|
UnitOfRatio,
|
|
UnitOfSpeed,
|
|
UnitOfTemperature,
|
|
UnitOfVolumetricFlux,
|
|
)
|
|
from homeassistant.core import HomeAssistant
|
|
from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback
|
|
from homeassistant.helpers.typing import StateType
|
|
from homeassistant.util.unit_system import METRIC_SYSTEM, US_CUSTOMARY_SYSTEM
|
|
|
|
from . import EcowittConfigEntry
|
|
from .entity import EcowittEntity
|
|
|
|
PARALLEL_UPDATES = 0
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
|
|
_METRIC: Final = (
|
|
EcoWittSensorTypes.TEMPERATURE_C,
|
|
EcoWittSensorTypes.RAIN_COUNT_MM,
|
|
EcoWittSensorTypes.RAIN_RATE_MM,
|
|
EcoWittSensorTypes.LIGHTNING_DISTANCE_KM,
|
|
EcoWittSensorTypes.SPEED_KPH,
|
|
EcoWittSensorTypes.PRESSURE_HPA,
|
|
)
|
|
_IMPERIAL: Final = (
|
|
EcoWittSensorTypes.TEMPERATURE_F,
|
|
EcoWittSensorTypes.RAIN_COUNT_INCHES,
|
|
EcoWittSensorTypes.RAIN_RATE_INCHES,
|
|
EcoWittSensorTypes.LIGHTNING_DISTANCE_MILES,
|
|
EcoWittSensorTypes.SPEED_MPH,
|
|
EcoWittSensorTypes.PRESSURE_INHG,
|
|
)
|
|
|
|
|
|
_RAIN_COUNT_SENSORS_STATE_CLASS_MAPPING: Final = {
|
|
"eventrainin": SensorStateClass.TOTAL_INCREASING,
|
|
"hourlyrainin": None,
|
|
"totalrainin": SensorStateClass.TOTAL_INCREASING,
|
|
"dailyrainin": SensorStateClass.TOTAL_INCREASING,
|
|
"weeklyrainin": SensorStateClass.TOTAL_INCREASING,
|
|
"monthlyrainin": SensorStateClass.TOTAL_INCREASING,
|
|
"yearlyrainin": SensorStateClass.TOTAL_INCREASING,
|
|
"last24hrainin": None,
|
|
"eventrainmm": SensorStateClass.TOTAL_INCREASING,
|
|
"hourlyrainmm": None,
|
|
"totalrainmm": SensorStateClass.TOTAL_INCREASING,
|
|
"dailyrainmm": SensorStateClass.TOTAL_INCREASING,
|
|
"weeklyrainmm": SensorStateClass.TOTAL_INCREASING,
|
|
"monthlyrainmm": SensorStateClass.TOTAL_INCREASING,
|
|
"yearlyrainmm": SensorStateClass.TOTAL_INCREASING,
|
|
"last24hrainmm": None,
|
|
"erain_piezo": SensorStateClass.TOTAL_INCREASING,
|
|
"hrain_piezo": None,
|
|
"drain_piezo": SensorStateClass.TOTAL_INCREASING,
|
|
"wrain_piezo": SensorStateClass.TOTAL_INCREASING,
|
|
"mrain_piezo": SensorStateClass.TOTAL_INCREASING,
|
|
"yrain_piezo": SensorStateClass.TOTAL_INCREASING,
|
|
"last24hrain_piezo": None,
|
|
"erain_piezomm": SensorStateClass.TOTAL_INCREASING,
|
|
"hrain_piezomm": None,
|
|
"drain_piezomm": SensorStateClass.TOTAL_INCREASING,
|
|
"wrain_piezomm": SensorStateClass.TOTAL_INCREASING,
|
|
"mrain_piezomm": SensorStateClass.TOTAL_INCREASING,
|
|
"yrain_piezomm": SensorStateClass.TOTAL_INCREASING,
|
|
"last24hrain_piezomm": None,
|
|
}
|
|
|
|
|
|
ECOWITT_SENSORS_MAPPING: Final = {
|
|
EcoWittSensorTypes.HUMIDITY: SensorEntityDescription(
|
|
key="HUMIDITY",
|
|
device_class=SensorDeviceClass.HUMIDITY,
|
|
native_unit_of_measurement=UnitOfRatio.PERCENTAGE,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
EcoWittSensorTypes.DEGREE: SensorEntityDescription(
|
|
key="DEGREE",
|
|
native_unit_of_measurement=DEGREE,
|
|
device_class=SensorDeviceClass.WIND_DIRECTION,
|
|
state_class=SensorStateClass.MEASUREMENT_ANGLE,
|
|
),
|
|
EcoWittSensorTypes.WATT_METERS_SQUARED: SensorEntityDescription(
|
|
key="WATT_METERS_SQUARED",
|
|
device_class=SensorDeviceClass.IRRADIANCE,
|
|
native_unit_of_measurement=UnitOfIrradiance.WATTS_PER_SQUARE_METER,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
EcoWittSensorTypes.UV_INDEX: SensorEntityDescription(
|
|
key="UV_INDEX",
|
|
native_unit_of_measurement=UV_INDEX,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
EcoWittSensorTypes.PM25: SensorEntityDescription(
|
|
key="PM25",
|
|
device_class=SensorDeviceClass.PM25,
|
|
native_unit_of_measurement=UnitOfDensity.MICROGRAMS_PER_CUBIC_METER,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
EcoWittSensorTypes.PM10: SensorEntityDescription(
|
|
key="PM10",
|
|
device_class=SensorDeviceClass.PM10,
|
|
native_unit_of_measurement=UnitOfDensity.MICROGRAMS_PER_CUBIC_METER,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
EcoWittSensorTypes.BATTERY_PERCENTAGE: SensorEntityDescription(
|
|
key="BATTERY_PERCENTAGE",
|
|
device_class=SensorDeviceClass.BATTERY,
|
|
native_unit_of_measurement=UnitOfRatio.PERCENTAGE,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
),
|
|
EcoWittSensorTypes.BATTERY_VOLTAGE: SensorEntityDescription(
|
|
key="BATTERY_VOLTAGE",
|
|
device_class=SensorDeviceClass.VOLTAGE,
|
|
native_unit_of_measurement=UnitOfElectricPotential.VOLT,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
suggested_display_precision=1,
|
|
),
|
|
EcoWittSensorTypes.CO2_PPM: SensorEntityDescription(
|
|
key="CO2_PPM",
|
|
device_class=SensorDeviceClass.CO2,
|
|
native_unit_of_measurement=UnitOfRatio.PARTS_PER_MILLION,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
EcoWittSensorTypes.LUX: SensorEntityDescription(
|
|
key="LUX",
|
|
device_class=SensorDeviceClass.ILLUMINANCE,
|
|
native_unit_of_measurement=LIGHT_LUX,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
EcoWittSensorTypes.TIMESTAMP: SensorEntityDescription(
|
|
key="TIMESTAMP", device_class=SensorDeviceClass.TIMESTAMP
|
|
),
|
|
EcoWittSensorTypes.VOLTAGE: SensorEntityDescription(
|
|
key="VOLTAGE",
|
|
device_class=SensorDeviceClass.VOLTAGE,
|
|
native_unit_of_measurement=UnitOfElectricPotential.VOLT,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
),
|
|
EcoWittSensorTypes.LIGHTNING_COUNT: SensorEntityDescription(
|
|
key="LIGHTNING_COUNT",
|
|
native_unit_of_measurement="strikes",
|
|
state_class=SensorStateClass.TOTAL_INCREASING,
|
|
),
|
|
EcoWittSensorTypes.TEMPERATURE_C: SensorEntityDescription(
|
|
key="TEMPERATURE_C",
|
|
device_class=SensorDeviceClass.TEMPERATURE,
|
|
native_unit_of_measurement=UnitOfTemperature.CELSIUS,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
EcoWittSensorTypes.TEMPERATURE_F: SensorEntityDescription(
|
|
key="TEMPERATURE_F",
|
|
device_class=SensorDeviceClass.TEMPERATURE,
|
|
native_unit_of_measurement=UnitOfTemperature.FAHRENHEIT,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
EcoWittSensorTypes.RAIN_COUNT_MM: SensorEntityDescription(
|
|
key="RAIN_COUNT_MM",
|
|
native_unit_of_measurement=UnitOfPrecipitationDepth.MILLIMETERS,
|
|
device_class=SensorDeviceClass.PRECIPITATION,
|
|
suggested_display_precision=1,
|
|
),
|
|
EcoWittSensorTypes.RAIN_COUNT_INCHES: SensorEntityDescription(
|
|
key="RAIN_COUNT_INCHES",
|
|
native_unit_of_measurement=UnitOfPrecipitationDepth.INCHES,
|
|
device_class=SensorDeviceClass.PRECIPITATION,
|
|
suggested_display_precision=2,
|
|
),
|
|
EcoWittSensorTypes.RAIN_RATE_MM: SensorEntityDescription(
|
|
key="RAIN_RATE_MM",
|
|
native_unit_of_measurement=UnitOfVolumetricFlux.MILLIMETERS_PER_HOUR,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
device_class=SensorDeviceClass.PRECIPITATION_INTENSITY,
|
|
suggested_display_precision=1,
|
|
),
|
|
EcoWittSensorTypes.RAIN_RATE_INCHES: SensorEntityDescription(
|
|
key="RAIN_RATE_INCHES",
|
|
native_unit_of_measurement=UnitOfVolumetricFlux.INCHES_PER_HOUR,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
device_class=SensorDeviceClass.PRECIPITATION_INTENSITY,
|
|
suggested_display_precision=2,
|
|
),
|
|
EcoWittSensorTypes.LIGHTNING_DISTANCE_KM: SensorEntityDescription(
|
|
key="LIGHTNING_DISTANCE_KM",
|
|
device_class=SensorDeviceClass.DISTANCE,
|
|
native_unit_of_measurement=UnitOfLength.KILOMETERS,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
EcoWittSensorTypes.LIGHTNING_DISTANCE_MILES: SensorEntityDescription(
|
|
key="LIGHTNING_DISTANCE_MILES",
|
|
device_class=SensorDeviceClass.DISTANCE,
|
|
native_unit_of_measurement=UnitOfLength.MILES,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
EcoWittSensorTypes.SOIL_RAWADC: SensorEntityDescription(
|
|
key="SOIL_RAWADC",
|
|
entity_registry_enabled_default=False,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
),
|
|
EcoWittSensorTypes.SPEED_KPH: SensorEntityDescription(
|
|
key="SPEED_KPH",
|
|
device_class=SensorDeviceClass.WIND_SPEED,
|
|
native_unit_of_measurement=UnitOfSpeed.KILOMETERS_PER_HOUR,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
suggested_display_precision=1,
|
|
),
|
|
EcoWittSensorTypes.SPEED_MPH: SensorEntityDescription(
|
|
key="SPEED_MPH",
|
|
device_class=SensorDeviceClass.WIND_SPEED,
|
|
native_unit_of_measurement=UnitOfSpeed.MILES_PER_HOUR,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
suggested_display_precision=1,
|
|
),
|
|
EcoWittSensorTypes.PRESSURE_HPA: SensorEntityDescription(
|
|
key="PRESSURE_HPA",
|
|
device_class=SensorDeviceClass.PRESSURE,
|
|
native_unit_of_measurement=UnitOfPressure.HPA,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
EcoWittSensorTypes.PRESSURE_INHG: SensorEntityDescription(
|
|
key="PRESSURE_INHG",
|
|
device_class=SensorDeviceClass.PRESSURE,
|
|
native_unit_of_measurement=UnitOfPressure.INHG,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
EcoWittSensorTypes.VPD_INHG: SensorEntityDescription(
|
|
key="VPD_INHG",
|
|
device_class=SensorDeviceClass.PRESSURE,
|
|
native_unit_of_measurement=UnitOfPressure.INHG,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
EcoWittSensorTypes.PERCENTAGE: SensorEntityDescription(
|
|
key="PERCENTAGE",
|
|
native_unit_of_measurement=UnitOfRatio.PERCENTAGE,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
EcoWittSensorTypes.SOIL_MOISTURE: SensorEntityDescription(
|
|
key="SOIL_MOISTURE",
|
|
device_class=SensorDeviceClass.MOISTURE,
|
|
native_unit_of_measurement=UnitOfRatio.PERCENTAGE,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
EcoWittSensorTypes.SOIL_EC: SensorEntityDescription(
|
|
key="SOIL_EC",
|
|
device_class=SensorDeviceClass.CONDUCTIVITY,
|
|
native_unit_of_measurement=UnitOfConductivity.MICROSIEMENS_PER_CM,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
EcoWittSensorTypes.DISTANCE_MM: SensorEntityDescription(
|
|
key="DISTANCE_MM",
|
|
device_class=SensorDeviceClass.DISTANCE,
|
|
native_unit_of_measurement=UnitOfLength.MILLIMETERS,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
EcoWittSensorTypes.HEAT_COUNT: SensorEntityDescription(
|
|
key="HEAT_COUNT",
|
|
state_class=SensorStateClass.TOTAL_INCREASING,
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
),
|
|
EcoWittSensorTypes.PM1: SensorEntityDescription(
|
|
key="PM1",
|
|
device_class=SensorDeviceClass.PM1,
|
|
native_unit_of_measurement=UnitOfDensity.MICROGRAMS_PER_CUBIC_METER,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
EcoWittSensorTypes.PM4: SensorEntityDescription(
|
|
key="PM4",
|
|
device_class=SensorDeviceClass.PM4,
|
|
native_unit_of_measurement=UnitOfDensity.MICROGRAMS_PER_CUBIC_METER,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
}
|
|
|
|
|
|
async def async_setup_entry(
|
|
hass: HomeAssistant,
|
|
entry: EcowittConfigEntry,
|
|
async_add_entities: AddConfigEntryEntitiesCallback,
|
|
) -> None:
|
|
"""Add sensors if new."""
|
|
ecowitt = entry.runtime_data
|
|
|
|
def _new_sensor(sensor: EcoWittSensor) -> None:
|
|
"""Add new sensor."""
|
|
if sensor.stype not in ECOWITT_SENSORS_MAPPING:
|
|
return
|
|
|
|
# Ignore metrics that are not supported by the user's locale
|
|
if sensor.stype in _METRIC and hass.config.units is not METRIC_SYSTEM:
|
|
return
|
|
if sensor.stype in _IMPERIAL and hass.config.units is not US_CUSTOMARY_SYSTEM:
|
|
return
|
|
mapping = ECOWITT_SENSORS_MAPPING[sensor.stype]
|
|
|
|
# Setup sensor description
|
|
description = dataclasses.replace(
|
|
mapping,
|
|
key=sensor.key,
|
|
name=sensor.name,
|
|
)
|
|
|
|
if sensor.stype in (
|
|
EcoWittSensorTypes.RAIN_COUNT_INCHES,
|
|
EcoWittSensorTypes.RAIN_COUNT_MM,
|
|
):
|
|
if sensor.key not in _RAIN_COUNT_SENSORS_STATE_CLASS_MAPPING:
|
|
_LOGGER.warning("Unknown rain count sensor: %s", sensor.key)
|
|
return
|
|
state_class = _RAIN_COUNT_SENSORS_STATE_CLASS_MAPPING[sensor.key]
|
|
description = dataclasses.replace(description, state_class=state_class)
|
|
|
|
async_add_entities([EcowittSensorEntity(sensor, description)])
|
|
|
|
ecowitt.new_sensor_cb.append(_new_sensor)
|
|
entry.async_on_unload(lambda: ecowitt.new_sensor_cb.remove(_new_sensor))
|
|
|
|
# Add all sensors that are already known
|
|
for sensor in ecowitt.sensors.values():
|
|
_new_sensor(sensor)
|
|
|
|
|
|
class EcowittSensorEntity(EcowittEntity, SensorEntity):
|
|
"""Representation of a Ecowitt Sensor."""
|
|
|
|
def __init__(
|
|
self, sensor: EcoWittSensor, description: SensorEntityDescription
|
|
) -> None:
|
|
"""Initialize the sensor."""
|
|
super().__init__(sensor)
|
|
self.entity_description = description
|
|
|
|
@property
|
|
@override
|
|
def native_value(self) -> StateType | datetime:
|
|
"""Return the state of the sensor."""
|
|
return self.ecowitt.value
|