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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use Hyperion human-readable effect names instead of API identifiers #45763

Merged

Conversation

dermotduffy
Copy link
Contributor

@dermotduffy dermotduffy commented Jan 31, 2021

Proposed change

Hyperion itself uses one set of identifiers in its API to refer to components/"sources" (e.g. "GRABBER", "V4L"), but its UI uses a different set of friendlier names (e.g. "Platform Capture", "USB Capture"). The home assistant integration currently uses the "unfriendly" API identifier in the light component, but the friendly UI names in the switch component.

This change deprecates these API identifiers (they won't be shown in the list, but automations that use them will still work and will print a warning).

Once this change is submitted, the switch component, light component and the Hyperion UI will all be using the same names.

Underlying library changes: dermotduffy/hyperion-py@v0.7.0...v0.7.2

Home Assistant Hyperion component:

Screen Shot 2021-01-30 at 8 36 55 PM

Hyperion-UI (remote panel):

Screen Shot 2021-01-30 at 8 38 05 PM

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

Example entry for configuration.yaml:

None.

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

@project-bot project-bot bot added this to Needs review in Dev Jan 31, 2021
@project-bot project-bot bot moved this from Needs review to By Code Owner in Dev Jan 31, 2021
@dermotduffy dermotduffy changed the title Deprecate the Hyperion API effects and use human-readable effect names instead Deprecate the Hyperion API effect names and use human-readable effect names instead Jan 31, 2021
@dermotduffy dermotduffy changed the title Deprecate the Hyperion API effect names and use human-readable effect names instead Use Hyperion human-readable effect names instead of API identifiers Jan 31, 2021
@dermotduffy dermotduffy force-pushed the hyperion-deprecate-old-effect-names branch 2 times, most recently from 14c8034 to 31ec430 Compare January 31, 2021 17:55
@github-actions
Copy link

github-actions bot commented Mar 2, 2021

There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days.
Thank you for your contributions.

@github-actions github-actions bot added the stale label Mar 2, 2021
@dermotduffy
Copy link
Contributor Author

This PR is still live, still desired and I'm still happy to respond to any feedback if someone has time to review. Thank you.

@github-actions github-actions bot removed the stale label Mar 3, 2021
@dermotduffy dermotduffy force-pushed the hyperion-deprecate-old-effect-names branch 2 times, most recently from faa3c11 to 6c159ee Compare March 24, 2021 02:26
@frenck frenck self-requested a review April 5, 2021 14:54
@dermotduffy dermotduffy force-pushed the hyperion-deprecate-old-effect-names branch from 6c159ee to 27ab615 Compare April 17, 2021 18:57
@dermotduffy
Copy link
Contributor Author

[April update, rebased from dev] This PR is still live, still desired and I'm still happy to respond to any feedback if someone has time to review. Thank you.

Dev automation moved this from By Code Owner to Reviewer approved Apr 19, 2021
Copy link
Member

@frenck frenck left a comment

Choose a reason for hiding this comment

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

Thanks, @dermotduffy 馃憤

../Frenck 馃殏

@frenck frenck merged commit 1560c00 into home-assistant:dev Apr 19, 2021
Dev automation moved this from Reviewer approved to Done Apr 19, 2021
@dermotduffy
Copy link
Contributor Author

Thank you!

@github-actions github-actions bot locked and limited conversation to collaborators Apr 21, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
Dev
  
Done
Development

Successfully merging this pull request may close these issues.

None yet

4 participants