evcc

https://docs.evcc.io/en/
Admin
evcc optimizes charging your electric vehicle with self-generated solar energy or low-cost...
Tokens:599,659
Snippets:4,001
Trust Score:9
Update:1 week ago
Show doc for...
Tokens:
Raw
### enable configuration example

Source: https://docs.evcc.io/en/reference/configuration/loadpoints

Example YAML for the `enable` section, setting threshold to 0 and delay to 1m for starting charging on solar surplus.

```yaml
enable:
  threshold: 0
  delay: 1m
```

--------------------------------

### Example event definition for start event

Source: https://docs.evcc.io/en/reference/configuration/messaging

Example of defining a start event with title and message using simple placeholder syntax.

```yaml
start: # charge start event
  title: Charge started
  msg: Started charging in "${mode}" mode
```

--------------------------------

### Install completions for every new session on Linux

Source: https://docs.evcc.io/en/reference/cli/evcc_completion_bash

Execute this command once to install bash completions for all new sessions on Linux. A new shell is required for the setup to take effect.

```plaintext
evcc completion bash > /etc/bash_completion.d/evcc
```

--------------------------------

### Start Claude Code and enter query

Source: https://docs.evcc.io/en/integrations/mcp

Command to start Claude Code and an example query prompt shown in the terminal.

```bash
claude


╭──────────────────────────────────────────────────────────────────────────────────────────╮
│ > Will I be able to fill my car with solar energy today?                                 │
╰──────────────────────────────────────────────────────────────────────────────────────────╯
```

--------------------------------

### Event definitions with Go template syntax

Source: https://docs.evcc.io/en/reference/configuration/messaging

Complete example of messaging events using Go template syntax with calculations and conditions for start, stop, connect, and disconnect events.

```yaml
messaging:
  events:
    start:
      title: "{{.vehicleTitle}}: Charging started"
      msg: |
        {{.title}} charging {{.vehicleTitle}} in {{ toString .mode | upper }} mode.
        Solar: {{round (divf .pvPower 1000) 1 }} kW
        Grid: {{round (divf .grid.Power 1000) 1 }} kW
        {{if .battery}}Battery: {{round (divf .battery.Power 1000) 1 }} kW ({{.battery.Soc }} %){{end}}
    stop:
      title: "{{.vehicleTitle}}: Charging finished"
      msg: |
        {{.title}}: {{round (divf .chargedEnergy 1000) 1 }} kWh in {{.chargeDuration}}.
        Solar share: {{round .sessionSolarPercentage 0 }}%
        {{- if .sessionPrice}}
        Cost: {{round .sessionPrice 2 }} {{.currency}} ({{round .sessionPricePerKWh 2 }} {{.currency}}/kWh)
        {{- end}}
    connect:
      title: "{{.vehicleTitle}} connected"
      msg: |
        {{.vehicleTitle}} connected to {{.title}}.
        SoC: {{.vehicleSoc }}% ({{.vehicleRange }} km)
        Solar: {{round (divf .pvPower 1000) 1 }} kW
    disconnect:
      title: "{{.vehicleTitle}} disconnected"
      msg: |
        {{.vehicleTitle}} disconnected from {{.title}} after {{.connectedDuration}}.
```

--------------------------------

### Install zsh completions for every new session on Linux

Source: https://docs.evcc.io/en/reference/cli/evcc_completion_zsh

Executes once to install completions for every new session on Linux. A new shell is required for the setup to take effect.

```plaintext
evcc completion zsh > "${fpath[1]}/_evcc"
```

--------------------------------

### Example service configuration with pushover template

Source: https://docs.evcc.io/en/reference/configuration/messaging

Example of defining a service using the pushover template with app ID and recipients.

```yaml
services:
  - type: template
    template: pushover
    app: 12345
    recipients:
      - 234567
```

--------------------------------

### Install evcc with pkg

Source: https://docs.evcc.io/en/installation/freebsd

Install the evcc package from the FreeBSD Ports tree. Run as root.

```sh
pkg install evcc
```

--------------------------------

### Configuration example for evcc.yaml

Source: https://docs.evcc.io/en/tariffs/spotovaelektrina-cz

YAML block for configuring the spotovaelektrina tariff template in evcc.yaml. Use this if you don't want to configure via the UI. The example shows the template with optional parameters commented out, and a formula example: math.Max((price + charges) * (1 + tax), 0.0).

```yaml
tariffs:
    grid:
      type: template
      template: spotovaelektrina
      currency: CZK # Currency, [CZK, EUR]
      charges: # Charge, Additional fixed charge per kWh (optional)
      chargesZones: # Charges zones, Time-based grid fees that override the default charge. (optional)
      tax: # Tax, Additional percentage charge (e.g. 0.2 for 20%) (optional)
      formula: math.Max((price + charges) * (1 + tax), 0.0) # Formula, Individual formula for calculating the price (optional)
      average: # Average by hour, optional
```

--------------------------------

### Example curtailer configuration with site reference

Source: https://docs.evcc.io/en/reference/configuration/curtailers

Shows a curtailer device using the solaredge template with modbus TCP, and its reference in site.curtailers. The productionnominalmax parameter sets the installed generator power in Wp.

```yaml
curtailers:
  - name: my_curtailer
    type: template
    template: solaredge
    modbus: tcpip
    host: 192.168.0.10
    port: 1502
    id: 1
    productionnominalmax: 15000 # installed generator power of the whole installation (Wp)


site:
  curtailers:
    - my_curtailer
```

--------------------------------

### Event definitions with simple placeholder syntax

Source: https://docs.evcc.io/en/reference/configuration/messaging

Complete example of messaging events using simple ${variableName} placeholders for start, stop, connect, and disconnect events.

```yaml
messaging:
  events:
    start:
      title: Charging started
      msg: >-
        ${title} charging ${vehicleTitle} in ${mode} mode
    stop:
      title: Charging finished
      msg: >-
        ${title}: ${vehicleTitle} charged ${chargedEnergy:%.1fk}kWh in ${chargeDuration}.
        Solar share: ${sessionSolarPercentage:%.0f}%
    connect:
      title: Vehicle connected
      msg: >-
        ${vehicleTitle} connected to ${title} at ${pvPower:%.1fk}kW solar
    disconnect:
      title: Vehicle disconnected
      msg: >-
        ${vehicleTitle} disconnected from ${title} after ${connectedDuration}
```

--------------------------------

### Enable and start evcc service

Source: https://docs.evcc.io/en/installation/freebsd

Enable evcc to start at boot and start the service immediately.

```sh
sysrc evcc_enable="YES"
service evcc start
```

--------------------------------

### Install completions for every new session on macOS

Source: https://docs.evcc.io/en/reference/cli/evcc_completion_bash

Execute this command once to install bash completions for all new sessions on macOS. A new shell is required for the setup to take effect.

```plaintext
evcc completion bash > $(brew --prefix)/etc/bash_completion.d/evcc
```

--------------------------------

### Get oauth token and installation id via curl and jq

Source: https://docs.evcc.io/en/heating/viessmann-heatpump-api

Command-line procedure to determine the installation ID. Requires curl, jq, and environment variables VIESSMANN_USER, VIESSMANN_PASS, VIESSMANN_CLIENT_ID, and VIESSMANN_REDIRECT_URI. The intermediate CODE is only valid for 20 seconds, so paste the entire block as-is.

```bash
VIESSMANN_REDIRECT_URI=<your-redirect-uri> VIESSMANN_CODE_CHALLENGE="5M5nhkBfkWZCGfLZYcTL-l7esjPUN7PpZ4rq8k4cmys" VIESSMANN_CODE_VERIFIER="6PygdmeK8JKPuuftlkc6q4ceyvjhMM_a_cJrPbcmcLc-SPjx2ZXTYr-SOofPUBydQ3McNYRy7Hibc2L2WtVLJFpOQ~Qbgic455ArKjUz9_UiTLnO6q8A3e.I_fIF8hAo"  VIESSMANN_CODE=$(curl -X POST --silent \
   --user $VIESSMANN_USER:$VIESSMANN_PASS \
   --output /dev/null \
   --dump-header -    \
   "https://iam.viessmann-climatesolutions.com/idp/v3/authorize?client_id=$VIESSMANN_CLIENT_ID&redirect_uri=$VIESSMANN_REDIRECT_URI&scope=IoT%20User%20offline_access&response_type=code&code_challenge=$VIESSMANN_CODE_CHALLENGE&code_challenge_method=S256" \
   | grep "^location: "            \
   | sed 's/.*\?code=\(.*\).*/\1/' \
   | tr -d '[:space:]')  TOKEN_RESPONSE=$(curl -XPOST --silent \
   -H "Content-Type: application/x-www-form-urlencoded" \
   --data "grant_type=authorization_code&client_id=$VIESSMANN_CLIENT_ID&redirect_uri=$VIESSMANN_REDIRECT_URI&code_verifier=$VIESSMANN_CODE_VERIFIER&code=$VIESSMANN_CODE" \
   https://iam.viessmann-climatesolutions.com/idp/v3/token)  VIESSMANN_TOKEN=$(echo $TOKEN_RESPONSE | jq --raw-output .access_token)
```

```bash
curl --silent -H "Authorization: Bearer $VIESSMANN_TOKEN" \
   https://api.viessmann-climatesolutions.com/iot/v2/equipment/installations?includeGateways=true \
   | jq '.data[].id'
```

--------------------------------

### Install zsh completions for every new session on macOS

Source: https://docs.evcc.io/en/reference/cli/evcc_completion_zsh

Executes once to install completions for every new session on macOS. A new shell is required for the setup to take effect.

```plaintext
evcc completion zsh > $(brew --prefix)/share/zsh/site-functions/_evcc
```

--------------------------------

### enable.delay example

Source: https://docs.evcc.io/en/reference/configuration/loadpoints

Example YAML for setting `enable.delay` to 1m, defining how long the threshold must be met.

```yaml
delay: 1m
```

--------------------------------

### Install evcc with Homebrew

Source: https://docs.evcc.io/en/installation/macos

Install Homebrew if not already installed, then run these commands to add the evcc tap and install the evcc cask.

```sh
brew trust --tap evcc-io/tap
brew tap evcc-io/tap
brew update
brew install --cask evcc
```

--------------------------------

### Start evcc from command prompt

Source: https://docs.evcc.io/en/installation/windows

Run this command in the extracted folder to start evcc. After starting, open the web interface at http://localhost:7070 to set an administrator password and configure devices.

```sh
./evcc
```

--------------------------------

### disable.threshold example

Source: https://docs.evcc.io/en/reference/configuration/loadpoints

Example YAML for setting `disable.threshold` to 200, allowing a maximum grid consumption of 200W.

```yaml
threshold: 200 # Maximum grid consumption of 200W is allowed
```

--------------------------------

### openwb broker parameter example

Source: https://docs.evcc.io/en/reference/configuration/meters

