HomeAssistant-OctopusEnergy
Unofficial Home Assistant integration for interacting with Octopus Energy
https://github.com/BottlecapDave/HomeAssistant-OctopusEnergy
Science Score: 26.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (9.3%) to scientific vocabulary
Keywords
Repository
Unofficial Home Assistant integration for interacting with Octopus Energy
Basic Info
- Host: GitHub
- Owner: BottlecapDave
- License: mit
- Language: Python
- Default Branch: develop
- Homepage: https://bottlecapdave.github.io/HomeAssistant-OctopusEnergy/
- Size: 7.04 MB
Statistics
- Stars: 774
- Watchers: 23
- Forks: 78
- Open Issues: 34
- Releases: 194
Topics
Metadata Files
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
- Name: David Kendall
- Login: BottlecapDave
- Kind: user
- Website: http://www.davidskendall.co.uk
- Twitter: BottlecapDave
- Repositories: 9
- Profile: https://github.com/BottlecapDave
GitHub Events
Total
- Create event: 70
- Commit comment event: 9
- Issues event: 357
- Release event: 41
- Watch event: 170
- Delete event: 26
- Issue comment event: 1,642
- Push event: 388
- Pull request review event: 41
- Pull request review comment event: 64
- Pull request event: 148
- Fork event: 19
Last Year
- Create event: 70
- Commit comment event: 9
- Issues event: 357
- Release event: 41
- Watch event: 170
- Delete event: 26
- Issue comment event: 1,642
- Push event: 388
- Pull request review event: 41
- Pull request review comment event: 64
- Pull request event: 148
- Fork event: 19
Committers
Last synced: 10 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| BottlecapDave | me@d****k | 1,108 |
| semantic-release-bot | s****t@m****t | 151 |
| Geoffrey Coan | 1****n@u****m | 11 |
| Sam Reed | s****m@r****t | 9 |
| Sam Reed | r****y@w****g | 7 |
| Thomas Grocutt | t****m@d****k | 4 |
| David Kendall | d****d@r****m | 2 |
| Lewis Juggins | 8****s@u****m | 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@u****m | 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@u****m | 1 |
| Ian Gibbs | i****s@c****g | 1 |
| Jack | 4****y@u****m | 1 |
| Jay Turner | j****r@g****m | 1 |
| Matt | 6****d@u****m | 1 |
| Michael | t****r@g****m | 1 |
| MrListerCoUk | 6****k@u****m | 1 |
| Speak to the Geek | 4****r@u****m | 1 |
| Stuart Chapman | S****z@u****m | 1 |
| UK-JustinSmall | 1****l@u****m | 1 |
| justwatchme | 5****e@u****m | 1 |
| ksimuk | m****v@g****m | 1 |
| reidjr2 | 1****2@u****m | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 10 months ago
All Time
- Total issues: 713
- Total pull requests: 337
- Average time to close issues: 25 days
- Average time to close pull requests: 7 days
- Total issue authors: 462
- Total pull request authors: 36
- Average comments per issue: 5.32
- Average comments per pull request: 0.51
- Merged pull requests: 286
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 229
- Pull requests: 149
- Average time to close issues: 14 days
- Average time to close pull requests: 4 days
- Issue authors: 180
- Pull request authors: 15
- Average comments per issue: 3.59
- Average comments per pull request: 0.33
- Merged pull requests: 116
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- BottlecapDave (47)
- reedy (13)
- djdarlo (12)
- gcoan (9)
- pacemaker82 (9)
- alfwro13 (8)
- sshaikh (7)
- springfall2008 (6)
- UK-JustinSmall (6)
- mdeakin99 (6)
- JRascagneres (5)
- holdestmade (5)
- ColinRobbins (5)
- plord12 (5)
- jwt99412 (5)
Pull Request Authors
- BottlecapDave (261)
- reedy (19)
- gcoan (6)
- lwis (6)
- 696GrocuttT (3)
- grantbevis (2)
- Pixel-Gavin (2)
- andrewaylett (2)
- thewishy (2)
- mitchellrj (2)
- TurnrDev (2)
- jeverley (2)
- thecem (2)
- eugeneniemand (2)
- sOckhamSter (2)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 2
- Total downloads: unknown
-
Total dependent packages: 0
(may contain duplicates) -
Total dependent repositories: 0
(may contain duplicates) - Total versions: 350
proxy.golang.org: github.com/bottlecapdave/homeassistant-octopusenergy
- Documentation: https://pkg.go.dev/github.com/bottlecapdave/homeassistant-octopusenergy#section-documentation
- License: mit
-
Latest release: v16.3.0+incompatible
published 10 months ago
Rankings
proxy.golang.org: github.com/BottlecapDave/HomeAssistant-OctopusEnergy
- Documentation: https://pkg.go.dev/github.com/BottlecapDave/HomeAssistant-OctopusEnergy#section-documentation
- License: mit
-
Latest release: v16.3.0+incompatible
published 10 months ago
Rankings
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