Add service in Nord Pool for fetching normalized price indices (home-assistant#147979)

Author: gjohansson-ST

homeassistant/components/nordpool/const.py

@@ -12,3 +12,4 @@
 DEFAULT_NAME = "Nord Pool"
 
 CONF_AREAS = "areas"
+ATTR_RESOLUTION = "resolution"

homeassistant/components/nordpool/icons.json

@@ -42,6 +42,9 @@
   "services": {
     "get_prices_for_date": {
       "service": "mdi:cash-multiple"
+    },
+    "get_price_indices_for_date": {
+      "service": "mdi:cash-multiple"
     }
   }
 }

homeassistant/components/nordpool/services.py

@@ -2,16 +2,21 @@
 
 from __future__ import annotations
 
+from collections.abc import Callable
 from datetime import date, datetime
+from functools import partial
 import logging
 from typing import TYPE_CHECKING
 
 from pynordpool import (
     AREAS,
     Currency,
+    DeliveryPeriodData,
     NordPoolAuthenticationError,
+    NordPoolClient,
     NordPoolEmptyResponseError,
     NordPoolError,
+    PriceIndicesData,
 )
 import voluptuous as vol
 
@@ -32,14 +37,15 @@
 
 if TYPE_CHECKING:
     from . import NordPoolConfigEntry
-from .const import DOMAIN
+from .const import ATTR_RESOLUTION, DOMAIN
 
 _LOGGER = logging.getLogger(__name__)
 ATTR_CONFIG_ENTRY = "config_entry"
 ATTR_AREAS = "areas"
 ATTR_CURRENCY = "currency"
 
 SERVICE_GET_PRICES_FOR_DATE = "get_prices_for_date"
+SERVICE_GET_PRICE_INDICES_FOR_DATE = "get_price_indices_for_date"
 SERVICE_GET_PRICES_SCHEMA = vol.Schema(
     {
         vol.Required(ATTR_CONFIG_ENTRY): ConfigEntrySelector({"integration": DOMAIN}),
@@ -50,6 +56,13 @@
         ),
     }
 )
+SERVICE_GET_PRICE_INDICES_SCHEMA = SERVICE_GET_PRICES_SCHEMA.extend(
+    {
+        vol.Optional(ATTR_RESOLUTION, default=60): vol.All(
+            cv.positive_int, vol.All(vol.Coerce(int), vol.In((15, 30, 60)))
+        ),
+    }
+)
 
 
 def get_config_entry(hass: HomeAssistant, entry_id: str) -> NordPoolConfigEntry:
@@ -71,11 +84,13 @@ def get_config_entry(hass: HomeAssistant, entry_id: str) -> NordPoolConfigEntry:
 def async_setup_services(hass: HomeAssistant) -> None:
     """Set up services for Nord Pool integration."""
 
-    async def get_prices_for_date(call: ServiceCall) -> ServiceResponse:
-        """Get price service."""
+    def get_service_params(
+        call: ServiceCall,
+    ) -> tuple[NordPoolClient, date, str, list[str], int]:
+        """Return the parameters for the service."""
         entry = get_config_entry(hass, call.data[ATTR_CONFIG_ENTRY])
-        asked_date: date = call.data[ATTR_DATE]
         client = entry.runtime_data.client
+        asked_date: date = call.data[ATTR_DATE]
 
         areas: list[str] = entry.data[ATTR_AREAS]
         if _areas := call.data.get(ATTR_AREAS):
@@ -85,14 +100,55 @@ async def get_prices_for_date(call: ServiceCall) -> ServiceResponse:
         if _currency := call.data.get(ATTR_CURRENCY):
             currency = _currency
 
+        resolution: int = 60
+        if _resolution := call.data.get(ATTR_RESOLUTION):
+            resolution = _resolution
+
         areas = [area.upper() for area in areas]
         currency = currency.upper()
 
