Skip to content

Home Assistant Octopus Energy#

Features#

Below are the main features of the integration

How to install#

There are multiple ways of installing the integration. Once you've installed the integration, you'll need to setup your account before you can use the integration.

HACS#

hacs_badge

This integration can be installed directly via HACS. To install:

Manual#

You should take the latest published release. The current state of develop will be in flux and therefore possibly subject to change.

To install, place the contents of custom_components into the <config directory>/custom_components folder of your Home Assistant installation. Once installed, don't forget to restart your home assistant instance for the integration to be picked up.

How to setup#

Please follow the setup guide to setup your initial account. This guide details the configuration, along with the entities that will be available to you.

Entities#

Electricity Entities#

Full list of electricity entities.

Gas Entities#

Full list of gas entities.

Home Mini#

If you are lucky enough to own an Octopus Home Mini, you can now receive this data within Home Assistant. When setting up (or editing) your account within Home Assistant, you will need to check the box next to I have a Home Mini. This will gain electricity entities and gas entities which can be added to the energy dashboard.

Info

You will only have the same data exposed in the integration that is available within the Octopus app. There has been reports of gas not appearing within the Octopus app (and integration) straight away, so you might have to wait a few days for this to appear. Once it's available within the Octopus app, if you reload the integration (or restart Home Assistant) then the entities should become available.

Warning

Export sensors are not provided as the data is not available.

Home Pro#

If you are lucky enough to own an Octopus Home Pro, you can now receive this data within Home Assistant. When setting up (or editing) your account within Home Assistant, you will need to configure your Home Pro. This will gain electricity entities and gas entities which can be added to the energy dashboard.

Info

You will only have the same data exposed in the integration that is available within the Octopus app. There has been reports of gas not appearing within the Octopus app (and integration) straight away, so you might have to wait a few days for this to appear. Once it's available within the Octopus app, if you reload the integration (or restart Home Assistant) then the entities should become available.

Warning

Export sensors are not provided as the data is not available.

Intelligent#

If you are on the intelligent tariff, then you'll get a few additional entities when you install the integration.

List of intelligent entities.

Warning

If you switch to the intelligent tariff after you have installed the integration, you will need to reload the integration or restart your Home Assistant instance.

Octoplus#

To support Octopus Energy's octoplus programme. Full list of octoplus entites.

Wheel of Fortune#

To support the wheel of fortune that is awarded every month to customers. Full list of wheel of fortune entites.

Greenness Forecast#

To support Octopus Energy's greener days. Full list of greenness forecast entites.

Target Rate Sensors#

These sensors calculate the lowest continuous or intermittent rates within a 24 hour period or on a rolling basis and turn on when these periods are active. If you are targeting an export meter, then the sensors will calculate the highest continuous or intermittent rates within a 24 hour period or on a rolling basis and turn on when these periods are active.

These sensors can then be used in automations to turn on/off devices that save you (and the planet) energy and money. You can go through this flow as many times as you need target rate sensors.

Please follow the setup guides for either standard target rate or rolling target rate sensors.

Cost Tracker Sensors#

These sensors track the consumption of other existing sensors and provide a daily cost of those sensors.

Please follow the setup guide.

Tariff Comparison Sensors#

These sensors compare the cost of the previous consumption to another tariff to see if you're on the best tariff.

Please follow the setup guide.

Events#

This integration raises several events, which can be used for various tasks like automations. For more information, please see the events docs.

Services#

This integration includes several services. Please review them in the services doc.

Energy Dashboard#

The core sensors have been designed to work with the energy dashboard. Please see the energy dashboard guide for instructions on how to set this up.

Blueprints#

A selection of blueprints are available to help get you up and running quickly with the integration.

Community Contributions#

A collection of community contributions can be found on the community contributions page.

FAQ#

Before raising anything, please read through the faq. If you have questions, then you can raise a discussion. If you have found a bug or have a feature request please raise it using the appropriate report template.

Sponsorship#

Please see the sponsorship page for more information.