Home Assistant Octopus Energy
Bring your Octopus Energy details into Home Assistant to help you towards a more energy efficient (and or cheaper) home.
https://github.com/BottlecapDave/HomeAssistant-OctopusEnergy
Category: Energy Systems
Sub Category: Building Energy Monitoring
Keywords
energy-consumption home-assistant home-automation octopus-energy smart-home
Keywords from Contributors
card hacs solar varta varta-storage power reporting route integrity selection
Last synced: about 3 hours ago
JSON representation
Repository metadata
Unofficial Home Assistant integration for interacting with Octopus Energy
- Host: GitHub
- URL: https://github.com/BottlecapDave/HomeAssistant-OctopusEnergy
- Owner: BottlecapDave
- License: mit
- Created: 2021-08-30T09:13:05.000Z (over 3 years ago)
- Default Branch: develop
- Last Pushed: 2025-04-15T16:34:57.000Z (11 days ago)
- Last Synced: 2025-04-21T19:09:34.803Z (5 days ago)
- Topics: energy-consumption, home-assistant, home-automation, octopus-energy, smart-home
- Language: Python
- Homepage: https://bottlecapdave.github.io/HomeAssistant-OctopusEnergy/
- Size: 6.26 MB
- Stars: 703
- Watchers: 25
- Forks: 74
- Open Issues: 32
- Releases: 177
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
README.md
Home Assistant Octopus Energy
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
- Electricity and gas meter support including consumption data and rate information
- Custom sensor support to target cheapest rates
- Custom sensor support for tracking costs of other entities
- Custom sensor support for comparing to other tariffs
- Octopus Home mini support
- Intelligent tariff settings support
- Saving sessions support
- Wheel of fortune support
- Greener days support
- Heat Pump support
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 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.
Owner metadata
- Name: David Kendall
- Login: BottlecapDave
- Email:
- Kind: user
- Description:
- Website: http://www.davidskendall.co.uk
- Location:
- Twitter: BottlecapDave
- Company:
- Icon url: https://avatars.githubusercontent.com/u/14993950?u=bb1dd529ecadeb7db9fa57be0203bc94f7dd2c57&v=4
- Repositories: 9
- Last ynced at: 2025-04-24T23:05:50.240Z
- Profile URL: https://github.com/BottlecapDave
GitHub Events
Total
- Create event: 52
- Commit comment event: 4
- Issues event: 226
- Release event: 31
- Watch event: 124
- Delete event: 21
- Issue comment event: 1255
- Push event: 269
- Pull request review event: 28
- Pull request review comment event: 55
- Pull request event: 106
- Fork event: 15
Last Year
- Create event: 52
- Commit comment event: 4
- Issues event: 226
- Release event: 31
- Watch event: 124
- Delete event: 21
- Issue comment event: 1255
- Push event: 269
- Pull request review event: 28
- Pull request review comment event: 55
- Pull request event: 106
- Fork event: 15
Committers metadata
Last synced: 5 days ago
Total Commits: 1,205
Total Committers: 27
Avg Commits per committer: 44.63
Development Distribution Score (DDS): 0.154
Commits in past year: 314
Committers in past year: 13
Avg Commits per committer in past year: 24.154
Development Distribution Score (DDS) in past year: 0.182
| Name | Commits | |
|---|---|---|
| BottlecapDave | me@d****k | 1020 |
| semantic-release-bot | s****t@m****t | 139 |
| Geoffrey Coan | 1****n | 11 |
| Sam Reed | s****m@r****t | 6 |
| Thomas Grocutt | t****m@d****k | 4 |
| David Kendall | d****d@r****m | 2 |
| Lewis Juggins | 8****s | 2 |
| Mark Cocker | m****r@u****m | 2 |
| Alec Rust | me@a****m | 1 |
| Andrew Aylett | a****w@a****k | 1 |
| Andrew Jackson | a****w@c****g | 1 |
| Ben Campbell | M****1 | 1 |
| Colin Seymour | c****n@s****o | 1 |
| DJBenson | d****n@g****m | 1 |
| Gavin Melling | g****n@p****m | 1 |
| Grant Bevis | 2****s | 1 |
| Ian Gibbs | i****s@c****g | 1 |
| Jack | 4****y | 1 |
| Jay Turner | j****r@g****m | 1 |
| Matt | 6****d | 1 |
| Michael | t****r@g****m | 1 |
| MrListerCoUk | 6****k | 1 |
| Stuart Chapman | S****z | 1 |
| UK-JustinSmall | 1****l | 1 |
| justwatchme | 5****e | 1 |
| ksimuk | m****v@g****m | 1 |
| reidjr2 | 1****2 | 1 |
Committer domains:
- cpan.org: 1
- pixelinspiration.com: 1
- symr.io: 1
- codechimp.org: 1
- aylett.co.uk: 1
- alecrust.com: 1
- uk.ibm.com: 1
- rocketmakers.com: 1
- dsoworld.co.uk: 1
- reedyboy.net: 1
- martynus.net: 1
- davidskendall.co.uk: 1
Issue and Pull Request metadata
Last synced: 1 day ago
Total issues: 774
Total pull requests: 229
Average time to close issues: 26 days
Average time to close pull requests: 8 days
Total issue authors: 405
Total pull request authors: 28
Average comments per issue: 6.71
Average comments per pull request: 0.66
Merged pull request: 211
Bot issues: 0
Bot pull requests: 0
Past year issues: 191
Past year pull requests: 75
Past year average time to close issues: 17 days
Past year average time to close pull requests: 7 days
Past year issue authors: 135
Past year pull request authors: 14
Past year average comments per issue: 5.98
Past year average comments per pull request: 0.31
Past year merged pull request: 64
Past year bot issues: 0
Past year bot pull requests: 0
Top Issue Authors
- BottlecapDave (47)
- djdarlo (14)
- pacemaker82 (13)
- reedy (12)
- gcoan (11)
- UK-JustinSmall (9)
- dmelliott20 (7)
- coleburg (7)
- jwt99412 (7)
- alfwro13 (7)
- plord12 (7)
- mdeakin99 (7)
- ColinRobbins (7)
- JRascagneres (6)
- sshaikh (6)
Top Pull Request Authors
- BottlecapDave (185)
- reedy (7)
- gcoan (5)
- 696GrocuttT (4)
- lwis (3)
- Pixel-Gavin (2)
- purcell-lab (2)
- MrListerCoUk (1)
- UK-JustinSmall (1)
- grantbevis (1)
- thecem (1)
- bobrippling (1)
- AlecRust (1)
- realflash (1)
- sargant (1)
Top Issue Labels
- bug (538)
- enhancement (186)
- stale (66)
- next release (24)
- awaiting release confirmation (23)
- More demand needed (18)
- external contributions welcome (10)
- breaking change (8)
- help wanted (7)
- Octopus Energy issue (6)
- awaiting response (2)
- Octopus Energy API change (2)
- question (2)
- under consideration (1)
Top Pull Request Labels
- released (79)
- enhancement (1)
Dependencies
- 657 dependencies
- @semantic-release/changelog ^6.0.1 development
- @semantic-release/exec ^6.0.2 development
- @semantic-release/git ^10.0.1 development
- commitizen ^4.2.4 development
- conventional-changelog-eslint ^3.0.9 development
- cz-customizable ^6.3.0 development
- husky ^4.3.8 development
- semantic-release ^18.0.0 development
- homeassistant >=2021.12.01
- mock *
- pytest *
- pytest-asyncio *
- pytest-socket *
- actions/stale v4 composite
- actions/checkout v2 composite
- asdf-vm/actions/install v1 composite
- devmasx/merge-branch master composite
- hacs/action main composite
- home-assistant/actions/hassfest master composite
- mike ==2.0.0
- mkdocs-material ==9.5.1
- actions/cache v3 composite
- actions/checkout v4 composite
- actions/setup-python v4 composite
Score: 9.895707365217167