Home Assistant Octopus Energy

• Home Assistant Octopus Energy
  • How to install
    • HACS
    • Manual
  • How to setup
  • Target Rate Sensors
  • Services
    • Service octopus_energy.update_target_config
  • Energy Dashboard
  • Community Contributions
  • FAQ

Custom component built from the ground up to bring your Octopus Energy details into Home Assistant to help you towards a more energy efficient (and or cheaper) home. This integration is built against the API provided by Octopus Energy UK and has not been tested for any other countries.

This integration is in no way affiliated with Octopus Energy.

If you find this useful and are planning on moving to Octopus Energy, why not use my referral link?

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

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

• Add the repository to your HACS installation
• Click Download

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 will include a few sensors be default depending on your account.

Target Rate Sensors

These sensors calculate the lowest continuous or intermittent rates within a 24 hour period 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 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 guide to setup.

Services

Service octopus_energy.update_target_config

Service for updating a given target rate's config. This allows you to change target rates sensors dynamically based on other outside criteria (e.g. you need to adjust the target hours to top up home batteries).

Please note this is temporary and will not persist between restarts.

Attribute	Optional	Description
target.entity_id	no	The name of the target sensor whose configuration is to be updated
data.target_hours	yes	The optional number of hours the target rate sensor should come on during a 24 hour period. Must be divisible by 0.5.
data.target_start_time	yes	The optional time the evaluation period should start. Must be in the format of HH:MM.
data.target_end_time	yes	The optional time the evaluation period should end. Must be in the format of HH:MM.
data.target_offset	yes	The optional offset to apply to the target rate when it starts. Must be in the format (+/-)HH:MM:SS

This can be used via automations in the following way. Assuming we have the following inputs.

input_number:
  octopus_energy_target_hours:
    name: Octopus Energy Target Hours
    min: 0
    max: 24

input_text:
  # From/to would ideally use input_datetime, but we need the time in a different format
  octopus_energy_target_from:
    name: Octopus Energy Target From
    initial: "00:00"
  octopus_energy_target_to:
    name: Octopus Energy Target To
    initial: "00:00"
  octopus_energy_target_offset:
    name: Octopus Energy Target Offset
    initial: "-00:00:00"

Then an automation might look like the following

automations:
  - alias: Update target rate config
    trigger:
    - platform: state
      entity_id:
      - input_number.octopus_energy_target_hours
      - input_text.octopus_energy_target_from
      - input_text.octopus_energy_target_to
      - input_text.octopus_energy_target_offset
    condition: []
    action:
    - service: octopus_energy.update_target_config
      data:
        target_hours: >
          "{{ states('input_number.octopus_energy_target_hours') | string }}"
        target_start_time: >
          {{ states('input_text.octopus_energy_target_from') }}
        target_end_time: >
          {{ states('input_text.octopus_energy_target_to') }}
        target_offset: >
          {{ states('input_text.octopus_energy_target_offset') }}
      target:
        entity_id: binary_sensor.octopus_energy_target_example

Energy Dashboard

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

Community Contributions

A collection of community contributions can be found here.

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.