Skip to content

Always add friendly name attribute to ZHA entities #19141

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.

Sign up for GitHub

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

Merged
balloob merged 2 commits into from
Dec 13, 2018
Merged

Always add friendly name attribute to ZHA entities #19141

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
992c0cd
Always add friendly name attribute
damarco Dec 9, 2018
46e0016
Only change device_info name
damarco Dec 13, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions homeassistant/components/zha/entities/entity.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,11 @@ def __init__(self, endpoint, in_clusters, out_clusters, manufacturer,
endpoint.endpoint_id,
kwargs.get('entity_suffix', ''),
)
self._device_state_attributes['friendly_name'] = "{}_{}{}".format(

@balloob balloob Dec 10, 2018

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This is wrong:

  • Define the name property to set the name
  • A name should not contain underscores, endpoint IDs etc. That's not a name, that's an identifier.

@damarco damarco Dec 10, 2018

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Understood. In that case I would skip the friendly name if we do not have model/manufacturer information and use the ieee network address as a name for the device registry. Is that ok?

@balloob balloob Dec 10, 2018

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

What you're changing is not for the device registry, this is for the entity

@damarco damarco Dec 10, 2018

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Yes, but currently the friendly name attribute is used as a name for the device registry. If there is no friendly name it errs out when adding it to the device registry. That is what I am trying to fix.

@balloob balloob Dec 10, 2018

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Then that should be fixed inside the device_info method?

@damarco damarco Dec 10, 2018

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Yes, is it ok to use the ieee network address as a name for the device registry? Or is there any other preferred naming convention?

@Adminiuga Adminiuga Dec 12, 2018

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I agree with balloob, If we don't have Manufacturer/Model, don't set 'friendly_name' at all and for the device_info['name'] use IEEE or "ZHA + IEEE"?

ieeetail,
endpoint.endpoint_id,
kwargs.get('entity_suffix', ''),
)

self._endpoint = endpoint
self._in_clusters = in_clusters
Expand Down