ha-openei

KO | EN

gitlite — search

#python #react #llm #machine-learning #rust #deep-learning #docker #macos #windows #awesome #vue #security #ios #openai

(★ 17)

OpenEI integration for Home Assistant

ha-openei Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# HA-OpenEI

[![GitHub Release][releases-shield]][releases]
[![GitHub Activity][commits-shield]][commits]
[![License][license-shield]](https://raw.githubusercontent.com/firstof9/ha-openei/master/LICENSE)

[![hacs][hacsbadge]][hacs]
![Project Maintenance][maintenance-shield]
[![BuyMeCoffee][buymecoffeebadge]][buymecoffee]

[![Discord][discord-shield]][discord]
[![Community Forum][forum-shield]][forum]

_Component to integrate with [OpenEI.org][openei]._

**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][step1img]

Step 2: Select your utility company:

![step2][step2img]

Step 3.1: Select your rate plan:

![step3.1][step3-1img]
![step3.2][step3-2img]

## Contributions are welcome!

If you want to contribute to this please read the [Contribution guidelines](CONTRIBUTING.md)

***

[openei]: https://openei.org/
[buymecoffee]: https://www.buymeacoffee.com/firstof9
[buymecoffeebadge]: https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg?style=for-the-badge
[commits-shield]: https://img.shields.io/github/commit-activity/y/firstof9/ha-openei.svg?style=for-the-badge
[commits]: https://github.com/firstof9/ha-openei/commits/master
[hacs]: https://github.com/custom-components/hacs
[hacsbadge]: https://img.shields.io/badge/HACS-Custom-orange.svg?style=for-the-badge
[discord]: https://discord.gg/Qa5fW2R
[discord-shield]: https://img.shields.io/discord/330944238910963714.svg?style=for-the-badge
[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg?style=for-the-badge
[forum]: https://community.home-assistant.io/
[license-shield]: https://img.shields.io/github/license/firstof9/ha-openei.svg?style=for-the-badge
[maintenance-shield]: https://img.shields.io/badge/maintainer-Chris%20Nowak%20%40firstof9-blue.svg?style=for-the-badge
[releases-shield]: https://img.shields.io/github/release/firstof9/ha-openei.svg?style=for-the-badge
[releases]: https://github.com/firstof9/ha-openei/releases
[step1img]: images/step1.png
[step2img]: images/step2.png
[step3-1img]: images/step3-1.png
[step3-2img]: images/step3-2.png

ha-openei

ha-openei Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

ha-openei

ha-openei Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README