Add BMW CarData vehicle module (SoC, range, charging status) by GERDerDennis · Pull Request #3251 · openWB/core

GERDerDennis · 2026-03-28T15:00:12Z

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.

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 · 2026-03-28T18:17:33Z

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 · 2026-03-28T23:25:39Z

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?

Fix auth UI: show user_code regardless of connection state, simplify auth button

Add odometer support via vehicle.vehicle.travelledDistance

GERDerDennis · 2026-03-29T14:56:06Z

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 ✅

Remove status file, return all auth data to UI for broker storage Remove status file, return all auth data to UI for broker storage

GERDerDennis · 2026-04-01T20:35:48Z

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.

Copilot

Pull request overview

This PR introduces an initial BMW CarData vehicle integration, including backend telemetry retrieval (SoC/range) plus a UI-driven device-code OAuth flow to obtain and refresh BMW API tokens.

Changes:

Added PHP endpoints to start BMW Device Code + PKCE auth and to poll token status.
Added a new Python vehicle module to fetch SoC/range (and handle token refresh + CarData container discovery/creation).
Added a UI settings component to configure BMW CarData vehicles and perform the coupling flow.

Reviewed changes

Copilot reviewed 6 out of 7 changed files in this pull request and generated 8 comments.

Show a summary per file

File	Description
`web/bmw_cardata/bmw_cardata_auth_start.php`	Starts BMW Device Code flow and returns verifier/device_code metadata to the UI.
`web/bmw_cardata/bmw_cardata_auth_status.php`	Polls the BMW token endpoint and returns access/refresh tokens when authorized.
`packages/modules/vehicles/bmw_cardata/config.py`	Adds dataclass-based configuration/setup for BMW CarData vehicles.
`packages/modules/vehicles/bmw_cardata/soc.py`	Implements token validation/refresh, container detection/creation, and telematic data extraction (SoC/range/odometer).
`packages/modules/vehicles/bmw_cardata/soc_test.py`	Adds unit tests for basic extraction/error handling paths.
`packages/modules/vehicles/bmw_cardata/__init__.py`	Initializes the new vehicle module package.
`openwb-ui-settings/src/components/vehicles/bmw_cardata/vehicle.vue`	Adds UI configuration and coupling flow with polling for token retrieval.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

packages/modules/vehicles/bmw_cardata/soc.py

Copilot · 2026-04-02T08:11:28Z

packages/modules/vehicles/bmw_cardata/soc.py

+    try:
+        raw = session.get(url).json()
+    except Exception as e:
+        msg = str(e)
+        if "404" in msg or "400" in msg:
+            log.warning("BMW CarData: Container ungültig, ermittle neu...")
+            cfg.container_id = ""
+            cid = get_container_id(cfg, token)
+            raw = session.get(
+                f"{BMW_API_URL}/customers/vehicles/{cfg.vin}/telematicData?containerId={cid}"
+            ).json()
+        else:
+            raise


Die Erkennung eines ungültigen Containers basiert auf String-Suche nach "404"/"400" in str(e). Das ist fragil (Format kann variieren) und kann dazu führen, dass Container-Refresh nicht ausgelöst wird. Besser: gezielt requests.exceptions.HTTPError abfangen (kommt durch raise_for_status() Hook) und e.response.status_code prüfen.

Copilot · 2026-04-02T08:11:28Z

packages/modules/vehicles/bmw_cardata/soc.py

+    soc_raw = val(FIELD_SOC) or val(FIELD_SOC_ALT)
+    rng_raw = val(FIELD_RANGE)
+    status = val(FIELD_STATUS)
+    odo_raw = val(FIELD_ODOMETER)
+
+    soc = int(float(soc_raw)) if soc_raw is not None else None
+    rng = int(float(rng_raw)) if rng_raw is not None else None
+    odo = int(float(odo_raw)) if odo_raw is not None else None
+
+    if soc is None:
+        raise Exception("BMW CarData: Kein SoC-Wert in API-Antwort gefunden!")
+
+    log.info("BMW CarData: SoC=%s%%, Reichweite=%s km, Status=%s, Odometer=%s km",
+             soc, rng, status, odo)
+    return CarState(soc=soc, range=rng, odometer=odo)
+


Es wird zwar charging.status ausgelesen und geloggt, aber nicht im CarState zurückgegeben oder anderweitig publiziert. Damit wird der im PR-Text erwähnte "charging status" aktuell nicht für openWB nutzbar. Entweder Status in ein passendes Datenfeld/Topic übernehmen oder die Feature-Behauptung/Logs entsprechend anpassen.

Der Ladestatus wird über den Ladecontroller ausgewertet. Im Fahrzeug-Modul ist er nicht nötig..

packages/modules/vehicles/bmw_cardata/soc.py

web/bmw_cardata/bmw_cardata_auth_start.php

web/bmw_cardata/bmw_cardata_auth_status.php

openwb-ui-settings/src/components/vehicles/bmw_cardata/vehicle.vue

LKuemmel

Bitte auch die Kommentare von Copilot beachten und die vue-Datei als PR für das settings-Repo einreichen.

openwb-ui-settings/src/components/vehicles/bmw_cardata/vehicle.vue

packages/modules/vehicles/bmw_cardata/soc.py

LKuemmel · 2026-04-02T08:45:50Z

packages/modules/vehicles/bmw_cardata/soc.py

