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

Allow customizing display name for energy device #112834

Merged
merged 2 commits into from
Apr 12, 2024

Conversation

karwosts
Copy link
Contributor

@karwosts karwosts commented Mar 9, 2024

Proposed change

Allow for storing a custom display name with individual device consumptions for energy dashboard. This allows users for a cleaner and less cluttered dashboard, as entity ids for energy devices often have terms like "Energy", "Consumption", "Daily", "Weekly", "Total", etc which are not relevant for the energy dashboard, but may still be wanted as part of the entity name when looking at it out of the context of energy dashboard.

Also space is at a premium for smaller/mobile devices, and the visual display can be improved with shorter names to minimize space consumption of the legend.

image

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:

@karwosts karwosts requested a review from a team as a code owner March 9, 2024 16:56
@home-assistant home-assistant bot added cla-signed integration: energy new-feature small-pr PRs with less than 30 lines. WTH Issues & PRs generated from the "Month of What the Heck?" Quality Scale: internal labels Mar 9, 2024
@home-assistant
Copy link

home-assistant bot commented Mar 9, 2024

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

Code owner commands

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

@karwosts
Copy link
Contributor Author

karwosts commented Mar 9, 2024

Frontend: home-assistant/frontend#20033

@karwosts karwosts closed this Mar 9, 2024
@karwosts karwosts reopened this Mar 9, 2024
Copy link
Member

@jpbede jpbede left a comment

Choose a reason for hiding this comment

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

LGTM, thanks @karwosts ❤️

@bramkragten bramkragten merged commit 77d1e2c into home-assistant:dev Apr 12, 2024
62 of 63 checks passed
@karwosts karwosts deleted the energy-device-names branch April 12, 2024 19:20
@github-actions github-actions bot locked and limited conversation to collaborators Apr 13, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
awaiting-frontend cla-signed integration: energy new-feature Quality Scale: internal small-pr PRs with less than 30 lines. WTH Issues & PRs generated from the "Month of What the Heck?"
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants