diff --git a/.gitignore b/.gitignore index 81f4c37f8..a266cb642 100644 --- a/.gitignore +++ b/.gitignore @@ -13,3 +13,5 @@ audi.* credentials.json token.json assets/js/debug.js +evcc +__debug_bin diff --git a/.golangci.yml b/.golangci.yml index 43ce53b2a..be79d57db 100644 --- a/.golangci.yml +++ b/.golangci.yml @@ -2,3 +2,5 @@ issues: exclude: - "func `..Wallbe..showIO` is unused" - "func `..Wallbe..showIOs` is unused" + - .regOverchargeProtect. is unused + - .regActualCurrent. is unused diff --git a/Dockerfile b/Dockerfile index f19fbc6f2..54d4a3fe3 100644 --- a/Dockerfile +++ b/Dockerfile @@ -26,7 +26,6 @@ FROM alpine # Import from builder. COPY --from=builder /usr/share/zoneinfo /usr/share/zoneinfo COPY --from=builder /etc/ssl/certs/ca-certificates.crt /etc/ssl/certs/ -COPY --from=builder /etc/passwd /etc/passwd # Copy our static executable COPY --from=builder /build/evcc /usr/local/bin/evcc diff --git a/Makefile b/Makefile index 65b7cf7a3..648b31bbe 100644 --- a/Makefile +++ b/Makefile @@ -33,7 +33,8 @@ build: publish-images: @echo Version: $(VERSION) $(BUILD_DATE) - seihon publish -v "$(TAG_NAME)" -v "latest" --image-name andig/evcc-base --base-runtime-image alpine --dry-run=false --targets=arm.v6,amd64 +# seihon publish -v "$(TAG_NAME)" -v "latest" --image-name andig/evcc1 --base-runtime-image alpine --dry-run=false --targets=arm.v6,amd64 + docker build -t "andig/evcc:latest" . && docker push andig/evcc:latest test-release: goreleaser --snapshot --skip-publish --rm-dist diff --git a/README.md b/README.md index a343d68e9..450e5c73a 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,17 @@ EVCC is an EV Charge Controller implemented in [Go](2). It comes with a bundled implementation for Wallbe chargers but supports any type of charger or meter through scripting and integration with MQTT. +Features: + +- support for Wallbe chargers +- support for any charger, meter or EV using scripting +- integration with home automation - supports shell scripts and MQTT +- soft ramp-up/ramp-down of charge current +- electric contactor protection +- clean, non-bloat user interface + +![Screenshot](docs/screenshot.png) + **NOTE:** You are using this software **entirely** at your own risk. It is your responsibility to verify it is working as intended. ## Background @@ -15,21 +26,27 @@ Hence, for a simplified and stricter implementation of an EV charge controller, - typed language with ability for systematic testing - achieved by using [Go](2) - structured cnofiguration - supports YAML-based [config file](evcc.dist.yaml) - avoidance of feature bloat, simple and clean UI - utilizes [Bootstrap](3) -- integration with home automation - supports shell scripts and MQTT - containerized operation beyond Raspbery Pi - provide multi-arch [Docker Image](4) - support for multiple load points - tbd -## User interface - -EVCC features a clean, non-bloat user interface: - -![Screenshot](docs/screenshot.png) - ## Installation -To build EVCC from source, [Go](2) 1.13 is required: +### Hardware - make +EVCC requires a supported charger and a combination of grid, PV and charge meter. +Charger and meters MUST be professionally installed. + +#### Wallbe Charger + +Wallbe chargers are supported out of the box. The Wallbe must be connected using Ethernet. If not configured, the default address `192.168.0.8:502` is used. + +To allow controlling charge start/stop, the Wallbe physical configuration must be modified. This requires opening the Wallbe and should only be done by professionals. Once opened, DIP 10 must be set to ON: + +![dip10](docs/dip10.jpeg) + +More information on interacting with Wallbe chargers can be found at [GoingElectric](https://www.goingelectric.de/forum/viewtopic.php?p=1212583). Use with care. + +### Software The preferred way of running EVCC is using the docker image: @@ -43,56 +60,52 @@ To run EVCC with given config file and UI on port 7070: docker run -v $(pwd)/evcc.dist.yaml:/etc/evcc.yaml -p 7070:7070 andig/evcc-bundle +To build EVCC from source, [Go](2) 1.13 is required: + + make + ## Configuration ### Charge Modes -Three operation modes are supported: +Multiple charge modes are supported: - **Off**: disable the charger, even if car gets connected. - **Now** (**Sofortladen**): charge immediately with maximum allowed current. - **Min + PV**: charge immediately with minimum configured current. Additionally use PV if available. - **PV**: use PV as available. May not charge the car if PV remains dark. -In general, due to the minimum value of 5% for signalling the EV duty cycle, the charger cannot limit the current to below 6A. If the available power calculation demands a limit less than 6A, handling depends on the charge mode. In **PV** mode, +In general, due to the minimum value of 5% for signalling the EV duty cycle, the charger cannot limit the current to below 6A. If the available power calculation demands a limit less than 6A, handling depends on the charge mode. In **PV** mode, the charger will be disabled until available PV power supports charging with at least 6A. In **Min + PV** mode, charging will continue at minimum current of 6A and charge current will be raised as PV power becomes available again. ### PV generator configuration For both PV modes, EVCC needs to assess how much residual PV power is available at the grid connection point and how much power the charger actually uses. Various methods are implemented to obtain this information, with different degrees of accuracy. -#### PV meter +- **PV meter**: Configuring a *PV meter* is the simplest option. *PV meter* measures the PV generation. The charger is allowed to consume: -Configuring a *PV meter* is the simplest option. *PV meter* measures the PV generation. The charger is allowed to consume: + Charge Power = PV Meter Power - Residual Power - Charge Power = PV Meter Power - Residual Power + The *Residual Power* is a configurable assumption how much power remaining facilities beside the charger use. -The *Residual Power* is a configurable assumption how much power remaining facilities beside the charger use. +- **Grid meter**: Configuring a *grid meter* is the preferred option. The *grid meter* is expected to be a two-way meter (import+export) and return the current amount of grid export as negative value measured in kWh. The charger is then allowed to consume: -#### Grid meter + Δ Charge Power = Grid Meter Power - Residual Power -Configuring a *grid meter* is the preferred option. The *grid meter* is expected to be a two-way meter (import+export) and return the current amount of grid export as negative value. The charger is then allowed to consume: + rounded down and capped at zero and - Δ Charge Power = Grid Meter Power - Residual Power + Charge Power = Current Charge Power + Δ Charge Power -rounded down and capped at zero and - - Charge Power = Current Charge Power + Δ Charge Power - -In this setup, *residual power* is used margin to account for fluctuations in PV production that may be faster than EVCC's control loop. + In this setup, *residual power* is used as margin to account for fluctuations in PV production that may be faster than EVCC's control loop. ### Charger configuration When using a *grid meter* for accurate control of PV utilization, EVCC needs to be able to determine the current charge power. There are two configurations for determining the *current charge power*: -#### Charge meter - -A *charge meter* is often integrated into the charger but can also be installed separately. EVCC expects the *charge meter* to supply *charge power* and preferably also *total energy*. +- **Charge meter**: A *charge meter* is often integrated into the charger but can also be installed separately. EVCC expects the *charge meter* to supply *charge power* and preferably also *total energy*. If *total energy* is supplied, it can be used to calculate the *charged energy* for the current charging cycle. -#### No charge meter - -If not charge meter is installed, *charge power* is deducted from *charge current* as controlled by the charger. This method is less accurate than using a *charge meter* since the EV may chose to use less power than EVCC has allowed for consumption. -If the charger supplies *total energy* for the charging cycle this value is preferred over the *charge meter*'s value (if present) +- **No charge meter**: If no charge meter is installed, *charge power* is deducted from *charge current* as controlled by the charger. This method is less accurate than using a *charge meter* since the EV may chose to use less power than EVCC has allowed for consumption. +If the charger supplies *total energy* for the charging cycle this value is preferred over the *charge meter*'s value (if present). ## Implementation @@ -102,23 +115,22 @@ EVCC consists of four basic elements: *Charger*, *Meter*, *SoC* and *Loadpoint*. Charger is reponsible for EV state handling: -- `Status()` -- `Enabled()` -- `Enable(enable bool)` -- `ActualCurrent()` -- `MaxCurrent(current int64)` (`ChargeController` only) +- `Status()`: get charge controller status (`A...F`) +- `Enabled()`: get charger availablity +- `Enable()`: set charger availability +- `MaxCurrent()`: set maximum allowed charge current in A Available charger implementations are: - `wallbe`: implements the interface to the Wallbe Eco chargers -- `configurable`: default charger implementation using configurable plugins for accessing device data +- `default`: default charger implementation using configurable plugins for integrating any type of charger ### Meter Meters provide data about power and energy consumption: -- `CurrentPower()` -- `TotalEnergy()` (`MeterEnergy` only) +- `CurrentPower()`: power in W +- `TotalEnergy()`: energy in kWh (optional) Meter has a single implementaton where meter readings- power and energy- can be configured to be delivered by plugin. @@ -126,13 +138,13 @@ Meter has a single implementaton where meter readings- power and energy- can be SoC represents a specific EV battery. Configuring a SoC allows to define it's `Capacity (kWh)` and dynamically provide: -- `ChargeState()` +- `ChargeState()`: state of charge in % If SoC is configured and assigned to the charger, charge status and remaining charge duration become available in the user interface. ### Loadpoint -Loadpoint controls the Charger behaviour according to the operations mode- off, now, pv + minimum or pv only. +Loadpoint controls the Charger behaviour according to the operations mode- *off*, *now*, *PV + minimum* or *PV only*. ## Plugins @@ -140,7 +152,7 @@ Plugins are used to implement accessing and updating generic data sources. EVCC - `mqtt`: this plugin allows to read values from MQTT topics. This is particularly useful for meters, e.g. when meter data is already available on MQTT. See [MBMD](5) for an example how to get Modbus meter data into MQTT. This plugin type is read-only and does not provide write access. -- `exec`: the exec plugin executes external scripts to read or update data. This plugin is useful to implement any type of external functionality. +- `script`: the script plugin executes external scripts to read or update data. This plugin is useful to implement any type of external functionality. When using plugins for *write* access, the actual data is provided as variable in form of `${var[:format]}`. The variable is replaced with the actual data before the plugin is executed. diff --git a/api/api.go b/api/api.go index ea484d0a9..6cb2f16f0 100644 --- a/api/api.go +++ b/api/api.go @@ -2,19 +2,19 @@ package api import "time" -//go:generate mockgen -package mock -destination ../mock/mock.go github.com/andig/evcc/api Charger,ChargeController,Meter,MeterEnergy +//go:generate mockgen -package mock -destination ../mock/mock.go github.com/andig/evcc/api Charger,Meter,MeterEnergy -// Meter is able to provide current power at metering point -type Meter interface { - CurrentPower() (float64, error) -} +// ChargeMode are charge modes modeled after OpenWB +type ChargeMode string -// MeterEnergy is able to provide current power at metering point -type MeterEnergy interface { - TotalEnergy() (float64, error) -} +const ( + ModeOff ChargeMode = "off" + ModeNow ChargeMode = "now" + ModeMinPV ChargeMode = "minpv" + ModePV ChargeMode = "pv" +) -// ChargeStatus is the EVSE models charging status from A to F +// ChargeStatus is the EV's charging status from A to F type ChargeStatus string const ( @@ -27,17 +27,21 @@ const ( StatusF ChargeStatus = "F" // Fzg. angeschlossen: ja Laden möglich: nein ) +// Meter is able to provide current power in W +type Meter interface { + CurrentPower() (float64, error) +} + +// MeterEnergy is able to provide current energy in kWh +type MeterEnergy interface { + TotalEnergy() (float64, error) +} + // Charger is able to provide current charging status and to enable/disabler charging type Charger interface { Status() (ChargeStatus, error) Enabled() (bool, error) Enable(enable bool) error - ActualCurrent() (int64, error) - // MaxCurrent(current int64) error -} - -// ChargeController provides controlling of the charger's max allowed power -type ChargeController interface { MaxCurrent(current int64) error } @@ -46,21 +50,11 @@ type ChargeTimer interface { ChargingTime() (time.Duration, error) } -// ChargeRater provides charged energy amount +// ChargeRater provides charged energy amount in kWh type ChargeRater interface { ChargedEnergy() (float64, error) } -// ChargeMode are charge modes modeled after OpenWB -type ChargeMode string - -const ( - ModeOff ChargeMode = "off" - ModeNow ChargeMode = "now" - ModeMinPV ChargeMode = "minpv" - ModePV ChargeMode = "pv" -) - // SoC represents the EV battery's state type SoC interface { ChargeState() (float64, error) diff --git a/assets/index.html b/assets/index.html index 78a36f0d4..2e6f4cd3f 100644 --- a/assets/index.html +++ b/assets/index.html @@ -36,19 +36,6 @@ -
-
-
- Error - HTTP {{error.status}} - -
-
{{error.message}}
-
-
-
+
+
+
+ Error + HTTP {{error.status}} + +
+
{{error.message}}
+
+
+