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 Option to Configure Scan Interval to vesync #127152

Closed
wants to merge 1 commit into from

Conversation

cdnninja
Copy link
Contributor

@cdnninja cdnninja commented Oct 1, 2024

Proposed change

Adds a scan_interval setting to resolve rate limiting on the API as per this issue:

#122620

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.

To help with the load of incoming pull requests:

@home-assistant
Copy link

home-assistant bot commented Oct 1, 2024

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

Code owner commands

Code owners of vesync 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 vesync 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.

@cdnninja cdnninja marked this pull request as draft October 1, 2024 03:48
@cdnninja
Copy link
Contributor Author

cdnninja commented Oct 1, 2024

This code currently shows the option in the GUI. I am not clear how to assign it to the entity. I haven't done it before without a coordinator. More research needed but if someone could point me to an example that would be awesome. I need to essentially set scan_interval = self._config_entry.options[CONF_SCAN_INTERVAL] however the config entry isn't available in the entity.

Comment on lines +43 to +48
vol.Optional(
CONF_SCAN_INTERVAL,
default=self.config_entry.options.get(
CONF_SCAN_INTERVAL, DEFAULT_SCAN_INTERVAL
),
): int,
Copy link
Member

Choose a reason for hiding this comment

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

We do not allow configuration of the scan interval.

We should provide a sane default out of the box. In case the default isn't correct, we should adjust that.

If an user wants to use a different schedule or a conditional scan interval, they can use the homeassistant.update_entity service instead.

@frenck frenck closed this Oct 1, 2024
@joostlek
Copy link
Member

joostlek commented Oct 1, 2024

@github-actions github-actions bot locked and limited conversation to collaborators Oct 2, 2024
@cdnninja cdnninja deleted the scan_interval branch January 1, 2025 20:20
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