Example of setting the `broker` parameter for an OpenWB, defining the hostname or IP address and port within the home network.

```yaml
broker: 192.0.2.2:1883
```

--------------------------------

### Install required dependencies

Source: https://docs.evcc.io/en/installation/linux

Install the required dependencies for adding the evcc APT repository.

```sh
sudo apt install -y debian-keyring debian-archive-keyring apt-transport-https curl
```

--------------------------------

### combined plugin reading example

Source: https://docs.evcc.io/en/reference/plugins

Example of the combined plugin converting boolean plugged and charging statuses from MQTT topics into an evcc-compatible charging status.

```yaml
source: combined
plugged:
  source: mqtt
  topic: openWB/lp/1/boolPlugStat
charging:
  source: mqtt
  topic: openWB/lp/1/boolChargeStat
```

--------------------------------

### Configuration File Method: Working Directory Example

Source: https://docs.evcc.io/en/installation/home-assistant

Example of the working directory configuration for the traditional configuration file method. This is added in the Configuration tab of the evcc app.

```sh
- config_file: /config/evcc.yaml
- sqlite_file: /data/evcc.db
```

--------------------------------

### enable.threshold example

Source: https://docs.evcc.io/en/reference/configuration/loadpoints

Example YAML for setting `enable.threshold` to 0, meaning export must reach minimum charging power.

```yaml
threshold: 0
```

--------------------------------

### disable configuration example

Source: https://docs.evcc.io/en/reference/configuration/loadpoints

Example YAML for the `disable` section, setting threshold to 200 W and delay to 10m for stopping charging on solar surplus.

```yaml
disable:
  threshold: 200 # maximum import power (W)
  delay: 10m
```

--------------------------------

### disable.delay example

Source: https://docs.evcc.io/en/reference/configuration/loadpoints

Example YAML for setting `disable.delay` to 10m, defining how long the threshold must be met.

```yaml
delay: 10m
```

--------------------------------

### soc configuration example

Source: https://docs.evcc.io/en/reference/configuration/loadpoints

Example YAML configuration for the `soc` section, setting poll mode to 'charging', poll interval to '60m', and enabling SoC estimation.

```yaml
soc:
  poll:
    mode: charging
    interval: 60m
  estimate: true
```

--------------------------------

### Start evcc service

Source: https://docs.evcc.io/en/installation/linux

Start the evcc systemd service.

```sh
sudo systemctl start evcc
```

--------------------------------

### Install fish completions for new sessions

Source: https://docs.evcc.io/en/reference/cli/evcc_completion_fish

Installs the fish completion script to the user's fish completions directory. A new shell session is required for the completions to take effect.

```plaintext
evcc completion fish > ~/.config/fish/completions/evcc.fish
```

--------------------------------

### sponsortoken YAML configuration example

Source: https://docs.evcc.io/en/reference/configuration/sponsortoken

Example of setting the sponsortoken in evcc.yaml. The token is provided from sponsor.evcc.io. The comment indicates the token source.

```yaml
sponsortoken: eyJhbGci[...]RX5s # your token from sponsor.evcc.io
```

--------------------------------

### Web Interface Configuration: Working Directory Example

Source: https://docs.evcc.io/en/installation/home-assistant

Example of the working directory configuration for the web interface method. This is added in the Configuration tab of the evcc app.

```sh
- sqlite_file: /data/evcc.db
```

--------------------------------

### Configuration example for evcc.yaml

Source: https://docs.evcc.io/en/chargers/solax-x3-hac

Example configuration for the Solax X3-HAC charger using either RS485 serial or RS485 TCP/IP Modbus connections.

```yaml
chargers:
    - name: my_charger
      type: template
      template: solax-g2


      # RS485 via adapter (Modbus RTU)
      modbus: rs485serial
      id: 70
      device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse
      baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200
      comset: "8N1" # Kommunikationsparameter für den Adapter


      # RS485 via TCP/IP (Modbus RTU)
      modbus: rs485tcpip
      id: 70
      host:  # Hostname
      port: 502 # Port
```

--------------------------------

### Start evcc with a configuration file

Source: https://docs.evcc.io/en/installation/macos

Starts evcc using a specific configuration file (evcc.yaml). This is an alternative to configuring via the web interface at http://localhost:7070.

```sh
./evcc -c evcc.yaml
```

--------------------------------

### site configuration example

Source: https://docs.evcc.io/en/reference/configuration/site

Shows a full site configuration with meters, curtailers, and residualPower. Requires at least one grid or PV meter.

```yaml
site:
  title: Home # display name for UI
  meters:
    grid: mygridmeter # grid meter reference
    pv:
      - mypv1 # first pv meter reference
      - mypv9 # second pv meter reference
    battery:
      - mybat5 # battery meter reference
    aux:
      - myaux1 # self-regulating consumer
    consumer:
      - myconsumer1 # regular consumer, recorded for consumption statistics
    ext:
      - myext1 # for data logging, load management, etc.
  curtailers:
    - my_curtailer # curtailment device reference
  residualPower: 100
```

--------------------------------

### Create labwc autostart file for kiosk mode

Source: https://docs.evcc.io/en/chargers/openwb-embedded-software-replacement

Create /home/pi/.config/labwc/autostart with these contents to start Firefox in kiosk mode and enable display power management via swayidle. Be careful: this allows anybody to enable charging.

```bash
/usr/bin/firefox-esr --kiosk http://localhost:7070/ &
/usr/bin/swayidle -w timeout 600 'wlopm --off \*' resume 'wlopm --on \*' &

```

