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

Fix: Xiaomi Miio Fan, delay off countdown unit conversion #94428

Merged
merged 1 commit into from Jun 12, 2023
Merged

Fix: Xiaomi Miio Fan, delay off countdown unit conversion #94428

merged 1 commit into from Jun 12, 2023

Conversation

golles
Copy link
Contributor

@golles golles commented Jun 11, 2023

Breaking change

The state of number.<device_name>_delay_off_countdown was wrongly converted to seconds (multiplied by 60), this change corrects that.

Proposed change

Fix bug that Xiaomi Miio Fan, delay off countdown unit conversion is wrong minutes/seconds

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 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 @rytilahti, @syssi, @starkillerOG, mind taking a look at this pull request as it has been labeled with an integration (xiaomi_miio) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of xiaomi_miio 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 xiaomi_miio Removes the current integration label and assignees on the pull request, add the integration domain after the command.

@syssi
Copy link
Member

syssi commented Jun 11, 2023

AFAIK some miIO devices expect minutes here and others seconds. Because of the inconsistent API / abstraction this isn't trivial to solve unfortunately.

@golles
Copy link
Contributor Author

golles commented Jun 11, 2023

Scherm­afbeelding 2023-06-11 om 15 28 48 Scherm­afbeelding 2023-06-11 om 15 28 29

@golles
Copy link
Contributor Author

golles commented Jun 11, 2023

AFAIK some miIO devices expect minutes here and others seconds. Because of the inconsistent API / abstraction this isn't trivial to solve unfortunately.

It looks like the only device that is acting differently is the FanP5
The property is in seconds https://github.com/rytilahti/python-miio/blob/0.5.12/miio/integrations/fan/dmaker/fan.py#L70-L73
And for setting it is in minutes https://github.com/rytilahti/python-miio/blob/0.5.12/miio/integrations/fan/dmaker/fan.py#L224-L234

@golles
Copy link
Contributor Author

golles commented Jun 11, 2023

@syssi what if I change it to

    async def async_set_delay_off_countdown(self, delay_off_countdown: int) -> bool:
        """Set the delay off countdown."""
        return await self._try_command(
            "Setting delay off miio device failed.",
            self._device.delay_off,
            delay_off_countdown * 60
            if self._model == MODEL_FAN_P5
            else delay_off_countdown,
        )

@syssi
Copy link
Member

syssi commented Jun 11, 2023

It looks like the only device that is acting differently is the FanP5

Thanks for looking this up!! In this case we should give it a try! Please mark the change as breaking so the users has a chance to be informed.

@syssi
Copy link
Member

syssi commented Jun 11, 2023

The issue/inconsistency should be fixed at the underlying library (python-miio). We shouldn't introduce workarounds here.

Copy link
Member

@syssi syssi left a comment

Choose a reason for hiding this comment

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

This is good to go!

@golles
Copy link
Contributor Author

golles commented Jun 11, 2023

The issue/inconsistency should be fixed at the underlying library (python-miio). We shouldn't introduce workarounds here.

I agree,

It looks like the only device that is acting differently is the FanP5

Thanks for looking this up!! In this case we should give it a try! Please mark the change as breaking so the users has a chance to be informed.

Done, let me know if you agree with what I wrote.

@syssi syssi merged commit c79b9d0 into home-assistant:dev Jun 12, 2023
23 checks passed
@frenck frenck added this to the 2023.6.2 milestone Jun 12, 2023
@github-actions github-actions bot locked and limited conversation to collaborators Jun 13, 2023
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.

Xiaomi Miio Fan, delay off countdown wrong unit of time
6 participants