feat(spotprice): German supplier prices — Ostrom, Octopus Energy Germany, aWATTar, EWS (#5431)

* feat(spotprice): Ostrom provider

Read Ostrom's (DE) dynamic tariff from its public API with an OAuth2
client-credentials token (cached until shortly before expiry, renewed
once on a 401). The contract is looked up once per run: the single
active dynamic contract, or spotprice_ostrom_contract_id. Prices are
requested at the contract's postcode so they carry the local taxes,
levies and variable grid fees, and the documented per-kWh price
(grossKwhPrice + grossKwhTaxAndLevies, VAT included) is used as-is,
like Tibber. A reply with no levies at all is rejected.

Suppliers now share a generic "supplier" source with its own fetch
time, back-off and cache. With spotprice_provider unset, the one
supplier whose credentials are set is used; credentials for several
suppliers, or half an Ostrom pair, are a single configuration error.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* feat(spotprice): Octopus Energy Germany provider

Read the active electricity agreement of an Octopus Energy Germany
account from its Kraken GraphQL API (api.oeg-kraken.energy). The API
key is exchanged for a JWT through obtainKrakenToken(APIKey), cached
until shortly before its exp claim, sent without a Bearer prefix and
replaced once when Kraken stops accepting it. The account number is
looked up from the key unless spotprice_octopus_de_account is set.

Rates come from the agreement under properties -> electricityMalos:
a dynamic tariff's unitRateForecast slots as published, otherwise the
time-of-use timeslots repeated daily in local time, or a fixed unit
rate over the window, clipped to the agreement's validity. These are
gross unit rates and are used as-is, like Tibber. Every query was
checked against the live schema without credentials.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* feat(spotprice): aWATTar (tado Energy HOURLY) provider

Add provider awattar: hourly spot prices for DE-LU and AT from the
public aWATTar market data API (api.awattar.de / api.awattar.at, no
key), the prices tado Energy's dynamic HOURLY tariff (formerly
aWATTar's) is billed on. It falls back to ENTSO-E (with a token) and
then Energy-Charts; other zones go straight to the fallbacks.

Add spotprice_markup_percent, a percentage of the absolute spot price
added before VAT, for any spot provider. It defaults to the published
3% for awattar and to 0 otherwise. The fixed 1.5 ct/kWh and the grid
fees stay in spotprice_markup.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* feat(spotprice): EWS Schönau provider

Add provider ews for EWS Schönau's "Ökostrom Dynamisch": quarter-hourly
gross prices for today and tomorrow from EWS's dynamic price API
(api.ews-schoenau.de/v1/dynamicprices/EWS-OEKO-DYN), authenticated
with an X-API-Key header. EWS issues keys on request. The totals are
gross cents per kWh with grid fees and levies included and are used
as-is, like Tibber.

The response shape (today/tomorrow lists of startsAt/total) is only
known from third-party use, so a reply whose typical value looks like
euros rather than cents is rejected instead of pricing every interval
a hundred times too low.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* fix(spotprice): fail loudly on ambiguous supplier replies

Octopus Energy Germany:
- Expand a forecast entry holding several time-of-use rates by its
  timeslot rules instead of taking the first rate.
- Price a dynamic agreement only from its forecast. With no forecast
  yet, record an error and publish nothing rather than a flat rate.
- Require spotprice_octopus_de_malo when active agreements sit on
  several market locations. Hand over to the next agreement on the
  location when the current one ends inside the window, and skip
  revoked agreements.
- Expand timeslot rules in Europe/Berlin, not the local timezone.
- Clip forecast slots to the agreement's validity.
- Retry on KT-CT-1125 (token keys rotated) rather than 1139, per the
  Kraken error code reference.

Ostrom: price ACTIVE contracts only; with none, report an error.

Cache: the name carries a digest of the configured Ostrom contract or
Octopus account and market location.

aWATTar: average quarter-hourly fallback prices to hourly, as the
HOURLY tariff bills.

Docs: an "Unverified assumptions" note under each supplier.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* fix(spotprice): single-successor handover, import-only averaging, explicit flat rates

Octopus Energy Germany:
- Chain agreements one handover at a time: the single non-revoked
  agreement starting at, or first after, the current end. Two
  claiming the same start are an error, and overlapping rates are
  refused rather than published.
- Without a forecast, price only an explicit fixed rate (Simple, not
  a time-of-use product) or a time-of-use rate whose every price has
  timeslots. Dynamic detection also reads the product's names and
  contract type, as the schema has no market-linked flag.
- Map the repeated autumn hour to its first occurrence and skipped
  spring times to the jump, so rule boundaries agree.
- KT-CT-1139 on a query is an auth error and is not retried.

Ostrom: ACTIVE matches in any case. When no contract has a status
field at all, the single dynamic contract is used with one warning.

aWATTar: average fallback quarter hours to hourly for import only;
export keeps the native quarter hours.

Cache: cached supplier prices carry the detected contract or account
and market location, and are dropped when detection finds another.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* fix(spotprice): key the supplier cache on a digest of the credential

Swapping a Tibber token, Ostrom client ID, or Octopus Energy Germany or
EWS API key, with no contract or market location set, kept the same
cache name. The old account's prices were then restored and counted as
fresh for up to six hours. The cache name now carries a salted SHA-256
of the credential and selectors, truncated to 12 hex characters. The
credential itself is never written to the name or the stored data.

The Kraken JWT stays bare, as the evcc project's Octopus Energy
Germany tariff sends it; a test now pins that.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* fix(spotprice): re-check the Ostrom contract daily and after a postcode error

The Ostrom contract and postcode were looked up once and kept until a
restart, so after a move the old postcode stayed priced. Without
spotprice_ostrom_contract_id, the contract is now looked up again once
a day, and straight after a 400/404/422 on /spot-prices, retrying once
with the new postcode. A changed contract or postcode drops the prices
held for the old one. With no active contract left, the usual "no
active Ostrom contract" error is raised and nothing is kept for the
old address. A configured contract is not re-checked.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* fix(spotprice): address German supplier review findings

---------

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>

Author: mgazza

.cspell/custom-dictionary-workspace.txt

@@ -43,6 +43,7 @@ autoflake
 automations
 autopep
 autoupdate
+awattar
 axvline
 axvspan
 Backfeed
@@ -171,12 +172,14 @@ dstamp
 dstart
 dtype
 dwindow
+Dynamisch
 eauth
 echargingpile
 ecosmart
 Eddi
 eddis
 efgh
+Elektrizitätswerke
 elif
 elinter
 eload
@@ -374,7 +377,11 @@ lstrip
 luxpower
 malloc
 mallopt
+malo
+malos
 markdownlint
+marketdata
+marketprice
 matplotlib
 maximise
 maxrss
@@ -473,6 +480,7 @@ openapi
 openrouter
 openweathermap
 Opticaster
+ostrom
 overclaim
 overfitting
 oversizing
@@ -578,6 +586,8 @@ saverestore
 savez
 scalarstring
 scalings
+schoenau
+Schönau
 searr
 securetoken
 Segoe
@@ -655,6 +665,7 @@ syscmd
 sysdn
 syssn
 tabindex
+tado
 tasmota
 TCWORLD
 tdata
@@ -679,6 +690,7 @@ timekey
 timelapse
 timenow
 timeobj
+timespec
 timestep
 timestr
 timezone
@@ -767,3 +779,4 @@ zappi
 zappis
 zcat
 zigbee
+Ökostrom

apps/predbat/components.py

@@ -583,14 +583,23 @@ def load_component_class(component_info):
         "class": "spotprice.SpotPriceAPI",
         "name": "Day-ahead Spot Price Tariff",
         "args": {
-            # No registry default: when unset, initialize() picks tibber whenever a Tibber token is set
-            # (with or without a zone), else energycharts
+            # No registry default: when unset, initialize() picks the one supplier whose credentials are
+            # set (with or without a zone), else energycharts; credentials for several is a config error
             "provider": {"required": False, "config": "spotprice_provider"},
             "zone": {"required": False, "config": "spotprice_zone"},
             "entsoe_token": {"required": False, "secret": True, "config": "spotprice_entsoe_token"},
             "tibber_token": {"required": False, "secret": True, "config": "spotprice_tibber_token"},
             "tibber_home_id": {"required": False, "secret": True, "config": "spotprice_tibber_home_id"},
+            "ostrom_client_id": {"required": False, "secret": True, "config": "spotprice_ostrom_client_id"},
+            "ostrom_client_secret": {"required": False, "secret": True, "config": "spotprice_ostrom_client_secret"},
+            "ostrom_contract_id": {"required": False, "secret": True, "config": "spotprice_ostrom_contract_id"},
+            "octopus_de_api_key": {"required": False, "secret": True, "config": "spotprice_octopus_de_api_key"},
+            "octopus_de_account": {"required": False, "secret": True, "config": "spotprice_octopus_de_account"},
+            "octopus_de_malo": {"required": False, "secret": True, "config": "spotprice_octopus_de_malo"},
+            "ews_api_key": {"required": False, "secret": True, "config": "spotprice_ews_api_key"},
             "markup": {"required": False, "config": "spotprice_markup", "default": 0.0},
+            # No registry default: when unset, initialize() uses the provider's published percentage (3 for awattar), else 0
+            "markup_percent": {"required": False, "config": "spotprice_markup_percent"},
             "vat": {"required": False, "config": "spotprice_vat", "default": 0.0},
             "charge_zones": {"required": False, "config": "spotprice_charge_zones", "default": []},
             "exchange_rate": {"required": False, "config": "spotprice_exchange_rate", "default": 1.0},
@@ -601,9 +610,10 @@ def load_component_class(component_info):
             "automatic": {"required": False, "config": "spotprice_automatic", "default": True},
         },
         # The provider defaults to energycharts, so gate on what a real configuration must carry: a
-        # bidding zone for the spot sources, or a Tibber token. Without this the component would
-        # start on every install.
-        "required_or": ["zone", "tibber_token"],
+        # bidding zone for the spot sources, or a supplier's credentials (either half of a pair is
+        # enough to start it, so a missing other half is reported rather than silently ignored).
+        # Without this the component would start on every install.
+        "required_or": ["zone", "tibber_token", "ostrom_client_id", "ostrom_client_secret", "octopus_de_api_key", "ews_api_key"],
         "can_restart": True,
         "phase": 1,
     },