--------------------------------

### Get Viessmann installation ID

Source: https://docs.evcc.io/en/heating/viessmann-heatpump-api

Uses the OAuth token to query the Viessmann API and extract the installation ID with jq. Requires the VIESSMANN_TOKEN from the previous step.

```bash
curl --silent -H "Authorization: Bearer $VIESSMANN_TOKEN" \
  https://api.viessmann-climatesolutions.com/iot/v2/equipment/installations?includeGateways=true \
  | jq '.data[].id'
```

--------------------------------

### HTTP Writing Example - Enable with Template

Source: https://docs.evcc.io/en/reference/plugins

Uses a Go template in the URI to turn a relay on or off based on the 'enable' value.

```yaml
enable:
  source: http
  uri: "http://charger/relay/0?turn={{if .enable}}on{{else}}off{{end}}"
```

--------------------------------

### meter parameter example

Source: https://docs.evcc.io/en/reference/configuration/loadpoints

Example of the `meter` parameter, which references a meter configuration by its `name`. Only needed if the charger doesn't provide its own current measurement.

```yaml
meter: charge
```

--------------------------------

### Go plugin writing example

Source: https://docs.evcc.io/en/reference/plugins

When used for writing, the value to be written is passed to the script as a variable named `maxcurrent`. This example prints the value.

```yaml
maxcurrent:
  source: go
  script: |
    fmt.Printf("Setting charge current: %d A\n", maxcurrent)
    // maxcurrent variable is automatically available
```

--------------------------------

### evcc://server example with URL-encoded values

Source: https://docs.evcc.io/en/reference/app

Example link that prefills the server URL, title, username, and password. The values are URL-encoded as required.

```plaintext
evcc://server?url=https://demo.evcc.io&title=Demo%20Server&username=admin&password=secret
```

--------------------------------

### Configuration example for evcc.yaml

Source: https://docs.evcc.io/en/meters/tq-energy-manager-em420

Use this YAML block to configure the TQ Energy Manager EM420 manually in your evcc.yaml file instead of using the UI.

```yaml
meters:
    - name: my_grid
      type: template
      template: tq-em420
      usage: grid
      host: 192.0.2.2 # IP address or hostname
      token: ey... # Access token, Access token for EM420 (Create in Profile -> Access tokens)
      port: 80 # Port, optional
      device: local # API Device Path, JSON-API -> Data Endpoint (optional)
```

--------------------------------

### title parameter example

Source: https://docs.evcc.io/en/reference/configuration/site

Sets the display name for the site in the UI.

```yaml
title: Home
```

--------------------------------

### Go plugin example with time functions

Source: https://docs.evcc.io/en/reference/plugins

Uses the time package to determine a price based on the current hour. Demonstrates conditional logic in a Go script.

```yaml
source: go
script: |
  hour := time.Now().Hour()
  price := 50.0 // Night tariff
  if hour >= 9 && hour < 17 {
    price = 100.0 // Tariff price during business hours
  }
  price
```

--------------------------------

### Configuration example for evcc.yaml

Source: https://docs.evcc.io/en/chargers/compleo-solo

Use this YAML block to configure the Compleo Solo charger manually in your evcc.yaml file instead of using the UI.

```yaml
chargers:
    - name: my_charger
      type: template
      template: compleo-solo


      # Modbus TCP
      modbus: tcpip
      id: 1
      host:  # Hostname
      port: 502 # Port
```

--------------------------------

### Tesla meter configuration example

Source: https://docs.evcc.io/en/reference/configuration/meters

Example YAML configuration for the `tesla` meter type, showing required parameters `type`, `usage`, `uri`, and `password`.

```yaml
type: tesla
usage: grid
uri: https://192.0.2.2/
password: "***"
```

--------------------------------

### Full EEBus configuration example

Source: https://docs.evcc.io/en/reference/configuration/eebus

Complete YAML block for EEBus configuration including shipid, interfaces, and certificate. This is the recommended way to configure EEBus in the UI, but this example shows the YAML equivalent.

```yaml
eebus:
  shipid: EVCC-1234567890abcdef
  interfaces:
    - eth0
  certificate:
    public: |
      -----BEGIN CERTIFICATE-----
      1234567890abcdef==
      -----END CERTIFICATE-----
    private: |
      -----BEGIN EC PRIVATE KEY-----
      1234567890abcdef
      -----END EC PRIVATE KEY-----
```

--------------------------------

### curl example for API access

Source: https://docs.evcc.io/en/features/remote-access

Use this curl command to access the evcc API with basic authentication. Replace the username and password with your client credentials and the domain with your personal evcc.cloud domain. The example queries the state endpoint with a jq filter to get the PV power.

```bash
curl --user Macbook:7IIGKZGP-MV0PJKSE "https://swift-dark-crow.evcc.cloud/api/state?jq=.pvPower"
```

--------------------------------

### Custom meter `voltages` parameter example

Source: https://docs.evcc.io/en/reference/configuration/meters

Example showing the `voltages` parameter for the custom meter, which is a list of plugin definitions to return voltage in volts (V) per phase.

```yaml
  voltages: # Voltage (V) per phase
    - source: # Phase 1 Plugin Type
      ...
    - source: # Phase 2 Plugin Type
      ...
    - source: # Phase 3 Plugin Type
      ...
  ...
```

--------------------------------

### calc plugin reading example (addition)

Source: https://docs.evcc.io/en/reference/plugins

Example of the calc plugin using the 'add' operand to sum multiple values. Each operand is a nested source definition.

