Handle Shelly channel names (if available)

[chemelli74]

Proposed change

Current code handle only device name; this PR handle also channels name when they are available.

Integration doc page should be updated to inform how naming works and how to update device/channel name for end user.

Type of change

• Dependency upgrade
• Bugfix (non-breaking change which fixes an issue)
• New integration (thank you!)
• New feature (which adds functionality to an existing integration)
• Breaking change (fix/feature causing existing functionality to break)
• Code quality improvements to existing code or addition of tests

Additional information

• This PR fixes or closes issue: fixes #
• This PR is related to issue:
• Link to documentation pull request: Explain Shelly entities naming

Checklist

• The code change is tested and works locally.
• Local tests pass. Your PR cannot be merged unless tests pass
• There is no commented out code in this PR.
• I have followed the development checklist
• The code has been formatted using Black (black --fast homeassistant tests)
• Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

• Documentation added/updated for www.home-assistant.io

If the code communicates with devices, web services, or third-party tools:

• The manifest file has all fields filled out correctly.
  Updated and included derived files by running: python3 -m script.hassfest.
• New or updated dependencies have been added to requirements_all.txt.
  Updated by running python3 -m script.gen_requirements_all.
• Untested files have been added to .coveragerc.

The integration reached or maintains the following Integration Quality Scale:

• No score or internal
• 🥈 Silver
• 🥇 Gold
• 🏆 Platinum

To help with the load of incoming pull requests:

• I have reviewed two other open pull requests in this repository.

[probot-home-assistant]

Hey there @balloob, @bieniu, mind taking a look at this pull request as its been labeled with an integration (shelly) you are listed as a codeowner for? Thanks!
_{^{(message by CodeOwnersMention)}}

[chemelli74]

Only missing the calculation of channel number for switch ( hardcoded 1 for the moment)

Simone

[bieniu]

IMO we still have an inconsistency here. If the device has one channel, we don't use the channel name, and if the device has more than one channel, we use the channel names.

[chemelli74]

IMO we still have an inconsistency here. If the device has one channel, we don't use the channel name, and if the device has more than one channel, we use the channel names.

Partially true:

• Shelly app "sync name" function use the name you gave to the channel and save it under "device" in the settings page of the device.
• Most likely channel name value for single channel devices will be removed by upcoming fw patches.

BTW, we still miss channel name for 3EM/EM; it's missing for firmware so before adding the node "emeters/name" I want to wait and see exactly how it will be implemented.

[bieniu]

So maybe we should wait with the channel names until the situation clears up. IMO channel names should be used in all cases or not at all.

[chemelli74]

So maybe we should wait with the channel names until the situation clears up. IMO channel names should be used in all cases or not at all.

I perfectly understand the idea to have a unique naming policy, but we should also take care of how the device works.
I would prefer to be as closed as possible to current Shelly app naming schema to make life easy for users.

So channel name -> device name -> hostname is the best name preference we can up with.

Simone

[bieniu]

I would prefer to be as closed as possible to current Shelly app naming schema to make life easy for users.

But we're not making copy of the Shelly app. I think that the opinion of someone from the HA Team is needed here.

[chemelli74]

I would prefer to be as closed as possible to current Shelly app naming schema to make life easy for users.

But we're not making copy of the Shelly app.

:-)

I think that the opinion of someone from the HA Team is needed here.

Agree

Simone

[thecode]

I suggest to remove "-" only between channel and name for sensors we leave the "-"

[chemelli74]

3 green lights, time to merge ;-)

Simone

[frenck]

The branch used isn't clean. It contains 44 commits, of which the larger part is unrelated. Please start with a fresh branch based on the upstream dev when creating a new feature. In this case, a git rebase can clean it up.

For information on how to handle upstream changes and keeping your fork up 2 date: https://developers.home-assistant.io/docs/development_catching_up

Integration doc page should be updated to inform how naming works and how to update device/channel name for end user.

Your PR description points out the need to adjust the documentation, however, I don't see a documentation PR linked up?

[chemelli74]

The branch used isn't clean. It contains 44 commits, of which the larger part is unrelated. Please start with a fresh branch based on the upstream dev when creating a new feature. In this case, a git rebase can clean it up.

For information on how to handle upstream changes and keeping your fork up 2 date: https://developers.home-assistant.io/docs/development_catching_up

Done.
Thx a lot for pointing this out.

Integration doc page should be updated to inform how naming works and how to update device/channel name for end user.

Your PR description points out the need to adjust the documentation, however, I don't see a documentation PR linked up?

We will provide info on how to name device in the doc, but nothing mandatory imho.
Currently Shelly users using their mobile app has things already in place.
Those not using, already found their way.

Simone

[chemelli74]

Doc PR linked, we should be on track for a merge now.

Simone

[MartinHjelmare]

It's standard to use a verb in imperative as first word in function names. I'd rename this to name_shelly.