Skip to content

Add entity options to entity registry#64350

Merged
emontnemery merged 3 commits intodevfrom
entity_options
Jan 18, 2022
Merged

Add entity options to entity registry#64350
emontnemery merged 3 commits intodevfrom
entity_options

Conversation

@emontnemery
Copy link
Copy Markdown
Contributor

@emontnemery emontnemery commented Jan 18, 2022

Proposed change

Add entity options to entity registry.

This could for example be the wanted unit of a sensor or weather entity, the minimum brightness of a light or the maximum volume of a speaker.

Entity options should be indexed by domain, e.g. options["light"]["minimum_brightness"]
A new helper method for setting options, EntityRegistry.async_update_entity_options, is added to the entity registry.

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

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue:
  • Link to documentation pull request:

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:

@emontnemery emontnemery requested a review from a team as a code owner January 18, 2022 09:25
@probot-home-assistant probot-home-assistant bot added core small-pr PRs with less than 30 lines. labels Jan 18, 2022
@emontnemery emontnemery marked this pull request as draft January 18, 2022 09:25
name: str | None | UndefinedType = UNDEFINED,
new_entity_id: str | UndefinedType = UNDEFINED,
new_unique_id: str | UndefinedType = UNDEFINED,
options: Mapping[str, Any] | UndefinedType = UNDEFINED,
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

let's move this to a new method, update_entity_options(domain, options)

@droberg
Copy link
Copy Markdown
Contributor

droberg commented Jan 18, 2022

Would this functionality add the possibility to have for example calibration values as entity options.

Also, would this make #64315 redundant ?

@emontnemery emontnemery changed the title WIP: Add entity options to entity registry Add entity options to entity registry Jan 18, 2022
@emontnemery emontnemery marked this pull request as ready for review January 18, 2022 21:42
@emontnemery
Copy link
Copy Markdown
Contributor Author

@droberg I think an option for configuring the wanted precision would be a welcome addition for sensor, not sure how well that maps to the resolution options for the Maxim DS18B20 though.

@emontnemery emontnemery merged commit a8c1483 into dev Jan 18, 2022
@emontnemery emontnemery deleted the entity_options branch January 18, 2022 21:47
@github-actions github-actions bot locked and limited conversation to collaborators Jan 19, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

cla-signed core small-pr PRs with less than 30 lines.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants