Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update entity names and IDs to include device name #110

Merged
merged 1 commit into from
Oct 20, 2024

Conversation

dvx76
Copy link
Member

@dvx76 dvx76 commented Oct 20, 2024

This will cause entity names and IDs to include the vehicle name, making it easier to identify and use the entities, especially when having multiple vehicles. The unique_id does not change.

E.g.

entity_description.key = charger_connected
unique_id = TMBXXXXXXXXXXXX_charger_connected
entitiy_id = sensor.skoda_enyaq_charger_connected
name = Skoda Enyaq Charger Connected

Reference: https://developers.home-assistant.io/docs/core/entity/#has_entity_name-true-mandatory-for-new-integrations

Fixes #57

This will be a somewhat breaking change in that in order to benefit from the new entitiy names users will need to delete and recreate the integration.

Thanks to @joostlek for the pointer!

This will cause entity names and IDs to include the vehicle name, making
it easier to identify and use the entities, especially when having
multiple vehicles. The unique_id does not change.

E.g.

```
entity_description.key = charger_connected
unique_id = TMBXXXXXXXXXXXX_charger_connected
entitiy_id = sensor.skoda_enyaq_charger_connected
name = Skoda Enyaq Charger Connected
```

Reference: https://developers.home-assistant.io/docs/core/entity/#has_entity_name-true-mandatory-for-new-integrations

This will be a somewhat breaking change in that in order to benefit from
the new entitiy names users will need to delete and recreate the
integration.

Fixes skodaconnect#57
@joostlek
Copy link

FYI, in core we don't see this as breaking change

Copy link
Contributor

@WebSpider WebSpider left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lgtm, this has been sufficiently discussed.

We should make sure to put this one in the release text, so that hacs users see this explicitly when they look at the release before hitting the update button

@dvx76 dvx76 merged commit f395060 into skodaconnect:main Oct 20, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add VIN number and/or integration name to ID of sensors
3 participants