273 lines
9.1 KiB
Python
273 lines
9.1 KiB
Python
"""Template platform that aggregates meteorological data."""
|
|
from __future__ import annotations
|
|
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.components.weather import (
|
|
ATTR_CONDITION_CLEAR_NIGHT,
|
|
ATTR_CONDITION_CLOUDY,
|
|
ATTR_CONDITION_EXCEPTIONAL,
|
|
ATTR_CONDITION_FOG,
|
|
ATTR_CONDITION_HAIL,
|
|
ATTR_CONDITION_LIGHTNING,
|
|
ATTR_CONDITION_LIGHTNING_RAINY,
|
|
ATTR_CONDITION_PARTLYCLOUDY,
|
|
ATTR_CONDITION_POURING,
|
|
ATTR_CONDITION_RAINY,
|
|
ATTR_CONDITION_SNOWY,
|
|
ATTR_CONDITION_SNOWY_RAINY,
|
|
ATTR_CONDITION_SUNNY,
|
|
ATTR_CONDITION_WINDY,
|
|
ATTR_CONDITION_WINDY_VARIANT,
|
|
ENTITY_ID_FORMAT,
|
|
Forecast,
|
|
WeatherEntity,
|
|
)
|
|
from homeassistant.const import CONF_NAME, CONF_TEMPERATURE_UNIT, CONF_UNIQUE_ID
|
|
from homeassistant.core import HomeAssistant
|
|
import homeassistant.helpers.config_validation as cv
|
|
from homeassistant.helpers.config_validation import PLATFORM_SCHEMA
|
|
from homeassistant.helpers.entity import async_generate_entity_id
|
|
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
|
from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType
|
|
from homeassistant.util.unit_conversion import (
|
|
DistanceConverter,
|
|
PressureConverter,
|
|
SpeedConverter,
|
|
TemperatureConverter,
|
|
)
|
|
|
|
from .template_entity import TemplateEntity, rewrite_common_legacy_to_modern_conf
|
|
|
|
CONDITION_CLASSES = {
|
|
ATTR_CONDITION_CLEAR_NIGHT,
|
|
ATTR_CONDITION_CLOUDY,
|
|
ATTR_CONDITION_FOG,
|
|
ATTR_CONDITION_HAIL,
|
|
ATTR_CONDITION_LIGHTNING,
|
|
ATTR_CONDITION_LIGHTNING_RAINY,
|
|
ATTR_CONDITION_PARTLYCLOUDY,
|
|
ATTR_CONDITION_POURING,
|
|
ATTR_CONDITION_RAINY,
|
|
ATTR_CONDITION_SNOWY,
|
|
ATTR_CONDITION_SNOWY_RAINY,
|
|
ATTR_CONDITION_SUNNY,
|
|
ATTR_CONDITION_WINDY,
|
|
ATTR_CONDITION_WINDY_VARIANT,
|
|
ATTR_CONDITION_EXCEPTIONAL,
|
|
}
|
|
|
|
CONF_WEATHER = "weather"
|
|
CONF_TEMPERATURE_TEMPLATE = "temperature_template"
|
|
CONF_HUMIDITY_TEMPLATE = "humidity_template"
|
|
CONF_CONDITION_TEMPLATE = "condition_template"
|
|
CONF_ATTRIBUTION_TEMPLATE = "attribution_template"
|
|
CONF_PRESSURE_TEMPLATE = "pressure_template"
|
|
CONF_WIND_SPEED_TEMPLATE = "wind_speed_template"
|
|
CONF_WIND_BEARING_TEMPLATE = "wind_bearing_template"
|
|
CONF_OZONE_TEMPLATE = "ozone_template"
|
|
CONF_VISIBILITY_TEMPLATE = "visibility_template"
|
|
CONF_FORECAST_TEMPLATE = "forecast_template"
|
|
CONF_PRESSURE_UNIT = "pressure_unit"
|
|
CONF_WIND_SPEED_UNIT = "wind_speed_unit"
|
|
CONF_VISIBILITY_UNIT = "visibility_unit"
|
|
CONF_PRECIPITATION_UNIT = "precipitation_unit"
|
|
|
|
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend(
|
|
{
|
|
vol.Required(CONF_NAME): cv.string,
|
|
vol.Required(CONF_CONDITION_TEMPLATE): cv.template,
|
|
vol.Required(CONF_TEMPERATURE_TEMPLATE): cv.template,
|
|
vol.Required(CONF_HUMIDITY_TEMPLATE): cv.template,
|
|
vol.Optional(CONF_ATTRIBUTION_TEMPLATE): cv.template,
|
|
vol.Optional(CONF_PRESSURE_TEMPLATE): cv.template,
|
|
vol.Optional(CONF_WIND_SPEED_TEMPLATE): cv.template,
|
|
vol.Optional(CONF_WIND_BEARING_TEMPLATE): cv.template,
|
|
vol.Optional(CONF_OZONE_TEMPLATE): cv.template,
|
|
vol.Optional(CONF_VISIBILITY_TEMPLATE): cv.template,
|
|
vol.Optional(CONF_FORECAST_TEMPLATE): cv.template,
|
|
vol.Optional(CONF_UNIQUE_ID): cv.string,
|
|
vol.Optional(CONF_TEMPERATURE_UNIT): vol.In(TemperatureConverter.VALID_UNITS),
|
|
vol.Optional(CONF_PRESSURE_UNIT): vol.In(PressureConverter.VALID_UNITS),
|
|
vol.Optional(CONF_WIND_SPEED_UNIT): vol.In(SpeedConverter.VALID_UNITS),
|
|
vol.Optional(CONF_VISIBILITY_UNIT): vol.In(DistanceConverter.VALID_UNITS),
|
|
vol.Optional(CONF_PRECIPITATION_UNIT): vol.In(DistanceConverter.VALID_UNITS),
|
|
}
|
|
)
|
|
|
|
|
|
async def async_setup_platform(
|
|
hass: HomeAssistant,
|
|
config: ConfigType,
|
|
async_add_entities: AddEntitiesCallback,
|
|
discovery_info: DiscoveryInfoType | None = None,
|
|
) -> None:
|
|
"""Set up the Template weather."""
|
|
|
|
config = rewrite_common_legacy_to_modern_conf(config)
|
|
unique_id = config.get(CONF_UNIQUE_ID)
|
|
|
|
async_add_entities(
|
|
[
|
|
WeatherTemplate(
|
|
hass,
|
|
config,
|
|
unique_id,
|
|
)
|
|
]
|
|
)
|
|
|
|
|
|
class WeatherTemplate(TemplateEntity, WeatherEntity):
|
|
"""Representation of a weather condition."""
|
|
|
|
_attr_should_poll = False
|
|
|
|
def __init__(
|
|
self,
|
|
hass: HomeAssistant,
|
|
config: ConfigType,
|
|
unique_id: str | None,
|
|
) -> None:
|
|
"""Initialize the Template weather."""
|
|
super().__init__(hass, config=config, unique_id=unique_id)
|
|
|
|
name = self._attr_name
|
|
self._condition_template = config[CONF_CONDITION_TEMPLATE]
|
|
self._temperature_template = config[CONF_TEMPERATURE_TEMPLATE]
|
|
self._humidity_template = config[CONF_HUMIDITY_TEMPLATE]
|
|
self._attribution_template = config.get(CONF_ATTRIBUTION_TEMPLATE)
|
|
self._pressure_template = config.get(CONF_PRESSURE_TEMPLATE)
|
|
self._wind_speed_template = config.get(CONF_WIND_SPEED_TEMPLATE)
|
|
self._wind_bearing_template = config.get(CONF_WIND_BEARING_TEMPLATE)
|
|
self._ozone_template = config.get(CONF_OZONE_TEMPLATE)
|
|
self._visibility_template = config.get(CONF_VISIBILITY_TEMPLATE)
|
|
self._forecast_template = config.get(CONF_FORECAST_TEMPLATE)
|
|
|
|
self._attr_native_precipitation_unit = config.get(CONF_PRECIPITATION_UNIT)
|
|
self._attr_native_pressure_unit = config.get(CONF_PRESSURE_UNIT)
|
|
self._attr_native_temperature_unit = config.get(CONF_TEMPERATURE_UNIT)
|
|
self._attr_native_visibility_unit = config.get(CONF_VISIBILITY_UNIT)
|
|
self._attr_native_wind_speed_unit = config.get(CONF_WIND_SPEED_UNIT)
|
|
|
|
self.entity_id = async_generate_entity_id(ENTITY_ID_FORMAT, name, hass=hass)
|
|
|
|
self._condition = None
|
|
self._temperature = None
|
|
self._humidity = None
|
|
self._attribution = None
|
|
self._pressure = None
|
|
self._wind_speed = None
|
|
self._wind_bearing = None
|
|
self._ozone = None
|
|
self._visibility = None
|
|
self._forecast: list[Forecast] = []
|
|
|
|
@property
|
|
def condition(self) -> str | None:
|
|
"""Return the current condition."""
|
|
return self._condition
|
|
|
|
@property
|
|
def native_temperature(self) -> float | None:
|
|
"""Return the temperature."""
|
|
return self._temperature
|
|
|
|
@property
|
|
def humidity(self) -> float | None:
|
|
"""Return the humidity."""
|
|
return self._humidity
|
|
|
|
@property
|
|
def native_wind_speed(self) -> float | None:
|
|
"""Return the wind speed."""
|
|
return self._wind_speed
|
|
|
|
@property
|
|
def wind_bearing(self) -> float | str | None:
|
|
"""Return the wind bearing."""
|
|
return self._wind_bearing
|
|
|
|
@property
|
|
def ozone(self) -> float | None:
|
|
"""Return the ozone level."""
|
|
return self._ozone
|
|
|
|
@property
|
|
def native_visibility(self) -> float | None:
|
|
"""Return the visibility."""
|
|
return self._visibility
|
|
|
|
@property
|
|
def native_pressure(self) -> float | None:
|
|
"""Return the air pressure."""
|
|
return self._pressure
|
|
|
|
@property
|
|
def forecast(self) -> list[Forecast]:
|
|
"""Return the forecast."""
|
|
return self._forecast
|
|
|
|
@property
|
|
def attribution(self) -> str | None:
|
|
"""Return the attribution."""
|
|
if self._attribution is None:
|
|
return "Powered by Home Assistant"
|
|
return self._attribution
|
|
|
|
async def async_added_to_hass(self) -> None:
|
|
"""Register callbacks."""
|
|
|
|
if self._condition_template:
|
|
self.add_template_attribute(
|
|
"_condition",
|
|
self._condition_template,
|
|
lambda condition: condition if condition in CONDITION_CLASSES else None,
|
|
)
|
|
if self._temperature_template:
|
|
self.add_template_attribute(
|
|
"_temperature",
|
|
self._temperature_template,
|
|
)
|
|
if self._humidity_template:
|
|
self.add_template_attribute(
|
|
"_humidity",
|
|
self._humidity_template,
|
|
)
|
|
if self._attribution_template:
|
|
self.add_template_attribute(
|
|
"_attribution",
|
|
self._attribution_template,
|
|
)
|
|
if self._pressure_template:
|
|
self.add_template_attribute(
|
|
"_pressure",
|
|
self._pressure_template,
|
|
)
|
|
if self._wind_speed_template:
|
|
self.add_template_attribute(
|
|
"_wind_speed",
|
|
self._wind_speed_template,
|
|
)
|
|
if self._wind_bearing_template:
|
|
self.add_template_attribute(
|
|
"_wind_bearing",
|
|
self._wind_bearing_template,
|
|
)
|
|
if self._ozone_template:
|
|
self.add_template_attribute(
|
|
"_ozone",
|
|
self._ozone_template,
|
|
)
|
|
if self._visibility_template:
|
|
self.add_template_attribute(
|
|
"_visibility",
|
|
self._visibility_template,
|
|
)
|
|
if self._forecast_template:
|
|
self.add_template_attribute(
|
|
"_forecast",
|
|
self._forecast_template,
|
|
)
|
|
await super().async_added_to_hass()
|