From 697c3c410a39a6bdeb6c385990d8a8b1973defe1 Mon Sep 17 00:00:00 2001
From: andig <cpuidle@gmx.de>
Date: Wed, 29 Apr 2020 10:53:21 +0200
Subject: [PATCH] Move developer docs to their own section (#77)

---
 README.md | 67 ++++++++++++++++++++++++++++++-------------------------
 1 file changed, 36 insertions(+), 31 deletions(-)

diff --git a/README.md b/README.md
index 4c380527b..dbcf537a3 100644
--- a/README.md
+++ b/README.md
@@ -36,6 +36,7 @@ EVCC is an extensible EV Charge Controller with PV integration implemented in [G
   - [MQTT](#mqtt-readwrite)
   - [Script](#script-readwrite)
   - [Combined status](#combined-status-read-only)
+- [Developer](#developer)
 - [Background](#background)
 
 ## Installation
@@ -114,18 +115,7 @@ EVCC consists of four basic elements: *Charger*, *Meter*, *SoC* and *Loadpoint*.
 
 ### Charger
 
-Charger is responsible for handling EV state and adjusting charge current:
-
-- `Status()`: get charge controller status (`A...F`)
-- `Enabled()`: get charger availability
-- `Enable(bool)`: set charger availability
-- `MaxCurrent(int)`: set maximum allowed charge current in A
-
-Optionally, charger can also provide:
-
-- `CurrentPower()`: power in W (used if charge meter is not present)
-
-Available charger implementations are:
+Charger is responsible for handling EV state and adjusting charge current. Available charger implementations are:
 
 - `wallbe`: Wallbe Eco chargers (see [Hardware Preparation](#Wallbe-hardware-preparation) for preparing the Wallbe). For older Wallbe boxes (pre 2019) with Phoenix EV-CC-AC1-M3-CBC-RCM-ETH controllers make sure to set `legacy: true` to enable correct current configuration.
 - `phoenix`: chargers with Phoenix EM-CP-PP-ETH controllers
@@ -190,28 +180,11 @@ chargers:
 
 ### Meter
 
-Meters provide data about power and energy consumption:
-
-- `CurrentPower()`: power in W
-- `TotalEnergy()`: energy in kWh (optional)
-
-Meter has a single implementation where meter readings- power and energy- can be configured to be delivered by [plugin](#plugins).
+Meters provide data about power and energy consumption. Meter has a single implementation where meter readings- power and energy- can be configured to be delivered by [plugin](#plugins).
 
 ### Vehicle
 
-Vehicle represents a specific EV vehicle and its battery:
-
-- `Title()`: vehicle name for display in the configuration UI
-- `Capacity()`: battery capacity in kWh
-- `ChargeState()`: state of charge in %
-
-Optionally, vehicles can also provide:
-
-- `CurrentPower()`: charge power in W (used if charge meter not present)
-- `ChargedEnergy()`: charged energy in kWh
-- `ChargeDuration()`: charge duration
-
-If vehicle is configured and assigned to the charger, charge status and remaining charge duration become available in the user interface.
+Vehicle represents a specific EV vehicle and its battery. If vehicle is configured and assigned to the charger, charge status and remaining charge duration become available in the user interface.
 
 Available vehicle implementations are:
 
@@ -338,6 +311,38 @@ charging:
   topic: openWB/lp/1/boolChargeStat
 ```
 
+## Developer
+
+EVCC has the following internal API. The full documentation is available in GoDoc format in https://pkg.go.dev/github.com/andig/evcc/api.
+
+### Charger API
+
+- `Status()`: get charge controller status (`A...F`)
+- `Enabled()`: get charger availability
+- `Enable(bool)`: set charger availability
+- `MaxCurrent(int)`: set maximum allowed charge current in A
+
+Optionally, charger can also provide:
+
+- `CurrentPower()`: power in W (used if charge meter is not present)
+
+### Meter API
+
+- `CurrentPower()`: power in W
+- `TotalEnergy()`: energy in kWh (optional)
+
+### Vehicle API
+
+- `Title()`: vehicle name for display in the configuration UI
+- `Capacity()`: battery capacity in kWh
+- `ChargeState()`: state of charge in %
+
+Optionally, vehicles can also provide:
+
+- `CurrentPower()`: charge power in W (used if charge meter not present)
+- `ChargedEnergy()`: charged energy in kWh
+- `ChargeDuration()`: charge duration
+
 ## Background
 
 EVCC is heavily inspired by [OpenWB](1). However, I found OpenWB's architecture slightly intimidating with everything basically global state and heavily relying on shell scripting. On the other side, especially the scripting aspect is one that contributes to [OpenWB's](1) flexibility.