Skip to content

docs(iobroker): clarify rest-api adapter requires webInstance config #33088

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.

Sign up for GitHub

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

Closed
github-actions wants to merge 1 commit into from
+4 −2
Closed

docs(iobroker): clarify rest-api adapter requires webInstance config #33088

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 4 additions & 2 deletions templates/definition/meter/iobroker.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,15 @@ requirements:
evcc: ["skiptest"]
description:
de: |
Auf der verwendeten ioBroker Instanz muss der `rest-api` adapter (nicht `simple-api`) installiert sein.
Auf der verwendeten ioBroker Instanz muss der `rest-api` adapter (nicht `simple-api`) installiert sein.
Der `rest-api` adapter muss mit einer `webInstance` (z.B. `web.0`) konfiguriert sein, damit er über den ioBroker Web Adapter unter `/rest-api/` erreichbar ist. Als URI unten muss Host und Port des Web Adapters (nicht des `rest-api` adapters selbst) verwendet werden.
Authentifiziert werden kann nur mittels `basic` authentication. Wird kein Passwort angegeben, so wird keine Authentifizierung durchgeführt.
Bei der Angabe der Entities für die einzelnen Messwerte ist darauf zu achten, dass diese korrekt URL-Encoded sind.
So wird aus `shelly.0.SHEM-3#8CAAB561991E#1.Total.ConsumedPower shelly.0.SHEM-3%238CAAB561991E%231.Total.ConsumedPower`
en: |
The `rest-api` adapter (not `simple-api`) must be installed on the ioBroker instance being used.
Authentication can only be performed using `basic` authentication. If no password is provided, no authentication will be performed.
The `rest-api` adapter must be configured with a `webInstance` (e.g. `web.0`), so that it is served through the ioBroker Web Adapter under `/rest-api/`. Use the Web Adapter's host and port (not the `rest-api` adapter's own port) as the URI below.
Authentication can only be performed using `basic` authentication. If no password is provided, no authentication will be performed.
When specifying the entities for the individual measured values, ensure that they are correctly URL-encoded.
For example, `shelly.0.SHEM-3#8CAAB561991E#1.Total.ConsumedPower` becomes `shelly.0.SHEM-3%238CAAB561991E%231.Total.ConsumedPower`
params:
Expand Down
Loading