Fix Starkvind fan capabilities and modes being incorrectly exposed

[freundTech]

Breaking change (for end-users in HA)

The IKEA Starkvind fan modes have been updated. Automations that used to set the fan to 10% speed to switch it to "auto mode" should now be updated to set the preset to "auto."

In auto mode, the actual fan speed is now properly displayed.

For more information, see the PR in the ZHA repo: #87

Proposed change

Fixes home-assistant/core#97440.
Previously, Starkvind exposed 10 speed settings and no modes, where 10% corresponded to auto mode and 20%-100% corresponded to fixed speeds.

This patch correctly exposes auto mode as a mode. It also adds support for showing the actual fan speed while auto mode is enabled.

Starkvind supports 9 fan speeds. Because 9 doesn't neatly fit into 100% I cheated a bit and divided the 100% into 10% increments, where trying to set the fan to 10% sets it to 20% instead. I believe that this gives the overall better user experience compared to having 11.11% increments. This also keeps the previous fixed speeds in HA, instead of changing them all.
The 5 speed modes present on the physical interface of the device correspond to HA speed settings 20%, 40%, 60% and 100%.

Additional information

This depends on home-assistant/core#122033 to work. That PR is no longer needed.
Previous PR: home-assistant/core#114854

[puddly]

You can fix most of the CI errors by running pre-commit:

pip install pre-commit
pre-commit install
pre-commit run --all-files

Ignoring the fan speed attribute values, just so that I understand correctly, the fan supports auto and then five unnamed speeds that you've mapped to 20-100%?

[freundTech]

You can fix most of the CI errors by running pre-commit

Done. Both pytest and pre-commit should now pass.

the fan supports auto and then five unnamed speeds that you've mapped to 20-100%?

The fan supports 9 speeds, of which only 5 are exposed on the physical interface. The other four speeds are halfway between those speeds and used in auto mode, as well as exposed in the official app.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.80%. Comparing base (c516144) to head (b363b7f).
Report is 8 commits behind head on dev.

Additional details and impacted files

@@           Coverage Diff           @@
##              dev      #87   +/-   ##
=======================================
  Coverage   95.79%   95.80%           
=======================================
  Files          61       61           
  Lines        9324     9340   +16     
=======================================
+ Hits         8932     8948   +16     
  Misses        392      392           

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

[freundTech]

Improved test coverage, cleaned up some code and addressed one of the review comments.

[freundTech]

Rebased again because of the conflict caused by #125

[freundTech]

Do you think it will be possible to get this into HA 2024.9 now that the zha rework has landed in 2024.8?

[TheJulianJES]

Testing the PR right now. The behavior and code of the the PR seems good to me.

where trying to set the fan to 10% sets it to 20% instead. I believe that this gives the overall better user experience compared to having 11.11% increments

This behavior is slightly weird, I could see a bug report coming along the lines of "I can't set my STARKVIND to 10% anymore". But on the other hand, I also don't like 11.11% increments..
Changing the increments might also be more of a breaking change than not doing that. So, let's keep it like this for now.
Eh, and 10% meant "auto" before, so, should be fine.

Still, for anyone using the Starkvind in automations, this PR could be a breaking change, as setting it to 10% no longer sets it to auto mode. Maybe, this should be mentioned in the "breaking changes" section when ZHA is bumped in HA.
Automations just have to be updated to the proper "auto" fan mode now.

Lastly, I wonder if we can/should add a translation key for the "auto" fan mode on the HA side after this:

[TheJulianJES]

I've added a "breaking change" text in the PR description. This should be copy-pasted by whoever bumps the lib in HA.
Also applied the small suggestions made above.

[TheJulianJES]

LGTM. Thanks!