-
Notifications
You must be signed in to change notification settings - Fork 0
Reference
Technical reference material, kept in the repository and (for the field catalogue) generated from BMW's own exports so it can't drift.
- telematics-fields.md — every descriptor BMW can stream, grouped by cluster, with the HA entity it maps to. This is the authoritative field-per-cluster breakdown referenced from step 4.
- bmw-cardata-api-guide.md — how the REST API is used.
- bmw-cardata-streaming-guide.md — the MQTT stream.
- bmw-cardata-api-reference.md — endpoint reference.
- Swagger: customer-api · device-flow.
- stream-scope-investigation.md — why per-descriptor streaming scopes don't work and Data Selection is portal-only.
The descriptor catalogue, metadata, translations, and the field reference are
all generated from BMW's exports by the pipeline in
tools/ — read
tools/README.md
before hand-editing any generated file. To change an entity name, edit
title_en in tools/curated_titles.json and re-run the pipeline.
BavarianData is an independent, community-built integration and is not affiliated with, endorsed by, or sponsored by BMW Group. "BMW", "Mini", "Rolls-Royce" and "CarData" are trademarks of their respective owners. Screenshots and documentation images of the MyBMW / BMW CarData portal are © BMW AG, shown here solely to document how to set up the service; personal data has been redacted. Released under the MIT License. · Issues · Discussions
Getting started
The card
Features
- Entities & devices
- Charging history & cost
- Battery health
- Trips
- Energy & statistics
- Export
- Events & blueprints
- API quota
Reference