Deep reference

Technical reference material, kept in the repository and (for the field catalogue) generated from BMW’s own exports so it can’t drift.

Descriptor / field catalogue#

• 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 API notes#

• 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.

Design investigations#

• stream-scope-investigation.md — why per-descriptor streaming scopes don’t work and Data Selection is portal-only.

For contributors#

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.