Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

I18n en translations reference #425

Merged
merged 30 commits into from
Sep 13, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
bff316c
Enable Docusaurus EN language support
duckfullstop Aug 10, 2023
97a328d
i18n: Translate HOME.md
duckfullstop Aug 10, 2023
1b97d40
i18n: Translate labels
duckfullstop Aug 10, 2023
8c82322
i18n: Translate sponsorship.md & other files
duckfullstop Aug 10, 2023
59d54c5
i18n: en/blog/Home.md, evcc should be lowercase
duckfullstop Aug 10, 2023
7009534
add wip-warning; update local dev notes
naltatis Aug 11, 2023
5ef7cc9
i18n: + index pages for reference & configuration
carygravel Aug 13, 2023
54374d3
i18n: + EN translation for reference/configuration/site.md
carygravel Aug 14, 2023
d825b4b
i18n: + EN translation for reference/configuration/loadpoints.md
carygravel Aug 14, 2023
f3c07a1
i18n: + EN translation for reference/configuration/chargers.mdx
carygravel Aug 14, 2023
fdcc4cc
i18n: + EN translation for reference/configuration/meters.md
carygravel Aug 14, 2023
1ace353
i18n: + EN translation for reference/configuration/vehicles.mdx
carygravel Aug 14, 2023
68841ba
i18n: + EN translation for reference/configuration/hems.md
carygravel Aug 14, 2023
efb6a78
i18n: + EN translation for reference/configuration/uri.md
carygravel Aug 15, 2023
90f4254
i18n: + EN translation for reference/configuration/interval.md
carygravel Aug 15, 2023
5fa47c3
i18n: fixed formatting in reference/configuration/interval.md
carygravel Aug 15, 2023
b513a2f
i18n: + EN translation for reference/configuration/log.md
carygravel Aug 15, 2023
c8db3c8
i18n: + EN translation for reference/configuration/tariffs.md
carygravel Aug 15, 2023
f41a05b
i18n: + EN translation for reference/configuration/messaging.md
carygravel Aug 15, 2023
acca9fa
i18n: + EN translation for reference/configuration/eebus.md
carygravel Aug 15, 2023
aecea07
i18n: + EN translation for reference/configuration/mqtt.md
carygravel Aug 15, 2023
5571d1f
i18n: + EN translation for reference/configuration/influx.md
carygravel Aug 15, 2023
e55b8c8
i18n: + EN translation for reference/configuration/sponsortoken.md
carygravel Aug 15, 2023
ffbb806
i18n: + EN translation for reference/configuration/sponsortelemetry.md
carygravel Aug 15, 2023
29829f9
i18n: + EN translation for reference/configuration/modbusproxy.md
carygravel Aug 15, 2023
212fc09
i18n: + EN translation for reference/plugins.md
carygravel Aug 15, 2023
e99cf3e
i18n: + EN translation for reference/modbus.md
carygravel Aug 15, 2023
0544adf
i18n: + EN translation for reference/api.md
carygravel Aug 15, 2023
0e76e6a
Merge branch 'main' into i18n-en-translations-reference
naltatis Aug 23, 2023
c451d7b
Merge branch 'evcc-io:main' into i18n-en-translations-reference
carygravel Sep 3, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
87 changes: 87 additions & 0 deletions i18n/en/docusaurus-plugin-content-docs/current/reference/api.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
---
sidebar_position: 5
---

# API

evcc can interact with REST and MQTT APIs.

All API IDs (e.g., Loadpoint ID) start at `1`.

## REST API

- `GET /api/state`: evcc state (static configuration and dynamic state as JSON object)
- `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/smartcostlimit/<cost>`: smart charging cost limit (previously known as "cheap" tariff)
- `GET /api/tariff/<type>`: list of prices (grid/feedin/planner)
- `GET /api/sessions[?format=csv&lang=<lang>]`: charging sessions
- `GET /api/telemetry`: telemetry enabled status
- `POST /api/telemetry/<status>`: enable/disable telemetry (true/false)

### Loadpoint

- `POST /api/loadpoints/<id>/mode/<mode>`: charge mode (off/pv/minpv/now)
- `POST /api/loadpoints/<id>/minsoc/<soc>`: minimum SoC in %
- `POST /api/loadpoints/<id>/target/soc/<soc>`: target SoC in %
- `POST /api/loadpoints/<id>/target/energy/<energy>`: target energy in kWh
- `POST /api/loadpoints/<id>/target/time/<time>`: target time in RFC3339 / ISO format \*\*
- `DELETE /api/loadpoints/<id>/target/time`: disable target charging
- `GET /api/loadpoints/<id>/target/plan[?targetTime=<time>]`: charging plan details
- `POST /api/loadpoints/<id>/phases/<phases>`: enabled 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/<vehicleId>`: set currently selected vehicle

:::note
Example: `curl -X POST http://evcc:7070/api/loadpoints/1/mode/pv` to set the charging mode of the 1st Loadpoint to `pv`.
:::

