Data

Tools

Indexes

Applications

Experiments

Open Sustainable Technology

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

solar varta varta-storage solar-energy hacs octopus sustainability

Last synced: about 24 hours ago
JSON representation

Repository metadata

Unofficial Home Assistant integration for interacting with Octopus Energy

README.md

Home Assistant Octopus Energy

installation_badge

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.

Owner metadata

GitHub Events

Total
Last Year

Committers metadata

Last synced: 2 days ago

Total Commits: 1,554
Total Committers: 53
Avg Commits per committer: 29.321
Development Distribution Score (DDS): 0.173

Commits in past year: 159
Committers in past year: 26
Avg Commits per committer in past year: 6.115
Development Distribution Score (DDS) in past year: 0.252

Name Email Commits
BottlecapDave me@d****k 1285
semantic-release-bot s****t@m****t 178
Sam Reed s****m@r****t 20
Geoffrey Coan 1****n 13
Thomas Grocutt t****m@d****k 4
Dave Wood d****d@g****m 2
David Kendall d****d@r****m 2
Lewis Juggins 8****s 2
Mark Cocker m****r@u****m 2
ProximusAl 1****l 2
Tom Carpenter T****r@l****k 2
DJBenson d****n@g****m 1
Gavin Melling g****n@p****m 1
Grant Bevis 2****s 1
Harry Coureau h****y@c****e 1
Ian Gibbs i****s@c****g 1
Isaac Rushworth 1****2 1
Ivan Alekseev 2****v 1
Jack 4****y 1
Cristian 8****c 1
Constantinos 1****t 1
Colin Seymour c****n@s****o 1
Ben Campbell M****1 1
Andrew Jackson a****w@c****g 1
Andrew Aylett a****w@a****k 1
Alexander Chernov a****r@c****t 1
wildsurfer i****n@y****s 1
Jay Turner j****r@g****m 1
reidjr2 1****2 1
prpr19xx 5****x 1
and 23 more...

Committer domains:

Issue and Pull Request metadata

Last synced: 2 days ago

Total issues: 948
Total pull requests: 428
Average time to close issues: 27 days
Average time to close pull requests: 8 days
Total issue authors: 615
Total pull request authors: 64
Average comments per issue: 5.63
Average comments per pull request: 0.55
Merged pull request: 351
Bot issues: 4
Bot pull requests: 0

Past year issues: 179
Past year pull requests: 65
Past year average time to close issues: about 1 month
Past year average time to close pull requests: 9 days
Past year issue authors: 146
Past year pull request authors: 30
Past year average comments per issue: 6.68
Past year average comments per pull request: 0.78
Past year merged pull request: 49
Past year bot issues: 4
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/BottlecapDave/HomeAssistant-OctopusEnergy

Top Issue Authors

  • BottlecapDave (53)
  • reedy (20)
  • gcoan (15)
  • djdarlo (12)
  • pacemaker82 (10)
  • jwt99412 (9)
  • alfwro13 (8)
  • f1wade (8)
  • ColinRobbins (7)
  • sshaikh (7)
  • springfall2008 (6)
  • UK-JustinSmall (6)
  • holdestmade (6)
  • JRascagneres (6)
  • mdeakin99 (6)

Top Pull Request Authors

  • BottlecapDave (303)
  • reedy (27)
  • gcoan (7)
  • lwis (6)
  • hCoureau (4)
  • sargant (4)
  • jeverley (3)
  • charliegadget (3)
  • 696GrocuttT (3)
  • TurnrDev (2)
  • thecem (2)
  • mitchellrj (2)
  • chalfontchubby (2)
  • thewishy (2)
  • con-ant (2)

Top Issue Labels

  • bug (670)
  • enhancement (218)
  • stale (109)
  • awaiting-maintainer-response (98)
  • next release (48)
  • More demand needed (14)
  • awaiting release confirmation (14)
  • Octopus Energy issue (12)
  • Available in beta (9)
  • external contributions welcome (7)
  • breaking change (7)
  • Octopus Energy API change (6)
  • help wanted (5)
  • graphql-deprecation (4)
  • awaiting response (2)
  • question (2)
  • next-release (2)
  • External Deadline (1)
  • under consideration (1)

Top Pull Request Labels

  • released (69)
  • awaiting-maintainer-response (13)
  • enhancement (1)
  • bug (1)
  • breaking change (1)

Package metadata

proxy.golang.org: github.com/BottlecapDave/HomeAssistant-OctopusEnergy

proxy.golang.org: github.com/bottlecapdave/homeassistant-octopusenergy

nixpkgs-unstable: home-assistant-custom-components.octopus_energy

Unofficial Home Assistant integration for interacting with Octopus Energy

Dependencies

package-lock.json npm
  • 657 dependencies
package.json npm
  • @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
requirements.test.txt pypi
  • homeassistant >=2021.12.01
  • mock *
  • pytest *
  • pytest-asyncio *
  • pytest-socket *
.github/workflows/main.yml actions
  • 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
.github/actions/setup/action.yml actions
  • asdf-vm/actions/install v4 composite
.github/actions/setup-python/action.yml actions
  • actions/cache v4 composite
  • actions/setup-python v5 composite
.github/workflows/close_issues.yml actions
  • actions/stale v9 composite
  • dessant/lock-threads v5 composite
.github/workflows/label_issues.yml actions
  • actions/github-script v7 composite
requirements.txt pypi
  • mike ==2.0.0
  • mkdocs-material ==9.5.1
.github/workflows/docs.yml actions
  • actions/cache v3 composite
  • actions/checkout v4 composite
  • actions/setup-python v4 composite
.github/workflows/triage_new_issue.yml actions
  • ./.github/actions/setup * composite
  • actions/checkout v6 composite
.github/workflows/check_deprecations.yml actions
  • ./.github/actions/setup * composite
  • actions/checkout v6 composite

Score: 10.987798056493379