8000 Fix VeSync air_quality fan attribute by jetpacktuxedo · Pull Request #71771 · home-assistant/core · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Fix VeSync air_quality fan attribute #71771

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

Merged
merged 4 commits into from
May 16, 2022

Conversation

jetpacktuxedo
Copy link
@jetpacktuxedo jetpacktuxedo commented May 13, 2022

Breaking change

Proposed change

A recent change to pyvesync (introduced in 2.02) changed air_quality to refer to air quality as an integer representation of perceived air quality rather than a direct reading of the PM2.5 sensor. This was reported as #71427. With an upgrade to pyvesync==2.03 the PM2.5 sensor access was restored as air_quality_value. Unfortunately, air_quality_value was not added as an attribute on the fan object, and rather only exists in the details dictionary on the fan object.

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

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.

The integration reached or maintains the following Integration Quality Scale:

  • No score or internal
  • 🥈 Silver
  • 🥇 Gold
  • 🏆 Platinum

To help with the load of incoming pull requests:

@homeassistant
Copy link
Contributor

Hi @jetpacktuxedo,

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

@probot-home-assistant
Copy link

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!
(message by CodeOwnersMention)

@jetpacktuxedo
Copy link
Author

I haven't updated the documentation yet because I am hoping to get confirmation from a pyvesync maintainer that the approach I took here is reasonable to them :)

@MartinHjelmare MartinHjelmare changed the title Refactor attribute inclusion for VeSync fans. Refactor attribute inclusion for VeSync fans May 13, 2022
A recent change to pyvesync (introduced in 2.2) changed `air_quality` to
refer to air quality as an integer representation of perceived air
quality rather than a direct reading of the PM2.5 sensor. With 2.3 the
PM2.5 sensor access was restored as `air_quality_value`. Unfortunately,
`air_quality_value` was not added as an attribute on the fan object, and
rather only exists in the `details` dictionary on the fan object.
jetpacktuxedo and others added 3 commits May 13, 2022 08:19
Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
This should make it more clear what the attribute actually represents
This restores previous behavior for this integration to what it was
before the `pyvesync==2.02` upgrade, using the `air_quality` attribute
to report pm2.5 concentrations (formerly `air_quality`) rather the
vague measurement now reported by `air_quality`.
Copy link
Member
@MartinHjelmare MartinHjelmare left a comment

Choose a reason for hiding this comment

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

Thanks!

@MartinHjelmare MartinHjelmare added this to the 2022.5.5 milestone May 16, 2022
@MartinHjelmare MartinHjelmare changed the title Refactor attribute inclusion for VeSync fans Fix VeSync air_quality fan attribute May 16, 2022
@MartinHjelmare MartinHjelmare merged commit e30a9d1 into home-assistant:dev May 16, 2022
@github-actions github-actions bot locked and limited conversation to collaborators May 17, 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.

Vesync Core300S air_quality reading no longer linked to air_quality_value
4 participants
0