diff --git a/README.md b/README.md index a8e916a4b..f7a4bf2ac 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ Official documentation repository of [evcc](https://evcc.io). ## General -- The source content of the folder `templates` is the `templates/docs` folder in the [evcc repository](https://github.com/evcc-io/evcc) +- The source content of the folder `templates` is the `templates/definition` folder in the [evcc repository](https://github.com/evcc-io/evcc) - We recommend to test changes locally, use the instructions below to run the documentation page locally as you can see how the changes will look like on the web page while you make changes. - English translation: If possible please provide the translation in English as well to ensure that the content does not get out of sync. diff --git a/i18n/en/docusaurus-plugin-content-docs/current/devices/meters.mdx b/i18n/en/docusaurus-plugin-content-docs/current/devices/meters.mdx index 93f59aed0..fbaf946ef 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/devices/meters.mdx +++ b/i18n/en/docusaurus-plugin-content-docs/current/devices/meters.mdx @@ -66,7 +66,7 @@ If your system isn't listed here, that might mean that it is 100% SunSpec-compat - + - + - + - + Function settings->Grid charging/discharging) A continuous time period should be entered here (e.g.: Charging time 1 00:00-23:00, Charging time 2 23:00-00:00). However, deactivate the "Grid charging" switch. The actual control takes place via evcc. Discharge stop is realized via a scheduled grid charge with a target SoC of 10%. Alternatively, it can also be configured via Modbus. To do this, set the registers `2134,2142,2135,2136,2144,2137,2175` to the values `0,0,23,0,23,0,0,0,0`. - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + /minSoc`: minimum soc in % (writable) +- `evcc/vehicles//limitSoc`: limit soc in % (writable) +- `evcc/vehicles//planSoc`: plan soc (writable using JSON payload: `{"value": 50, "time": "2023-03-05T07:00:00Z"}`) + +## Loadpoints + +- `evcc/loadpoints`: number of available loadpoints +- `evcc/loadpoints/`: dynamic state +- `evcc/loadpoints//mode`: charge mode (writable) +- `evcc/loadpoints//minSoc`: minimum SoC (writable) +- `evcc/loadpoints//limitSoc`: limit SoC in % (writable) - only applicable for online vehicles +- `evcc/loadpoints//limitEnergy`: limit energy in kWh (writable) - only applicable for offline vehicles +- `evcc/loadpoints//plan/energy`: plan energy (writable using JSON payload: `{"value": 50, "time": "2023-03-05T07:00:00Z"}`) +- `evcc/loadpoints//phases`: enabled phases (writable) +- `evcc/loadpoints//minCurrent`: current minCurrent value (writable) +- `evcc/loadpoints//maxCurrent`: current maxCurrent value (writable) +- `evcc/loadpoints//enableThreshold`: threshold value (writable) +- `evcc/loadpoints//enableDelay`: delay value (s) (writable) +- `evcc/loadpoints//disableThreshold`: threshold value (writable) +- `evcc/loadpoints//disableDelay`: delay value (s) (writable) +- `evcc/loadpoints//batteryboost`: battery boost enabled (writeable: [1/0]) +- `evcc/loadpoints//priority`: priority value (writable) + +:::note +To set any of the writable values, add a `/set` at the end of the topic for which a +change should be made. + +Example: `mosquitto_pub -t "evcc/loadpoints/1/phases/set" -m "3"` to set the number of +phases for the first loadpoint to `3`. +::: + +:::info +\*\* Times are in UTC in the following format: `yyyy-mm-ddThh:mm:ssZ` + +Examples: + +`2023-03-05T07:00:00Z` = 5th of March 2023 at 8:00 CET + +`2023-08-17T19:30:00Z` = 17th of August 2023 at 21:30 CEST +::: diff --git a/i18n/en/docusaurus-plugin-content-docs/current/integrations/rest-api.md b/i18n/en/docusaurus-plugin-content-docs/current/integrations/rest-api.md new file mode 100644 index 000000000..9b2c38751 --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/integrations/rest-api.md @@ -0,0 +1,61 @@ +--- +sidebar_position: 1 +--- + +# REST API + +All API IDs (e.g. the loadpoint ID) begin at `1`. + +## State + +- `GET /api/state`: returns the state of the system
+ Use the optional `jq` parameter for select a subset or specific value. e.g.: `/api/state?jq=.statistics["30d"].avgPrice` + +## Site + +- `GET /api/health`: evcc health check +- `POST /api/prioritysoc/`: battery priority soc in % +- `POST /api/buffersoc/`: battery buffer soc in % +- `POST /api/bufferstartsoc/`: battery buffer start soc in % +- `POST /api/residualpower/`: grid residual power in W +- `POST /api/batterydischargecontrol/`: enable/disable battery discharge control (true/false) +- `POST /api/smartcostlimit/`: smart charging cost limit (previously known as "cheap" tariff) +- `GET /api/tariff/`: list of prices (grid/feedin/co2/planner) +- `GET /api/sessions[?format=csv&lang=]`: charging sessions +- `GET /api/settings/telemetry`: telemetry enabled status +- `POST /api/settings/telemetry/`: enable/disable telemetry (true/false) + +## Vehicles + +**Note**: for vehicle names see `vehicles` array in `/api/state` response. + +- `POST /api/vehicles//minsoc/`: minimum soc in % +- `POST /api/vehicles//limitsoc/`: limit soc in % +- `POST /api/vehicles//plan/soc//