Skip to content
EN | DE

OpenEMS REST-API

This page shows the nightly version. Switch to the release version.

License notice:

For active battery control on FENECON FEMS systems, a commercial license (FEMS App REST/JSON Write Access) is required.

FEMS documentation:
OpenEMS documentation:

Supported features

  • Battery control: External control of home battery charging and discharging via evcc.

Usage areas

  • Grid meter
  • Solar production
  • Battery

Parameters

NameDescriptionValueLevel
hostIP address or hostname
Example: 192.0.2.2
optional
capacity [kWh]Battery capacity
Example: 50
optional
minsoc [%]Minimum charge

Lower limit when discharging the battery in normal operation

Example: 25
optional
maxsoc [%]Maximum charge

Upper limit when charging the battery from the grid

Example: 95
optional
passwordPassword

Service account password

Default: user
advanced
maxacpower [W]Maximum AC power of the hybrid inverter
Default: 0
Example: 5000
advanced
batteryControllable battery component

active battery control (REST/JSON Write Access)

Example: ess0
advanced
watchdogFEMS/OpenEMS battery control API timeout

FEMS/OpenEMS standard 60s

Default: 60s
advanced
maxchargepower [W]Maximum charge power

For forced charging of the battery.

advanced
maxdischargepower [W]Maximum discharge power

Maximum discharge power of the storage.

advanced
cacheCache

Time interval for data refresh

Default: 1s
Example: 5m
advanced
Configuration example for evcc.yaml

If you don't want to configure via the UI, you can alternatively use this YAML block.

meters:
- name: my_grid
type: template
template: openems
usage: grid
host: 192.0.2.2 # IP address or hostname
password: user # Password, Service account password (optional)
cache: 1s # Cache, Time interval for data refresh (optional)
meters:
- name: my_pv
type: template
template: openems
usage: pv
host: 192.0.2.2 # IP address or hostname
password: user # Password, Service account password (optional)
maxacpower: 0 # Maximum AC power of the hybrid inverter (W), optional
cache: 1s # Cache, Time interval for data refresh (optional)
meters:
- name: my_battery
type: template
template: openems
usage: battery
host: 192.0.2.2 # IP address or hostname
capacity: 50 # Battery capacity (kWh), optional
minsoc: 25 # Minimum charge (%), Lower limit when discharging the battery in normal operation (optional)
maxsoc: 95 # Maximum charge (%), Upper limit when charging the battery from the grid (optional)
password: user # Password, Service account password (optional)
battery: ess0 # Controllable battery component, active battery control (REST/JSON Write Access) (optional)
watchdog: 60s # FEMS/OpenEMS battery control API timeout, FEMS/OpenEMS standard 60s (optional)
maxchargepower: # Maximum charge power (W), For forced charging of the battery. (optional)
maxdischargepower: # Maximum discharge power (W), Maximum discharge power of the storage. (optional)
cache: 1s # Cache, Time interval for data refresh (optional)