128 lines
4.3 KiB
Python
128 lines
4.3 KiB
Python
"""Support for the OpenWeatherMap (OWM) service."""
|
|
from __future__ import annotations
|
|
|
|
from homeassistant.components.weather import Forecast, WeatherEntity
|
|
from homeassistant.config_entries import ConfigEntry
|
|
from homeassistant.const import PRESSURE_HPA, PRESSURE_INHG, TEMP_CELSIUS
|
|
from homeassistant.core import HomeAssistant
|
|
from homeassistant.helpers.device_registry import DeviceEntryType
|
|
from homeassistant.helpers.entity import DeviceInfo
|
|
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
|
from homeassistant.util.pressure import convert as pressure_convert
|
|
|
|
from .const import (
|
|
ATTR_API_CONDITION,
|
|
ATTR_API_FORECAST,
|
|
ATTR_API_HUMIDITY,
|
|
ATTR_API_PRESSURE,
|
|
ATTR_API_TEMPERATURE,
|
|
ATTR_API_WIND_BEARING,
|
|
ATTR_API_WIND_SPEED,
|
|
ATTRIBUTION,
|
|
DEFAULT_NAME,
|
|
DOMAIN,
|
|
ENTRY_NAME,
|
|
ENTRY_WEATHER_COORDINATOR,
|
|
MANUFACTURER,
|
|
)
|
|
from .weather_update_coordinator import WeatherUpdateCoordinator
|
|
|
|
|
|
async def async_setup_entry(
|
|
hass: HomeAssistant,
|
|
config_entry: ConfigEntry,
|
|
async_add_entities: AddEntitiesCallback,
|
|
) -> None:
|
|
"""Set up OpenWeatherMap weather entity 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]
|
|
|
|
unique_id = f"{config_entry.unique_id}"
|
|
owm_weather = OpenWeatherMapWeather(name, unique_id, weather_coordinator)
|
|
|
|
async_add_entities([owm_weather], False)
|
|
|
|
|
|
class OpenWeatherMapWeather(WeatherEntity):
|
|
"""Implementation of an OpenWeatherMap sensor."""
|
|
|
|
_attr_attribution = ATTRIBUTION
|
|
_attr_should_poll = False
|
|
_attr_temperature_unit = TEMP_CELSIUS
|
|
|
|
def __init__(
|
|
self,
|
|
name: str,
|
|
unique_id: str,
|
|
weather_coordinator: WeatherUpdateCoordinator,
|
|
) -> None:
|
|
"""Initialize the sensor."""
|
|
self._attr_name = name
|
|
self._attr_unique_id = unique_id
|
|
self._attr_device_info = DeviceInfo(
|
|
entry_type=DeviceEntryType.SERVICE,
|
|
identifiers={(DOMAIN, unique_id)},
|
|
manufacturer=MANUFACTURER,
|
|
name=DEFAULT_NAME,
|
|
)
|
|
self._weather_coordinator = weather_coordinator
|
|
|
|
@property
|
|
def condition(self) -> str | None:
|
|
"""Return the current condition."""
|
|
return self._weather_coordinator.data[ATTR_API_CONDITION]
|
|
|
|
@property
|
|
def temperature(self) -> float | None:
|
|
"""Return the temperature."""
|
|
return self._weather_coordinator.data[ATTR_API_TEMPERATURE]
|
|
|
|
@property
|
|
def pressure(self) -> float | None:
|
|
"""Return the pressure."""
|
|
pressure = self._weather_coordinator.data[ATTR_API_PRESSURE]
|
|
# OpenWeatherMap returns pressure in hPA, so convert to
|
|
# inHg if we aren't using metric.
|
|
if not self.hass.config.units.is_metric and pressure:
|
|
return pressure_convert(pressure, PRESSURE_HPA, PRESSURE_INHG)
|
|
return pressure
|
|
|
|
@property
|
|
def humidity(self) -> float | None:
|
|
"""Return the humidity."""
|
|
return self._weather_coordinator.data[ATTR_API_HUMIDITY]
|
|
|
|
@property
|
|
def wind_speed(self) -> float | None:
|
|
"""Return the wind speed."""
|
|
wind_speed = self._weather_coordinator.data[ATTR_API_WIND_SPEED]
|
|
if self.hass.config.units.name == "imperial":
|
|
return round(wind_speed * 2.24, 2)
|
|
return round(wind_speed * 3.6, 2)
|
|
|
|
@property
|
|
def wind_bearing(self) -> float | str | None:
|
|
"""Return the wind bearing."""
|
|
return self._weather_coordinator.data[ATTR_API_WIND_BEARING]
|
|
|
|
@property
|
|
def forecast(self) -> list[Forecast] | None:
|
|
"""Return the forecast array."""
|
|
return self._weather_coordinator.data[ATTR_API_FORECAST]
|
|
|
|
@property
|
|
def available(self) -> bool:
|
|
"""Return True if entity is available."""
|
|
return self._weather_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._weather_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._weather_coordinator.async_request_refresh()
|