Giter VIP home page Giter VIP logo

smartenergy.goecharger's Introduction

Homeassistant integration for go-e Charger Cloud

hacs_badge

This is an integration for the Home Assistant for the go-e Charger Cloud wallbox (API v2) using this library.

How to use it

HACS

  1. Open your Home Assistant in a browser.
  2. In case you don't have HACS, follow the steps from here https://hacs.xyz/docs/configuration/basic.
  3. In the left menu you should have HACS icon, click it.
  4. Click on Integrations -> click 3 dots top right corner -> click Custom repositories.
  5. In the dialog window, add https://github.com/openkfw/smartenergy.goecharger as a repository and select Integration as a category.
  6. Click ADD, wait for spinner to finish and close the dialog.
  7. Click EXPLORE & DOWNLOAD REPOSITORIES -> search for go-e -> select the go-e Charger Cloud -> wait and click DOWNLOAD.
  8. Go to Settings -> System -> click RESTART and wait few seconds.
  9. Go to Settings -> Devices & Services. Click the ADD INTEGRATION button.
  10. Search for go-e Charger Cloud -> click -> fill in details -> click SUBMIT.

Example config:

example config

Make sure that there is no trailing slash in the API host, otherwise the validation fails. When pressing submit, validation will also check the connectivity and fails if not able to connect and authenticate.

  1. Go to the dashboard screen, you should see bunch of sensors for the go-e Charger Cloud integration.

Example Lovelace card

TBD

Features

Sensors

Parameter Name Description
car car_status State of the car - connected/charging/etc.
alw charging_allowed Whether the car is allowed to charge at all.
amp charger_max_current Requested current for charging in A.
wh energy_since_car_connected Energy in kWh since car is connected.
eto energy_total Total energy used in kWh.
psm phase_switch_mode Phase switch mode - auto/1/3.
pnp phases_number_connected Number of connected phases - relates to the phase_switch_mode.
acs charger_access Access controll for the device - 0/1.
N/A name Friendly name of the device.

Buttons

Parameter Name Description
acs access_control Changes access control to open if desired.

Number inputs

Parameter Name Description
amp charger_max_current Set the max current. Min and max values are taken from the mca and ama parameters.

Select inputs

Parameter Name Description
psm phase_switch_mode Set the phase switch mode.

Exposed services

Following functions are exposed as Home Assistant services, thus can be used by other integrations.

Name Parameters Description
start_charging {"device_name": "example_charger", "charging_power": 10} or {"device_name": "example_charger"} Starts charging with a specified charging power. charging_power is optional and you can use this service purely to start without setting the charging power.
stop_charging {"device_name": "example_charger"} Stop charging.
change_charging_power {"device_name": "example_charger", "charging_power": 10} Change charging power for a given charger.
set_phase {"device_name": "example_charger", "phase": 1} Change phase for a given charger. phase accepts values 0, 1, 2.
set_transaction {"device_name": "example_charger", "status": 0} Set the wallbox transaction. status accepts values None (no transaction) and 0 (authenticate all users).

Configuration

The integration can be configured either via UI (config flow) as described in the How to use it - HACS section or via configuration.yaml. For example:

smartenergy_goecharger:
  chargers:
    - name: examplecharger
      host: https://example.api.v3.go-e.io
      api_token: 12345

Development

In case you are interested in development, check the guide here.

smartenergy.goecharger's People

Contributors

dependabot[bot] avatar ingmarm avatar jzakotnik avatar mmacai avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

Forkers

georgimld

smartenergy.goecharger's Issues

Can't add go-eCharger

Summary and context

I can't add my go-e Chargers - I get an invalid Host
image

How to reproduce

checked if i can access the api via browser which worked:
image

Expected behavior

the integration should test the url and add the charger

Versions (please complete the following information):**

  • smart_energy_goecharger Firmware Version: 055.8
  • Home Assistant:
    Core 2024.3.0.dev20240215
    Supervisor 2024.02.0.dev1404
    Operating System 12.0.dev20240214
    Frontend 20240215.0.dev

config flow error - setup could not be completed successfully

after saving the initial config, integration could not be loaded. Log-Message:

This error originated from a custom integration.

Logger: homeassistant.setup
Source: custom_components/goechargerv2/init.py:98
Integration: go-e Charger v2 (documentation, issues)
First occurred: 2:35:44 PM (1 occurrences)
Last logged: 2:35:44 PM

Error during setup of component goechargerv2
Traceback (most recent call last):
File "/usr/src/homeassistant/homeassistant/setup.py", line 235, in _async_setup_component
result = await task
File "/config/custom_components/goechargerv2/init.py", line 211, in async_setup
chargers_api = _setup_apis(config, hass)
File "/config/custom_components/goechargerv2/init.py", line 98, in _setup_apis
raise ValueError(f"Missing {DOMAIN} entry in the config")
ValueError: Missing goechargerv2 entry in the config

Config flow validation

Add a validation to the config/options flow:

  • validate if host is a valid url
  • check for trailing slash
  • check authentication with the filled in host + token => ping wallbox

How to use exposed services in Home Assistant

Hello all,

I tried with automatiation and called the service go-e Charger Cloud: Start charging under services.
with the parameters:

device_name: go-e

But I get the error "topped because an error was encountered at 20. November 2023 um 18:17:18 (runtime: 0.03 seconds)

'go-e'"

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.