Skip to content

GuyKh/iec-custom-component

Repository files navigation

Israel Electric Corporation (IEC) Custom Component

GitHub Release GitHub Activity License

Project Maintenance BuyMeCoffee

Integration to integrate with IEC API.

This integration will set up the following platforms.

Example Image

Platform Description
sensor Show info from IEC invoice and meters.

Installation

Automatic (HACS):

  1. Add this path to HACS: https://github.com/GuyKh/iec-custom-component
  2. Install through HACS

Manual:

  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 iec.
  4. Download all the files from the custom_components/iec/ 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 "IEC"

Configuration is done in the UI

Logs

To view logs in debug add this to configuration.yaml:

logger:
  default: info
  logs:
    ...
    custom_components.iec: debug
    iec_api: debug

Frequently Asked Questions

How often is the data fetched?

The component currently fetches data from IEC every hour, but IEC doesn't update the data very often and they don't really have a consistant behavior, it could arrive with 2 days delay.

Can this component be used even if I'm using a private electric company?

Yes.
However, the only difference is that in the Invoices you'll see balance = 0 since you're paying to the private company

Should I enter my configuration credentials every time?

No.
You should do it only once when configuring the component.

I have a "dumb" meter, would this component still work for me.

Yes, But....
You would only get a subset of sensors, based on your Invoice information.

Examples of usage.

You can head to usage and examples page to see examples of this components used in cards in HomeAssistant

Using Postman Collection for calling the IEC API

If you want to use Postman to get the API calls - please read the Postman Collections Guide

Contributions are welcome!

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