Zum Hauptinhalt springen

Octopus Energy (UK) Smart-Home-Integration, kostenlos und Open Source

Octopus Energy (UK)-Integration für Gladys Assistant

Unofficial: Octopus Energy UK meters, half-hourly use, tariffs and public Agile prices.

Auf GitHub ansehenAlle Integrationen
Info

Die Dokumentation dieser Integration wird von ihrem Autor geschrieben und ist bisher nur auf Englisch verfügbar.

Unofficial connector, not affiliated with Octopus Energy. It brings your Octopus Energy account (Great Britain) into Gladys: your electricity and gas meters, the half-hourly electricity consumption in the Gladys energy monitoring, yesterday's gas use, your current unit rates and standing charges, and the public Agile prices with "cheapest hours" scene triggers. Octopus Energy is a trademark of Octopus Energy Group. For Octopus Energy France, use the Octopus Energy France integration instead: this one only talks to the British API.

What you get​

SurfaceContent
One device per electricity meter point (MPAN)the 30-minute consumption for the energy monitoring, the unit rate now (£/kWh, VAT included) and the standing charge (£/day)
One device per gas meter point (MPRN)the gas used yesterday in kWh (a plain sensor, not in the energy monitoring: see below), the unit rate now and the standing charge
One Agile region deviceAgile price now, next price, today's average, minimum and maximum, a "cheap period" sensor and a "negative price" sensor
Scene triggerscheap period started / ended (the N cheapest hours of the day), negative price started (plunge pricing), tomorrow's prices published (around 16:00 UK time)
Scene actionsprice now and cheapest hours (the N cheapest consecutive hours of the next 24 hours, of today or of tomorrow)
WidgetOctopus prices: now, next, averages, cheapest hours, negative prices, price curve of today and tomorrow
Energy contract (Gladys 5.2+)Octopus Energy electricity template: each half hour priced at the unit rate of your tariff at that time, plus the standing charge

Installation​

  1. In your Octopus dashboard, open API access: copy the API key (sk_live_…) and your account number (A-XXXXXXXX).
  2. Install the integration, paste both, save, then click Test the connection: your meters, their tariff and the current Agile price show up.
  3. Open Discovery and add the devices you want (the meters, the Agile region).
  4. Put the Octopus prices widget on a dashboard and pick the Agile region (or a meter on a half-hourly tariff).

Without an Octopus account leave the key empty and choose an Agile prices region: you get the public Agile device, its triggers and the widget. With an account, "Automatic" takes the region of your electricity tariff.

Energy monitoring​

Smart meter readings reach Octopus with a delay (often the next day). The integration therefore publishes dated half hours: each reading lands in its own half hour of the energy monitoring, even when it arrives a day late. Only the meters whose device you created are read. When an electricity meter device is added, the last 14 days are filled in right away; then the last 3 days are read every hour, and the 14 days again once a day (after 04:00 UK time) for the readings Octopus fills in late.

Gas is not in the energy tab as long as the Gladys core does not handle gas contracts: the core would add any gas consumption to the main electricity meter and price it at the electricity rate. The gas device therefore only shows Gas used yesterday (kWh), once the whole day is known, plus its unit rate and standing charge; it changes nothing in your energy monitoring or your costs. Gas read in cubic metres (SMETS2) is converted to kWh with the calorific value of the configuration (×1.02264 ÷ 3.6); choose kWh for a SMETS1 gas meter. After a gas meter change (new serial), check Unit of the gas meter readings again: a SMETS1 meter replaced by a SMETS2 one switches from kWh to cubic metres.

Already using version 0.1.2 or older with a gas device? Its old "Consumption (30 min)" feature was counted as electricity. Open Integrations → Octopus Energy → Discovery and click Update on the gas device: the old feature is replaced by "Gas used yesterday (kWh)". Until you do, Gladys keeps the old feature (it receives nothing new). Delete any contract you created from the former Octopus Energy gas template: it is no longer offered and no longer priced. If the gas still shows in the energy tab after that, delete the gas device, then add it again from Discovery.

To see the electricity costs, create a contract in Energy monitoring → Contracts from the Octopus Energy electricity template, attached to the electricity meter device. Enter the standing charge shown by the device. Gladys then asks the integration to price each half hour from your own tariff history, tariff changes included; a half hour outside every agreement of the account (just before your first one, for example) takes the nearest agreement.

Scenes​

  • Cheap period started / ended: the current half hour enters or leaves the N cheapest hours of the day (N = Cheap hours per day, 3 by default). Start the dishwasher, the car charger, the hot water.
  • Negative price started: Agile pays you to use electricity this half hour.
  • Tomorrow's prices published: once a day, with the average, the extremes, the number of negative half hours and the cheapest window.

The scene actions give their results to the next actions of the scene, in their variable list (written {{<step>.<action>.<key>}}, for example {{0.0.price}}): price now gives price, cheap, negative, next_price, avg_price, window_start_time…; cheapest hours gives start_time, end_time, start and end (ISO dates for a "wait until"), minutes_until_start and the saving against the period.