## MQTT API

The MQTT API follows the REST API structure:

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

- `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)

- `evcc/loadpoints`: number of available loadpoints
- `evcc/loadpoints/<id>`: loadpoint dynamic state
- `evcc/loadpoints/<id>/mode`: loadpoint charge mode (writable)
- `evcc/loadpoints/<id>/minSoc`: loadpoint minimum SoC (writable)
- `evcc/loadpoints/<id>/targetSoc`: loadpoint target SoC in % (writable)
- `evcc/loadpoints/<id>/targetEnergy`: loadpoint target energy in kWh (writable)
- `evcc/loadpoints/<id>/targetTime`: loadpoint target time in RFC3339 / ISO format (writable) \*\*
- `evcc/loadpoints/<id>/phases`: loadpoint enabled phases (writable)
- `evcc/loadpoints/<id>/minCurrent`: loadpoint current minCurrent value (writable)
- `evcc/loadpoints/<id>/maxCurrent`: loadpoint current maxCurrent value (writable)
- `evcc/loadpoints/<id>/enableThreshold`: loadpoint threshold value (writable)
- `evcc/loadpoints/<id>/disableThreshold`: loadpoint threshold value (writable)

:::note
To perform writable settings, add `/set` at the end of the topic to which the new value will be sent.
Example: `mosquitto_pub -t "evcc/loadpoints/1/phases/set" -m "3"` to set the number of grid-side phases of the 1st Loadpoint to `3`.
:::

:::info
\*\* Time is in UTC in the format `yyyy-mm-ddThh:mm:ssZ`

Examples:

`2023-03-05T07:00:00Z` = 5th March 2023 at 7:00 AM UTC

`2023-08-17T19:30:00Z` = 17th August 2023 at 7:30 PM UTC
:::
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
---
sidebar_position: 4
---

import SponsorshipRequired from "/docs/_sponsorship_required.mdx";

# `chargers`

To control the charging process, evcc must be able to communicate with a charger.

A charger must have at least the following configuration:

```yaml
chargers:
- name: charger1 # reference name
type: ...
...
```

Below, the possible parameters are explained.

---

## Required Parameters

### `name`

A short designation of the charger defined here. The value is used when referencing the charger in the configuration of the [charger](loadpoints#charger).

**For example**:

```yaml
name: charger1
```

---

### `type`

This is the evcc-specific charger type that allows communication with the charger. Known chargers can be integrated using the `template` type. The appropriate (template) type can be found under [devices - chargers](/docs/devices/chargers).

For unknown chargers (or for other individual reasons), the default implementation can be used through [Plugins](/docs/reference/plugins).

**For example**:

```yaml
type: custom
```

---
## Optional Parameters

### `integrateddevice`

This parameter causes chargers that operate without a "vehicle" (e.g. heat pump, eBike) to not display a vehicle, thus omitting vehicle detection.

In connection with this parameter, an icon can also be assigned (see [`vehicle.icon`](/docs/reference/configuration/vehicles#icon)), which will then be displayed at the charger.

**For example**:

```yaml
integrateddevice: true
icon: bike
```

---
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
---
sidebar_position: 13
---

# `eebus`

:::warning
EEBUS support is still experimental. Please expect some issues while using it!
:::

**For example**:

```yaml
eebus:
shipid: EVCC-1234567890abcdef
interfaces:
- eth0
certificate:
public: |
-----BEGIN CERTIFICATE-----
1234567890abcdef==
-----END CERTIFICATE-----
private: |
-----BEGIN EC PRIVATE KEY-----
1234567890abcdef
-----END EC PRIVATE KEY-----
```

---

## Required Parameters

### `certificate`

Defines the certificate and its private key to be used for the required HTTPS connection.

This can be generated using `evcc eebus-cert`.

**For example**:

```yaml
certificate:
public: |
-----BEGIN CERTIFICATE-----
1234567890abcdef==
-----END CERTIFICATE-----
private: |
-----BEGIN EC PRIVATE KEY-----
1234567890abcdef
-----END EC PRIVATE KEY-----
```

---

### `certificate.public`

The public certificate.

**For example**:

```yaml
public: |
-----BEGIN CERTIFICATE-----
1234567890abcdef==
-----END CERTIFICATE-----
```

---

### `certificate.private`

The private key of the certificate.

**For example**:

```yaml
private: |
-----BEGIN EC PRIVATE KEY-----
1234567890abcdef
-----END EC PRIVATE KEY-----
```

---

## Optional Parameters

### `interfaces`

Defines a list of network interfaces through which EEBUS should communicate. By default, all interfaces are used, but this might lead to communication issues.

**For example**:

```yaml
interfaces:
- eth0
```

### `shipid`

Defines the Device ID (SKI) to be used.

**For example**:

```yaml
shipid: EVCC-1234567890abcdef
```
Loading