chore: improve template link consistency (#26606)
This commit is contained in:
Michael Geers
GitHub
parent
a19e16e41c
commit
9ed9b2bfe8
20 changed files with 67 additions and 50 deletions
|
|
@ -50,7 +50,7 @@ Allows to define a list of meter devices that are typically installed with this
|
|||
**Possible values**:
|
||||
|
||||
- `grid`: for grid meters
|
||||
- `pv`: for pv inverter/meter
|
||||
- `pv`: for pv inverter/meter
|
||||
- `battery`: for battery inverter/meter
|
||||
|
||||
#### `multiple`
|
||||
|
|
@ -85,12 +85,29 @@ Example Use Case: With SMA Home Manager, there can be a SMA Energy Meter used fo
|
|||
**Possible Values**:
|
||||
|
||||
- `sponsorship`: If the device requires a sponsorship token
|
||||
- `eebus`: If the device is accessed via the eebus protocol and thus requires the corresponding setup
|
||||
- `eebus`: If the device is accessed via the EEBus protocol and thus requires the corresponding setup
|
||||
- `mqtt`: If the device a MQTT setup
|
||||
|
||||
### `description`
|
||||
|
||||
`description` expects language specific texts via `de`, `en` to provide specific things the user has to do, e.g. minimum firmware versions or specific hardware setup requirements. The content can be multiline and Markdown
|
||||
`description` expects language-specific texts via `de`, `en` to provide specific things the user has to do, e.g. minimum firmware versions or specific hardware setup requirements.
|
||||
|
||||
**Markdown formatting**:
|
||||
|
||||
- The content can be multiline
|
||||
- The content supports Markdown formatting
|
||||
- External URLs should always use Markdown link format with the hostname as display text: `[docs.example.com](https://docs.example.com/path/to/page)`. This provides clear context while keeping the text readable.
|
||||
- Use code formatting `` `text` `` for technical identifiers, tokens, configuration values, and entity patterns
|
||||
- Use bold formatting `**text**` sparingly and only for important warnings or critical information
|
||||
|
||||
Example:
|
||||
|
||||
```
|
||||
en: |
|
||||
Requires `hcaptcha` token from [developer.example.com](https://developer.example.com/tokens).
|
||||
|
||||
**Attention**: Token is only valid for 2 minutes.
|
||||
```
|
||||
|
||||
## `params`
|
||||
|
||||
|
|
|
|||
|
|
@ -6,8 +6,8 @@ products:
|
|||
capabilities: ["mA", "1p3p", "rfid"]
|
||||
requirements:
|
||||
description:
|
||||
de: Die automatische Phasenumschaltung bei 1p Fahrzeugen muss deaktiviert sein. Siehe https://docs.warp-charger.com/docs/mqtt_http/api_reference/evse#evse_phase_auto_switch_warp3.
|
||||
en: The automatic phase switching for 1p vehicles must be deactivated. Siehe https://docs.warp-charger.com/docs/mqtt_http/api_reference/evse#evse_phase_auto_switch_warp3.
|
||||
de: Die automatische Phasenumschaltung bei 1p Fahrzeugen muss deaktiviert sein. Siehe [docs.warp-charger.com](https://docs.warp-charger.com/docs/mqtt_http/api_reference/evse#evse_phase_auto_switch_warp3).
|
||||
en: The automatic phase switching for 1p vehicles must be deactivated. See [docs.warp-charger.com](https://docs.warp-charger.com/docs/mqtt_http/api_reference/evse#evse_phase_auto_switch_warp3).
|
||||
evcc: ["skiptest"]
|
||||
params:
|
||||
- preset: mqtt
|
||||
|
|
|
|||
|
|
@ -18,8 +18,8 @@ params:
|
|||
- name: token
|
||||
required: true
|
||||
help:
|
||||
de: API Token (https://developer.volttime.com/api-reference/authentication#personal-access-tokens)
|
||||
en: API Token (https://developer.volttime.com/api-reference/authentication#personal-access-tokens)
|
||||
de: API Token ([developer.volttime.com](https://developer.volttime.com/api-reference/authentication#personal-access-tokens))
|
||||
en: API Token ([developer.volttime.com](https://developer.volttime.com/api-reference/authentication#personal-access-tokens))
|
||||
- name: serial_number
|
||||
required: true
|
||||
help:
|
||||
|
|
|
|||
|
|
@ -30,16 +30,16 @@ params:
|
|||
description:
|
||||
generic: QcellsCloud TokenID
|
||||
help:
|
||||
de: Token ID von https://qhome-ess-g3.q-cells.eu/#/api/ oder https://qhome-ess-g3.q-cells.us/#/api/ hier eintragen.
|
||||
en: Go to https://qhome-ess-g3.q-cells.eu/#/api/ or https://qhome-ess-g3.q-cells.us/#/api/ and take the value of "ObtaintokenID".
|
||||
de: Token ID von [qhome-ess-g3.q-cells.eu](https://qhome-ess-g3.q-cells.eu/#/api/) oder [qhome-ess-g3.q-cells.us](https://qhome-ess-g3.q-cells.us/#/api/) hier eintragen.
|
||||
en: Go to [qhome-ess-g3.q-cells.eu](https://qhome-ess-g3.q-cells.eu/#/api/) or [qhome-ess-g3.q-cells.us](https://qhome-ess-g3.q-cells.us/#/api/) and take the value of "ObtaintokenID".
|
||||
- name: serial
|
||||
required: true
|
||||
description:
|
||||
de: Seriennummer
|
||||
en: Serial number
|
||||
help:
|
||||
de: Registriernummer von https://qhome-ess-g3.q-cells.eu/blue/#/inverter oder https://qhome-ess-g3.q-cells.us/blue/#/inverter hier eintragen.
|
||||
en: Go to https://qhome-ess-g3.q-cells.eu/blue/#/inverter or https://qhome-ess-g3.q-cells.us/blue/#/inverter and take the value of registration number.
|
||||
de: Registriernummer von [qhome-ess-g3.q-cells.eu](https://qhome-ess-g3.q-cells.eu/blue/#/inverter) oder [qhome-ess-g3.q-cells.us](https://qhome-ess-g3.q-cells.us/blue/#/inverter) hier eintragen.
|
||||
en: Go to [qhome-ess-g3.q-cells.eu](https://qhome-ess-g3.q-cells.eu/blue/#/inverter) or [qhome-ess-g3.q-cells.us](https://qhome-ess-g3.q-cells.us/blue/#/inverter) and take the value of registration number.
|
||||
- preset: battery-params
|
||||
render: |
|
||||
type: custom
|
||||
|
|
|
|||
|
|
@ -75,8 +75,8 @@ params:
|
|||
en: Simulate terrain shadows
|
||||
de: Simuliert Verschattung durch Umgebung
|
||||
help:
|
||||
en: Each number representing the horizon height in degrees. see https://api.akkudoktor.net/#/pv%20generation%20calculation/getForecast and https://doc.forecast.solar/horizon
|
||||
de: Jede Zahl steht für die Horizonthöhe in Grad. Siehe https://api.akkudoktor.net/#/pv%20generation%20calculation/getForecast und https://doc.forecast.solar/horizon
|
||||
en: Each number representing the horizon height in degrees. See [api.akkudoktor.net](https://api.akkudoktor.net/#/pv%20generation%20calculation/getForecast) and [doc.forecast.solar](https://doc.forecast.solar/horizon)
|
||||
de: Jede Zahl steht für die Horizonthöhe in Grad. Siehe [api.akkudoktor.net](https://api.akkudoktor.net/#/pv%20generation%20calculation/getForecast) und [doc.forecast.solar](https://doc.forecast.solar/horizon)
|
||||
type: string
|
||||
example: "10,0,10,15"
|
||||
advanced: true
|
||||
|
|
|
|||
|
|
@ -3,8 +3,8 @@ products:
|
|||
- brand: Fraunhofer ISE
|
||||
requirements:
|
||||
description:
|
||||
de: "Day-ahead Energiepreise (je kWh) an der Börse. Kann ohne vorherige Anmeldung auf https://api.energy-charts.info/ abgerufen werden. Nutzbar u.a. für dynamische Stromtarife, wo der Anbieter bis dato auf der Kundenschnittstelle noch kein Preis-Vorhersagen anbietet."
|
||||
en: "Day-ahead forecast of energy prices (per kWh) on the exchange. No prior registration for https://api.energy-charts.info/ necessary. Can be used for dynamic electricity tariffs, for example, where the supplier does not yet offer a price forecast on the customer interface."
|
||||
de: "Day-ahead Energiepreise (je kWh) an der Börse. Kann ohne vorherige Anmeldung auf [api.energy-charts.info](https://api.energy-charts.info/) abgerufen werden. Nutzbar u.a. für dynamische Stromtarife, wo der Anbieter bis dato auf der Kundenschnittstelle noch kein Preis-Vorhersagen anbietet."
|
||||
en: "Day-ahead forecast of energy prices (per kWh) on the exchange. No prior registration for [api.energy-charts.info](https://api.energy-charts.info/) necessary. Can be used for dynamic electricity tariffs, for example, where the supplier does not yet offer a price forecast on the customer interface."
|
||||
evcc: ["skiptest"]
|
||||
group: price
|
||||
countries: ["EU"]
|
||||
|
|
@ -36,8 +36,8 @@ params:
|
|||
en: Bidding zone
|
||||
de: Gebotszone
|
||||
help:
|
||||
de: "siehe https://api.energy-charts.info/#/prices/day_ahead_price_price_get"
|
||||
en: "see https://api.energy-charts.info/#/prices/day_ahead_price_price_get"
|
||||
de: "siehe [api.energy-charts.info](https://api.energy-charts.info/#/prices/day_ahead_price_price_get)"
|
||||
en: "see [api.energy-charts.info](https://api.energy-charts.info/#/prices/day_ahead_price_price_get)"
|
||||
- preset: tariff-base
|
||||
- preset: tariff-features
|
||||
render: |
|
||||
|
|
|
|||
|
|
@ -4,10 +4,10 @@ products:
|
|||
requirements:
|
||||
description:
|
||||
de: |
|
||||
Day-ahead-Preise für den europäischen Strommarkt. Siehe https://transparency.entsoe.eu für weitere Informationen.
|
||||
Day-ahead-Preise für den europäischen Strommarkt. Siehe [transparency.entsoe.eu](https://transparency.entsoe.eu) für weitere Informationen.
|
||||
Basis für viele dynamische Tarife.
|
||||
en: |
|
||||
Day-ahead prices for the European electricity market. See https://transparency.entsoe.eu for more information.
|
||||
Day-ahead prices for the European electricity market. See [transparency.entsoe.eu](https://transparency.entsoe.eu) for more information.
|
||||
Basis for many dynamic tariffs.
|
||||
group: price
|
||||
countries: ["EU"]
|
||||
|
|
@ -16,13 +16,13 @@ params:
|
|||
description:
|
||||
generic: Security token
|
||||
help:
|
||||
de: "Registrierung und anschließende Helpdesk-Anfrage erforderlich. Details zum Ablauf gibts hier https://transparency.entsoe.eu/content/static_content/Static%20content/web%20api/Guide.html#_authentication_and_authorisation"
|
||||
en: "Registration and subsequent helpdesk request required. Details on the process can be found here https://transparency.entsoe.eu/content/static_content/Static%20content/web%20api/Guide.html#_authentication_and_authorisation"
|
||||
de: "Registrierung und anschließende Helpdesk-Anfrage erforderlich. Details zum Ablauf gibts hier [transparency.entsoe.eu](https://transparency.entsoe.eu/content/static_content/Static%20content/web%20api/Guide.html#_authentication_and_authorisation)"
|
||||
en: "Registration and subsequent helpdesk request required. Details on the process can be found here [transparency.entsoe.eu](https://transparency.entsoe.eu/content/static_content/Static%20content/web%20api/Guide.html#_authentication_and_authorisation)"
|
||||
- name: domain
|
||||
example: BZN|DE-LU
|
||||
help:
|
||||
de: "siehe https://transparency.entsoe.eu/content/static_content/Static%20content/web%20api/Guide.html#_areas"
|
||||
en: "see https://transparency.entsoe.eu/content/static_content/Static%20content/web%20api/Guide.html#_areas"
|
||||
de: "siehe [transparency.entsoe.eu](https://transparency.entsoe.eu/content/static_content/Static%20content/web%20api/Guide.html#_areas)"
|
||||
en: "see [transparency.entsoe.eu](https://transparency.entsoe.eu/content/static_content/Static%20content/web%20api/Guide.html#_areas)"
|
||||
- preset: tariff-base
|
||||
- preset: tariff-features
|
||||
render: |
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ products:
|
|||
requirements:
|
||||
evcc: ["skiptest"]
|
||||
description:
|
||||
en: "Spain PVPC tariff extracted from https://api.esios.ree.es. It is possible to create grid and feed-in tariffs. You need a token in order to be able to use the api"
|
||||
generic: "Spain PVPC tariff extracted from [api.esios.ree.es](https://api.esios.ree.es). It is possible to create grid and feed-in tariffs. You need a token in order to be able to use the API"
|
||||
group: price
|
||||
countries: ["ES"]
|
||||
params:
|
||||
|
|
|
|||
|
|
@ -14,8 +14,8 @@ params:
|
|||
type: string
|
||||
required: true
|
||||
help:
|
||||
de: "Erstelle eine App in https://api-portal.eco2grid.com und kopiere den Key"
|
||||
en: "Create an app in https://api-portal.eco2grid.com and copy the key"
|
||||
de: "Erstelle eine App in [api-portal.eco2grid.com](https://api-portal.eco2grid.com) und kopiere den Key"
|
||||
en: "Create an app in [api-portal.eco2grid.com](https://api-portal.eco2grid.com) and copy the key"
|
||||
- name: zone
|
||||
description:
|
||||
de: Zonencode
|
||||
|
|
|
|||
|
|
@ -13,8 +13,8 @@ params:
|
|||
type: string
|
||||
required: true
|
||||
help:
|
||||
de: "Erstelle eine App in https://ned.nl/nl/user/register und kopiere den Key"
|
||||
en: "Create an app in https://ned.nl/nl/user/register and copy the key"
|
||||
de: "Erstelle eine App in [ned.nl](https://ned.nl/nl/user/register) und kopiere den Key"
|
||||
en: "Create an app in [ned.nl](https://ned.nl/nl/user/register) and copy the key"
|
||||
render: |
|
||||
type: custom
|
||||
tariff: co2
|
||||
|
|
|
|||
|
|
@ -11,8 +11,8 @@ params:
|
|||
en: Region
|
||||
de: Region
|
||||
help:
|
||||
de: "Ungenauer als die Verwendung eines Postleitzahl. Siehe https://carbon-intensity.github.io/api-definitions/#region-list"
|
||||
en: "Coarser than using a postcode. See https://carbon-intensity.github.io/api-definitions/#region-list"
|
||||
de: "Ungenauer als die Verwendung eines Postleitzahl. Siehe [carbon-intensity.github.io](https://carbon-intensity.github.io/api-definitions/#region-list)"
|
||||
en: "Coarser than using a postcode. See [carbon-intensity.github.io](https://carbon-intensity.github.io/api-definitions/#region-list)"
|
||||
- name: postalcode
|
||||
type: string
|
||||
example: "SW1"
|
||||
|
|
|
|||
|
|
@ -5,8 +5,8 @@ products:
|
|||
generic: API
|
||||
requirements:
|
||||
description:
|
||||
de: "Den API-Key bekommst du im Octopus Portal https://octopus.energy/dashboard/new/accounts/personal-details/api-access"
|
||||
en: "You can get the API key in the Octopus portal https://octopus.energy/dashboard/new/accounts/personal-details/api-access"
|
||||
de: "Den API-Key bekommst du im Octopus Portal: [octopus.energy](https://octopus.energy/dashboard/new/accounts/personal-details/api-access)"
|
||||
en: "You can get the API key in the Octopus portal: [octopus.energy](https://octopus.energy/dashboard/new/accounts/personal-details/api-access)"
|
||||
countries: ["GB"]
|
||||
group: price
|
||||
params:
|
||||
|
|
|
|||
|
|
@ -21,8 +21,8 @@ params:
|
|||
choice: ["A", "B", "C", "D", "E", "F", "G", "H", "J", "K", "L", "M", "N", "P"]
|
||||
required: true
|
||||
help:
|
||||
de: "Die DNO-Region, in der Sie sich befinden. Weitere Informationen: https://www.energy-stats.uk/dno-region-codes-explained/"
|
||||
en: "The DNO region you are located in. More information: https://www.energy-stats.uk/dno-region-codes-explained/"
|
||||
de: "Die DNO-Region, in der Sie sich befinden. Weitere Informationen: [energy-stats.uk](https://www.energy-stats.uk/dno-region-codes-explained/)"
|
||||
en: "The DNO region you are located in. More information: [energy-stats.uk](https://www.energy-stats.uk/dno-region-codes-explained/)"
|
||||
- name: directDebit
|
||||
type: bool
|
||||
default: true
|
||||
|
|
|
|||
|
|
@ -3,8 +3,8 @@ products:
|
|||
- brand: Ostrom
|
||||
requirements:
|
||||
description:
|
||||
en: "Create a 'Production Client' in the Ostrom developer portal: https://developer.ostrom-api.io/"
|
||||
de: "Erzeuge einen 'Production Client' im Ostrom-Entwicklerportal: https://developer.ostrom-api.io/"
|
||||
en: "Create a 'Production Client' in the Ostrom developer portal: [developer.ostrom-api.io](https://developer.ostrom-api.io/)"
|
||||
de: "Erzeuge einen 'Production Client' im Ostrom-Entwicklerportal: [developer.ostrom-api.io](https://developer.ostrom-api.io/)"
|
||||
evcc: ["skiptest"]
|
||||
group: price
|
||||
countries: ["DE"]
|
||||
|
|
|
|||
|
|
@ -4,8 +4,8 @@ products:
|
|||
requirements:
|
||||
evcc: ["skiptest"]
|
||||
description:
|
||||
de: "Preisdaten von https://www.mercatoelettrico.org/it/. Wird oft zur Einspeisung ins Netz verwendet."
|
||||
en: "Price data from https://www.mercatoelettrico.org/it/. Often used for feeding into the grid."
|
||||
de: "Preisdaten von [mercatoelettrico.org](https://www.mercatoelettrico.org/it/). Wird oft zur Einspeisung ins Netz verwendet."
|
||||
en: "Price data from [mercatoelettrico.org](https://www.mercatoelettrico.org/it/). Often used for feeding into the grid."
|
||||
group: price
|
||||
countries: ["IT"]
|
||||
params:
|
||||
|
|
|
|||
|
|
@ -20,8 +20,8 @@ params:
|
|||
en: Item type to be queried.
|
||||
de: Elementtyp, der abgefragt werden soll.
|
||||
help:
|
||||
en: Item and id/token are only required if more than one location is configured or if a specific item is to be queried. Otherwise, the API returns the data for the first location. See also https://www.solarprognose.de/web/en-en/solarprediction/page/api
|
||||
de: Item und id/token werden nur benötigt, wenn mehr als ein Standort konfiguriert ist oder ein bestimmtes Element abgefragt werden soll. Ansonsten gibt die API die Daten für den ersten Standort zurück. Siehe auch https://www.solarprognose.de/web/de-de/solarprediction/page/api
|
||||
en: Item and id/token are only required if more than one location is configured or if a specific item is to be queried. Otherwise, the API returns the data for the first location. See also [solarprognose.de](https://www.solarprognose.de/web/en-en/solarprediction/page/api)
|
||||
de: Item und id/token werden nur benötigt, wenn mehr als ein Standort konfiguriert ist oder ein bestimmtes Element abgefragt werden soll. Ansonsten gibt die API die Daten für den ersten Standort zurück. Siehe auch [solarprognose.de](https://www.solarprognose.de/web/de-de/solarprediction/page/api)
|
||||
advanced: true
|
||||
- name: id
|
||||
description:
|
||||
|
|
|
|||
|
|
@ -13,8 +13,8 @@ params:
|
|||
en: Contract ID
|
||||
de: Vertragsnummer
|
||||
help:
|
||||
de: "Die Vertragsnummer bekommst du im Kundenportal https://i.spottyenergie.at/"
|
||||
en: "You can get your contract id from the customer portal https://i.spottyenergie.at/"
|
||||
de: "Die Vertragsnummer bekommst du im Kundenportal [i.spottyenergie.at](https://i.spottyenergie.at/)"
|
||||
en: "You can get your contract id from the customer portal [i.spottyenergie.at](https://i.spottyenergie.at/)"
|
||||
- name: pricetype
|
||||
default: CONSUMPTION
|
||||
type: choice
|
||||
|
|
@ -24,8 +24,8 @@ params:
|
|||
en: Price type
|
||||
de: Preistyp
|
||||
help:
|
||||
de: "Preistyp, entweder Börsenpreis, Verbrauchspreis oder Einspeisevergütung (falls vereinbart), siehe https://www.spottyenergie.at/blog/energie-smart-produzieren"
|
||||
en: "Price type, either spotmarket price, consumption price or generation compensation (if contractually agreed), more info at https://www.spottyenergie.at/blog/energie-smart-produzieren"
|
||||
de: "Preistyp, entweder Börsenpreis, Verbrauchspreis oder Einspeisevergütung (falls vereinbart), siehe [spottyenergie.at](https://www.spottyenergie.at/blog/energie-smart-produzieren)"
|
||||
en: "Price type, either spotmarket price, consumption price or generation compensation (if contractually agreed), more info at [spottyenergie.at](https://www.spottyenergie.at/blog/energie-smart-produzieren)"
|
||||
- preset: tariff-base
|
||||
render: |
|
||||
type: custom
|
||||
|
|
|
|||
|
|
@ -3,8 +3,8 @@ products:
|
|||
- brand: Tibber
|
||||
requirements:
|
||||
description:
|
||||
en: "Get your API token from the Tibber developer portal: https://developer.tibber.com/"
|
||||
de: "Hol dir deinen API-Token aus dem Tibber-Entwicklerportal: https://developer.tibber.com/"
|
||||
en: "Get your API token from the Tibber developer portal: [developer.tibber.com](https://developer.tibber.com/)"
|
||||
de: "Hol dir deinen API-Token aus dem Tibber-Entwicklerportal: [developer.tibber.com](https://developer.tibber.com/)"
|
||||
evcc: ["skiptest"]
|
||||
group: price
|
||||
countries: ["NO", "SE", "DE", "NL"]
|
||||
|
|
|
|||
|
|
@ -5,8 +5,8 @@ products:
|
|||
group: generic
|
||||
requirements:
|
||||
description:
|
||||
de: Open Source Tesla BLE HTTP Proxy https://github.com/wimaha/TeslaBleHttpProxy
|
||||
en: Open Source Tesla BLE HTTP Proxy https://github.com/wimaha/TeslaBleHttpProxy
|
||||
de: Open Source Tesla BLE HTTP Proxy [github.com/wimaha/TeslaBleHttpProxy](https://github.com/wimaha/TeslaBleHttpProxy)
|
||||
en: Open Source Tesla BLE HTTP Proxy [github.com/wimaha/TeslaBleHttpProxy](https://github.com/wimaha/TeslaBleHttpProxy)
|
||||
params:
|
||||
- preset: vehicle-common
|
||||
- name: vin
|
||||
|
|
|
|||
|
|
@ -5,8 +5,8 @@ products:
|
|||
group: generic
|
||||
requirements:
|
||||
description:
|
||||
en: Open source Tesla data logger https://github.com/adriankumpf/teslamate. MQTT broker required.
|
||||
de: Open Source Tesla Datenlogger https://github.com/adriankumpf/teslamate. Voraussetzung ist konfigurierter MQTT Broker.
|
||||
en: Open source Tesla data logger [github.com/adriankumpf/teslamate](https://github.com/adriankumpf/teslamate). MQTT broker required.
|
||||
de: Open Source Tesla Datenlogger [github.com/adriankumpf/teslamate](https://github.com/adriankumpf/teslamate). Voraussetzung ist konfigurierter MQTT Broker.
|
||||
params:
|
||||
- preset: vehicle-common
|
||||
- name: id
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue