Handle missing or incorrect device name and unique id for ESPHome during manual add #95678

bdraco · 2023-07-01T16:02:42Z

Proposed change

upstream changelog: esphome/aioesphomeapi@v15.0.1...v15.1.1

If we did not have the device name during setup we could never get the key from the dashboard. The device will send us its name if we try encryption which allows us to find the right key from the dashboard.

When the unique id was configured manually it would be uppercase, but zeroconf would discovery it lower case which would mean you could set up the same device multiple times and things would break.

This should help get users unstuck (this is common when users are using the device across subnets / remote / no mdns ) when they change the key and cannot get the device back online after deleting and trying to set it up again manually because they have trouble finding the right key.

This also brings the config flow coverage to 100%

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)
Deprecation (breaking change to happen in the future)
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:

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
I have followed the perfect PR recommendations
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.
For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.
Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

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

If we did not have the device name during setup we could never get the key from the dashboard. The device will send us its name if we try encryption which allows us to find the right key from the dashboard. This should help get users unstuck when they change the key and cannot get the device back online after deleting and trying to set it up again manually

home-assistant · 2023-07-01T16:02:50Z

Hey there @OttoWinter, @jesserockz, mind taking a look at this pull request as it has been labeled with an integration (esphome) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of esphome can trigger bot actions by commenting:

@home-assistant close Closes the pull request.
@home-assistant rename Awesome new title Renames the pull request.
@home-assistant reopen Reopen the pull request.
@home-assistant unassign esphome Removes the current integration label and assignees on the pull request, add the integration domain after the command.

bdraco · 2023-07-01T16:18:19Z

needs another round of functional testing

bdraco · 2023-07-01T19:52:30Z

Something isn't working right with preventing multiple of the same device.

Nothing is stopping my from setting it up twice

bdraco · 2023-07-01T19:53:47Z

That explains all the issues with conflicting devices

bdraco · 2023-07-01T19:56:36Z

the user step never sets the unique id 🤦

bdraco · 2023-07-01T19:56:47Z

Let's get that fixed

bdraco · 2023-07-01T20:12:34Z

I think self._device_info.mac_address probably needs to go through format_mac

bdraco · 2023-07-01T20:16:45Z

doesn't seem to be the problem... so something outside esphome maybe

bdraco · 2023-07-01T20:22:11Z

nope that is the problem the zeroconf one is lowercase and the device info is upper case

bdraco · 2023-07-01T20:25:46Z

It was hard to find the issue because we have this code which fixes it after it sets up the dupe

            # Migrate config entry to new unique ID if necessary
            # This was changed in 2023.1
            if entry.unique_id != format_mac(device_info.mac_address):
                hass.config_entries.async_update_entry(
                    entry, unique_id=format_mac(device_info.mac_address)
                )

bdraco · 2023-07-01T20:28:35Z

opened esphome/esphome#5034 to start advertising if encryption is on so we don't have to probe.

Thats for the future though

bdraco · 2023-07-01T20:32:19Z

Now I know how I broke my production system in testing a few months ago 🤦

…fix_device_name_esphome

…ing manual add (#95678) * Handle incorrect or missing device name for ESPHome noise encryption If we did not have the device name during setup we could never get the key from the dashboard. The device will send us its name if we try encryption which allows us to find the right key from the dashboard. This should help get users unstuck when they change the key and cannot get the device back online after deleting and trying to set it up again manually * bump lib to get name * tweak * reduce number of connections * less connections when we know we will fail * coverage shows it works but it does not * add more coverage * fix test * bump again

home-assistant bot added cla-signed has-tests integration: esphome small-pr PRs with less than 30 lines. labels Jul 1, 2023

home-assistant bot assigned OttoWinter and jesserockz Jul 1, 2023

home-assistant bot added by-code-owner Quality Scale: No score labels Jul 1, 2023

bdraco changed the title ~~Handle incorrect or missing device name for ESPHome noise encryption~~ Handle incorrect or missing device name for ESPHome noise encryption during manual add Jul 1, 2023

bump lib to get name

4ad237c

bdraco added 3 commits July 1, 2023 14:24

tweak

44c8dc5

reduce number of connections

0230e88

less connections when we know we will fail

6f34eb8

bdraco added this to the 2023.7.0 milestone Jul 1, 2023

bdraco changed the title ~~Handle incorrect or missing device name for ESPHome noise encryption during manual add~~ Handle missing device name and unique id for ESPHome noise encryption during manual add Jul 1, 2023

bdraco added 2 commits July 1, 2023 15:05

coverage shows it works but it does not

dbbb7d9

add more coverage

6514c05

bdraco changed the title ~~Handle missing device name and unique id for ESPHome noise encryption during manual add~~ Handle missing device name for ESPHome noise encryption during manual add Jul 1, 2023

bdraco changed the title ~~Handle missing device name for ESPHome noise encryption during manual add~~ Handle missing device name and unique id for ESPHome during manual add Jul 1, 2023

bdraco changed the title ~~Handle missing device name and unique id for ESPHome during manual add~~ Handle missing or incorrect device name and unique id for ESPHome during manual add Jul 1, 2023

fix test

c268279

Merge branch 'dev' into fix_device_name_esphome

378f783

bdraco marked this pull request as ready for review July 1, 2023 20:31

bdraco requested review from OttoWinter and jesserockz as code owners July 1, 2023 20:31

bdraco mentioned this pull request Jul 1, 2023

Duplicated entities after upgrading ESPHome firmware #93215

Closed

bdraco added 2 commits July 1, 2023 16:33

bump again

25f0edf

Merge remote-tracking branch 'upstream/fix_device_name_esphome' into …

c00c2be

…fix_device_name_esphome

balloob approved these changes Jul 2, 2023

View reviewed changes

balloob merged commit f0cb03e into dev Jul 2, 2023

balloob deleted the fix_device_name_esphome branch July 2, 2023 14:29

balloob added the cherry-picked label Jul 3, 2023

github-actions bot locked and limited conversation to collaborators Jul 4, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Handle missing or incorrect device name and unique id for ESPHome during manual add #95678

Handle missing or incorrect device name and unique id for ESPHome during manual add #95678

bdraco commented Jul 1, 2023 •

edited

Loading

home-assistant bot commented Jul 1, 2023

bdraco commented Jul 1, 2023

bdraco commented Jul 1, 2023

bdraco commented Jul 1, 2023

bdraco commented Jul 1, 2023

bdraco commented Jul 1, 2023

bdraco commented Jul 1, 2023

bdraco commented Jul 1, 2023

bdraco commented Jul 1, 2023

bdraco commented Jul 1, 2023

bdraco commented Jul 1, 2023

bdraco commented Jul 1, 2023

Handle missing or incorrect device name and unique id for ESPHome during manual add #95678

Handle missing or incorrect device name and unique id for ESPHome during manual add #95678

Conversation

bdraco commented Jul 1, 2023 • edited Loading

Proposed change

Type of change

Additional information

Checklist

home-assistant bot commented Jul 1, 2023

bdraco commented Jul 1, 2023

bdraco commented Jul 1, 2023

bdraco commented Jul 1, 2023

bdraco commented Jul 1, 2023

bdraco commented Jul 1, 2023

bdraco commented Jul 1, 2023

bdraco commented Jul 1, 2023

bdraco commented Jul 1, 2023

bdraco commented Jul 1, 2023

bdraco commented Jul 1, 2023

bdraco commented Jul 1, 2023

bdraco commented Jul 1, 2023 •

edited

Loading