Add vehicle BYD by seaspotter · Pull Request #4085 · openWB/core

seaspotter · 2026-10-09T18:05:05Z

Neues Fahrzeug-(SoC)-Modul byd: liest SoC, Reichweite und Kilometerstand über die BYD-Cloud-API. Protokoll reverse-engineered von pyBYD (MIT) und ioBroker.byd (MIT), synchron mit requests nachgebaut (pyBYD selbst braucht Python ≥3.11, openWB läuft auf 3.9). official=False.

Wichtig: BYD erlaubt nur eine aktive Sitzung pro Account – ein zweiter/geteilter Account ist nötig (Workaround in der UI dokumentiert, siehe separater UI-PR). Ein fehlgeschlagener Login wird daher 1h pausiert, um keine Login-Versuche zu verbrennen. Jeder Account bekommt außerdem einen eigenen, zufälligen Geräte-Fingerprint statt eines global geteilten (wirkte sonst wie ein Bot-Signal).

Live getestet über den normalen Control-Loop: Login, Fingerprint-Generierung, VIN-Auflösung und SoC-Abruf erfolgreich. flake8 sauber, volle Testsuite ohne Regressionen. Hybrid-Fahrzeuge (energy_type) technisch unterstützt, aber nur an einem reinen EV-Account getestet.

…stream protocol issue)

_fetch_realtime() checked elecPercent is not None to detect real data, but the vehicleRealTimeRequest trigger response is a placeholder that already contains elecPercent=0 (not absent), so it was accepted immediately instead of waiting for the vehicleRealTimeResult poll. Confirmed via a clean upstream-pybyd-only test against the affected account: the backend returns real telemetry fine, so this was a bug in our own readiness check, not a BYD-side restriction. Ports pyBYD's own is_ready_raw() heuristic (onlineState/time/tire-pressure/ enduranceMileage) instead of the elecPercent check.

- Bisher hat jede openWB-Installation beim Login denselben hart codierten (und ungültig formatierten) Geräte-Fingerprint an BYD geschickt - aus Sicht des Backends ein klassisches Bot/Credential-Stuffing-Signal und ein plausibler Mitverursacher der beobachteten Login-Sperren. Jeder konfigurierte Account bekommt jetzt einen eigenen, zufälligen aber plausiblen Android-Fingerprint (gültige IMEI per Luhn-Prüfziffer, zufällige MAC, aus einem kleinen Pool echter Geräte), einmalig generiert und über den bestehenden retained-MQTT-Mechanismus dauerhaft gespeichert (analog zu key_expires_at bei myskoda), damit der Account immer als dasselbe Gerät auftritt. Pool/Generator von https://github.com/TA2k/ioBroker.byd (MIT) übernommen. - Ein fehlgeschlagener Login (falsches Passwort, Sperre durch gleichzeitig aktive Session, etc.) verbraucht einen von wenigen Versuchen, bevor der BYD-Account gesperrt wird. Neuer Cooldown von 1h nach jedem Login-Fehler, damit das reguläre Polling (alle 5min während des Ladens) den Account nicht einfach weiter verbrennt. - Veralteten Kommentar korrigiert, der behauptete, der VIN-Cache würde wie key_expires_at bei myskoda dauerhaft gespeichert - tut er nicht (kein Pub()-Aufruf dafür), nur der Geräte-Fingerprint jetzt tatsächlich.

vehicle ist zwar als int typisiert, wird vom Aufrufer (subdata.py, direkt aus dem MQTT-Topic geparst) aber tatsächlich als str übergeben - bestätigt durch einen echten Crash beim ersten Live-Test. Betraf sowohl die neue Fingerprint-Logzeile in soc.py als auch eine bereits bestehende Logzeile in api.py (Session-Ablauf-Meldung). Beide auf %s umgestellt.

Copilot

🟡 Changes recommended

Authentication recovery, concurrent multi-vehicle accounts, account-scoped fingerprints, VIN ambiguity, and upstream license notices need correction.

7 open findings

Reject ambiguous VIN omission for multi-vehicle accounts · New
Serialize per-account session login and cache updates · New
Authentication errors are swallowed during poll retries · New
Retry authentication during VIN resolution · New
Persist device fingerprints at account scope · New
Include pyBYD copyright and MIT notice · New
Include ioBroker.byd MIT notice · New

What changed in this PR

Adds an unofficial BYD Cloud vehicle module for retrieving SoC, range, and odometer data.

Changes:

Implements encrypted BYD API authentication and polling.
Adds session caching, login cooldowns, and device fingerprints.
Integrates BYD configuration and vehicle-state updates.

File	Description
`packages/modules/vehicles/byd/__init__.py`	Defines the BYD package.
`packages/modules/vehicles/byd/api.py`	Implements Cloud API communication and state extraction.
`packages/modules/vehicles/byd/bangcle_tables.bin`	Provides Bangcle cipher lookup tables.
`packages/modules/vehicles/byd/config.py`	Defines module configuration.
`packages/modules/vehicles/byd/crypto.py`	Implements encryption, signing, and key derivation.
`packages/modules/vehicles/byd/device_fingerprint.py`	Generates Android device identities.
`packages/modules/vehicles/byd/soc.py`	Connects the module to openWB vehicle updates.

🧠 Review effort: Balanced

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

…oll auth retry

Copilot

🟡 Changes recommended

Session refresh coordination, telemetry timestamp preservation, and persisted fingerprint selection need correction.

1 open issue

Polling order can overwrite persisted account device identity · New

2 previously missed issues

In code that hasn't changed since last review

Concurrent session refresh invalidates another vehicle's replacement session

packages/modules/vehicles/byd/api.py:403

If two vehicles on the same account reject the same expired session, both call _get_session(..., force_relogin=True). The account lock serializes the logins but does not deduplicate them. Under BYD's one-active-session rule, the second login invalidates the first vehicle's replacement session, so its only retry can fail. Pass the rejected session into _get_session and, under the account lock, reuse the cached session if another thread has already replaced it. Add a concurrent refresh test; the existing concurrency test covers only initial login.

Older SoC readings bypass stale-data protection

packages/modules/vehicles/byd/api.py:411

A response with an older positive time can pass _is_realtime_ready, but its timestamp is discarded here. CarState then assigns the current time, bypassing ConfigurableVehicle's stale-data charging fallback and out-of-order check. This can replace a newer SoC with an older reading. Pass the positive measurement timestamp as soc_timestamp; CarState already converts millisecond timestamps to seconds.

7 resolved since last review

_{Review effort: Balanced}

…reshed session, pass real soc_timestamp