+    soc_raw = val(FIELD_SOC) or val(FIELD_SOC_ALT)
+    rng_raw = val(FIELD_RANGE)
+    status = val(FIELD_STATUS)
+    odo_raw = val(FIELD_ODOMETER)
+
+    soc = int(float(soc_raw)) if soc_raw is not None else None
+    rng = int(float(rng_raw)) if rng_raw is not None else None
+    odo = int(float(odo_raw)) if odo_raw is not None else None
+
+    if soc is None:
+        raise Exception("BMW CarData: Kein SoC-Wert in API-Antwort gefunden!")
+
+    log.info("BMW CarData: SoC=%s%%, Reichweite=%s km, Status=%s, Odometer=%s km",
+             soc, rng, status, odo)
+    return CarState(soc=soc, range=rng, odometer=odo)
+


Der Ladestatus wird über den Ladecontroller ausgewertet. Im Fahrzeug-Modul ist er nicht nötig..

benderl

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.

openwb-ui-settings/src/components/vehicles/bmw_cardata/vehicle.vue

web/bmw_cardata/bmw_cardata_auth_start.php

web/bmw_cardata/bmw_cardata_auth_status.php

GERDerDennis · 2026-04-02T18:27:13Z

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 🙂

…ponse.status_code

GERDerDennis · 2026-04-02T21:11:23Z

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

Add initial BMW CarData vehicle module with UI

8077c6f

GERDerDennis marked this pull request as draft March 28, 2026 15:13

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 added 10 commits March 29, 2026 00:11

Add files via upload

96b1804

Add files via upload

395d82b

Create bmw_cardata

f4e1208

Delete web/bmw_cardata

c9823e7

Create bmw_cardata_auth_start.php

e6f09f2

Add files via upload

e5f37b4

Add files via upload

13ce119

Delete packages/modules/vehicles/bmw_cardata/auth.py

4ce8597

Delete packages/modules/vehicles/bmw_cardata/auth_start.py

9f2ef63

Delete packages/modules/vehicles/bmw_cardata/auth_status.py

2dc1e30

GERDerDennis added 2 commits March 29, 2026 16:12

Add files via upload

93aff36

Fix auth UI: show user_code regardless of connection state, simplify auth button

Add files via upload

f034f26

Add odometer support via vehicle.vehicle.travelledDistance

GERDerDennis added 8 commits March 29, 2026 18:15

Add files via upload

6f3eee5

Add unit tests for BMW CarData SoC module

58e4abe

Remove test mode, add auth status fields for broker integration

4c92233

Replace urllib with req.get_http_session(), remove test mode

2237d53

Remove test mode UI, simplify settings, update API limit hints

09ea5c6

Store auth data in broker via updateConfiguration, send to PHP on poll

83e57ca

Update

70efc85

Remove status file, return all auth data to UI for broker storage Remove status file, return all auth data to UI for broker storage

Fix unit tests: use requests mock, add container_id to test config

d2dabbd

Improve auth status error handling, add explicit error cases

1a54611

LKuemmel requested a review from Copilot April 2, 2026 08:04

Copilot started reviewing on behalf of LKuemmel April 2, 2026 08:05 View session

Copilot AI reviewed Apr 2, 2026

View reviewed changes

LKuemmel requested changes Apr 2, 2026

View reviewed changes

LKuemmel requested a review from benderl April 2, 2026 08:50

benderl requested changes Apr 2, 2026

View reviewed changes

Refactor soc.py: extract helper functions, improve error handling

ac6b597

GERDerDennis added 7 commits April 2, 2026 21:13

Update soc_test.py

2422882

Update soc_test.py

a405d04

Remove legacy CLI path, improve container recovery with HTTPError.res…

5eab873

…ponse.status_code

Add tests for token refresh, container auto-create and retry flow

cfdede0

Add CURLOPT_SSL_VERIFYHOST=2 for TLS hostname validation

ce42a0a

Add CURLOPT_SSL_VERIFYHOST=2 for TLS hostname validation

5604736

Return HTTP 400 on missing client_id

65f2387

GERDerDennis added 9 commits April 2, 2026 23:13

Remove vehicle.vue - moved to openwb-ui-settings repo

4ed95d8

Move PHP auth files to public/modules/vehicles/bmw_cardata/

0ce1c04

Move PHP auth files to public/modules/vehicles/bmw_cardata/

292589f

Fix W292: add newline at end of file

d465524

Fix W292: add newline at end of file

256275a

Fix W292: add newline at end of file

c8c68d2

Fix W292: add newline at end of file

32277ee

Add files via upload

b47ab7b

Update soc_test.py

1d6898e

Conversation

GERDerDennis commented Mar 28, 2026

Features

Background

UI

Notes

Status

Uh oh!

GERDerDennis commented Mar 28, 2026

Uh oh!

GERDerDennis commented Mar 28, 2026

Uh oh!

GERDerDennis commented Mar 29, 2026

Uh oh!

GERDerDennis commented Apr 1, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Copilot AI Apr 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 2, 2026

Choose a reason for hiding this comment

Uh oh!

LKuemmel Apr 2, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

LKuemmel left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

LKuemmel Apr 2, 2026

Choose a reason for hiding this comment

Uh oh!

benderl left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

GERDerDennis commented Apr 2, 2026

Uh oh!

GERDerDennis commented Apr 2, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants