Test Adapter skoda-public-api v0.1.x

tmarthy

Hallo zusammen,

ich suche Tester für den neuen Adapter ioBroker.skoda-public-api.

Der Adapter bindet Škoda-Fahrzeuge über die offizielle MyŠkoda Public API in ioBroker ein. Er liest Fahrzeugdaten aus und unterstützt – soweit vom jeweiligen Fahrzeug und der API angeboten – verschiedene Fernsteuerungsbefehle.

Aktuelle Testversion

Version: 0.1.6

GitHub:
https://github.com/tmarthy/ioBroker.skoda-public-api

npm:
https://www.npmjs.com/package/iobroker.skoda-public-api

Pull Request zur Aufnahme in das ioBroker-Latest-Repository:
https://github.com/ioBroker/ioBroker.repositories/pull/6592

Voraussetzungen

Node.js 22 oder neuer
js-controller 6.0.11 oder neuer
Admin 7.6.20 oder neuer
MyŠkoda-App ab Version 8.16
ein in der MyŠkoda-App erstellter Public-API-Schlüssel
mindestens eine für diesen API-Schlüssel freigegebene VIN

Der API-Schlüssel wird in der MyŠkoda-App unter „API key“ erstellt. Beim Erstellen muss das gewünschte Fahrzeug ausgewählt werden.

Wichtig: Die Public API erlaubt maximal 20 Anfragen pro Stunde und VIN. Der Adapter verwaltet dieses Kontingent und reserviert auf Wunsch Anfragen für Fahrzeugbefehle.

Installation

Da der Adapter noch nicht im offiziellen ioBroker-Repository enthalten ist:

Im ioBroker-Admin den Bereich „Adapter“ öffnen.
„Adapter aus eigener URL installieren“ auswählen.
Unter „Beliebig/Custom“ folgende URL eintragen:

https://registry.npmjs.org/iobroker.skoda-public-api/-/iobroker.skoda-public-api-0.1.6.tgz

Anschliessend eine Instanz des Adapters erstellen.
API-Schlüssel und VIN in der Adapterkonfiguration eintragen.
Mit „Verbindung testen“ die Konfiguration prüfen.

Alternativ kann der Adapter über seine GitHub-Adresse installiert werden:

https://github.com/tmarthy/ioBroker.skoda-public-api

Bitte beachten: Der Adapter befindet sich noch in der Testphase. Vor der Installation wird ein aktuelles Backup der ioBroker-Installation empfohlen.

Unterstützte Funktionen

Je nach Fahrzeugausstattung und API-Antwort unter anderem:

Ladezustand und elektrische Reichweite
Kilometerstand
Ladezustand und Ladestatus
Türen, Fenster, Kofferraum und Motorhaube
Verriegelungs- und Lichtstatus
Klimatisierung
Fensterheizung
aktive Belüftung
Standheizung
Parkposition
API-Kontingent und Rücksetzzeit
Ablaufdatum des API-Schlüssels
Informationen zum letzten Fahrzeugbefehl
Unterstützung mehrerer Fahrzeuge beziehungsweise VINs

Die Objektstruktur wird dynamisch anhand der vom Fahrzeug gelieferten Daten aufgebaut. Deshalb können sich die vorhandenen Datenpunkte zwischen verschiedenen Fahrzeugmodellen und Ausstattungen unterscheiden.

Besonders gesucht

Hilfreich wären Tests mit unterschiedlichen Škoda-Modellen, Modelljahren und Antriebsarten, insbesondere:

Enyaq
Elroq
weitere Elektrofahrzeuge
Plug-in-Hybride
Verbrenner, sofern von der Public API unterstützt
mehrere Fahrzeuge in einer Adapterinstanz

Was sollte getestet werden?

Installation und Verbindung

Lässt sich Version 0.1.6 problemlos installieren?
Startet die Instanz ohne Fehler?
Funktioniert „Verbindung testen“?
Wird info.connection korrekt gesetzt?
Werden Fahrzeug und verfügbare Datenpunkte korrekt erkannt?

Fahrzeugdaten

Sind Ladezustand, Reichweite, Kilometerstand und Fahrzeugstatus plausibel?
Werden nur tatsächlich unterstützte Fahrzeugbereiche angelegt?
Aktualisieren sich die Werte entsprechend dem eingestellten Intervall?
Funktioniert das Verhalten bei einem schlafenden beziehungsweise länger unveränderten Fahrzeug?

API-Limit

Sind die Datenpunkte unter <VIN>.rateLimit.* plausibel?
Bleibt das API-Kontingent auch nach einem Adapterneustart nachvollziehbar?
Wartet der Adapter bei ausgeschöpftem Kontingent bis zum nächsten API-Zeitfenster?

Fahrzeugbefehle

Nur freiwillig und unter Beachtung der Auswirkungen auf das Fahrzeug testen:

Laden starten und stoppen
Klimatisierung starten und stoppen
aktive Belüftung starten und stoppen
Standheizung starten und stoppen, sofern unterstützt
Fensterheizung, sofern unterstützt

Bitte danach prüfen:

Reagiert das Fahrzeug wie erwartet?
Wird <VIN>.info.lastCommand.result korrekt aktualisiert?
Wird der Fahrzeugzustand beim späteren Kontrollabruf korrekt erkannt?

Ein mit ack = true bestätigter Befehl bedeutet zunächst nur, dass die API ihn angenommen hat. Die tatsächliche Ausführung wird erst durch einen späteren Fahrzeugabruf sichtbar.

Ein Befehl mit anschliessender Überprüfung benötigt normalerweise zwei API-Anfragen.

Weitere Tests

mehrere konfigurierte VINs
deaktiviertes Abrufen der Parkposition
ungültiger oder abgelaufener API-Schlüssel
falsche beziehungsweise nicht für den Schlüssel freigegebene VIN
Neustart des Adapters und des ioBroker-Hosts
Darstellung der Admin-Oberfläche und der Objektnamen in verschiedenen Sprachen

Unterstützte Sprachen:

en, de, ru, pt, nl, fr, it, es, pl, uk, zh-cn

Bekannte Einschränkungen

Die MyŠkoda Public API erlaubt nur 20 Anfragen pro Stunde und VIN.
Es gibt keine Push-Benachrichtigungen oder Webhooks.
Fahrzeugdaten sind daher nicht in Echtzeit verfügbar.
Die API meldet bei Fahrzeugbefehlen nur die Annahme des Befehls. Ob das Fahrzeug ihn tatsächlich ausgeführt hat, wird erst beim nächsten Abruf sichtbar.
Eine direkte Regelung des Ladestroms wird von der API nicht angeboten.
Der ioBroker Compact Mode wird in dieser Version noch nicht unterstützt.

Rückmeldungen

Bitte bei Problemen möglichst folgende Informationen angeben:

Adapterversion
Škoda-Modell
Modelljahr und Antriebsart, soweit bekannt
Node.js-Version
js-controller-Version
Admin-Version
Betriebssystem beziehungsweise Docker-Umgebung
genaue Schritte zur Reproduktion
erwartetes und tatsächliches Verhalten
relevante Logauszüge mit Log-Level debug, falls erforderlich

Bitte niemals folgende vertrauliche Daten veröffentlichen:

API-Schlüssel
S-PIN
vollständige VIN
Kennzeichen
genaue Fahrzeugkoordinaten

Auch bei bereits anonymisierten Logs bitte vor dem Veröffentlichen nochmals kontrollieren, ob persönliche Daten enthalten sind.

Fehler und Feature-Wünsche können zusätzlich als GitHub-Issue gemeldet werden:

https://github.com/tmarthy/ioBroker.skoda-public-api/issues

Vielen Dank für eure Unterstützung und besonders für Rückmeldungen von unterschiedlichen Fahrzeugmodellen.

Community Forum

NEWS