* Add BYD vehicle SoC module (community, login blocked on unresolved upstream protocol issue) * Fix BYD realtime data detection returning placeholder as final data _fetch_realtime() checked elecPercent is not None to detect real data, but the vehicleRealTimeRequest trigger response is a placeholder that already contains elecPercent=0 (not absent), so it was accepted immediately instead of waiting for the vehicleRealTimeResult poll. Confirmed via a clean upstream-pybyd-only test against the affected account: the backend returns real telemetry fine, so this was a bug in our own readiness check, not a BYD-side restriction. Ports pyBYD's own is_ready_raw() heuristic (onlineState/time/tire-pressure/ enduranceMileage) instead of the elecPercent check. * BYD-Fahrzeugmodul: Geräte-Fingerprint pro Account, Login-Cooldown - Bisher hat jede openWB-Installation beim Login denselben hart codierten (und ungültig formatierten) Geräte-Fingerprint an BYD geschickt - aus Sicht des Backends ein klassisches Bot/Credential-Stuffing-Signal und ein plausibler Mitverursacher der beobachteten Login-Sperren. Jeder konfigurierte Account bekommt jetzt einen eigenen, zufälligen aber plausiblen Android-Fingerprint (gültige IMEI per Luhn-Prüfziffer, zufällige MAC, aus einem kleinen Pool echter Geräte), einmalig generiert und über den bestehenden retained-MQTT-Mechanismus dauerhaft gespeichert (analog zu key_expires_at bei myskoda), damit der Account immer als dasselbe Gerät auftritt. Pool/Generator von https://github.com/TA2k/ioBroker.byd (MIT) übernommen. - Ein fehlgeschlagener Login (falsches Passwort, Sperre durch gleichzeitig aktive Session, etc.) verbraucht einen von wenigen Versuchen, bevor der BYD-Account gesperrt wird. Neuer Cooldown von 1h nach jedem Login-Fehler, damit das reguläre Polling (alle 5min während des Ladens) den Account nicht einfach weiter verbrennt. - Veralteten Kommentar korrigiert, der behauptete, der VIN-Cache würde wie key_expires_at bei myskoda dauerhaft gespeichert - tut er nicht (kein Pub()-Aufruf dafür), nur der Geräte-Fingerprint jetzt tatsächlich. * BYD-Fahrzeugmodul: %d-Logging-Crash bei String-Fahrzeug-ID beheben vehicle ist zwar als int typisiert, wird vom Aufrufer (subdata.py, direkt aus dem MQTT-Topic geparst) aber tatsächlich als str übergeben - bestätigt durch einen echten Crash beim ersten Live-Test. Betraf sowohl die neue Fingerprint-Logzeile in soc.py als auch eine bereits bestehende Logzeile in api.py (Session-Ablauf-Meldung). Beide auf %s umgestellt. * BYD-Fahrzeugmodul: Anzeigename auf "BYD" kürzen * fix copilot findings: require VIN, serialize per-account login, fix poll auth retry * fix copilot findings: seed account fingerprint cache early, reuse refreshed session, pass real soc_timestamp

seaspotter added 5 commits October 9, 2026 19:18

Add BYD vehicle SoC module (community, login blocked on unresolved up…

6b4b445

…stream protocol issue)

BYD-Fahrzeugmodul: Anzeigename auf "BYD" kürzen

4947c74

seaspotter mentioned this pull request Oct 11, 2026

Add experimental MyNISSAN EU vehicle SoC support #4088

Merged

LKuemmel requested a balanced review from Copilot October 13, 2026 14:27

Copilot started reviewing on behalf of LKuemmel October 13, 2026 14:28

View session

Copilot AI reviewed Oct 13, 2026

View reviewed changes

fix copilot findings: require VIN, serialize per-account login, fix p…

225b6c3

…oll auth retry

LKuemmel requested a review from ndrsnhs October 14, 2026 06:12

LKuemmel added this to the 2.3.0 milestone Oct 19, 2026

ndrsnhs requested a balanced review from Copilot October 19, 2026 11:56

Copilot started reviewing on behalf of ndrsnhs October 19, 2026 11:57

View session

Copilot AI reviewed Oct 19, 2026

View reviewed changes

Comment thread packages/modules/vehicles/byd/api.py

fix copilot findings: seed account fingerprint cache early, reuse ref…

3fc37c5

…reshed session, pass real soc_timestamp

ndrsnhs approved these changes Oct 20, 2026

View reviewed changes

LKuemmel merged commit b1ad625 into openWB:master Oct 20, 2026
1 check passed

seaspotter deleted the add-byd-vehicle-module branch October 20, 2026 13:16

Navigation Menu

Repository navigation

Add vehicle BYD - #4085

Add vehicle BYD#4085
LKuemmel merged 7 commits into
openWB:masterfrom
seaspotter:add-byd-vehicle-module

seaspotter commented Oct 9, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

seaspotter commented Oct 9, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

🟡 Changes recommended

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

🟡 Changes recommended

Uh oh!

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants