Fallback smart device alias to model when nickname is empty #1521

nicosemp · 2025-04-04T11:20:59Z

Fallback smart device alias to model if nickname is empty.

This will apply to any device, not just the P304M smart strip. If we prefer to have this exception just for the P304M I can add and model == "P304M" in the elif on line 601.

The end result:

Notice that the name will be P304M P304M, however this can easily be edited in the UI:

Entity ids look great:

Let me know if this solution is good or you would like to tweak it :)

EDIT: I see tests need fixing, I'll wait on your decision between having this fallback globally or only for P304M before fixing them.

nicosemp · 2025-04-04T14:48:01Z

Link to the original comments on the home-assistant/core PR

rytilahti

We should improve this by using device type based user-friendly strings, e.g., "Power strip" for DeviceType.Strip etc. to help users who may have many of such devices, making it hard to distinguish among them.

Maybe we should additionally use some device-specific information (Mac address? Device id?) as a part of this generic alias. As this is only used when the device has no name, we can be verbose and rather relaxed about this.

What do you think, @sdb9696 ?

codecov · 2025-04-05T23:51:08Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.66%. Comparing base (e21ab90) to head (4937672).
⚠️ Report is 13 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #1521   +/-   ##
=======================================
  Coverage   92.66%   92.66%           
=======================================
  Files         150      150           
  Lines        9538     9541    +3     
  Branches      974      975    +1     
=======================================
+ Hits         8838     8841    +3     
  Misses        499      499           
  Partials      201      201

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

nicosemp · 2025-04-05T23:52:34Z

@rytilahti that sounds even better. I copied the DEVICE_TYPE_TO_PRODUCT_GROUP dict in a new DEVICE_TYPE_TO_LABEL one and used it in the extra elif. I guess having these strings hardcoded in english is fine because people can rename them and it's just for devices with no nickname.

The result with the P304M is the name becomes Power Strip P304M (easily editable in the UI) and the ids begin with power_strip_ which works great.

I believe adding the mac address or device id would not be ideal, as you would be stuck with long "ugly" ids.

Out of curiosity: what happens if a user adds another identical power strip, or two identical power plugs? What's added to the ids to keep them unique? I don't have duplicates to test this.

kasa/smart/smartdevice.py

rytilahti

Apologies for taking the time to respond, I added a couple of comments but this is looking good with a couple of minor nits! 👍

kasa/smart/smartdevice.py

rytilahti · 2025-06-01T18:59:47Z

kasa/smart/smartdevice.py

        if self._info and (nickname := self._info.get("nickname")):
            return base64.b64decode(nickname).decode()
+        elif label := DEVICE_TYPE_TO_LABEL.get(self._device_type):
+            return label


Suggested change

return label

return f"Unnamed {label} ({self.model} {self.device_id})"

How about something like this? As this is just a fallback when there is no name set, I think it makes sense to give the user as much information about the device as possible.

Sounds great thank you! I fixed the other nits too, take a look whenever you get a chance.

Actually wait, I did push this but I believe this is exactly what causes the problem I was trying to fix.
The while string, including the Unnamed part, will be used as the device id as well as the beginning of all the connected entities' ids. It's a pain to rename all the ids to something more meaningful. And not renaming the ids is annoying when working with manual templates.

Since the power strip is unnamable on the Tapo app, what I'm trying to achieve is an acceptable default id so we don't have to rename all the entity ids. Can we use a simpler string that would be fine as a default device/entity id?

Ahh, sorry, indeed... I'm starting to wonder if it would be better to fix this somehow inside the homeassistant integration instead when a None is encountered? For the cli tool, we can do a pretty-printing otherwise. Would that make sense to you? This will also allow adapting the naming scheme in case homeassistant changes its scheme at some point.

@rytilahti I see what you mean, not sure about the cli tool part.
Anyway this is the original PR proposed on home-assistant/core. Do you think that would work, or do you want to have a generic fallback for any model?

@rytilahti a more generic solution in the linked PR could be to have

if device.model: return device.model return None

or directly return device.model if we are sure the model is always present.

Let me know if this makes sense, in which case I would need someone to unlock and reopen the PR. Thanks!

@rytilahti pinging again in case this got lost, any chance you could reopen the original PR?

@rytilahti any chance you could give me some feedback on how to proceed?
If the original PR on home-assistant/core can't be reopened I could open another PR, up to you.

… fix test

…tring

nicosemp · 2025-06-11T17:43:23Z

tests/smart/test_smartdevice.py

    assert (
        repr(dev)
-        == f"<DeviceType.Plug at {DISCOVERY_MOCK_IP} - None ({short_model}) - update() needed>"
+        == f"<DeviceType.Plug at {DISCOVERY_MOCK_IP} - Plug ({short_model} {disco_id}) ({short_model}) - update() needed>"


@rytilahti I removed the Unnamed part from your suggested string, but I still see that the returned string doesn't match with the test unless I add ({short_model}) again, so maybe it's not needed on line 620 of kasa/smart/smartdevice.py because it's appended at a later step anyway?

In kasa/smart/smartdevice.py, how about we just do return f"{label} ({self.device_id})"?

github-actions · 2025-12-10T00:53:39Z

There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days.
If you are the author of this PR, please leave a comment if you want to keep it open. Also, please rebase your PR onto the latest dev branch to ensure that it's up to date with the latest changes.
Thank you for your contribution!

nicosemp mentioned this pull request Apr 4, 2025

Default name for Tapo P304M that can't be named home-assistant/core#141069

Closed

19 tasks

rytilahti reviewed Apr 4, 2025

View reviewed changes

nicosemp force-pushed the nicosemp/fallback-alias-for-p304m branch from 385a798 to 5036e7d Compare April 5, 2025 23:48

nicosemp commented Apr 5, 2025

View reviewed changes

kasa/smart/smartdevice.py Outdated Show resolved Hide resolved

nicosemp mentioned this pull request May 22, 2025

Tapo P304M entities are always registered as unnamed_p304m_name_of_entity home-assistant/core#138983

Closed

rytilahti reviewed Jun 1, 2025

View reviewed changes

nicosemp added 3 commits June 11, 2025 17:04

nicosemp/fallback-alias-for-p304m: fallback p304m alias to model

edc9e38

nicosemp/fallback-alias-for-p304m: use device type instead of model +…

6662b73

… fix test

nicosemp/fallback-alias-for-p304m: address nits

164e37a

nicosemp force-pushed the nicosemp/fallback-alias-for-p304m branch from 5036e7d to 164e37a Compare June 11, 2025 17:04

nicosemp/fallback-alias-for-p304m: remove the unnamed part from the s…

83bc7f1

…tring

nicosemp commented Jun 11, 2025

View reviewed changes

nicosemp/fallback-alias-for-p304m: remove duplicate short_model

4937672

rytilahti added the bug Something isn't working label Jul 3, 2025

github-actions bot added stale and removed stale labels Dec 10, 2025

	return label
	return f"Unnamed {label} ({self.model} {self.device_id})"

Uh oh!

Fallback smart device alias to model when nickname is empty #1521

Are you sure you want to change the base?

Fallback smart device alias to model when nickname is empty #1521

Conversation

nicosemp commented Apr 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nicosemp commented Apr 4, 2025

Uh oh!

rytilahti left a comment

Choose a reason for hiding this comment

Uh oh!

codecov bot commented Apr 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

nicosemp commented Apr 5, 2025

Uh oh!

Uh oh!

rytilahti left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Dec 10, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

nicosemp commented Apr 4, 2025 •

edited

Loading

codecov bot commented Apr 5, 2025 •

edited

Loading