Skip to content
Docs
EN | DE

meters

Meters (current measurement devices) is a list of devices in the house that can measure power and energy consumption, PV generation, or house battery usage. A meter defines a point of energy measurement and can be a physical device (e.g., a meter at the grid connection point), a PV inverter (AC or DC in the case of hybrid inverters), or a battery inverter.

Chargers may have an integrated meter or it can be externally connected. If a charger has an internal current measurement device, no entry for it needs to be created in meters. If the charger doesn’t have such a meter, evcc will use the meter configured here and assigned to the charger under meters in the charging point configuration, or assume that the charging power set is actually being used.

evcc uses a consistent sign convention for power and current values (power, powers, currents):

  • Positive (+) for incoming energy: grid consumption, PV generation, house battery discharge
  • Negative (-) for outgoing energy: grid feed-in, PV inverter standby consumption, house battery charging
  • Consumers (charger, aux meters) are always positive (+)

If the device returns values with the opposite sign, this can be corrected in the plugin configuration using scale: -1.

The meters configuration is a list of different available devices.

For example:

meters:
  - name: grid
    type: ...
  - name: pv
    type: ...
  - name: battery
    type: ...
  - name: charge
    type: ...
  - name: aux
    type: ...

Configurations for known devices can be found under Devices - House Installation.

Below, the various parameters are explained.

Required Parameters

Section titled “Required Parameters”

name

Section titled “name”

A short designation of the meter. The value is used when referencing the device in the configuration of the site or the charger.

For example:

name: charger1

type

Section titled “type”

This is the evcc-specific meter type that allows communication with the device. The appropriate type for known devices can be found under Devices - House Installation.

For example:

type: modbus

The various possible types and their additional parameters are documented below:

Supported Types

Section titled “Supported Types”

movingaverage

Section titled “movingaverage”

This meter type can smooth fluctuating meter values. It can be used in all meter applications (usage). The decay parameter indicates the percentage of the new value to be included in the calculation.

For example

meters:
- name: grid
  type: movingaverage
  decay: 0.1
  meter:
    type: template
    template: solarlog
    usage: grid
    host: 192.0.2.2
    ...

In this example, 10% of the new value is included. After 10 cycles, the oldest value is removed from the calculation. The duration of this process depends on the interval.

modbus

Section titled “modbus”

Devices connected via the ModBus interface and supported by the MBMD (ModBus Measurement Daemon) project.

For example:

  type: modbus
  power: Power
  energy: Sum
  soc: ChargeState
  ...

Required Parameters

Section titled “Required Parameters”

In addition to the parameters defined here, additional parameters are necessary. These are listed in the Modbus documentation.

power
Section titled “power”

Defines the MBMD measurement value that returns the power, typically Power.

For example:

power: Power
energy
Section titled “energy”

Defines the method of measurement that MBMD returns for energy, typically Sum.

For example:

energy: Sum

Optional Parameters

Section titled “Optional Parameters”
soc
Section titled “soc”

Defines the method of measurement that MBMD returns for battery state of charge (SoC), typically ChargeState.

For example:

soc: ChargeState

lgess

Section titled “lgess”

LG ESS Home 8/10 devices.

For example:

type: lgess
usage: grid
uri: https://192.0.2.2/
password: "DE200..."

Required Parameters

Section titled “Required Parameters”
usage
Section titled “usage”

Defines which measurements are needed here.

Possible Values:

  • grid: For measurements at the grid connection point
  • pv: For measurements of PV generation
  • battery: For measurements of the house battery
uri
Section titled “uri”

Defines the URL within the home network of the LG ESS device.

For example:

uri: https://192.0.2.2/
password
Section titled “password”

The registration number of the LG ESS HOME inverter must be entered here.

For example:

password: "DE200..."

openwb

Section titled “openwb”

Using measurements from an OpenWB charger

For example:

type: openwb
usage: grid
broker: 192.0.2.2

Required Parameters

Section titled “Required Parameters”
usage
Section titled “usage”

Defines which measurements are needed here.

Possible Values:

  • grid: For measurements at the grid connection point
  • pv: For measurements of PV generation
  • battery: For measurements of the house battery
broker
Section titled “broker”

Defines the hostname or IP address and port address within the home network of the OpenWB.

For example:

broker: 192.0.2.2:1883

sma

Section titled “sma”

For using the SMA Home Manager 2.0, SMA Energy Meter, or an SMA inverter. Devices must support the Speedwire protocol.

For example:

type: sma
uri: 192.0.2.2
serial: 12345678
interface: eth0

Required Parameters

Section titled “Required Parameters”
uri
Section titled “uri”

Defines the hostname or IP address within the home network of the device.

For example:

uri: 192.0.2.2
serial
Section titled “serial”

Defines the serial number of the device from which measurements should be received.

For example:

serial: 12345678

Optional Parameters

Section titled “Optional Parameters”
interface
Section titled “interface”

Multicast messages can only be received on a specific network interface. Usually, this is the first interface on the system. If it is not the interface connected to the meter, the interface needs to be explicitly specified.

For example:

interface: eth0

tesla

Section titled “tesla”

tesla: For using measurements from a Tesla Powerwall.

For example:

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

Required Parameters

Section titled “Required Parameters”
usage
Section titled “usage”

Defines which measurements are needed here.

Possible Values:

  • grid: For measurements at the grid connection point
  • pv: For measurements of PV generation
  • battery: For measurements of the house battery
uri
Section titled “uri”

Defines the hostname or IP address within the home network of the device.

For example:

uri: 192.0.2.2
password
Section titled “password”

The password for the customer user must be entered here.

For example:

password: "ThePassword"

custom

Section titled “custom”

Standard implementation, in which individual values are defined via plugins.

For example:

  type: custom
  power: # Power (W)
    source: # Plugin Type
    ...
  energy: # Energy (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
      ...
  ...

Required Parameters

Section titled “Required Parameters”
power
Section titled “power”

Plugin definition to return power in watts (W).

For example:

  power: ... # Power (W)
    source: # Plugin Type
    ...

Optional Parameters

Section titled “Optional Parameters”
energy
Section titled “energy”

Plugin definition to return consumed energy in kilowatt-hours (kWh).

For example:

  energy: ... # Energy (kWh)
    source: # Plugin Type
    ...

soc

Section titled “soc”

Plugin definition to return battery state of charge (SoC) in percentage (%).

For example:

  soc: ... # Battery SOC (%)
    source: # Plugin Type
    ...

capacity

Section titled “capacity”

Indication of battery capacity. Only useful when multiple batteries are present. Used to determine the overall SoC.

currents

Section titled “currents”

A list of plugin definitions to return current in amperes (A) per phase.

For example:

  currents: # Current (A) per phase
    - source: # Phase 1 Plugin Type
      ...
    - source: # Phase 2 Plugin Type
      ...
    - source: # Phase 3 Plugin Type
      ...
  ...

powers

Section titled “powers”

A list of plugin definitions to return power in watts (W) per phase.

For example:

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

voltages

Section titled “voltages”

A list of plugin definitions to return voltage in volts (V) per phase.

For example:

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