```yaml
source: calc
add:
- source: ...
  ...
- source: ...
  ...
```

--------------------------------

### Configuration example for evcc.yaml

Source: https://docs.evcc.io/en/chargers/chargeline-business-wallbox

Use this YAML block to configure the ChargeLine Business Wallbox manually in evcc.yaml if not using the UI.

```yaml
chargers:
    - name: my_charger
      type: template
      template: peblar


      # Modbus TCP
      modbus: tcpip
      id: 1
      host:  # Hostname
      port: 502 # Port
```

--------------------------------

### Docker CLI: Update evcc container

Source: https://docs.evcc.io/en/installation/docker

Pull the latest image, then stop and remove the existing container. Start the container again with the same docker run command as during installation.

```sh
sudo docker pull evcc/evcc:latest
sudo docker stop evcc
sudo docker rm evcc
```

--------------------------------

### Add evcc APT repository (stable)

Source: https://docs.evcc.io/en/installation/linux

Add the stable evcc APT repository using the setup script.

```sh
curl -1sLf 'https://dl.evcc.io/public/evcc/stable/setup.deb.sh' | sudo -E bash
```

--------------------------------

### Custom meter configuration example

Source: https://docs.evcc.io/en/reference/configuration/meters

Example YAML configuration for the `custom` meter type, showing how to define individual values via plugins for power, energy, return energy, SOC, capacity, currents, powers, and voltages.

```yaml
  type: custom
  power: # Power (W)
    source: # Plugin Type
    ...
  energy: # Energy (kWh)
    source: # Plugin Type
    ...
  returnenergy: # Energy in reverse direction (kWh)
    source: # Plugin Type
    ...
  soc: # Battery SOC (%)
    source: # Plugin Type
    ...
  capacity: # Optional Battery Capacity (kWh)
  currents: # Current (A) per phase
    - source: # Phase 1 Plugin Type
      ...
    - source: # Phase 2 Plugin Type
      ...
    - source: # Phase 3 Plugin Type
      ...
  powers: # Power (W) per phase
    - source: # Phase 1 Plugin Type
      ...
    - source: # Phase 2 Plugin Type
      ...
    - source: # Phase 3 Plugin Type
      ...
  voltages: # Voltage (V) per phase
    - source: # Phase 1 Plugin Type
      ...
    - source: # Phase 2 Plugin Type
      ...
    - source: # Phase 3 Plugin Type
      ...
  ...
```

--------------------------------

### certificate.public example

Source: https://docs.evcc.io/en/reference/configuration/eebus

The public certificate.

```yaml
public: |
  -----BEGIN CERTIFICATE-----
  1234567890abcdef==
  -----END CERTIFICATE-----
```

--------------------------------

### GPIO write example

Source: https://docs.evcc.io/en/reference/plugins

Sets a GPIO pin (BCM pin 27) to HIGH or LOW. Requires Linux with access to /dev/gpiomem.

```yaml
source: gpio
function: write
pin: 27 # BCM pin number
```

--------------------------------

### Custom meter `powers` parameter example

Source: https://docs.evcc.io/en/reference/configuration/meters

Example showing the `powers` parameter for the custom meter, which is a list of plugin definitions to return power in watts (W) per phase.

```yaml
  powers: # Power (W) per phase
    - source: # Phase 1 Plugin Type
      ...
    - source: # Phase 2 Plugin Type
      ...
    - source: # Phase 3 Plugin Type
      ...
  ...
```

--------------------------------

### Configure DZG DVH4013 for Charger Meter in evcc.yaml

Source: https://docs.evcc.io/en/meters/dzg-dvh4013

Example configuration for using the DZG DVH4013 as a charger meter, showing both serial and TCP/IP Modbus setups.

```yaml
meters:
    - name: my_charger
      type: template
      template: dzg
      usage: charge


      # RS485 via adapter (Modbus RTU)
      modbus: rs485serial
      id: 1
      device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse
      baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200
      comset: "8N1" # Kommunikationsparameter für den Adapter


      # RS485 via TCP/IP (Modbus RTU)
      modbus: rs485tcpip
      id: 1
      host:  # Hostname
      port: 502 # Port
```

--------------------------------

### Create and navigate to test folder

Source: https://docs.evcc.io/en/integrations/mcp

Commands to create an empty folder for testing and navigate into it.

```bash
mkdir evcc-mcp-test
cd evcc-mcp-test
```

--------------------------------

### Configure DZG DVH4013 for Solar Production in evcc.yaml

Source: https://docs.evcc.io/en/meters/dzg-dvh4013

Example configuration for using the DZG DVH4013 as a solar production meter, showing both serial and TCP/IP Modbus setups.

```yaml
meters:
    - name: my_pv
      type: template
      template: dzg
      usage: pv


      # RS485 via adapter (Modbus RTU)
      modbus: rs485serial
      id: 1
      device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse
      baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200
      comset: "8N1" # Kommunikationsparameter für den Adapter


      # RS485 via TCP/IP (Modbus RTU)
      modbus: rs485tcpip
      id: 1
      host:  # Hostname
      port: 502 # Port
```

--------------------------------

### Configuration example for evcc.yaml

Source: https://docs.evcc.io/en/meters/esphome-dsmr

Use this YAML block to configure the ESPHome DSMR meter manually in evcc.yaml instead of using the UI.

```yaml
meters:
    - name: my_grid
      type: template
      template: slimmelezer
      usage: grid
      host: 192.0.2.2 # IP address or hostname
      scale: 1000 # Scale factor, Use scale of 1000 for Zuidwijk Slimmelezer. Use scale 1 for ESPHome DSMR and P1 Dongle
```

