Skip to content

Commit ae75906

Browse files
naltatisCopilot
andauthored
Add evcc App reference page (#1098)
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
1 parent 4dee5da commit ae75906

5 files changed

Lines changed: 127 additions & 0 deletions

File tree

astro.config.mjs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -229,6 +229,7 @@ export default defineConfig({
229229
{ label: "Plugins", slug: "reference/plugins" },
230230
{ label: "Modbus", slug: "reference/modbus" },
231231
{ label: "Web UI", slug: "reference/web-ui" },
232+
{ label: "evcc App", slug: "reference/app" },
232233
{
233234
label: "CLI",
234235
collapsed: true,

src/content/docs/de/features/app.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,12 @@ Genau wie beim Zugriff über den Browser musst du dich mit der App im gleichen N
6363
Für die Nutzung aus dem Internet empfehlen wir die Nutzung von VPN-Diensten.
6464
Viele Router bringen so eine Funktion mit, aber auch Dienste wie [Tailscale](https://tailscale.com/) oder [ZeroTier](https://zerotier.com/) werden gerne genutzt.
6565

66+
## URL-Schema
67+
68+
Die App registriert ein `evcc://`-URL-Schema.
69+
Damit kannst du per Link oder QR-Code die Servereinrichtung vorausfüllen oder direkt zu einer Seite springen.
70+
Die verfügbaren Links findest du unter [evcc App](/de/reference/app).
71+
6672
## Ausblick
6773

6874
Mit der nativen App haben wir die Basis für zukünftige Funktionen geschaffen, die mit der Web-UI nicht möglich sind.
Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
---
2+
title: "evcc App"
3+
sidebar:
4+
order: 4
5+
---
6+
7+
Die [Companion-App](/de/features/app) registriert auf deinem Gerät ein `evcc://`-URL-Schema.
8+
Ein solcher Link füllt die Servereinrichtung vor oder öffnet direkt eine Seite.
9+
10+
## Server hinzufügen {#server}
11+
12+
Öffnet die Servereingabe mit vorausgefüllten Werten.
13+
Alle Parameter sind optional.
14+
15+
Praktisch beim Onboarding: Teile einen Link oder QR-Code, der Server-URL und Login vorausfüllt, sodass niemand eine lange Adresse abtippen muss.
16+
17+
```
18+
evcc://server?url=...&title=...&username=...&password=...
19+
```
20+
21+
| Parameter | Beschreibung |
22+
| ---------- | -------------- |
23+
| `url` | Server-URL |
24+
| `title` | Anzeigename |
25+
| `username` | Login-Benutzer |
26+
| `password` | Login-Passwort |
27+
28+
Achte darauf, dass die Werte URL-codiert sind.
29+
30+
```
31+
evcc://server?url=https://demo.evcc.io&title=Demo%20Server&username=admin&password=secret
32+
```
33+
34+
![QR-Code für den Beispiel-Link](https://api.qrserver.com/v1/create-qr-code/?color=000000&bgcolor=FFFFFF&data=evcc%3A%2F%2Fserver%3Furl%3Dhttps%3A%2F%2Fdemo.evcc.io%26title%3DDemo%2520Server%26username%3Dadmin%26password%3Dsecret&qzone=1&margin=0&size=150x150&ecc=L)
35+
36+
## Vorhersage öffnen {#forecast}
37+
38+
Öffnet die Vorhersageseite.
39+
40+
```
41+
evcc://forecast?server=<index>
42+
```
43+
44+
`server` ist der bei `0` beginnende Index eines gespeicherten Servers.
45+
Ohne Angabe wird der aktive Server verwendet.
46+
47+
## Ladepunkt öffnen {#loadpoint}
48+
49+
Öffnet die Ladepunktseite.
50+
51+
```
52+
evcc://loadpoint?lp=<number>&server=<index>
53+
```
54+
55+
`lp` wählt den Ladepunkt mit dieser bei `1` beginnenden Nummer.
56+
Ohne Angabe wird der aktuelle Ladepunkt verwendet.
57+
`server` funktioniert wie oben.

src/content/docs/en/features/app.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,12 @@ Just like when accessing via browser, you need to be on the same network as your
6363
For internet access, we recommend using VPN services.
6464
Many routers include such functionality, but services like [Tailscale](https://tailscale.com/) or [ZeroTier](https://zerotier.com/) are also commonly used.
6565

66+
## URL Scheme
67+
68+
The app registers an `evcc://` URL scheme.
69+
Use it to prefill the server setup or jump to a page via a link or QR code.
70+
See [evcc App](/en/reference/app) for the available links.
71+
6672
## Perspectives
6773

6874
With the native app, we've created the foundation for future features that aren't possible with the Web UI.
Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
---
2+
title: "evcc App"
3+
sidebar:
4+
order: 4
5+
---
6+
7+
The [companion app](/en/features/app) registers an `evcc://` URL scheme on your device.
8+
Open such a link to prefill the server setup or jump to a page.
9+
10+
## Add a Server {#server}
11+
12+
Opens the server entry with prefilled values.
13+
All parameters are optional.
14+
15+
Handy for onboarding: share a link or QR code that fills in the server URL and login, so nobody has to type a long address by hand.
16+
17+
```
18+
evcc://server?url=...&title=...&username=...&password=...
19+
```
20+
21+
| Parameter | Description |
22+
| ---------- | -------------- |
23+
| `url` | Server URL |
24+
| `title` | Display name |
25+
| `username` | Login user |
26+
| `password` | Login password |
27+
28+
Make sure the values are URL-encoded.
29+
30+
```
31+
evcc://server?url=https://demo.evcc.io&title=Demo%20Server&username=admin&password=secret
32+
```
33+
34+
![QR code for the example link](https://api.qrserver.com/v1/create-qr-code/?color=000000&bgcolor=FFFFFF&data=evcc%3A%2F%2Fserver%3Furl%3Dhttps%3A%2F%2Fdemo.evcc.io%26title%3DDemo%2520Server%26username%3Dadmin%26password%3Dsecret&qzone=1&margin=0&size=150x150&ecc=L)
35+
36+
## Open the Forecast {#forecast}
37+
38+
Navigates to the forecast page.
39+
40+
```
41+
evcc://forecast?server=<index>
42+
```
43+
44+
`server` is the zero-based index of a saved server.
45+
If omitted, the active server is used.
46+
47+
## Open a Loadpoint {#loadpoint}
48+
49+
Navigates to the loadpoints page.
50+
51+
```
52+
evcc://loadpoint?lp=<number>&server=<index>
53+
```
54+
55+
`lp` focuses the loadpoint with that one-based number.
56+
If omitted, the current loadpoint is used.
57+
`server` works the same as above.

0 commit comments

Comments
 (0)