add ostrom electricity tariff (#2188)

* add ostrom electricity tariff

* fix request when no zip code provided

Author: miradarya

packages/modules/electricity_tariffs/ostrom/__init__.py

@@ -0,0 +1,21 @@
+from typing import Optional
+
+
+class OstromTariffConfiguration:
+    def __init__(self,
+                 client_id: Optional[str] = None,
+                 client_secret: Optional[str] = None,
+                 zip: Optional[str] = None):
+        self.client_id = client_id
+        self.client_secret = client_secret
+        self.zip = zip
+
+
+class OstromTariff:
+    def __init__(self,
+                 name: str = "ostrom",
+                 type: str = "ostrom",
+                 configuration: OstromTariffConfiguration = None) -> None:
+        self.name = name
+        self.type = type
+        self.configuration = configuration or OstromTariffConfiguration()

packages/modules/electricity_tariffs/ostrom/config.py

@@ -0,0 +1,54 @@
+#!/usr/bin/env python3
+from base64 import b64encode
+from datetime import datetime, timezone, timedelta
+from urllib.parse import quote
+from typing import Dict
+from modules.common import req
+from modules.common.abstract_device import DeviceDescriptor
+from modules.common.component_state import TariffState
+from modules.electricity_tariffs.ostrom.config import OstromTariffConfiguration
+from modules.electricity_tariffs.ostrom.config import OstromTariff
+
+
+def fetch_prices(config: OstromTariffConfiguration) -> Dict[int, float]:
+    access_token = req.get_http_session().post(
+        url="https://auth.production.ostrom-api.io/oauth2/token",
+        data={"grant_type": "client_credentials"},
+        headers={
+            "accept": "application/json",
+            "content-type": "application/x-www-form-urlencoded",
+            "authorization": "Basic " + b64encode((config.client_id + ":" + config.client_secret).encode()).decode()
+        }
+    ).json()["access_token"]
+    utcnow = datetime.now(timezone.utc)
+    startDate = quote(utcnow.strftime("%Y-%m-%dT%H:00:00.000Z"))
+    endDate = quote((utcnow + timedelta(days=1)).strftime("%Y-%m-%dT%H:00:00.000Z"))
+    if config.zip:
+        zip = f"&zip={config.zip}"
+    else:
+        zip = ""
+    raw_prices = req.get_http_session().get(
+        url="https://production.ostrom-api.io/spot-prices?" +
+            f"startDate={startDate}&endDate={endDate}&resolution=HOUR{zip}",
+        headers={
+            "accept": "application/json",
+            "authorization": "Bearer " + access_token
+        }
+    ).json()["data"]
+    prices: Dict[int, float] = {}
+    for raw_price in raw_prices:
+        # Note: with Python >= 3.11, we can use: timestamp = datetime.fromisoformat(raw_price["date"]).timestamp()
+        timestamp = datetime.strptime(raw_price["date"], "%Y-%m-%dT%H:%M:%S.000Z")\
+            .replace(tzinfo=timezone.utc).timestamp()
+        price = float(raw_price["grossKwhPrice"] + raw_price["grossKwhTaxAndLevies"]) / 100000  # ct/kWh --> EUR/Wh
+        prices.update({str(int(timestamp)): price})
+    return prices
+
+
+def create_electricity_tariff(config: OstromTariff):
+    def updater():
+        return TariffState(prices=fetch_prices(config.configuration))
+    return updater
+
+
+device_descriptor = DeviceDescriptor(configuration_factory=OstromTariff)