https://github.com/mattdahepic/ha-midas

Home Assistant integration to get energy prices from California's MIDAS energy price API
https://github.com/mattdahepic/ha-midas

api california energy home-assistant

Last synced: 2 days ago
JSON representation

Home Assistant integration to get energy prices from California's MIDAS energy price API

• Host: GitHub
• URL: https://github.com/mattdahepic/ha-midas
• Owner: MattDahEpic
• License: mit
• Created: 2024-08-26T01:59:44.000Z (about 1 month ago)
• Default Branch: main
• Last Pushed: 2024-09-17T02:33:50.000Z (10 days ago)
• Last Synced: 2024-09-20T12:50:53.721Z (7 days ago)
• Topics: api, california, energy, home-assistant
• Language: Python
• Homepage:
• Size: 236 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# MIDAS (California Energy Prices)

![MIDAS integration logo](https://brands.home-assistant.io/midas/logo.png)

Custom integration to get the current electricity price and other data for many California electric bills from the California energy regulator's electricity price API MIDAS.

If your electric bill has a **RIN QR Code** on it, you can use this integration to get your current electricity price.

## Installation

[![Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=MattDahEpic&repository=ha-midas&category=Integration)

To install this integration, add this GitHub Repo to the HACS Custom Repositories, or click the badge above.

## Configuration

Configuration is done in the UI, please follow the steps below for guidance.

1. Add the integration in the `Devices & services` section or click this add link:  

[![Open your Home Assistant instance and start setting up a new integration.](https://my.home-assistant.io/badges/config_flow_start.svg)](https://my.home-assistant.io/redirect/config_flow_start/?domain=midas)

2. Choose whether you have a MIDAS account or not.  

  ![Config step 1: Do you have a MIDAS account? Yes or no](.pictures/config-step1.png)

3. If you don't have a MIDAS account the integration will help you create one.  

  ![Config step 1.5: Create a MIDAS account.](.pictures/config-step1.5.png)  

  Once complete, click the link sent to your email to activate your account.  

  ![Config step 1.75: MIDAS account creation successful. Please click the link in your email to activate the account before continuing.](.pictures/config-step1.75.png)

4. Enter your MIDAS account information.  

  ![Config step 2: Enter your MIDAS account credentials](.pictures/config-step2.png)

5. Enter one or more Rate IDs to monitor, obtained from the QR code on your electric bill.  

  ![Config step 3: Enter Rate IDs to monitor](.pictures/config-step3.png)

6. A device will be created for each Rate ID entered.  

  ![Config step 4: Devices are created for each entered RID](.pictures/config-step4.png)

These entities can be used in the Energy dashboard to set prices, in automations to help conserve energy when prices will increase soon, and more!  

![Price entities being used in the Energy dashboard for price tracking](.pictures/energy-dashboard-usage.png)

![Tariff name entity being used in an automation for taking actions when peak usage starts](.pictures/automation-usage.png)

## Setup recommendations

I recommend placing the MIDAS price entities inside a "Combine the state of several sensors" helper. This can help resolve the following issues and make your steup more resilient:

* If you're a Community Choice Aggregation (CCA) customer you have 2 RINs. Combine them with a Sum type to get a single entity that has your true per-kWh cost.

* If you ever change your electricity plan, like moving from one time-of-use plan to another or buying an electric vehicle or solar panels, placing your price sensors inside a helper will let you keep your energy dashboard history and replace the source sensor when your plan updates.

* Your electricity company can update your RIN at any time even if the amount you actually pay stays the same. If that happens, you'll need to update which RINs this integration provides which may cause the loss of the old rate's data.

## Contributions are welcome!

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