--------------------------------

### Start evcc manually with version check

Source: https://docs.evcc.io/en/installation/macos

Run the evcc binary from the extracted folder to verify the installation. The command prints the current version, e.g., 'evcc version 0.xxx.y'.

```sh
./evcc -v
```

--------------------------------

### Add GPIO configuration to /boot/firmware/config.txt

Source: https://docs.evcc.io/en/chargers/openwb-embedded-software-replacement

Append these lines to the end of /boot/firmware/config.txt to configure GPIO pins for OpenWB hardware access. Required for installation without display.

```plaintext
[all]
gpio=4,5,7,11,17,22,23,24,25,26,27=op,dl
gpio=6,8,9,10,12,13,16,21=ip,pu

```

--------------------------------

### Create systemd user service kiosk.service

Source: https://docs.evcc.io/en/chargers/openwb-embedded-software-replacement

Create /home/pi/.config/systemd/user/kiosk.service with this content to start labwc as a systemd user service. Enable it with 'systemctl --user enable kiosk' and use 'loginctl enable-linger pi' to allow start without login.

```ini
[Unit]
Description=Start Kiosk mode
[Service]
Type=simple
ExecStart=/usr/bin/labwc
[Install]
WantedBy=default.target

```

--------------------------------

### Configuration example for evcc.yaml

Source: https://docs.evcc.io/en/meters/homewizard-wi-fi-p1-meter

Use this YAML block to configure the HomeWizard Wi-Fi P1 Meter manually if you prefer not to use the UI.

```yaml
meters:
    - name: my_grid
      type: template
      template: homewizard
      usage: grid
      host: 192.0.2.2 # IP address or hostname
```

--------------------------------

### Configure Pracht Alpha XT in evcc.yaml

Source: https://docs.evcc.io/en/chargers/pracht-alpha-xt

Example configuration for the Pracht Alpha XT charger using template-based setup in evcc.yaml. Includes configurations for RS485 serial, RS485 TCP/IP, and Modbus TCP.

```yaml
chargers:
    - name: my_charger
      type: template
      template: pracht-alpha


      # RS485 via adapter (Modbus RTU)
      modbus: rs485serial
      id: 1
      device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse
      baudrate: 9600 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200
      comset: "8N1" # Kommunikationsparameter für den Adapter


      # RS485 via TCP/IP (Modbus RTU)
      modbus: rs485tcpip
      id: 1
      host:  # Hostname
      port: 502 # Port


      # Modbus TCP
      modbus: tcpip
      id: 1
      host:  # Hostname
      port: 502 # Port
      connector: 1 # Connector number, For multi-connector stations. Numbering starts at 1. (optional)
```

--------------------------------

### Configuration example for evcc.yaml

Source: https://docs.evcc.io/en/meters/hoymiles-hm-and-hms-series-via-ahoydtu

A YAML configuration block for setting up a Hoymiles inverter via AhoyDTU when not using the UI.

```yaml
meters:
    - name: my_pv
      type: template
      template: hoymiles-ahoydtu
      usage: pv
      host: 192.0.2.2 # IP address or hostname
      id: 0 # Inverter ID, If multiple exist. The numbering starts at 0. See AhoyDTU webinterface -> Inverter #[ID] (optional)
      cache: 1s # Cache, Time interval for data refresh (optional)
```

--------------------------------

### Configuration example for evcc.yaml

Source: https://docs.evcc.io/en/meters/tq-energy-manager-em2xx-em3xx

Use this YAML block to configure the TQ Energy Manager meter manually if you prefer not to use the UI.

```yaml
meters:
    - name: my_grid
      type: template
      template: tq-em
      usage: grid
      host: 192.0.2.2 # IP address or hostname
      port: 80 # Port, optional
      password: # Password, Service account password (optional)
```

--------------------------------

### Ignore plugin example

Source: https://docs.evcc.io/en/reference/plugins

Suppresses a specific modbus error message when writing. The nested 'set' plugin is executed; if the error message starts with the given 'error' string, the error is ignored and success is returned. Used for harmless device errors.

```yaml
batterymode:
  source: switch
  switch:
    - case: 1 # normal
      set:
        source: const
        value: 2
        set:
          source: ignore
          error: "modbus: response data size '18' does not match count '4'"
          set:
            source: modbus
            uri: 192.168.1.10:502
            id: 1
            register:
              address: 0x1110
              type: writemultiple
              encoding: int16
```

--------------------------------

### Map plugin reading example (device value to evcc)

Source: https://docs.evcc.io/en/reference/plugins

YAML configuration for the map plugin when reading. The 'get' plugin returns a value that is looked up in the 'values' table and mapped to an evcc standard value. If no matching value is found, an error occurs.

```yaml
getmode:
  source: map
  values:
    0: 2 # Device "Free" → evcc "normal"
    1: 1 # Device "Forced off" → evcc "reduced"
    2: 3 # Device "Recommended on" → evcc "boost"
    3: 3 # Device "Forced on" → evcc "boost"
  get:
    source: modbus
    uri: 192.168.1.10:502
    id: 1
    register:
      address: 55
      type: holding
      encoding: int16
```

--------------------------------

### Go plugin example with string processing

Source: https://docs.evcc.io/en/reference/plugins

Uses the strings package to convert a string to uppercase. Demonstrates string manipulation in a Go script.