apps/predbat/config.py

@@ -2871,12 +2871,20 @@
     "iboost_energy_today": {"type": "sensor", "sensor_type": "float"},
     "metric_octopus_gas": {"type": "sensor", "sensor_type": "float"},
     "rates_gas": {"type": "dict_list"},
-    "spotprice_provider": {"type": "string", "empty": False, "allowed": ["entsoe", "energycharts", "tibber"]},
+    "spotprice_provider": {"type": "string", "empty": False, "allowed": ["entsoe", "energycharts", "tibber", "ostrom", "octopus_de", "awattar", "ews"]},
     "spotprice_zone": {"type": "string", "empty": False},
     "spotprice_entsoe_token": {"type": "string", "empty": False},
     "spotprice_tibber_token": {"type": "string", "empty": False},
     "spotprice_tibber_home_id": {"type": "string", "empty": False},
+    "spotprice_ostrom_client_id": {"type": "string", "empty": False},
+    "spotprice_ostrom_client_secret": {"type": "string", "empty": False},
+    "spotprice_ostrom_contract_id": {"type": "string|integer", "empty": False},
+    "spotprice_octopus_de_api_key": {"type": "string", "empty": False},
+    "spotprice_octopus_de_account": {"type": "string", "empty": False},
+    "spotprice_octopus_de_malo": {"type": "string|integer", "empty": False},
+    "spotprice_ews_api_key": {"type": "string", "empty": False},
     "spotprice_markup": {"type": "float"},
+    "spotprice_markup_percent": {"type": "float"},
     "spotprice_vat": {"type": "float"},
     "spotprice_charge_zones": {"type": "dict_list"},
     "spotprice_exchange_rate": {"type": "float"},