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

Avoid recording additional light attributes #121776

Merged
merged 1 commit into from
Jul 12, 2024
Merged

Avoid recording additional light attributes #121776

merged 1 commit into from
Jul 12, 2024

Conversation

bdraco
Copy link
Member

@bdraco bdraco commented Jul 11, 2024

Breaking change

The following attributes are no longer saved in the database for light entities because their combinations would quickly fill up the database and they are never used by Home Assistant:

  • brightness
  • color_mode
  • color_temp
  • color_temp_kelvin
  • effect
  • hs_color
  • rgb_color
  • rgbw_color
  • rgbww_color
  • xy_color

This has no effect on the run time of light entities.

Proposed change

For some cases, these attributes would take up more space in the database than any other data, including all of the long term statistics and states.

We have at least three cases where we can generate a massive amount of data in state_attributes:

  • Automations that frequently change light colors
  • Lights that report color changes during effects
  • Custom integrations like adaptive lighting that frequently change color temp

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.

To help with the load of incoming pull requests:

The following attributes are no longer saved in the database for light entities
because their combinations would quickly fill up the database and they are
never used by Home Assistant core:

- brightness
- color_mode
- color_temp
- color_temp_kelvin
- effect
- hs_color
- rgb_color
- rgbw_color
- rgbww_color
- xy_color

This has no effect on the run time of light entities.
@home-assistant
Copy link

Hey there @home-assistant/core, mind taking a look at this pull request as it has been labeled with an integration (light) you are listed as a code owner for? Thanks!

Code owner commands

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

@bdraco bdraco marked this pull request as ready for review July 11, 2024 15:11
@bdraco bdraco requested a review from a team as a code owner July 11, 2024 15:11
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, @bdraco 👍

Makes sense right now; maybe in the future these values would be helpful for things like machine learning or away simulations, but that isn't that case right now.

../Frenck

@frenck frenck merged commit a67b6c5 into dev Jul 12, 2024
40 checks passed
@frenck frenck deleted the light_attrs_unrec branch July 12, 2024 14:27
adriencog pushed a commit to adriencog/homeassistant-core that referenced this pull request Jul 13, 2024
@github-actions github-actions bot locked and limited conversation to collaborators Jul 13, 2024
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.

Recorder Many State Attributes for Changing Light Attributes
3 participants