Limits​

  • Great Britain only (Octopus Energy UK API). Germany and Italy are not covered in this version (their Octopus API works differently, with an e-mail and password login), nor the other Kraken countries.
  • Two-rate tariffs (Economy 7) have no single unit rate: their unit rate feature stays empty and their contract cannot be priced yet.
  • Export meters (solar) are not read yet.
  • A negative Agile price is counted as a zero cost in the contracts (Gladys costs cannot be negative).
  • Calls: the account every 6 hours (after a failure: 5, 15, then every 60 minutes), each created meter's consumption and each tariff every hour, the Agile prices every hour, at 16:02 UK time and every 15 minutes after that until tomorrow's prices are out. When Octopus asks to slow down (429), every call pauses for the time it asks (15 minutes otherwise).

Troubleshooting​

  • "Octopus refused the API key or the account number": copy them again from the API access page; a key regenerated there replaces the old one.
  • "Octopus does not know this account number": check the number (A-XXXXXXXX); the integration tries again after 5, 15, then every 60 minutes.
  • "The Octopus account could not be read … new try in N min": Octopus was busy or unreachable; nothing to do, the integration tries again.
  • "Octopus does not publish this tariff (404)": the Agile product or the region changed; they are read again every day.
  • No consumption: check that the meter device is created; smart meter data can take a day or more to reach Octopus.
  • No Agile device: choose a region, or enter your account so "Automatic" can read it from your tariff.
  • Logs: set the LOG_LEVEL variable of the integration.

Privacy​

The key and the account number are kept by Gladys in its database, never shown again, and sent only to Octopus. They are masked in the interface, not encrypted: they sit in clear in the Gladys database (and so in its backups). The key is sent only to api.octopus.energy, and only for the account and consumption requests (the tariffs and Agile prices are public). Nothing is logged with the key or the account number.

Credits​

The tariff and meter logic follows BottlecapDave/HomeAssistant-OctopusEnergy (MIT, © 2021 David Kendall).

Konfigurationseinstellungen​

Diese Einstellungen fragt Octopus Energy (UK) in seinem Konfigurationsbildschirm in Gladys ab.

EinstellungTypPflichtfeldBeschreibung
Octopus Energy account (Great Britain)sectionNeinUnofficial connector, not affiliated with Octopus Energy. For Octopus Energy customers in Great Britain (for France, use the Octopus Energy France integration). Copy your API key and your account number (A-XXXXXXXX) from the "API access" page of your Octopus dashboard: the integration discovers your electricity and gas meters, feeds the half-hourly electricity consumption to the Gladys energy monitoring, shows yesterday's gas use (outside the energy monitoring, which does not handle gas yet) and your current unit rates and standing charges. Without an account, choose an Agile region below to get the public Agile prices only.
API keysecretNeinStarts with sk_live_. Kept by Gladys in its database, never shown again, only sent to Octopus (api.octopus.energy). Leave empty for the public Agile prices only.
Account numbersecretNeinShown on your bills and on the API access page. Like the key: kept by Gladys in its database, never shown again, only sent to Octopus.
Agile prices regionselectNeinThe public half-hourly Agile prices of this region, with the cheap-hours triggers. "Automatic" uses the region of your electricity tariff.
Cheap hours per daynumberNeinThe N cheapest hours of the day (by half hours) make the Agile "cheap period" (sensor, triggers, widget).
Unit of the gas meter readingsselectNeinSMETS2 smart gas meters report cubic metres, converted to kWh; SMETS1 meters report kWh.
Gas calorific value (MJ/m³)numberNeinPrinted on your gas bill (about 39 to 40). Only used for meters read in cubic metres.

So installierst du Octopus Energy (UK) in Gladys​

  1. Öffne in Gladys Integrationen: Octopus Energy (UK) erscheint im Katalog neben den nativen Integrationen, mit einem Community-Badge.
  2. Klicke auf Installieren. Gladys lädt das Docker-Image (ghcr.io/lm1lc3n7/gladys-octopus-energy:0.1.3) herunter, startet es in einer vom Kern isolierten Sandbox und erzeugt die Oberfläche der Integration (Geräte, Erkennung und Konfiguration).
  3. Öffne den Bildschirm Konfiguration der Integration, fülle die Einstellungen aus und speichere.
  4. Du kannst sie auch direkt über die URL ihres Repositorys installieren: https://github.com/LM1LC3N7/gladys-octopus-energy.

Octopus Energy (UK) benötigt Gladys >=5.2.0. Der Katalog in Gladys wird stündlich aktualisiert, eine neue Version ist also spätestens eine Stunde nach ihrer Veröffentlichung verfügbar.

Du nutzt Gladys noch nicht? Es ist kostenlos und Open Source: folge der Installationsanleitung, um loszulegen.

Über externe Integrationen​

Octopus Energy (UK) ist eine externe Integration: eine Community-Integration, die als Docker-Container verpackt und auf GitHub veröffentlicht wird. Gladys installiert sie mit einem Klick und führt sie in einer vom Kern isolierten Sandbox aus. Sie wird von LM1LC3N7 veröffentlicht und gepflegt, nicht vom Gladys-Kernteam.

Abonniere den Newsletter von Gladys Assistant

Ein paar E-Mails im Monat zu neuen Releases und Neuigkeiten aus dem Projekt. Verschickt von Pierre-Gilles Leymarie, dem Gründer des Projekts. Jederzeit abbestellbar 🙂
Zuletzt aktualisiert am