Add support for OpenWeatherMap One Call API v4.0

homeassistant/components/openweathermap/__init__.py

@@ -3,16 +3,14 @@
 from dataclasses import dataclass
 import logging
 
-from pyopenweathermap import create_owm_client
-
 from homeassistant.config_entries import ConfigEntry
 from homeassistant.const import CONF_API_KEY, CONF_LANGUAGE, CONF_MODE
 from homeassistant.core import HomeAssistant
 
 from .const import CONFIG_FLOW_VERSION, DEFAULT_OWM_MODE, OWM_MODES, PLATFORMS
 from .coordinator import OWMUpdateCoordinator, get_owm_update_coordinator
 from .repairs import async_create_issue, async_delete_issue
-from .utils import build_data_and_options
+from .utils import build_data_and_options, get_owm_client
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -40,7 +38,7 @@ async def async_setup_entry(
     else:
         async_delete_issue(hass, entry.entry_id)
 
-    owm_client = create_owm_client(api_key, mode, lang=language)
+    owm_client = get_owm_client(api_key, mode, language)
     owm_coordinator = get_owm_update_coordinator(mode)(hass, entry, owm_client)
 
     await owm_coordinator.async_config_entry_first_refresh()

homeassistant/components/openweathermap/const.py

@@ -65,9 +65,11 @@
 OWM_MODE_FREE_CURRENT = "current"
 OWM_MODE_FREE_FORECAST = "forecast"
 OWM_MODE_V30 = "v3.0"
+OWM_MODE_V40 = "v4.0"
 OWM_MODE_AIRPOLLUTION = "air_pollution"
 OWM_MODES = [
     OWM_MODE_V30,
+    OWM_MODE_V40,
     OWM_MODE_FREE_CURRENT,
     OWM_MODE_FREE_FORECAST,
     OWM_MODE_AIRPOLLUTION,

homeassistant/components/openweathermap/coordinator.py

@@ -69,6 +69,7 @@
     OWM_MODE_FREE_CURRENT,
     OWM_MODE_FREE_FORECAST,
     OWM_MODE_V30,
+    OWM_MODE_V40,
     WEATHER_CODE_SUNNY_OR_CLEAR_NIGHT,
 )
 
@@ -309,6 +310,7 @@ def get_owm_update_coordinator(mode: str) -> type[OWMUpdateCoordinator]:
     """Create coordinator with a factory."""
     coordinators = {
         OWM_MODE_V30: WeatherUpdateCoordinator,
+        OWM_MODE_V40: WeatherUpdateCoordinator,
         OWM_MODE_FREE_CURRENT: WeatherUpdateCoordinator,
         OWM_MODE_FREE_FORECAST: WeatherUpdateCoordinator,
         OWM_MODE_AIRPOLLUTION: AirPollutionUpdateCoordinator,

homeassistant/components/openweathermap/strings.json

@@ -69,7 +69,7 @@
   },
   "exceptions": {
     "service_minute_forecast_mode": {
-      "message": "Minute forecast is available only when {name} mode is set to v3.0"
+      "message": "Minute forecast is available only when {name} mode is set to v3.0 or v4.0"
     }
   },
   "issues": {

homeassistant/components/openweathermap/utils.py

@@ -3,20 +3,42 @@
 from typing import Any
 
 from pyopenweathermap import RequestError, create_owm_client
+from pyopenweathermap.client.onecall_client import OWMOneCallClient
 
 from homeassistant.const import CONF_LANGUAGE, CONF_MODE
 
-from .const import DEFAULT_LANGUAGE, DEFAULT_OWM_MODE
+from .const import DEFAULT_LANGUAGE, DEFAULT_OWM_MODE, OWM_MODE_V40
 
 OPTION_DEFAULTS = {CONF_LANGUAGE: DEFAULT_LANGUAGE, CONF_MODE: DEFAULT_OWM_MODE}
 
 
+class OWMOneCallClientV4(OWMOneCallClient):
+    """OWM client for One Call API 4.0."""
+
+    def _get_url(self, lat: float, lon: float) -> str:
+        return (
+            "https://api.openweathermap.org/data/4.0/onecall?"
+            f"lat={lat}&"
+            f"lon={lon}&"
+            f"appid={self.api_key}&"
+            f"units={self.units}&"
+            f"lang={self.lang}"
+        )
+
+
+def get_owm_client(api_key: str, mode: str, language: str = DEFAULT_LANGUAGE) -> Any:
+    """Get the OWM client."""
+    if mode == OWM_MODE_V40:
+        return OWMOneCallClientV4(api_key, mode, lang=language)
+    return create_owm_client(api_key, mode, lang=language)
+
+
 async def validate_api_key(api_key, mode):
     """Validate API key."""
     api_key_valid = None
     errors, description_placeholders = {}, {}
     try:
-        owm_client = create_owm_client(api_key, mode)
+        owm_client = get_owm_client(api_key, mode)
         api_key_valid = await owm_client.validate_key()
     except RequestError as error:
         errors["base"] = "cannot_connect"

homeassistant/components/openweathermap/weather.py

@@ -44,6 +44,7 @@
     OWM_MODE_AIRPOLLUTION,
     OWM_MODE_FREE_FORECAST,
     OWM_MODE_V30,
+    OWM_MODE_V40,
 )
 from .coordinator import OWMUpdateCoordinator
 
@@ -106,7 +107,7 @@ def __init__(
         )
         self.mode = mode
 
-        if mode == OWM_MODE_V30:
+        if mode in (OWM_MODE_V30, OWM_MODE_V40):
             self._attr_supported_features = (
                 WeatherEntityFeature.FORECAST_DAILY
                 | WeatherEntityFeature.FORECAST_HOURLY
@@ -117,7 +118,7 @@ def __init__(
     async def async_get_minute_forecast(self) -> dict[str, list[dict]] | dict:
         """Return Minute forecast."""
 
-        if self.mode == OWM_MODE_V30:
+        if self.mode in (OWM_MODE_V30, OWM_MODE_V40):
             return self.coordinator.data[ATTR_API_MINUTE_FORECAST]
         raise ServiceValidationError(
             translation_domain=DOMAIN,

tests/components/openweathermap/conftest.py

@@ -155,11 +155,11 @@ def owm_client_mock() -> Generator[AsyncMock]:
     client.validate_key.return_value = True
     with (
         patch(
-            "homeassistant.components.openweathermap.create_owm_client",
+            "homeassistant.components.openweathermap.get_owm_client",
             return_value=client,
         ),
         patch(
-            "homeassistant.components.openweathermap.utils.create_owm_client",
+            "homeassistant.components.openweathermap.utils.get_owm_client",
             return_value=client,
         ),
     ):