MCPcopy Index your code
hub / github.com/BottlecapDave/HomeAssistant-OctopusEnergy

github.com/BottlecapDave/HomeAssistant-OctopusEnergy @v18.3.2

Chat with this repo
repository ↗ · DeepWiki ↗ · release v18.3.2 ↗ · + Follow
2,062 symbols 9,821 edges 310 files 1,007 documented · 49%
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

Home Assistant Octopus Energy

installation_badge - Home Assistant Octopus Energy - Features - How to install - HACS - Manual - How to setup - Docs - FAQ - Sponsorship

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?

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 sensors that will be available to you.

Docs

To get full use of the integration, please visit the docs.

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

If you are enjoying the integration, why not use my referral link if you're not already a part of Octopus Energy, or if possible, make a one off or monthly GitHub sponsorship.

Core symbols most depended-on inside this repo

dict_to_typed_dict
called by 151
custom_components/octopus_energy/utils/attributes.py
create_rate_data
called by 147
tests/unit/__init__.py
create_consumption_data
called by 46
tests/unit/__init__.py
_create_client_session
called by 37
custom_components/octopus_energy/api_client/__init__.py
get_test_context
called by 34
tests/integration/__init__.py
get_active_tariff
called by 33
custom_components/octopus_energy/utils/__init__.py
safe_repair_key
called by 28
custom_components/octopus_energy/utils/repairs.py
async_refresh_electricity_rates_data
called by 27
custom_components/octopus_energy/coordinators/electricity_rates.py

Shape

Method 1,078
Function 785
Class 195
Route 4

Languages

Python100%

Modules by API surface

custom_components/octopus_energy/api_client/__init__.py68 symbols
tests/unit/coordinators/test_async_refresh_electricity_rates_data.py34 symbols
tests/unit/coordinators/test_previous_consumption_and_rates.py26 symbols
tests/unit/coordinators/test_async_refresh_intelligent_dispatches.py26 symbols
custom_components/octopus_energy/intelligent/__init__.py21 symbols
custom_components/octopus_energy/config_flow.py21 symbols
tests/unit/coordinators/test_async_refresh_gas_rates_data.py20 symbols
tests/unit/coordinators/test_async_refresh_account.py20 symbols
custom_components/octopus_energy/cost_tracker/cost_tracker.py20 symbols
custom_components/octopus_energy/api_client/heat_pump.py20 symbols
tests/unit/config/test_validate_main_config.py19 symbols
custom_components/octopus_energy/cost_tracker/cost_tracker_week.py19 symbols

For agents

$ claude mcp add HomeAssistant-OctopusEnergy \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact

Ask about this repo answers extend the page