Add lyric integration

[shellster]

Breaking change

Proposed change

This is my attempt to resubmit a PR to add Honeywell Lyric T5-T6 support. I've included the changes requested from the previous attempt to merge, including getting the original author @bramkragten to merge some changes to his support library and bump the pip library, and then removing my updated version from this pull to make it cleaner.

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

Example entry for configuration.yaml:

lyric:
  client_id: wqeioqweuoiewuoadslqsdfkasdiosdu
  client_secret: sadiasduasoiduqwo8erq

Additional information

• This PR is based off of the original work by @bramkragten, which was prior to the climate change refactor. This code is compliant with that refactor and includes fan support.

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

[jkrall]

@shellster I was looking into HA support for Honeywell water detectors, and research led me to your PRs here — can you confirm that this PR brings support for the latest python-lyric up-to-date with HA, but that more work would need to be added on top of this to support water detector devices in HA?

Asking because I see apparent support for these devices in the python-lyric library here: https://github.com/bramkragten/python-lyric/blob/master/lyric/__init__.py#L304

Appreciate any pointers/advice you have here, as I'm considering building upon your work to add support for these myself...

[shellster]

@jkrall: I actually stripped the water detector code in this last round of updates because it wasn't germane to the temperature code, and I was hoping that streamlining it would help increase the chance that it actually got merged. The water detector code is in an older commit (shellster@12baa93), if you look back. You still will need to add a component inside home-assist, and I haven't really figured out or needed to figure out how that works. Would definitely be interested in PR's to my branch, or it may make more sense to split that into a new module, but happy to entertain the idea. I just have no way to test it.

[shellster]

To any devs: I don't know how to not fail the codecov/patch check.

[jasondefuria]

@balloob -it looks like @shellster needs a little help here.

[shellster]

@frenck I don't know how/where I'm supposed to add documentation. Any help?

[whattheschnell]

@shellster

The documentation page doesn't exist yet on home-assistant.io It needs its own PR and supporting info to describe to users how they can use the component.

https://home-assistant.io/components/lyric/ or https://home-assistant.io/integrations/lyric/

[shellster]

I'll work on this this weekend.

[shellster]

Documentation: home-assistant/home-assistant.io#12217

[shellster]

Problem found upstream. Waiting for another python-lyric pull to land: bramkragten/python-lyric#6

[shellster]

What do I need to do to get this landed? I don't want to be stuck in a loop repeatedly tending a branch to keep it up to date with dev, if no one is going to land this for me anytime soon.

[frenck]

I've taken a quick look, made the first small comment, scrolled through it a bit and noticed the configurator. That should actually not be used anymore. Since a large part of the code relies on it, I've left this initial review with just that comment.

Let's migrate it to a config flow before looking at it further. 👍

[frenck]

You can remove these additional lines. Just the first line is OK.

[frenck]

The configurator is deprecated. Use a config flow instead.

https://developers.home-assistant.io/docs/config_entries_config_flow_handler#defining-your-config-flow

and for handling OAuth:

https://developers.home-assistant.io/docs/config_entries_config_flow_handler#configuration-via-oauth2

[bramkragten]

The other PR #23015 was a long way and had a config flow, might want to check that one out, or use it as a starting point.

[stale]

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.
Thank you for your contributions.