chore: consistent URL patterns in template descriptions (#28628)
This commit is contained in:
Michael Geers
GitHub
parent
32cfc5ac6a
commit
1850f805cb
10 changed files with 27 additions and 23 deletions
|
|
@ -68,7 +68,9 @@ Either `brand`, or `description` need to be set.
|
|||
- Omit `www.` from the display text: `[example.com](https://www.example.com/path)`
|
||||
- GitHub URLs use `github.com/user/repo` as display text: `[github.com/user/repo](https://github.com/user/repo)`
|
||||
- Use code formatting `` `text` `` for technical identifiers, tokens, configuration values, and entity patterns
|
||||
- Use only plain ASCII quotes (`"`, `'`) — never typographic/curly quotes (`“`, `”`, `„`, `‘`, `’`)
|
||||
- Placeholder and example URLs (IP addresses, hostnames, device endpoints) should also use code formatting: `` `http://<charger-host>:8000/semp` ``, `` `ws://<evcc-host>:8887/` ``
|
||||
- Use angle-bracket placeholders for device addresses: `<evcc-host>`, `<charger-host>`, `<meter-host>`, `<inverter-host>`
|
||||
- Use only plain ASCII quotes (`”`, `’`) — never typographic/curly quotes (`”`, `”`, `„`, `’`, `’`)
|
||||
- Use bold formatting `**text**` sparingly and only for important warnings or critical information
|
||||
|
||||
Example:
|
||||
|
|
@ -76,6 +78,8 @@ Example:
|
|||
```
|
||||
en: |
|
||||
Requires `hcaptcha` token from [developer.example.com](https://developer.example.com/tokens).
|
||||
Configure the SEMP base URL (`http://<charger-host>:8000/semp`).
|
||||
Set the backend URL to `ws://<evcc-host>:8887/`.
|
||||
|
||||
**Attention**: Token is only valid for 2 minutes.
|
||||
```
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@ requirements:
|
|||
* Erforderliche Firmwareversion verifizieren: Ladesteuergerät: V1.51.00, Leistungsregelmodul: V1.19.00
|
||||
* In der Autel Charge app, klicken sie auf "OCPP Server"
|
||||
* Geben Sie "Custom" in das Feld ein und wählen Sie "Personalisierung" darunter
|
||||
* Server-URL: ws://[evcc-adresse]:8887/ (Verbindung über das lokale Netzwerk)
|
||||
* Server-URL: `ws://<evcc-host>:8887/` (Verbindung über das lokale Netzwerk)
|
||||
* Ladegerät-ID: Leer lassen (zur Verwendung der Seriennummer) oder einen benutzerdefinierten Wert definieren, der in der Konfiguration als *stationid* wiederverwendet wird
|
||||
* Autorisierungsschlüssel: leer lassen
|
||||
en: |
|
||||
|
|
@ -23,7 +23,7 @@ requirements:
|
|||
* Validate required firmware version: Charge Control Module: V1.51.00, Power Control Module: V1.19.00
|
||||
* In the Autel Charge app, click on "OCPP Server"
|
||||
* In the search bar type "Custom" and select it.
|
||||
* Server URL: ws://[evcc-address]:8887/ (local network connection)
|
||||
* Server URL: `ws://<evcc-host>:8887/` (local network connection)
|
||||
* Charger ID: Leave empty (for use the serial number) or set custom value which is reused in configuration as *stationid*
|
||||
* Authorisation Key: leave empty
|
||||
params:
|
||||
|
|
|
|||
|
|
@ -8,11 +8,11 @@ requirements:
|
|||
description:
|
||||
de: |
|
||||
Die Verwendung mit evcc erfordert einen eingebauten Stromzähler (Ausführungen HC11L/HC22L Energy oder Profi).
|
||||
Die OCPP-Konfiguration erfolgt über den EFR-SECC-Ladecontroller über die URL http://host/secc.
|
||||
Die OCPP-Konfiguration erfolgt über den EFR-SECC-Ladecontroller über die URL `http://<charger-host>/secc`.
|
||||
Den Zugang erfragen Sie bitte beim Hersteller EFR (www.efr.de) oder Ihrem Händler.
|
||||
en: |
|
||||
The charger must be equipped with a built-in meter (models HC11L/HC22L Energy or Profi).
|
||||
For the OCPP configuration, you need to access the EFR-SECC charge controller at http://host/secc.
|
||||
For the OCPP configuration, you need to access the EFR-SECC charge controller at `http://<charger-host>/secc`.
|
||||
For login credentials, ask your dealer or the vendor EFR (www.efr.de).
|
||||
evcc: ["sponsorship", "skiptest"]
|
||||
params:
|
||||
|
|
|
|||
|
|
@ -15,11 +15,11 @@ requirements:
|
|||
de: |
|
||||
Zur Konfiguration die Weboberfläche der ACU aufrufen.
|
||||
Setup, Backend, Übertragungsprotokoll: Open Charge Point Protocol v1.6J
|
||||
Setup, Backend, Backend-Server: Hier muss die evcc URL `ws://<evcc-address>:8887/` eingetragen sein. Basic Authentication: deaktivieren. OCPP 1.6 Einstellungen: alle Optionen aktivieren.
|
||||
Setup, Backend, Backend-Server: Hier muss die evcc URL `ws://<evcc-host>:8887/` eingetragen sein. Basic Authentication: deaktivieren. OCPP 1.6 Einstellungen: alle Optionen aktivieren.
|
||||
en: |
|
||||
To configure, open the web interface of the ACU.
|
||||
Setup, Backend, Communication Protocol: Open Charge Point Protocol v1.6J
|
||||
Setup, Backend, Backend Server: The evcc URL `ws://<evcc-address>:8887/` must be entered here. Basic Authentication: Disabled. OCPP 1.6 Settings: Enable all options.
|
||||
Setup, Backend, Backend Server: The evcc URL `ws://<evcc-host>:8887/` must be entered here. Basic Authentication: Disabled. OCPP 1.6 Settings: Enable all options.
|
||||
evcc: ["sponsorship", "skiptest"]
|
||||
params:
|
||||
- preset: ocpp
|
||||
|
|
|
|||
|
|
@ -20,15 +20,15 @@ requirements:
|
|||
|
||||
* "OCPP aktivieren" (myWallbox app) bzw. den "OCPP-WebSocket-Verbindung" Schalter (myWallbox Portal) aktivieren
|
||||
* Zusätzlich die "Verbesserte Ladegerätsteuerung" (Profil -> Experimentelle Funktionen) einschalten (myWallbox app)
|
||||
* URL: ws://[evcc-adresse]:8887/ (Verbindung über das lokale Netzwerk)
|
||||
* URL: `ws://<evcc-host>:8887/` (Verbindung über das lokale Netzwerk)
|
||||
* Ladepunktidentität: beliebiger Wert (z.B. die Seriennummer der Box), der als *stationid* verwendet wird
|
||||
* Passwort: leer lassen
|
||||
en: |
|
||||
Setup Guide: [support.wallbox.com](https://support.wallbox.com/en/knowledge-base/ocpp-activation-and-setup-guide/)
|
||||
|
||||
* Switch on "Enable OCPP" (myWallbox app) or enable the "OCPP WebSocket connection" switch (myWallbox Portal)
|
||||
* Enable "Improved charger control" (Profile -> Experimental functions) (myWallbox app)
|
||||
* URL: ws://[evcc-adresse]:8887/ (local network connection)
|
||||
* Enable "Improved charger control" (Profile -> Experimental functions) (myWallbox app)
|
||||
* URL: `ws://<evcc-host>:8887/` (local network connection)
|
||||
* Charge Point Identity: Custom value (e.g. serial number of charger) which is reused in configuration as *stationid*
|
||||
* Password: leave empty
|
||||
evcc: ["sponsorship", "skiptest"]
|
||||
|
|
|
|||
|
|
@ -20,15 +20,15 @@ requirements:
|
|||
|
||||
* "OCPP aktivieren" (myWallbox app) bzw. den "OCPP-WebSocket-Verbindung" Schalter (myWallbox Portal) aktivieren
|
||||
* Zusätzlich die "Verbesserte Ladegerätsteuerung" (Profil -> Experimentelle Funktionen) einschalten (myWallbox app)
|
||||
* URL: ws://[evcc-adresse]:8887/ (Verbindung über das lokale Netzwerk)
|
||||
* URL: `ws://<evcc-host>:8887/` (Verbindung über das lokale Netzwerk)
|
||||
* Ladepunktidentität: beliebiger Wert (z.B. die Seriennummer der Box), der als *stationid* verwendet wird
|
||||
* Passwort: leer lassen
|
||||
en: |
|
||||
Setup Guide: [support.wallbox.com](https://support.wallbox.com/en/knowledge-base/ocpp-activation-and-setup-guide/)
|
||||
|
||||
* Switch on "Enable OCPP" (myWallbox app) or enable the "OCPP WebSocket connection" switch (myWallbox Portal)
|
||||
* Enable "Improved charger control" (Profile -> Experimental functions) (myWallbox app)
|
||||
* URL: ws://[evcc-adresse]:8887/ (local network connection)
|
||||
* Enable "Improved charger control" (Profile -> Experimental functions) (myWallbox app)
|
||||
* URL: `ws://<evcc-host>:8887/` (local network connection)
|
||||
* Charge Point Identity: Custom value (e.g. serial number of charger) which is reused in configuration as *stationid*
|
||||
* Password: leave empty
|
||||
evcc: ["sponsorship", "skiptest"]
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ requirements:
|
|||
Die Wallbox muss daher evcc via Hostname (funktionierende DNS-Auflösung erforderlich!) oder über die IP-Adresse auf Port 8887 erreichen können.
|
||||
Standardmäßig wird die erste eingehende Verbindung mit einer beliebigen Ladepunktkennung verwendet.
|
||||
Um mehrere Ladepunkte eindeutig zuordnen zu können müssen die jeweilige Stationskennung (`stationid: `) und Anschlussnummer (`connector: `) hinterlegt werden.
|
||||
Viele Wallboxen fügen die `stationid` automatisch der Backend-URL hinzu, bei manchen muss dies manuell geschehen `ws://<evcc>:8887/<stationid>`.
|
||||
Viele Wallboxen fügen die `stationid` automatisch der Backend-URL hinzu, bei manchen muss dies manuell geschehen `ws://<evcc-host>:8887/<stationid>`.
|
||||
Für Zählermesswerte sollte in der Wallbox wenn möglich ein kurzes Zeitintervall (< 10s) konfiguriert werden.
|
||||
Nutzen Sie Ihre RFID-Tags (dies ermöglicht z. B. eine Fahrzeugidentifizierung) oder setzen Sie Ihre Wallbox auf "freies Laden" oder "Autostart" um die für die Ladefreigabe benötigte Transaktion zu erzeugen.
|
||||
|
||||
|
|
@ -21,7 +21,7 @@ requirements:
|
|||
|
||||
Voraussetzungen:
|
||||
* Ggf. zuvor konfigurierte OCPP-Profile (z.B. durch eine andere Backend-Anbindung) in der Wallboxkonfiguration entfernen
|
||||
* Backend-URL (Central System) in der Wallboxkonfiguration: `ws://[evcc-adresse]:8887/` (eventuell noch um `stationid` erweitern)
|
||||
* Backend-URL (Central System) in der Wallboxkonfiguration: `ws://<evcc-host>:8887/` (eventuell noch um `stationid` erweitern)
|
||||
* Protokoll: OCPP-J v1.6, ocpp16j, JSON, Websocket, ws:// o.ä.
|
||||
* Keine Verschlüsselung, keine Authentifizierung, kein Passwort
|
||||
* Verbindung über das lokale Netzwerk
|
||||
|
|
@ -32,7 +32,7 @@ requirements:
|
|||
The charger needs to be able to reach evcc via the host name (functioning DNS resolution required!) or via the IP address on port 8887.
|
||||
By default, the first incoming connection with any station identifier is used.
|
||||
In order to be able to clearly assign several charging points, the respective station identifier (`stationid: `) and connector number (`connector: `) must be configured.
|
||||
Many wallboxes automatically add the `station id` to the backend URL, some have to do this manually `ws://<evcc>:8887/<stationid>`.
|
||||
Many wallboxes automatically add the `station id` to the backend URL, some have to do this manually `ws://<evcc-host>:8887/<stationid>`.
|
||||
If the charger supports sending metering values, try to adjust the interval to a short time span (< 10s) .
|
||||
Use your RFID tags (this allows e.g. vehicle identification) or set your charger to "free charging" or "autostart" to generate the transaction required for charging release.
|
||||
|
||||
|
|
@ -41,7 +41,7 @@ requirements:
|
|||
|
||||
Requirements:
|
||||
* If necessary, remove previously configured OCPP profiles (e.g. used for a different backend connection) in the charger configuration
|
||||
* Backend URL (Central System) in the charger configuration: `ws://[evcc-adresse]:8887/` (possibly add `stationid`)
|
||||
* Backend URL (Central System) in the charger configuration: `ws://<evcc-host>:8887/` (possibly add `stationid`)
|
||||
* Protocol: OCPP-J v1.6, ocpp16j, JSON, Websocket, ws:// or similar
|
||||
* No encryption, no authentication, no password
|
||||
* Local network connection
|
||||
|
|
|
|||
|
|
@ -11,11 +11,11 @@ requirements:
|
|||
evcc: ["sponsorship", "skiptest"]
|
||||
description:
|
||||
en: |
|
||||
Configure the SEMP base URL (e.g. http://192.168.178.100/SEMP) and the device ID of the charger.
|
||||
Configure the SEMP base URL (`http://<charger-host>/SEMP`) and the device ID of the charger.
|
||||
IMPORTANT: The charger must NOT be registered directly as a consumer in the Sunny Home Manager / Sunny Portal at the same time!
|
||||
The configuration option "Disconnect after full charge" must be disabled.
|
||||
de: |
|
||||
Konfiguriere die SEMP Basis-URL (z.B. http://192.168.178.100/SEMP) und die Geräte-ID des Chargers.
|
||||
Konfiguriere die SEMP Basis-URL (`http://<charger-host>/SEMP`) und die Geräte-ID des Chargers.
|
||||
WICHTIG: Der Charger darf NICHT gleichzeitig im Sunny Home Manager bzw. im Sunny Portal direkt als Verbraucher registriert sein!
|
||||
Die Konfigurationsoption "Trennung nach Vollladung" muss deaktiviert sein.
|
||||
params:
|
||||
|
|
|
|||
|
|
@ -10,11 +10,11 @@ requirements:
|
|||
description:
|
||||
en: |
|
||||
SEMP (Smart Energy Management Protocol) compatible wallbox or device that can be controlled directly via HTTP/XML API.
|
||||
Configure the SEMP base URL (e.g. http://192.168.1.100:8000/semp) and the device ID of the wallbox.
|
||||
Configure the SEMP base URL (`http://<charger-host>:8000/semp`) and the device ID of the wallbox.
|
||||
IMPORTANT: The wallbox must NOT be registered directly as a consumer in the Sunny Home Manager / Sunny Portal at the same time!
|
||||
de: |
|
||||
SEMP (Smart Energy Management Protocol) kompatible Wallbox oder Verbraucher, die direkt über HTTP/XML API gesteuert werden kann.
|
||||
Konfiguriere die SEMP Basis-URL (z.B. http://192.168.1.100:8000/semp) und die Geräte-ID der Wallbox.
|
||||
Konfiguriere die SEMP Basis-URL (`http://<charger-host>:8000/semp`) und die Geräte-ID der Wallbox.
|
||||
WICHTIG: Die Wallbox darf NICHT gleichzeitig im Sunny Home Manager bzw. im Sunny Portal direkt als Verbraucher registriert sein!
|
||||
params:
|
||||
- name: uri
|
||||
|
|
|
|||
|
|
@ -7,12 +7,12 @@ requirements:
|
|||
description:
|
||||
en: |
|
||||
Requires an IoTaWatt device accessible on the local network.
|
||||
Find available series names on the IoTaWatt status page (http://<device-ip>).
|
||||
Find available series names on the IoTaWatt status page (`http://<device-host>`).
|
||||
For single-phase setups, configure only the main series (e.g. `GridNet`, `Solar`).
|
||||
For three-phase, configure one series per phase (e.g. `Grid_A`, `Grid_B`, `Grid_C`).
|
||||
de: |
|
||||
Erfordert ein IoTaWatt-Gerät im lokalen Netzwerk.
|
||||
Verfügbare Seriennamen finden Sie auf der IoTaWatt-Statusseite (http://<device-ip>).
|
||||
Verfügbare Seriennamen finden Sie auf der IoTaWatt-Statusseite (`http://<device-host>`).
|
||||
Für einphasige Installationen nur die Hauptserie konfigurieren (z.B. `GridNet`, `Solar`).
|
||||
Für dreiphasig je eine Serie pro Phase angeben (z.B. `Grid_A`, `Grid_B`, `Grid_C`).
|
||||
params:
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue