Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add options flow to the airq integration #109337

Merged
merged 4 commits into from
May 15, 2024

Conversation

Sibgatulin
Copy link
Contributor

@Sibgatulin Sibgatulin commented Feb 1, 2024

Another iteration of a previous PR, which needed to be split.

Proposed change

Expose to the user the following configuration:

  1. A choice between fetching from the device either: a. the averaged (previous and the new default behaviour) or b. noisy momentary sensor reading
  2. A toggle to clip (spuriously) negative sensor values (default functionality, previously unexposed)

To those ends:

  • Introduce an OptionsFlowHandler alongside with a listener AirQCoordinator.async_set_options
  • Introduce constants to handle represent options
  • Add tests and strings

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

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 Ruff (ruff format homeassistant tests)
  • Tests have been added to verify that the new code works.

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

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:

@home-assistant
Copy link

home-assistant bot commented Feb 1, 2024

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

Code owner commands

Code owners of airq 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 airq Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

homeassistant/components/airq/coordinator.py Outdated Show resolved Hide resolved
homeassistant/components/airq/config_flow.py Outdated Show resolved Hide resolved
@home-assistant
Copy link

home-assistant bot commented Feb 2, 2024

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

@home-assistant home-assistant bot marked this pull request as draft February 2, 2024 08:50
@Sibgatulin Sibgatulin marked this pull request as ready for review February 3, 2024 14:24
Copy link

github-actions bot commented Apr 3, 2024

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!

@github-actions github-actions bot added the stale label Apr 3, 2024
@github-actions github-actions bot closed this Apr 10, 2024
@joostlek joostlek reopened this Apr 10, 2024
@github-actions github-actions bot removed the stale label Apr 11, 2024
@emontnemery emontnemery changed the title Add support for options to airq integration Add options flow to the airq integration Apr 23, 2024
Copy link
Contributor

@emontnemery emontnemery left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The changes look good, but the PR needs to be rebased.

@home-assistant home-assistant bot marked this pull request as draft April 23, 2024 14:51
Expose to the user the following configuration:
1. A choice between fetching from the device either:
    a. the averaged (previous and the new default behaviour) or
    b. noisy momentary sensor reading
2. A toggle to clip (spuriously) negative sensor values (default
    functionality, previously unexposed)

To those ends:
- Introduce an `OptionsFlowHandler` alongside with a listener
  `AirQCoordinator.async_set_options`
- Introduce constants to handle represent options
- Add tests and strings
Modify `AirQCoordinator.__init__` to accommodate the change in option
handling, and drop `async_set_options` which slipped through the
previous commit.
@Sibgatulin Sibgatulin marked this pull request as ready for review May 14, 2024 21:01
@home-assistant home-assistant bot requested a review from emontnemery May 14, 2024 21:01
Copy link
Contributor

@emontnemery emontnemery left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks @Sibgatulin 👍

@emontnemery emontnemery merged commit be5d642 into home-assistant:dev May 15, 2024
24 checks passed
@Sibgatulin Sibgatulin deleted the airq_add_option_flow branch May 15, 2024 14:47
@github-actions github-actions bot locked and limited conversation to collaborators May 16, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants