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

vesync support for debug mode in library #134571

Open
wants to merge 8 commits into
base: dev
Choose a base branch
from

Conversation

cdnninja
Copy link
Contributor

@cdnninja cdnninja commented Jan 3, 2025

Proposed change

Previously debug mode for the logger didn't pass to pyvesync library. The library overrides the settings back to default. Instead it has a flag you can pass in. This takes the debug mode setting and passes to the library allowing the standard debug functions to work. It also has listeners to adjust this on the fly.

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

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue:
  • Link to documentation pull request:

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 Jan 3, 2025

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.

@iprak
Copy link
Contributor

iprak commented Jan 3, 2025

That will work but it requires restarting the integration. Can we list to the event EVENT_LOGGING_CHANGED like self.hass.bus.async_listen(EVENT_LOGGING_CHANGED, handle_logging_changed) and then update the debug property on the VeSync component? esphome/manager.py has good sample in this direction.

@joostlek
Copy link
Member

joostlek commented Jan 3, 2025

That's indeed a good point, we should be able to change it on runtime for the best experience. Why do we actually overwrite this in the lib as opposed to just logging in debug?

@cdnninja
Copy link
Contributor Author

cdnninja commented Jan 3, 2025

Good question, I'm not sure why the library over writes it. @webdjoe thoughts?

@cdnninja cdnninja changed the title vesync support for debug mode vesync support for debug mode in library Jan 10, 2025
@cdnninja
Copy link
Contributor Author

I have added listeners to adjust the debug mode on the fly. This is functional in my testing. @iprak @joostlek ready for review.

Copy link
Member

@joostlek joostlek left a comment

Choose a reason for hiding this comment

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

There's a merge conflict

@home-assistant home-assistant bot marked this pull request as draft January 10, 2025 12:02
@home-assistant
Copy link

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.

@cdnninja cdnninja marked this pull request as ready for review January 10, 2025 14:20
@home-assistant home-assistant bot requested a review from joostlek January 10, 2025 14:20
@cdnninja
Copy link
Contributor Author

Fixed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants