349 lines
11 KiB
Python
349 lines
11 KiB
Python
"""Support for the OpenWeatherMap (OWM) service."""
|
|
from __future__ import annotations
|
|
|
|
from datetime import datetime
|
|
|
|
from homeassistant.components.sensor import (
|
|
SensorDeviceClass,
|
|
SensorEntity,
|
|
SensorEntityDescription,
|
|
SensorStateClass,
|
|
)
|
|
from homeassistant.config_entries import ConfigEntry
|
|
from homeassistant.const import (
|
|
DEGREE,
|
|
PERCENTAGE,
|
|
UV_INDEX,
|
|
UnitOfLength,
|
|
UnitOfPrecipitationDepth,
|
|
UnitOfPressure,
|
|
UnitOfSpeed,
|
|
UnitOfTemperature,
|
|
UnitOfVolumetricFlux,
|
|
)
|
|
from homeassistant.core import HomeAssistant
|
|
from homeassistant.helpers.device_registry import DeviceEntryType, DeviceInfo
|
|
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
|
from homeassistant.helpers.typing import StateType
|
|
from homeassistant.helpers.update_coordinator import DataUpdateCoordinator
|
|
from homeassistant.util import dt as dt_util
|
|
|
|
from .const import (
|
|
ATTR_API_CLOUDS,
|
|
ATTR_API_CONDITION,
|
|
ATTR_API_DEW_POINT,
|
|
ATTR_API_FEELS_LIKE_TEMPERATURE,
|
|
ATTR_API_FORECAST,
|
|
ATTR_API_FORECAST_CONDITION,
|
|
ATTR_API_FORECAST_PRECIPITATION,
|
|
ATTR_API_FORECAST_PRECIPITATION_PROBABILITY,
|
|
ATTR_API_FORECAST_PRESSURE,
|
|
ATTR_API_FORECAST_TEMP,
|
|
ATTR_API_FORECAST_TEMP_LOW,
|
|
ATTR_API_FORECAST_TIME,
|
|
ATTR_API_HUMIDITY,
|
|
ATTR_API_PRECIPITATION_KIND,
|
|
ATTR_API_PRESSURE,
|
|
ATTR_API_RAIN,
|
|
ATTR_API_SNOW,
|
|
ATTR_API_TEMPERATURE,
|
|
ATTR_API_UV_INDEX,
|
|
ATTR_API_VISIBILITY_DISTANCE,
|
|
ATTR_API_WEATHER,
|
|
ATTR_API_WEATHER_CODE,
|
|
ATTR_API_WIND_BEARING,
|
|
ATTR_API_WIND_SPEED,
|
|
ATTRIBUTION,
|
|
DEFAULT_NAME,
|
|
DOMAIN,
|
|
ENTRY_NAME,
|
|
ENTRY_WEATHER_COORDINATOR,
|
|
MANUFACTURER,
|
|
)
|
|
from .weather_update_coordinator import WeatherUpdateCoordinator
|
|
|
|
WEATHER_SENSOR_TYPES: tuple[SensorEntityDescription, ...] = (
|
|
SensorEntityDescription(
|
|
key=ATTR_API_WEATHER,
|
|
name="Weather",
|
|
),
|
|
SensorEntityDescription(
|
|
key=ATTR_API_DEW_POINT,
|
|
name="Dew Point",
|
|
native_unit_of_measurement=UnitOfTemperature.CELSIUS,
|
|
device_class=SensorDeviceClass.TEMPERATURE,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
SensorEntityDescription(
|
|
key=ATTR_API_TEMPERATURE,
|
|
name="Temperature",
|
|
native_unit_of_measurement=UnitOfTemperature.CELSIUS,
|
|
device_class=SensorDeviceClass.TEMPERATURE,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
SensorEntityDescription(
|
|
key=ATTR_API_FEELS_LIKE_TEMPERATURE,
|
|
name="Feels like temperature",
|
|
native_unit_of_measurement=UnitOfTemperature.CELSIUS,
|
|
device_class=SensorDeviceClass.TEMPERATURE,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
SensorEntityDescription(
|
|
key=ATTR_API_WIND_SPEED,
|
|
name="Wind speed",
|
|
native_unit_of_measurement=UnitOfSpeed.METERS_PER_SECOND,
|
|
device_class=SensorDeviceClass.WIND_SPEED,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
SensorEntityDescription(
|
|
key=ATTR_API_WIND_BEARING,
|
|
name="Wind bearing",
|
|
native_unit_of_measurement=DEGREE,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
SensorEntityDescription(
|
|
key=ATTR_API_HUMIDITY,
|
|
name="Humidity",
|
|
native_unit_of_measurement=PERCENTAGE,
|
|
device_class=SensorDeviceClass.HUMIDITY,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
SensorEntityDescription(
|
|
key=ATTR_API_PRESSURE,
|
|
name="Pressure",
|
|
native_unit_of_measurement=UnitOfPressure.HPA,
|
|
device_class=SensorDeviceClass.PRESSURE,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
SensorEntityDescription(
|
|
key=ATTR_API_CLOUDS,
|
|
name="Cloud coverage",
|
|
native_unit_of_measurement=PERCENTAGE,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
SensorEntityDescription(
|
|
key=ATTR_API_RAIN,
|
|
name="Rain",
|
|
native_unit_of_measurement=UnitOfVolumetricFlux.MILLIMETERS_PER_HOUR,
|
|
device_class=SensorDeviceClass.PRECIPITATION_INTENSITY,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
SensorEntityDescription(
|
|
key=ATTR_API_SNOW,
|
|
name="Snow",
|
|
native_unit_of_measurement=UnitOfVolumetricFlux.MILLIMETERS_PER_HOUR,
|
|
device_class=SensorDeviceClass.PRECIPITATION_INTENSITY,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
SensorEntityDescription(
|
|
key=ATTR_API_PRECIPITATION_KIND,
|
|
name="Precipitation kind",
|
|
),
|
|
SensorEntityDescription(
|
|
key=ATTR_API_UV_INDEX,
|
|
name="UV Index",
|
|
native_unit_of_measurement=UV_INDEX,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
SensorEntityDescription(
|
|
key=ATTR_API_VISIBILITY_DISTANCE,
|
|
name="Visibility",
|
|
native_unit_of_measurement=UnitOfLength.METERS,
|
|
device_class=SensorDeviceClass.DISTANCE,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
SensorEntityDescription(
|
|
key=ATTR_API_CONDITION,
|
|
name="Condition",
|
|
),
|
|
SensorEntityDescription(
|
|
key=ATTR_API_WEATHER_CODE,
|
|
name="Weather Code",
|
|
),
|
|
)
|
|
FORECAST_SENSOR_TYPES: tuple[SensorEntityDescription, ...] = (
|
|
SensorEntityDescription(
|
|
key=ATTR_API_FORECAST_CONDITION,
|
|
name="Condition",
|
|
),
|
|
SensorEntityDescription(
|
|
key=ATTR_API_FORECAST_PRECIPITATION,
|
|
name="Precipitation",
|
|
device_class=SensorDeviceClass.PRECIPITATION,
|
|
native_unit_of_measurement=UnitOfPrecipitationDepth.MILLIMETERS,
|
|
),
|
|
SensorEntityDescription(
|
|
key=ATTR_API_FORECAST_PRECIPITATION_PROBABILITY,
|
|
name="Precipitation probability",
|
|
native_unit_of_measurement=PERCENTAGE,
|
|
),
|
|
SensorEntityDescription(
|
|
key=ATTR_API_FORECAST_PRESSURE,
|
|
name="Pressure",
|
|
native_unit_of_measurement=UnitOfPressure.HPA,
|
|
device_class=SensorDeviceClass.PRESSURE,
|
|
),
|
|
SensorEntityDescription(
|
|
key=ATTR_API_FORECAST_TEMP,
|
|
name="Temperature",
|
|
native_unit_of_measurement=UnitOfTemperature.CELSIUS,
|
|
device_class=SensorDeviceClass.TEMPERATURE,
|
|
),
|
|
SensorEntityDescription(
|
|
key=ATTR_API_FORECAST_TEMP_LOW,
|
|
name="Temperature Low",
|
|
native_unit_of_measurement=UnitOfTemperature.CELSIUS,
|
|
device_class=SensorDeviceClass.TEMPERATURE,
|
|
),
|
|
SensorEntityDescription(
|
|
key=ATTR_API_FORECAST_TIME,
|
|
name="Time",
|
|
device_class=SensorDeviceClass.TIMESTAMP,
|
|
),
|
|
SensorEntityDescription(
|
|
key=ATTR_API_WIND_BEARING,
|
|
name="Wind bearing",
|
|
native_unit_of_measurement=DEGREE,
|
|
),
|
|
SensorEntityDescription(
|
|
key=ATTR_API_WIND_SPEED,
|
|
name="Wind speed",
|
|
native_unit_of_measurement=UnitOfSpeed.METERS_PER_SECOND,
|
|
device_class=SensorDeviceClass.WIND_SPEED,
|
|
),
|
|
SensorEntityDescription(
|
|
key=ATTR_API_CLOUDS,
|
|
name="Cloud coverage",
|
|
native_unit_of_measurement=PERCENTAGE,
|
|
),
|
|
)
|
|
|
|
|
|
async def async_setup_entry(
|
|
hass: HomeAssistant,
|
|
config_entry: ConfigEntry,
|
|
async_add_entities: AddEntitiesCallback,
|
|
) -> None:
|
|
"""Set up OpenWeatherMap sensor entities based on a config entry."""
|
|
domain_data = hass.data[DOMAIN][config_entry.entry_id]
|
|
name = domain_data[ENTRY_NAME]
|
|
weather_coordinator = domain_data[ENTRY_WEATHER_COORDINATOR]
|
|
|
|
entities: list[AbstractOpenWeatherMapSensor] = [
|
|
OpenWeatherMapSensor(
|
|
name,
|
|
f"{config_entry.unique_id}-{description.key}",
|
|
description,
|
|
weather_coordinator,
|
|
)
|
|
for description in WEATHER_SENSOR_TYPES
|
|
]
|
|
|
|
entities.extend(
|
|
[
|
|
OpenWeatherMapForecastSensor(
|
|
f"{name} Forecast",
|
|
f"{config_entry.unique_id}-forecast-{description.key}",
|
|
description,
|
|
weather_coordinator,
|
|
)
|
|
for description in FORECAST_SENSOR_TYPES
|
|
]
|
|
)
|
|
|
|
async_add_entities(entities)
|
|
|
|
|
|
class AbstractOpenWeatherMapSensor(SensorEntity):
|
|
"""Abstract class for an OpenWeatherMap sensor."""
|
|
|
|
_attr_should_poll = False
|
|
_attr_attribution = ATTRIBUTION
|
|
|
|
def __init__(
|
|
self,
|
|
name: str,
|
|
unique_id: str,
|
|
description: SensorEntityDescription,
|
|
coordinator: DataUpdateCoordinator,
|
|
) -> None:
|
|
"""Initialize the sensor."""
|
|
self.entity_description = description
|
|
self._coordinator = coordinator
|
|
|
|
self._attr_name = f"{name} {description.name}"
|
|
self._attr_unique_id = unique_id
|
|
split_unique_id = unique_id.split("-")
|
|
self._attr_device_info = DeviceInfo(
|
|
entry_type=DeviceEntryType.SERVICE,
|
|
identifiers={(DOMAIN, f"{split_unique_id[0]}-{split_unique_id[1]}")},
|
|
manufacturer=MANUFACTURER,
|
|
name=DEFAULT_NAME,
|
|
)
|
|
|
|
@property
|
|
def available(self) -> bool:
|
|
"""Return True if entity is available."""
|
|
return self._coordinator.last_update_success
|
|
|
|
async def async_added_to_hass(self) -> None:
|
|
"""Connect to dispatcher listening for entity data notifications."""
|
|
self.async_on_remove(
|
|
self._coordinator.async_add_listener(self.async_write_ha_state)
|
|
)
|
|
|
|
async def async_update(self) -> None:
|
|
"""Get the latest data from OWM and updates the states."""
|
|
await self._coordinator.async_request_refresh()
|
|
|
|
|
|
class OpenWeatherMapSensor(AbstractOpenWeatherMapSensor):
|
|
"""Implementation of an OpenWeatherMap sensor."""
|
|
|
|
def __init__(
|
|
self,
|
|
name: str,
|
|
unique_id: str,
|
|
description: SensorEntityDescription,
|
|
weather_coordinator: WeatherUpdateCoordinator,
|
|
) -> None:
|
|
"""Initialize the sensor."""
|
|
super().__init__(name, unique_id, description, weather_coordinator)
|
|
self._weather_coordinator = weather_coordinator
|
|
|
|
@property
|
|
def native_value(self) -> StateType:
|
|
"""Return the state of the device."""
|
|
return self._weather_coordinator.data.get(self.entity_description.key, None)
|
|
|
|
|
|
class OpenWeatherMapForecastSensor(AbstractOpenWeatherMapSensor):
|
|
"""Implementation of an OpenWeatherMap this day forecast sensor."""
|
|
|
|
def __init__(
|
|
self,
|
|
name: str,
|
|
unique_id: str,
|
|
description: SensorEntityDescription,
|
|
weather_coordinator: WeatherUpdateCoordinator,
|
|
) -> None:
|
|
"""Initialize the sensor."""
|
|
super().__init__(name, unique_id, description, weather_coordinator)
|
|
self._weather_coordinator = weather_coordinator
|
|
|
|
@property
|
|
def native_value(self) -> StateType | datetime:
|
|
"""Return the state of the device."""
|
|
forecasts = self._weather_coordinator.data.get(ATTR_API_FORECAST)
|
|
if not forecasts:
|
|
return None
|
|
|
|
value = forecasts[0].get(self.entity_description.key, None)
|
|
if (
|
|
value
|
|
and self.entity_description.device_class is SensorDeviceClass.TIMESTAMP
|
|
):
|
|
return dt_util.parse_datetime(value)
|
|
|
|
return value
|