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 RainMachine config option to use default run times from app #80984

Merged
merged 6 commits into from
Oct 27, 2022
Merged

Add RainMachine config option to use default run times from app #80984

merged 6 commits into from
Oct 27, 2022

Conversation

shbatm
Copy link
Contributor

@shbatm shbatm commented Oct 26, 2022

Proposed change

Adds an option to RainMachine for the integration to use the default per-zone run times a user has set in the RainMachine app when turning on a zone from Home Assistant.

Currently, the user can specify a default run time that all zones share when toggling the switch from the front end. If the new option is enabled, the integration uses the last manual watering time for each zone from the app.

Defaults to False to prevent breaking changes.

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
  • 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:

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

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

Code owner commands

Code owners of rainmachine can trigger bot actions by commenting:

  • @home-assistant close Closes the issue.
  • @home-assistant rename Awesome new title Change the title of the issue.
  • @home-assistant unassign rainmachine Removes the current integration label and assignees on the issue, add the integration domain after the command.

@shbatm
Copy link
Contributor Author

shbatm commented Oct 26, 2022

@bachya Take a look and let me know if you can think of a better way to store/grab the values. I'll try and explain my reasoning here:

The zoneDurations is from the /provision endpoint, so it's not updated at the same time as the zones. It's also only a unreferenced array of times, in the same order as the list of zones.

Because it's in a different update coordinator, and to not have to perform any intensive lookups at the time of a turn_on call, I went with the plan to store the duration for each zone as an attribute for that zone entity if this option is turned on. It's updated whenever the zone is updated. The turn_on call just uses this attribute if no other duration is provided.

Copy link
Contributor

@bachya bachya left a comment

Choose a reason for hiding this comment

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

Initial comments.

homeassistant/components/rainmachine/__init__.py Outdated Show resolved Hide resolved
homeassistant/components/rainmachine/switch.py Outdated Show resolved Hide resolved
Copy link
Contributor

@bachya bachya left a comment

Choose a reason for hiding this comment

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

Looks good to me! @bdraco, you want to weigh in further?

@bachya bachya merged commit e785d04 into home-assistant:dev Oct 27, 2022
@shbatm shbatm deleted the rainmachine_use_controller_duratiosn branch October 27, 2022 13:26
@github-actions github-actions bot locked and limited conversation to collaborators Oct 28, 2022
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.

3 participants