docs: vehicle brand consistency (#30018)

This commit is contained in:
Michael Geers 2026-05-19 18:30:09 +02:00 • committed by GitHub
parent 3588040e71
commit 2d28ae6d69
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
5 changed files with 30 additions and 9 deletions

View file

@ -22,10 +22,27 @@ The following describes each possible element in a yaml file
Each product contains:
- `brand`: an optional brand description of the product
- `description`: an optional description e.g. of the product model. Expects `generic`, `de`, `en`: an optional description of the product
- `brand`: company that makes the product or offers the service. No regions, variants, or API names — those, if required for clarity, belong in `description`.
- `description`: product, service, model, or API name. Expects `generic`, `de`, `en`.
Either `brand`, or `description` need to be set.
Either `brand` or `description` needs to be set. Examples by device class:
- Vehicles — `brand` is the make, `description` the connected service:
- `brand: Hyundai`, `description.generic: Bluelink`
- `brand: Hyundai`, `description.generic: Bluelink (US)`
- Chargers — `brand` is the manufacturer, `description` the product model:
- `brand: ABL`, `description.generic: eMH1`
- `brand: ABL`, `description.generic: eMH2`
- `brand: Alfen`, `description.generic: Eve`
- Meters — `brand` is the manufacturer, `description` the product model:
- `brand: ABB`, `description.generic: A43`
- `brand: my-PV`, `description.generic: AC ELWA 2`
- Tariffs — `brand` is the service provider, `description` the API variant:
- `brand: Electricity Maps`, `description.generic: Commercial API`
- `brand: Electricity Maps`, `description.generic: Free API`
- Generic integrations (OSS tools, community projects): omit `brand`, put the project name in `description.generic`, set `group: generic`. Keep upstream casing (e.g. `TeslaFi`, `ioBroker.bmw`, `mg2mqtt`).
Note: The official website of the manufacturer or service provider is the reference for the exact spelling.
## `group`

View file

@ -2,10 +2,10 @@ template: cardata
products:
- brand: BMW
description:
generic: CarData (EU Data Act)
generic: CarData
- brand: Mini
description:
generic: CarData (EU Data Act)
generic: CarData
requirements:
description:
de: |

View file

@ -1,6 +1,8 @@
template: ford-connect-query
products:
- brand: Ford (FordConnect Query)
- brand: Ford
description:
generic: FordConnect Query
params:
- preset: vehicle-common
- name: clientid

View file

@ -1,7 +1,9 @@
template: ford-connect
deprecated: true
products:
- brand: Ford (Legacy FordConnect)
- brand: Ford
description:
generic: FordConnect (Legacy)
params:
- preset: vehicle-common
- name: clientid

View file

@ -1,8 +1,8 @@
template: hyundai-us
products:
- brand: Hyundai (US)
- brand: Hyundai
description:
generic: Bluelink
generic: Bluelink (US)
params:
- preset: vehicle-base
render: |