Skip to content

Add BMW CarData vehicle module (SoC, range, charging status)#3251

Open
GERDerDennis wants to merge 42 commits intoopenWB:masterfrom
GERDerDennis:feature/bmw-cardata
Open

Add BMW CarData vehicle module (SoC, range, charging status)#3251
GERDerDennis wants to merge 42 commits intoopenWB:masterfrom
GERDerDennis:feature/bmw-cardata

Conversation

@GERDerDennis
Copy link
Copy Markdown

@GERDerDennis GERDerDennis commented Mar 28, 2026

This PR adds an initial BMW CarData integration for openWB vehicles.

Features

  • Retrieves SoC, electric range and charging status via BMW CarData API
  • Supports modern BMW BEV models (e.g. iX, iX3)
  • Automatic token refresh handling
  • Automatic container detection
  • Automatic container creation if none exist (common CarData issue)
  • Prioritized SoC field selection:
    • charging.level (preferred for newer vehicles)
    • batteryManagement.header (fallback)

Background

BMW CarData often returns an empty container list even with valid authentication and vehicle mapping.

This implementation detects that condition and automatically creates a minimal container, allowing telematic data retrieval without manual intervention.

UI

  • Adds a configuration UI for BMW CarData vehicles

Notes

  • Respects BMW API limits (50 requests/day)
  • No aggressive polling
  • Tested with BMW iX M60
  • Telematic data also successfully retrieved from a BMW iX3 test vehicle

Status

Work in progress. Further improvements planned:

  • Auth flow refinement
  • UI improvements
  • additional telemetry fields

Feedback is very welcome.

@GERDerDennis GERDerDennis marked this pull request as draft March 28, 2026 15:13
@GERDerDennis
Add files via upload
9311857 
Add BMW CarData SoC module - auth wrapper scripts

Add auth_start.py and auth_status.py as wrapper scripts
for the BMW CarData authentication flow.
@GERDerDennis
Copy link
Copy Markdown
Author

GERDerDennis commented Mar 28, 2026

Seit dem initialen Commit wurde das Modul erheblich weiterentwickelt und auf einer eigenen openWB-Testinstallation (Proxmox VM, Debian 11, openWB 2.1.9-Patch.2) getestet.
Erreichter Stand:

Natives openWB SoC-Modul vollständig implementiert
SoC, Reichweite und Ladestatus werden korrekt abgerufen
BMW OAuth2 Device Code Flow mit PKCE vollständig implementiert
Auth kann direkt aus der openWB UI gestartet werden mit Statusanzeige und automatischem Polling
Token werden persistent gespeichert und automatisch erneuert
Container-ID wird gecacht – typischerweise nur 1 API-Call pro Abfrage
Automatische Container-Erstellung falls keine vorhanden (häufiges BMW CarData Problem)
Testmodus ohne BMW API-Calls für sichere Entwicklung

Getestete Fahrzeuge:

BMW iX M60 (2023) – vollständig funktionsfähig
BMW iX3 G08 – SoC und Reichweite erfolgreich abgerufen
BMW i3s – SoC und Reichweite erfolgreich abgerufen

Weitere Fahrzeuge noch nicht getestet. Feedback willkommen.
Bekannte offene Punkte:
Die Auth-Integration nutzt aktuell eine PHP-Bridge mit sudoers-Regel damit Apache Python-Skripte als openwb-User ausführen kann. Das ist eine temporäre Lösung und wird vor dem finalen PR ersetzt.
Die vehicle.vue liegt aktuell noch im Core-Fork und wird in einen separaten openwb-ui-settings PR verschoben.

@GERDerDennis
Copy link
Copy Markdown
Author

GERDerDennis commented Mar 28, 2026

Update zum aktuellen Stand:

Die bisherige PHP-Bridge mit sudoers-Regel wurde vollständig ersetzt.

Auth-Architektur (neu):

  • Der BMW OAuth2 Device Code Flow mit PKCE läuft jetzt komplett in PHP via curl – kein sudo, kein Python-Subprocess, keine sudoers-Regel
  • Tokens werden direkt in der openWB-Fahrzeugkonfiguration gespeichert.
  • Kein separates Token-File mehr
  • config.py enthält die Token-Felder direkt in der Konfigurationsklasse

Weitere Verbesserungen:

  • Kilometerstand wird über vehicle.vehicle.travelledDistance abgerufen
  • Container wird bei Bedarf automatisch erstellt
  • Container-Auswahl bevorzugt openWB-eigene Container (purpose='openWB')
  • Token-Ablaufdatum wird in der UI angezeigt
  • Hinweis auf 'Speichern' nach erfolgreicher Auth
  • Fehlermeldung bei Tageslimit (CU-429) wird korrekt in der UI angezeigt

Getestete Fahrzeuge:

  • BMW iX M60 (2023) – vollständig funktionsfähig
  • BMW iX3 G08 – SoC und Reichweite erfolgreich abgerufen
  • BMW i3s – SoC und Reichweite erfolgreich abgerufen

Noch offen:

  • vehicle.vue liegt noch im Core-Fork und wird in einen separaten openwb-ui-settings PR verschoben
  • Rechteproblem: PHP schreibt die Auth-Status-Datei nach /var/www/html/openWB/data/ – dieses Verzeichnis gehört openwb. Gibt es ein Verzeichnis das sowohl von www-data beschrieben als auch von openwb gelesen werden kann?

@GERDerDennis
Add files via upload
93aff36 
Fix auth UI: show user_code regardless of connection state, simplify auth button
@GERDerDennis
Add files via upload
f034f26 
Add odometer support via vehicle.vehicle.travelledDistance
@GERDerDennis
Copy link
Copy Markdown
Author

GERDerDennis commented Mar 29, 2026

Update 29.03.2026
Seit dem letzten Update wurden folgende Verbesserungen eingebaut:
Kilometerstand:

Wird über vehicle.vehicle.travelledDistance abgerufen
CarState.odometer wird korrekt befüllt (nutzt PR #3210)
Container-Descriptor wurde entsprechend erweitert

Auth-UI Fixes:

User-Code und Verification-URL werden jetzt auch angezeigt wenn bereits eine Verbindung besteht
Auth-Button immer sichtbar mit Hinweis wenn Verbindung bereits aktiv

Aktueller Stand:

SoC, Reichweite, Ladestatus und Kilometerstand werden korrekt abgerufen ✅

@GERDerDennis
Copy link
Copy Markdown
Author

GERDerDennis commented Apr 1, 2026

Update: Feedback eingearbeitet

urllib → req.get_http_session()
Alle HTTP-Calls nutzen jetzt req.get_http_session() statt urllib.

Testmodus entfernt
Der Testmodus wurde entfernt. Die Einstellungen sind auf das Wesentliche reduziert: Client ID, VIN, SoC-Berechnung während Ladung.

Auth-Status im Broker statt Datei
Die bmw_cardata_auth_status.json Datei wird nicht mehr verwendet. Der Auth-Status (device_code, code_verifier, expires_at) wird während des Device Code Flows im lokalen Vue-State gehalten und direkt im POST-Body an PHP übergeben. Nach erfolgreicher Auth werden die Tokens via updateConfiguration im Broker gespeichert – analog zu den Token-Daten. Das Rechteproblem mit /var/www/html/openWB/data/ ist damit vollständig gelöst.

Unit Tests aktualisiert
Die Tests wurden auf req.get_http_session() umgestellt und der Testmodus entfernt. Alle 8 Tests bestehen.

@LKuemmel LKuemmel requested a review from Copilot April 2, 2026 08:04
@LKuemmel LKuemmel requested a review from benderl April 2, 2026 08:50
benderl
benderl requested changes Apr 2, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@benderl benderl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wie Lena schon geschrieben hat, bitte die Vue-Datei in einen PR gegen das Settings-Repo packen. Die beiden PHP-Dateien gehören auch dort hin. Im Pfad public/modules/vehicles/ findest Du schon vergleichbare Dateien für die Tesla und Mercedeseq SoC-Module.

Comment thread openwb-ui-settings/src/components/vehicles/bmw_cardata/vehicle.vue Outdated
Comment thread openwb-ui-settings/src/components/vehicles/bmw_cardata/vehicle.vue Outdated
Comment thread openwb-ui-settings/src/components/vehicles/bmw_cardata/vehicle.vue Outdated
Comment thread openwb-ui-settings/src/components/vehicles/bmw_cardata/vehicle.vue Outdated
Comment thread openwb-ui-settings/src/components/vehicles/bmw_cardata/vehicle.vue Outdated
Comment thread web/bmw_cardata/bmw_cardata_auth_start.php Outdated
Comment thread web/bmw_cardata/bmw_cardata_auth_status.php Outdated
@GERDerDennis
Copy link
Copy Markdown
Author

GERDerDennis commented Apr 2, 2026

Danke für das ausführliche Feedback!

Ein Großteil der angesprochenen Punkte ist bereits im aktuellen Stand umgesetzt:

  • Wechsel von urllib auf req.get_http_session()
  • Entfernung des Testmodus und Reduktion der Konfiguration
  • Auth-Zwischenstatus wird nicht mehr über Datei, sondern über das Konfig-/Broker-Modell gehandhabt
  • Container-Handling inkl. Retry wurde überarbeitet (HTTP-Status-basiert statt String-Matching)
  • Tests für Token-Refresh, Container-Auto-Create und Retry ergänzt (aktuell 11 Tests grün)

Zusätzlich werde ich:

  • vehicle.vue sowie die PHP-Dateien in einen separaten PR gegen das Settings-Repo auslagern
  • UI-Texte (z. B. „Auth“) verständlicher formulieren
  • HTTP-Statuscodes in den PHP-Endpunkten ergänzen

Einige vorgeschlagene Änderungen beziehen sich auf ältere Code-Stände und sind im aktuellen Branch bereits angepasst.

Falls ich etwas übersehen habe, gerne nochmal kurz Bescheid geben 🙂

@GERDerDennis
Copy link
Copy Markdown
Author

GERDerDennis commented Apr 2, 2026

Die vehicle.vue wurde in einen separaten openwb-ui-settings PR verschoben:
openWB/openwb-ui-settings#941

@LKuemmel
Copy link
Copy Markdown
Contributor

LKuemmel commented Apr 8, 2026

Bitte noch nach den Flake8-Meldungen schauen.

@GERDerDennis
Copy link
Copy Markdown
Author

GERDerDennis commented Apr 10, 2026

Bitte noch nach den Flake8-Meldungen schauen.

Flake8-Fehler wurden behoben: HTTPError und store Imports entfernt, Whitespace-Probleme in soc.py und soc_test.py korrigiert. Lokal läuft flake8 ohne Fehler durch.

@GERDerDennis GERDerDennis marked this pull request as ready for review April 13, 2026 07:49
@benderl benderl added enhancement New feature or request ui depends on changes in ui repository labels Apr 20, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@benderl benderl benderl approved these changes

@LKuemmel LKuemmel LKuemmel approved these changes

Assignees

No one assigned

Labels

enhancement New feature or request ui depends on changes in ui repository

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@GERDerDennis @LKuemmel @benderl