Skip to content

firstof9/openevse

Repository files navigation

OpenEVSE

GitHub Release GitHub Activity License

hacs Project Maintenance BuyMeCoffee

Discord Community Forum

Component to integrate with OpenEVSE chargers.

This component will set up the following platforms.

Platform Description
binary_sensor On/Off sensors for various settings.
button Button to restart the ESP chip or the EVSE.
light Set the LED brightness.
number Set the charge rate.
select Select the ampers limit and service level.
sensor Show info from an OpenEVSE charger's API.
switch Switch to toggle various charger modes.
update Idicate when a firmware update is available.

Services

Services are prefixed with openevse (ie: openevse.set_override)

Service Return Value Description
set_override n Sets override settings on a charger.
clear_override n Clears an override on a charger.
set_limit n This will set the limit type, value and auto release.
clear_limit n Clears a limit on a charger.
get_limit y Gets a limit on a charger.
make_claim n Make/Update a claim on a charger.
release_claim n Releases a claim on a charger.
list_claims y Lists claims on an EVSE.
list_overrides y Lists overrides on an EVSE.

Installation via HACS (recommended)

Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.

  1. Follow the link here
  2. Use the custom repo link https://github.com/firstof9/openevse
  3. Select the category type integration
  4. Then once it's there (still in HACS) click the INSTALL button
  5. Restart Home Assistant
  6. Once restarted, in the HA UI go to Configuration (the ⚙️ in the lower left) -> Devices and Services click + Add Integration and search for openevse

Manual (non-HACS)

Instructions
You probably do not want to do this! Use the HACS method above unless you know what you are doing and have a good reason as to why you are installing manually
  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 openevse.
  4. Download all the files from the custom_components/openevse/ directory (folder) in this repository.
  5. Place the files you downloaded in the new directory (folder) you created.
  6. Restart Home Assistant
  7. Once restarted, in the HA UI go to Configuration (the ⚙️ in the lower left) -> Devices and Services click + Add Integration and search for openevse

Configuration is done in the UI

Contributions are welcome!

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


TODO

  • Add Wiki
  • Update documentation
  • Add tests
  • Current
  • Voltage
  • Power
  • Session Energy
  • Total Energy
  • Status
  • Temps
  • Vehicle connected
  • Rssi
  • Max current
  • Charge current
  • Manual Override
  • Schedule
  • Divert mode
  • Auto discovery
  • Setup via Home Assistant UI
  • Real time updates via web socket
  • Support energy integration
  • Use newer OpenEVSE APIs