Zum Hauptinhalt springen

API

Mit evcc kann über REST und MQTT APIs interagiert werden.

Alle API IDs (z.B. die Loadpoint ID) beginnen bei 1.

REST API​

Site​

  • GET /api/state: evcc state (static configuration and dynamic state as JSON object)
  • (can also be used with filtering. e.g.: /api/state?jq=.statistics["30d"].avgPrice)
  • GET /api/health: evcc health check
  • POST /api/prioritysoc/<soc>: battery priority soc in %
  • POST /api/buffersoc/<soc>: battery buffer soc in %
  • POST /api/bufferstartsoc/<soc>: battery buffer start soc in %
  • POST /api/residualpower/<power>: grid residual power in W
  • POST /api/batterydischargecontrol/<status>: enable/disable battery discharge control (true/false)
  • POST /api/smartcostlimit/<cost>: smart charging cost limit (previously known as "cheap" tariff)
  • GET /api/tariff/<type>: list of prices (grid/feedin/co2/planner)
  • GET /api/sessions[?format=csv&lang=<lang>]: charging sessions
  • GET /api/settings/telemetry: telemetry enabled status
  • POST /api/settings/telemetry/<status>: enable/disable telemetry (true/false)

Vehicles​

Note: for vehicle names see vehicles array in /api/state response.

  • POST /api/vehicles/<name>/minsoc/<soc>: minimum soc in %
  • POST /api/vehicles/<name>/limitsoc/<soc>: limit soc in %
  • POST /api/vehicles/<name>/plan/soc/<soc>/<time>: soc in % / time in RFC3339 format **
  • DELETE /api/vehicles/<name>/plan/soc: disable plan charging

Loadpoints​

  • POST /api/loadpoints/<id>/mode/<mode>: charge mode (off/pv/minpv/now)
  • POST /api/loadpoints/<id>/limitsoc/<soc>: limit soc in % - only applicable for online vehicles
  • POST /api/loadpoints/<id>/limitenergy/<energy>: limit energy in kWh - only applicable for offline vehicles
  • POST /api/loadpoints/<id>/plan/energy/<energy>/<time>: energy in kWh / target time in RFC3339 format **
  • DELETE /api/loadpoints/<id>/plan/energy: disable plan charging
  • GET /api/loadpoints/<id>/plan: charging plan details
  • POST /api/loadpoints/<id>/phases/<phases>: allowed phases (0=auto/1=1p/3=3p)
  • POST /api/loadpoints/<id>/mincurrent/<current>: current minCurrent value in A
  • POST /api/loadpoints/<id>/maxcurrent/<current>: current maxCurrent value in A
  • POST /api/loadpoints/<id>/enable/threshold/<threshold>: threshold value in W
  • POST /api/loadpoints/<id>/disable/threshold/<threshold>: threshold value in W
  • POST /api/loadpoints/<id>/vehicle/<name>: set currently selected vehicle
  • DELETE /api/loadpoints/<id>/vehicle: remove vehicle
  • PATCH /api/loadpoints/<id>/vehicle: start vehicle detection
note

Beispiel: curl -X POST http://evcc:7070/api/loadpoints/1/mode/pv um den Lademodus des 1. Ladepunkts auf pv zu stellen.

MQTT API​

Die MQTT API folgt der REST API Struktur.

  • evcc: root topic
  • evcc/status: status (online/offline)
  • evcc/updated: timestamp of last update

Site​

  • evcc/site: site dynamic state
  • evcc/site/prioritySoc: battery priority SoC (writable)
  • evcc/site/bufferSoc: battery buffer SoC (writable)
  • evcc/site/bufferStartSoc: battery buffer start SoC (writable)
  • evcc/site/residualPower: grid residual power (writable)
  • evcc/site/smartCostLimit: smart charging cost limit (previously known as "cheap" tariff) (writable)

Vehicles​

Note: for vehicle names see evcc/vehicles.

  • evcc/vehicles: number of vehicles
  • evcc/vehicles/<name>/minSoc: minimum soc in % (writable)
  • evcc/vehicles/<name>/limitSoc: limit soc in % (writable)
  • evcc/vehicles/<name>/planSoc: plan soc (writable using JSON payload: {"value": 50, "time": "2023-03-05T07:00:00Z"})

Loadpoints​

  • evcc/loadpoints: number of available loadpoints
  • evcc/loadpoints/<id>: dynamic state
  • evcc/loadpoints/<id>/mode: charge mode (writable)
  • evcc/loadpoints/<id>/minSoc: minimum SoC (writable)
  • evcc/loadpoints/<id>/limitSoc: limit SoC in % (writable) - only applicable for online vehicles
  • evcc/loadpoints/<id>/limitEnergy: limit energy in kWh (writable) - only applicable for offline vehicles
  • evcc/loadpoints/<id>/plan/energy: plan energy (writable using JSON payload: {"value": 50, "time": "2023-03-05T07:00:00Z"})
  • evcc/loadpoints/<id>/phases: enabled phases (writable)
  • evcc/loadpoints/<id>/minCurrent: current minCurrent value (writable)
  • evcc/loadpoints/<id>/maxCurrent: current maxCurrent value (writable)
  • evcc/loadpoints/<id>/enableThreshold: threshold value (writable)
  • evcc/loadpoints/<id>/disableThreshold: threshold value (writable)
note

Um schreibbare Einstellungen durchzuführen, muss ein /set am Ende des Topics hinzugefügt werden an welches der neue Wert gesendet wird. Beispiel: mosquitto_pub -t "evcc/loadpoints/1/phases/set" -m "3" um die Anzahl der netzseitigen Phasen am 1. Ladepunkt auf 3 festzulegen.

info

** Zeitangabe efolgt in UTC im Format yyyy-mm-ddThh:mm:ssZ

Beispiele:

2023-03-05T07:00:00Z = 5. März 2023 um 8:00 Uhr MEZ

2023-08-17T19:30:00Z = 17. August 2023 um 21:30 Uhr MESZ