firstof9 / ha-openei

OpenEI integration for Home Assistant
MIT License
15 stars 2 forks source link
api energy hacktoberfest home-assistant homeassistant integration rates

HA-OpenEI

GitHub Release GitHub Activity License

hacs Project Maintenance BuyMeCoffee

Discord Community Forum

Component to integrate with OpenEI.org.

This component will set up the following platforms.

Platform Description
sensor Show info from OpenEI's API.

Installation

  1. Using the tool of choice open the directory (folder) for your HA configuration (where you find configuration.yaml).
  2. If you do not have a custom_components directory (folder) there, you need to create it.
  3. In the custom_components directory (folder) create a new folder called openei.
  4. Download all the files from the custom_components/openei/ directory (folder) in this repository.
  5. Place the files you downloaded in the new directory (folder) you created.
  6. Restart Home Assistant
  7. In the HA UI go to "Configuration" -> "Integrations" click "+" and search for "OpenEI Utility Rates"

Configuration is done in the UI

Step 1: Enter your API Key:

step1

Step 2: Select your utility company:

step2

Step 3.1: Select your rate plan:

step3.1 step3.2

Contributions are welcome!

If you want to contribute to this please read the Contribution guidelines