+        return (client, asked_date, currency, areas, resolution)
+
+    async def get_prices_for_date(
+        client: NordPoolClient,
+        asked_date: date,
+        currency: str,
+        areas: list[str],
+        resolution: int,
+    ) -> DeliveryPeriodData:
+        """Get prices."""
+        return await client.async_get_delivery_period(
+            datetime.combine(asked_date, dt_util.utcnow().time()),
+            Currency(currency),
+            areas,
+        )
+
+    async def get_price_indices_for_date(
+        client: NordPoolClient,
+        asked_date: date,
+        currency: str,
+        areas: list[str],
+        resolution: int,
+    ) -> PriceIndicesData:
+        """Get prices."""
+        return await client.async_get_price_indices(
+            datetime.combine(asked_date, dt_util.utcnow().time()),
+            Currency(currency),
+            areas,
+            resolution=resolution,
+        )
+
+    async def get_prices(func: Callable, call: ServiceCall) -> ServiceResponse:
+        """Get price service."""
+        client, asked_date, currency, areas, resolution = get_service_params(call)
+
         try:
-            price_data = await client.async_get_delivery_period(
-                datetime.combine(asked_date, dt_util.utcnow().time()),
-                Currency(currency),
+            price_data = await func(
+                client,
+                asked_date,
+                currency,
                 areas,
+                resolution,
             )
         except NordPoolAuthenticationError as error:
             raise ServiceValidationError(
@@ -122,7 +178,14 @@ async def get_prices_for_date(call: ServiceCall) -> ServiceResponse:
     hass.services.async_register(
         DOMAIN,
         SERVICE_GET_PRICES_FOR_DATE,
-        get_prices_for_date,
+        partial(get_prices, get_prices_for_date),
         schema=SERVICE_GET_PRICES_SCHEMA,
         supports_response=SupportsResponse.ONLY,
     )
+    hass.services.async_register(
+        DOMAIN,
+        SERVICE_GET_PRICE_INDICES_FOR_DATE,
+        partial(get_prices, get_price_indices_for_date),
+        schema=SERVICE_GET_PRICE_INDICES_SCHEMA,
+        supports_response=SupportsResponse.ONLY,
+    )

homeassistant/components/nordpool/services.yaml

@@ -46,3 +46,59 @@ get_prices_for_date:
             - "PLN"
             - "SEK"
           mode: dropdown
+get_price_indices_for_date:
+  fields:
+    config_entry:
+      required: true
+      selector:
+        config_entry:
+          integration: nordpool
+    date:
+      required: true
+      selector:
+        date:
+    areas:
+      selector:
+        select:
+          options:
+            - "EE"
+            - "LT"
+            - "LV"
+            - "AT"
+            - "BE"
+            - "FR"
+            - "GER"
+            - "NL"
+            - "PL"
+            - "DK1"
+            - "DK2"
+            - "FI"
+            - "NO1"
+            - "NO2"
+            - "NO3"
+            - "NO4"
+            - "NO5"
+            - "SE1"
+            - "SE2"
+            - "SE3"
+            - "SE4"
+            - "SYS"
+          mode: dropdown
+    currency:
+      selector:
+        select:
+          options:
+            - "DKK"
+            - "EUR"
+            - "NOK"
+            - "PLN"
+            - "SEK"
+          mode: dropdown
+    resolution:
+      selector:
+        select:
+          options:
+            - "15"
+            - "30"
+            - "60"
+          mode: dropdown

homeassistant/components/nordpool/strings.json

@@ -114,6 +114,32 @@
           "description": "Currency to get prices in. If left empty it will use the currency already configured."
         }
       }
+    },
+    "get_price_indices_for_date": {
+      "name": "Get price indices for date",
+      "description": "Retrieves the price indices for a specific date.",
+      "fields": {
+        "config_entry": {
+          "name": "Config entry",
+          "description": "The Nord Pool configuration entry for this action."
+        },
+        "date": {
+          "name": "Date",
+          "description": "Only dates two months in the past and one day in the future is allowed."
+        },
+        "areas": {
+          "name": "Areas",
+          "description": "One or multiple areas to get prices for. If left empty it will use the areas already configured."
+        },
+        "currency": {
+          "name": "Currency",
+          "description": "Currency to get prices in. If left empty it will use the currency already configured."
+        },
+        "resolution": {
+          "name": "Resolution",
+          "description": "Resolution time for the prices, can be any of 15, 30 and 60 minutes."
+        }
+      }
     }
   },
   "exceptions": {