```yaml
source: go
script: |
  text := "hello world"
  strings.ToUpper(text) // returns "HELLO WORLD"
```

--------------------------------

### Delta plugin write example

Source: https://docs.evcc.io/en/reference/plugins

Configures a delta plugin to convert absolute values to deltas. Reads the current total from a modbus input register and writes the calculated delta to a writeholding register. Requires the 'set' parameter; 'get' is optional but recommended to maintain synchronization across restarts.

```yaml
setmaxpower:
  source: delta
  get: # Read current total from device
    source: modbus
    uri: 192.168.1.50:502
    id: 50
    register:
      address: 2012 # Device's internal sum register
      type: input
      decode: uint16
  set: # Write calculated delta
    source: modbus
    uri: 192.168.1.50:502
    id: 50
    register:
      address: 2201 # Delta register
      type: writeholding
      decode: uint16
```

--------------------------------

### evcc.yaml configuration for Viridian EV EVSE EPC 2.0 Plus

Source: https://docs.evcc.io/en/chargers/viridian-ev-evse-epc-2-0-plus

YAML block for configuring the charger in evcc.yaml. Includes commented examples for RS485 serial (Modbus RTU), RS485 via TCP/IP, and Modbus TCP. Adjust the device, baudrate, comset, host, and port according to your setup.

```yaml
chargers:
    - name: my_charger
      type: template
      template: obo


      # RS485 via adapter (Modbus RTU)
      modbus: rs485serial
      id: 101
      device: /dev/ttyUSB0 # USB-RS485 Adapter Adresse
      baudrate: 19200 # Prüfe die Geräteeinstellungen, typische Werte sind 9600, 19200, 38400, 57600, 115200
      comset: "8E1" # Kommunikationsparameter für den Adapter


      # RS485 via TCP/IP (Modbus RTU)
      modbus: rs485tcpip
      id: 101
      host:  # Hostname
      port: 502 # Port


      # Modbus TCP
      modbus: tcpip
      id: 101
      host:  # Hostname
      port: 502 # Port

```

--------------------------------

### Configure Smartfox Box as Smart Consumer

Source: https://docs.evcc.io/en/meters/smartfox-box

Example YAML configuration for using the Smartfox Box as a smart consumer (aux).

```yaml
meters:
    - name: my_aux
      type: template
      template: smartfox
      usage: aux
      host: 192.0.2.2 # IP address or hostname
      cache: 1s # Cache, Time interval for data refresh (optional)
```

--------------------------------

### Configure Tesla Wall Connector in evcc with proxyToken

Source: https://docs.evcc.io/en/blog/2025/01/20/tesla-api-update

Configure a Tesla vehicle in evcc with an additional proxyToken for Tesla Wall Connector users. This setup routes charging commands through the myteslamate.com proxy, which signs them with your Tesla application. The proxy token is powerful; limit its permissions to Charge Start, Charge Stop, and Set Charging Amps.

```yaml
vehicles:
  - type: template
    template: tesla
    title: Tesla Model 3
    clientId: aaaaaa-11111-... # from developer.tesla.com
    accessToken: ey1234567890... # from myteslamate.com
    refreshToken: EU_1234567890... # from myteslamate.com
    proxyToken: aaaaa-bbbbb-... # from myteslamate.com
```

--------------------------------

### Update package list and install evcc

Source: https://docs.evcc.io/en/installation/linux

Update the package list and install evcc. During installation, a user 'evcc' is created, so ensure the logged-in user does not have the name 'evcc'.

```sh
sudo apt update
sudo apt install -y evcc
```

--------------------------------

### Configuration example for evcc.yaml

Source: https://docs.evcc.io/en/chargers/cubos-c11e

Use this YAML block to configure the CUBOS C11E charger manually if not using the UI.

```yaml
chargers:
    - name: my_charger
      type: template
      template: bender-cc


      # Modbus TCP
      modbus: tcpip
      id: 255
      host:  # Hostname
      port: 502 # Port
```

--------------------------------

### charger parameter example

Source: https://docs.evcc.io/en/reference/configuration/loadpoints

Example of the `charger` parameter, which references a charger configuration by its `name`.

```yaml
charger: charger
```

--------------------------------

### Configuration example for evcc.yaml

Source: https://docs.evcc.io/en/chargers/lektrico-1p7k-3p22k-charging-station

Use this YAML block to configure the Lektrico charger manually if you prefer not to use the UI.

```yaml
chargers:
    - name: my_charger
      type: template
      template: lektrico
      host: 192.0.2.2 # IP address or hostname
      cache: 5m # Cache, Time interval for data refresh (optional)
```

--------------------------------

### title parameter example

Source: https://docs.evcc.io/en/reference/configuration/loadpoints

Example of the `title` parameter, which is a display name for the charging point in the UI.

```yaml
title: Garage
```

--------------------------------

### Configuration example for evcc.yaml

Source: https://docs.evcc.io/en/tariffs/dwd-bright-sky-temperature

Use this YAML block to configure the DWD temperature tariff manually in your evcc.yaml file instead of using the UI.

```yaml
tariffs:
    temperature:
      type: template
      template: dwd-temperature
      lat: 55.7351 # Latitude
      lon: 9.1275 # Longitude
      interval: 1h # Interval, optional
```

--------------------------------

### poll.interval example

Source: https://docs.evcc.io/en/reference/configuration/loadpoints

Example YAML for setting `poll.interval` to '60m', defining how often the vehicle is queried when not charging.

```yaml
interval: 60m
```

--------------------------------

### Configuration example for evcc.yaml

