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

Deprecate old config options for MQTT json light #111676

Merged
merged 8 commits into from Mar 5, 2024
Merged

Deprecate old config options for MQTT json light #111676

merged 8 commits into from Mar 5, 2024

Conversation

jbouwh
Copy link
Contributor

@jbouwh jbouwh commented Feb 27, 2024

Breaking change

Support for brightness is now assumed for mqtt lights with the json schema unless only color modes rgb, rgbw or rgbww are supported.

For light which only support color modes rgb, rgbw or rgbww, the brightness option flag can still be set to false if brightness is not supported, in this case brightness support is emulated in Home Assistant by scaling the RGBx-values.

For all other color modes except ColorMode.ONOFF, it is assumed brightness is supported and the brightness attribute will be included in the MQTT payload when the brightness attribute is supplied to the light.turn_on service.

Proposed change

Deprecate the flag settings color_mode, color_temp, hs, rgb and xy for the mqtt light schema. The options color_temp, hs, rgb and xy were already removed from the documentation, but the options were not marked deprecated in the schema yet.

The color_mode flag is not used anymore, and should be removed. Instead supported_color_modes is checked. If it is not set, then the color_temp, hs, rgbandxy` flags will still be evaluated.

Brightness is assumed to be supported by default. For rgbx lights that do not support brightness brightness should be explicitly set to false.

The deprecated options are planned to be removed with HA Core 2025.3, this is in line with the deprecation grace period on the light entity platform support.

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.
  • Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

@home-assistant
Copy link

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

Code owner commands

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

@jbouwh jbouwh changed the title Deprecate old config options forMQTT json light Deprecate old config options for MQTT json light Feb 28, 2024
homeassistant/components/mqtt/light/schema_json.py Outdated Show resolved Hide resolved
homeassistant/components/mqtt/light/schema_json.py Outdated Show resolved Hide resolved
homeassistant/components/mqtt/light/schema_json.py Outdated Show resolved Hide resolved
homeassistant/components/mqtt/light/schema_json.py Outdated Show resolved Hide resolved
@home-assistant home-assistant bot marked this pull request as draft March 4, 2024 08:18
@home-assistant
Copy link

home-assistant bot commented Mar 4, 2024

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.

@jbouwh jbouwh marked this pull request as ready for review March 4, 2024 18:09
@jbouwh jbouwh added the smash Indicator this PR is close to finish for merging or closing label Mar 4, 2024
Copy link
Contributor

@emontnemery emontnemery left a comment

Choose a reason for hiding this comment

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

Thanks, @jbouwh 👍

@jbouwh jbouwh merged commit 0c2cf88 into dev Mar 5, 2024
53 checks passed
@jbouwh jbouwh deleted the mqtt-json-light branch March 5, 2024 07:49
@github-actions github-actions bot locked and limited conversation to collaborators Mar 6, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
breaking-change by-code-owner cla-signed core has-tests integration: mqtt Quality Scale: gold small-pr PRs with less than 30 lines. smash Indicator this PR is close to finish for merging or closing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

MQTT JSON light options brightness and color_mode should be deprecated
2 participants