diff --git a/astro.config.mjs b/astro.config.mjs index ed61e2d1f..3b47f6085 100644 --- a/astro.config.mjs +++ b/astro.config.mjs @@ -214,6 +214,7 @@ export default defineConfig({ }, { label: "Plugins", slug: "reference/plugins" }, { label: "Modbus", slug: "reference/modbus" }, + { label: "evcc App", slug: "reference/app" }, { label: "CLI", collapsed: true, diff --git a/src/content/docs/de/features/app.mdx b/src/content/docs/de/features/app.mdx index 127d312bf..bc8008f41 100644 --- a/src/content/docs/de/features/app.mdx +++ b/src/content/docs/de/features/app.mdx @@ -63,6 +63,12 @@ Genau wie beim Zugriff über den Browser musst du dich mit der App im gleichen N Für die Nutzung aus dem Internet empfehlen wir die Nutzung von VPN-Diensten. Viele Router bringen so eine Funktion mit, aber auch Dienste wie [Tailscale](https://tailscale.com/) oder [ZeroTier](https://zerotier.com/) werden gerne genutzt. +## URL-Schema + +Die App registriert ein `evcc://`-URL-Schema. +Damit kannst du per Link oder QR-Code die Servereinrichtung vorausfüllen oder direkt zu einer Seite springen. +Die verfügbaren Links findest du unter [evcc App](/de/reference/app). + ## Ausblick Mit der nativen App haben wir die Basis für zukünftige Funktionen geschaffen, die mit der Web-UI nicht möglich sind. diff --git a/src/content/docs/de/reference/app.md b/src/content/docs/de/reference/app.md new file mode 100644 index 000000000..2536de4a6 --- /dev/null +++ b/src/content/docs/de/reference/app.md @@ -0,0 +1,57 @@ +--- +title: "evcc App" +sidebar: + order: 4 +--- + +Die [Companion-App](/de/features/app) registriert auf deinem Gerät ein `evcc://`-URL-Schema. +Ein solcher Link füllt die Servereinrichtung vor oder öffnet direkt eine Seite. + +## Server hinzufügen {#server} + +Öffnet die Servereingabe mit vorausgefüllten Werten. +Alle Parameter sind optional. + +Praktisch beim Onboarding: Teile einen Link oder QR-Code, der Server-URL und Login vorausfüllt, sodass niemand eine lange Adresse abtippen muss. + +``` +evcc://server?url=...&title=...&username=...&password=... +``` + +| Parameter | Beschreibung | +| ---------- | -------------- | +| `url` | Server-URL | +| `title` | Anzeigename | +| `username` | Login-Benutzer | +| `password` | Login-Passwort | + +Achte darauf, dass die Werte URL-codiert sind. + +``` +evcc://server?url=https://demo.evcc.io&title=Demo%20Server&username=admin&password=secret +``` + +![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) + +## Vorhersage öffnen {#forecast} + +Öffnet die Vorhersageseite. + +``` +evcc://forecast?server= +``` + +`server` ist der bei `0` beginnende Index eines gespeicherten Servers. +Ohne Angabe wird der aktive Server verwendet. + +## Ladepunkt öffnen {#loadpoint} + +Öffnet die Ladepunktseite. + +``` +evcc://loadpoint?lp=&server= +``` + +`lp` wählt den Ladepunkt mit dieser bei `1` beginnenden Nummer. +Ohne Angabe wird der aktuelle Ladepunkt verwendet. +`server` funktioniert wie oben. diff --git a/src/content/docs/en/features/app.mdx b/src/content/docs/en/features/app.mdx index 89ee71fea..c71d2fb30 100644 --- a/src/content/docs/en/features/app.mdx +++ b/src/content/docs/en/features/app.mdx @@ -63,6 +63,12 @@ Just like when accessing via browser, you need to be on the same network as your For internet access, we recommend using VPN services. Many routers include such functionality, but services like [Tailscale](https://tailscale.com/) or [ZeroTier](https://zerotier.com/) are also commonly used. +## URL Scheme + +The app registers an `evcc://` URL scheme. +Use it to prefill the server setup or jump to a page via a link or QR code. +See [evcc App](/en/reference/app) for the available links. + ## Perspectives With the native app, we've created the foundation for future features that aren't possible with the Web UI. diff --git a/src/content/docs/en/reference/app.md b/src/content/docs/en/reference/app.md new file mode 100644 index 000000000..ca688af1b --- /dev/null +++ b/src/content/docs/en/reference/app.md @@ -0,0 +1,57 @@ +--- +title: "evcc App" +sidebar: + order: 4 +--- + +The [companion app](/en/features/app) registers an `evcc://` URL scheme on your device. +Open such a link to prefill the server setup or jump to a page. + +## Add a Server {#server} + +Opens the server entry with prefilled values. +All parameters are optional. + +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. + +``` +evcc://server?url=...&title=...&username=...&password=... +``` + +| Parameter | Description | +| ---------- | -------------- | +| `url` | Server URL | +| `title` | Display name | +| `username` | Login user | +| `password` | Login password | + +Make sure the values are URL-encoded. + +``` +evcc://server?url=https://demo.evcc.io&title=Demo%20Server&username=admin&password=secret +``` + +![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) + +## Open the Forecast {#forecast} + +Navigates to the forecast page. + +``` +evcc://forecast?server= +``` + +`server` is the zero-based index of a saved server. +If omitted, the active server is used. + +## Open a Loadpoint {#loadpoint} + +Navigates to the loadpoints page. + +``` +evcc://loadpoint?lp=&server= +``` + +`lp` focuses the loadpoint with that one-based number. +If omitted, the current loadpoint is used. +`server` works the same as above.