Source: https://docs.evcc.io/en/chargers/victron-ev-charging-station-via-gx

Use this YAML block to configure the Victron charger manually if you prefer not to use the UI.

```yaml
chargers:
    - name: my_charger
      type: template
      template: victron


      # Modbus TCP
      modbus: tcpip
      id: 100
      host:  # Hostname
      port: 502 # Port
```

--------------------------------

### poll.mode example

Source: https://docs.evcc.io/en/reference/configuration/loadpoints

Example YAML for setting `poll.mode` to 'charging', which updates vehicle data only during a charging session.

```yaml
mode: charging
```

--------------------------------

### vehicle parameter example

Source: https://docs.evcc.io/en/reference/configuration/loadpoints

Example of the `vehicle` parameter, which references a vehicle configuration by its `name` as the default vehicle.

```yaml
vehicle: renault
```

--------------------------------

### Configuration example for evcc.yaml

Source: https://docs.evcc.io/en/smartswitches/tp-link-h-series-smart-plug

Use this YAML block to configure the TP-Link smart plug manually in your evcc.yaml file instead of using the user interface.

```yaml
chargers:
    - name: my_smartswitch
      type: template
      template: tplink
      host: 192.0.2.2 # IP address or hostname
      standbypower: 15 # Standby power (W), Power values above this value will be considered as charging power and hence status "charging". Negative values deactivate status detection. (optional)
      integrateddevice: # Integrated device, Integrated device. No charging sessions (optional)
      heating: # Heating device, Shows °C instead of % (optional)
      icon: # Icon, Will be displayed in the user interface [car, bike, bus, moped, motorcycle, rocket, scooter, taxi, tractor, rickshaw, shuttle, van, airpurifier, battery, bulb, climate, coffeemaker, compute, cooking, cooler, desktop, device, dishwasher, dryer, floorlamp, generic, heater, heatexchange, heatpump, kettle, laundry, laundry2, machine, meter, microwave, pump, smartconsumer, tool, waterheater] (optional)
```

--------------------------------

### Install evcc service with NSSM

Source: https://docs.evcc.io/en/installation/windows

Install the evcc service using NSSM. This opens a dialog to configure the service.

```sh
nssm install evcc
```

--------------------------------

### Configuration example for evcc.yaml

Source: https://docs.evcc.io/en/heating/bosch-sg-ready

YAML block to configure the Bosch SG Ready heating via the emsesp template. All parameters are optional; defaults are shown in comments.

```yaml
chargers:
    - name: my_heating
      type: template
      template: emsesp
      host: 192.0.2.2 # IP address or hostname
      token: # Token, optional
      powersource: hpcurrpower # Power source, [hpcurrpower, hppower] (optional)
      tempsource: # Temperature source, [warmwater] (optional)
      sg1: hpin1opt # SG1 input, [hpin1opt, hpin2opt, hpin3opt, hpin4opt] (optional)
      sg4: hpin4opt # SG4 input, [hpin1opt, hpin2opt, hpin3opt, hpin4opt] (optional)
      powercontrol: # Power limitation, EMS-ESP entity to limit the maximum compressor power (kW) at PV surplus. [pvmaxcomp] (optional)
      value_normal_sg4: 0xxxxxxxxxxx # Bitmask for SG4 in normal mode, optional
      value_normal_sg1: 0xxxxxxxxxxxxxx # Bitmask for SG1 in normal mode, optional
      value_boost_sg4: 1xxxxxxxxxxx # Bitmask for SG4 in boost mode, optional
      value_boost_sg1: # Bitmask for SG1 in boost mode, optional
      value_dim_sg1: 1xxxxxxxxxxxxxx # Bitmask for SG1 in dim mode, optional
      value_dim_sg4: 0xxxxxxxxxxx # Bitmask for SG4 in dim mode, optional
      cache: 1s # Cache, Time interval for data refresh (optional)

```

--------------------------------

### const plugin reading example

Source: https://docs.evcc.io/en/reference/plugins

Example of the const plugin returning a constant value, useful for offsets or testing.

```yaml
source: const
value: -16247
```

--------------------------------

### type parameter example

Source: https://docs.evcc.io/en/reference/configuration/meters

Example of setting the `type` parameter to specify the evcc-specific meter type for communication with the device.

```yaml
type: modbus
```

--------------------------------

### estimate example

Source: https://docs.evcc.io/en/reference/configuration/loadpoints

Example YAML for setting `estimate` to false, disabling SoC interpolation between vehicle data queries.

```yaml
estimate: false # No interpolation
```

--------------------------------

### Start Docker Compose container

Source: https://docs.evcc.io/en/installation/docker

Starts the evcc container defined in compose.yml. Whether sudo is needed depends on your system.

```sh
sudo docker compose up -d
```

--------------------------------

### error plugin example

Source: https://docs.evcc.io/en/reference/plugins

Example of the error plugin returning a known error value, here ErrNotAvailable, to mark an attribute as unavailable.

```yaml
soc:
  source: error
  error: ErrNotAvailable
```

--------------------------------

### Tesla meter `password` parameter example

Source: https://docs.evcc.io/en/reference/configuration/meters

Example showing the `password` parameter for the Tesla meter, which is the password for the *customer* user.

```yaml
password: "ThePassword"
```

--------------------------------

### lgess password parameter example

Source: https://docs.evcc.io/en/reference/configuration/meters

Example of setting the `password` parameter for an LG ESS device, which is the registration number of the inverter.

```yaml
password: "DE200..."
```
Tokens:
Raw