328 lines
11 KiB
Python
328 lines
11 KiB
Python
"""Support for the Environment Canada weather service."""
|
|
from __future__ import annotations
|
|
|
|
from collections.abc import Callable
|
|
from dataclasses import dataclass
|
|
from typing import Any
|
|
|
|
from homeassistant.components.sensor import (
|
|
SensorDeviceClass,
|
|
SensorEntity,
|
|
SensorEntityDescription,
|
|
SensorStateClass,
|
|
)
|
|
from homeassistant.config_entries import ConfigEntry
|
|
from homeassistant.const import (
|
|
ATTR_LOCATION,
|
|
DEGREE,
|
|
LENGTH_KILOMETERS,
|
|
LENGTH_MILLIMETERS,
|
|
PERCENTAGE,
|
|
PRESSURE_KPA,
|
|
SPEED_KILOMETERS_PER_HOUR,
|
|
TEMP_CELSIUS,
|
|
UV_INDEX,
|
|
)
|
|
from homeassistant.core import HomeAssistant
|
|
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
|
from homeassistant.helpers.update_coordinator import CoordinatorEntity
|
|
|
|
from .const import ATTR_STATION, DOMAIN
|
|
|
|
ATTR_TIME = "alert time"
|
|
|
|
|
|
@dataclass
|
|
class ECSensorEntityDescriptionMixin:
|
|
"""Mixin for required keys."""
|
|
|
|
value_fn: Callable[[Any], Any]
|
|
|
|
|
|
@dataclass
|
|
class ECSensorEntityDescription(
|
|
SensorEntityDescription, ECSensorEntityDescriptionMixin
|
|
):
|
|
"""Describes Environment Canada sensor entity."""
|
|
|
|
transform: Callable[[Any], Any] | None = None
|
|
|
|
|
|
SENSOR_TYPES: tuple[ECSensorEntityDescription, ...] = (
|
|
ECSensorEntityDescription(
|
|
key="condition",
|
|
name="Current Condition",
|
|
value_fn=lambda data: data.conditions.get("condition", {}).get("value"),
|
|
),
|
|
ECSensorEntityDescription(
|
|
key="dewpoint",
|
|
name="Dew Point",
|
|
device_class=SensorDeviceClass.TEMPERATURE,
|
|
native_unit_of_measurement=TEMP_CELSIUS,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
value_fn=lambda data: data.conditions.get("dewpoint", {}).get("value"),
|
|
),
|
|
ECSensorEntityDescription(
|
|
key="high_temp",
|
|
name="High Temperature",
|
|
device_class=SensorDeviceClass.TEMPERATURE,
|
|
native_unit_of_measurement=TEMP_CELSIUS,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
value_fn=lambda data: data.conditions.get("high_temp", {}).get("value"),
|
|
),
|
|
ECSensorEntityDescription(
|
|
key="humidex",
|
|
name="Humidex",
|
|
device_class=SensorDeviceClass.TEMPERATURE,
|
|
native_unit_of_measurement=TEMP_CELSIUS,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
value_fn=lambda data: data.conditions.get("humidex", {}).get("value"),
|
|
),
|
|
ECSensorEntityDescription(
|
|
key="humidity",
|
|
name="Humidity",
|
|
device_class=SensorDeviceClass.HUMIDITY,
|
|
native_unit_of_measurement=PERCENTAGE,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
value_fn=lambda data: data.conditions.get("humidity", {}).get("value"),
|
|
),
|
|
ECSensorEntityDescription(
|
|
key="icon_code",
|
|
name="Icon Code",
|
|
value_fn=lambda data: data.conditions.get("icon_code", {}).get("value"),
|
|
),
|
|
ECSensorEntityDescription(
|
|
key="low_temp",
|
|
name="Low Temperature",
|
|
device_class=SensorDeviceClass.TEMPERATURE,
|
|
native_unit_of_measurement=TEMP_CELSIUS,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
value_fn=lambda data: data.conditions.get("low_temp", {}).get("value"),
|
|
),
|
|
ECSensorEntityDescription(
|
|
key="normal_high",
|
|
name="Normal High Temperature",
|
|
device_class=SensorDeviceClass.TEMPERATURE,
|
|
native_unit_of_measurement=TEMP_CELSIUS,
|
|
value_fn=lambda data: data.conditions.get("normal_high", {}).get("value"),
|
|
),
|
|
ECSensorEntityDescription(
|
|
key="normal_low",
|
|
name="Normal Low Temperature",
|
|
device_class=SensorDeviceClass.TEMPERATURE,
|
|
native_unit_of_measurement=TEMP_CELSIUS,
|
|
value_fn=lambda data: data.conditions.get("normal_low", {}).get("value"),
|
|
),
|
|
ECSensorEntityDescription(
|
|
key="pop",
|
|
name="Chance of Precipitation",
|
|
native_unit_of_measurement=PERCENTAGE,
|
|
value_fn=lambda data: data.conditions.get("pop", {}).get("value"),
|
|
),
|
|
ECSensorEntityDescription(
|
|
key="precip_yesterday",
|
|
name="Precipitation Yesterday",
|
|
native_unit_of_measurement=LENGTH_MILLIMETERS,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
value_fn=lambda data: data.conditions.get("precip_yesterday", {}).get("value"),
|
|
),
|
|
ECSensorEntityDescription(
|
|
key="pressure",
|
|
name="Barometric Pressure",
|
|
device_class=SensorDeviceClass.PRESSURE,
|
|
native_unit_of_measurement=PRESSURE_KPA,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
value_fn=lambda data: data.conditions.get("pressure", {}).get("value"),
|
|
),
|
|
ECSensorEntityDescription(
|
|
key="temperature",
|
|
name="Temperature",
|
|
device_class=SensorDeviceClass.TEMPERATURE,
|
|
native_unit_of_measurement=TEMP_CELSIUS,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
value_fn=lambda data: data.conditions.get("temperature", {}).get("value"),
|
|
),
|
|
ECSensorEntityDescription(
|
|
key="tendency",
|
|
name="Tendency",
|
|
value_fn=lambda data: data.conditions.get("tendency", {}).get("value"),
|
|
transform=lambda val: str(val).capitalize(),
|
|
),
|
|
ECSensorEntityDescription(
|
|
key="text_summary",
|
|
name="Summary",
|
|
value_fn=lambda data: data.conditions.get("text_summary", {}).get("value"),
|
|
transform=lambda val: val[:255],
|
|
),
|
|
ECSensorEntityDescription(
|
|
key="timestamp",
|
|
name="Observation Time",
|
|
device_class=SensorDeviceClass.TIMESTAMP,
|
|
value_fn=lambda data: data.metadata.get("timestamp"),
|
|
),
|
|
ECSensorEntityDescription(
|
|
key="uv_index",
|
|
name="UV Index",
|
|
native_unit_of_measurement=UV_INDEX,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
value_fn=lambda data: data.conditions.get("uv_index", {}).get("value"),
|
|
),
|
|
ECSensorEntityDescription(
|
|
key="visibility",
|
|
name="Visibility",
|
|
native_unit_of_measurement=LENGTH_KILOMETERS,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
value_fn=lambda data: data.conditions.get("visibility", {}).get("value"),
|
|
),
|
|
ECSensorEntityDescription(
|
|
key="wind_bearing",
|
|
name="Wind Bearing",
|
|
native_unit_of_measurement=DEGREE,
|
|
value_fn=lambda data: data.conditions.get("wind_bearing", {}).get("value"),
|
|
),
|
|
ECSensorEntityDescription(
|
|
key="wind_chill",
|
|
name="Wind Chill",
|
|
device_class=SensorDeviceClass.TEMPERATURE,
|
|
native_unit_of_measurement=TEMP_CELSIUS,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
value_fn=lambda data: data.conditions.get("wind_chill", {}).get("value"),
|
|
),
|
|
ECSensorEntityDescription(
|
|
key="wind_dir",
|
|
name="Wind Direction",
|
|
value_fn=lambda data: data.conditions.get("wind_dir", {}).get("value"),
|
|
),
|
|
ECSensorEntityDescription(
|
|
key="wind_gust",
|
|
name="Wind Gust",
|
|
native_unit_of_measurement=SPEED_KILOMETERS_PER_HOUR,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
value_fn=lambda data: data.conditions.get("wind_gust", {}).get("value"),
|
|
),
|
|
ECSensorEntityDescription(
|
|
key="wind_speed",
|
|
name="Wind Speed",
|
|
native_unit_of_measurement=SPEED_KILOMETERS_PER_HOUR,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
value_fn=lambda data: data.conditions.get("wind_speed", {}).get("value"),
|
|
),
|
|
)
|
|
|
|
AQHI_SENSOR = ECSensorEntityDescription(
|
|
key="aqhi",
|
|
name="AQHI",
|
|
device_class=SensorDeviceClass.AQI,
|
|
native_unit_of_measurement="AQI",
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
value_fn=lambda data: data.current,
|
|
)
|
|
|
|
ALERT_TYPES: tuple[ECSensorEntityDescription, ...] = (
|
|
ECSensorEntityDescription(
|
|
key="advisories",
|
|
name="Advisory",
|
|
icon="mdi:bell-alert",
|
|
value_fn=lambda data: data.alerts.get("advisories", {}).get("value"),
|
|
transform=len,
|
|
),
|
|
ECSensorEntityDescription(
|
|
key="endings",
|
|
name="Endings",
|
|
icon="mdi:alert-circle-check",
|
|
value_fn=lambda data: data.alerts.get("endings", {}).get("value"),
|
|
transform=len,
|
|
),
|
|
ECSensorEntityDescription(
|
|
key="statements",
|
|
name="Statements",
|
|
icon="mdi:bell-alert",
|
|
value_fn=lambda data: data.alerts.get("statements", {}).get("value"),
|
|
transform=len,
|
|
),
|
|
ECSensorEntityDescription(
|
|
key="warnings",
|
|
name="Warnings",
|
|
icon="mdi:alert-octagon",
|
|
value_fn=lambda data: data.alerts.get("warnings", {}).get("value"),
|
|
transform=len,
|
|
),
|
|
ECSensorEntityDescription(
|
|
key="watches",
|
|
name="Watches",
|
|
icon="mdi:alert",
|
|
value_fn=lambda data: data.alerts.get("watches", {}).get("value"),
|
|
transform=len,
|
|
),
|
|
)
|
|
|
|
|
|
async def async_setup_entry(
|
|
hass: HomeAssistant,
|
|
config_entry: ConfigEntry,
|
|
async_add_entities: AddEntitiesCallback,
|
|
) -> None:
|
|
"""Add a weather entity from a config_entry."""
|
|
coordinator = hass.data[DOMAIN][config_entry.entry_id]["weather_coordinator"]
|
|
sensors: list[ECBaseSensor] = [ECSensor(coordinator, desc) for desc in SENSOR_TYPES]
|
|
sensors.extend([ECAlertSensor(coordinator, desc) for desc in ALERT_TYPES])
|
|
aqhi_coordinator = hass.data[DOMAIN][config_entry.entry_id]["aqhi_coordinator"]
|
|
sensors.append(ECSensor(aqhi_coordinator, AQHI_SENSOR))
|
|
async_add_entities(sensors)
|
|
|
|
|
|
class ECBaseSensor(CoordinatorEntity, SensorEntity):
|
|
"""Environment Canada sensor base."""
|
|
|
|
entity_description: ECSensorEntityDescription
|
|
|
|
def __init__(self, coordinator, description):
|
|
"""Initialize the base sensor."""
|
|
super().__init__(coordinator)
|
|
self.entity_description = description
|
|
self._ec_data = coordinator.ec_data
|
|
self._attr_attribution = self._ec_data.metadata["attribution"]
|
|
self._attr_name = f"{coordinator.config_entry.title} {description.name}"
|
|
self._attr_unique_id = f"{coordinator.config_entry.title}-{description.key}"
|
|
|
|
@property
|
|
def native_value(self):
|
|
"""Return the native value of the sensor."""
|
|
value = self.entity_description.value_fn(self._ec_data)
|
|
if value is not None and self.entity_description.transform:
|
|
value = self.entity_description.transform(value)
|
|
return value
|
|
|
|
|
|
class ECSensor(ECBaseSensor):
|
|
"""Environment Canada sensor for conditions."""
|
|
|
|
def __init__(self, coordinator, description):
|
|
"""Initialize the sensor."""
|
|
super().__init__(coordinator, description)
|
|
self._attr_extra_state_attributes = {
|
|
ATTR_LOCATION: self._ec_data.metadata.get("location"),
|
|
ATTR_STATION: self._ec_data.metadata.get("station"),
|
|
}
|
|
|
|
|
|
class ECAlertSensor(ECBaseSensor):
|
|
"""Environment Canada sensor for alerts."""
|
|
|
|
@property
|
|
def extra_state_attributes(self):
|
|
"""Return the extra state attributes."""
|
|
value = self.entity_description.value_fn(self._ec_data)
|
|
if not value:
|
|
return None
|
|
|
|
extra_state_attrs = {
|
|
ATTR_LOCATION: self._ec_data.metadata.get("location"),
|
|
ATTR_STATION: self._ec_data.metadata.get("station"),
|
|
}
|
|
for index, alert in enumerate(value, start=1):
|
|
extra_state_attrs[f"alert_{index}"] = alert.get("title")
|
|
extra_state_attrs[f"alert_time_{index}"] = alert.get("date")
|
|
|
|
return extra_state_attrs
|