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

Add sensor summation to area card #20749

Draft
wants to merge 1 commit into
base: dev
Choose a base branch
from

Conversation

seevee
Copy link

@seevee seevee commented May 7, 2024

Proposed change

Area cards currently average the values of all sensors within the given area. These changes provide a mechanism for specifying the type of function to use for a given sensor type - A further improved solution might allow for selecting any statistical function (mean, min, max, avg, sum) for any given sensor type.

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New feature (thank you!)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Example configuration

I tested this by adding two dummy power sensors and two dummy temperature sensors (all with different values) then assigning them to a single Area. Adding the area card to a dashboard view showed the average temperature and the summed power.

Additional information

Checklist

  • The code change is tested and works locally.
  • There is no commented out code in this PR.
  • Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

Copy link

@home-assistant home-assistant bot left a comment

Choose a reason for hiding this comment

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

Hello @seevee,

When attempting to inspect the commits of your pull request for CLA signature status among all authors we encountered commit(s) which were not linked to a GitHub account, thus not allowing us to determine their status(es).

The commits that are missing a linked GitHub account are the following:

Unfortunately, we are unable to accept this pull request until this situation is corrected.

Here are your options:

  1. If you had an email address set for the commit that simply wasn't linked to your GitHub account you can link that email now and it will retroactively apply to your commits. The simplest way to do this is to click the link to one of the above commits and look for a blue question mark in a blue circle in the top left. Hovering over that bubble will show you what email address you used. Clicking on that button will take you to your email address settings on GitHub. Just add the email address on that page and you're all set. GitHub has more information about this option in their help center.

  2. If you didn't use an email address at all, it was an invalid email, or it's one you can't link to your GitHub, you will need to change the authorship information of the commit and your global Git settings so this doesn't happen again going forward. GitHub provides some great instructions on how to change your authorship information in their help center.

    • If you only made a single commit you should be able to run
      git commit --amend --author="Author Name <email@address.com>"
      
      (substituting "Author Name" and "email@address.com" for your actual information) to set the authorship information.
    • If you made more than one commit and the commit with the missing authorship information is not the most recent one you have two options:
      1. You can re-create all commits missing authorship information. This is going to be the easiest solution for developers that aren't extremely confident in their Git and command line skills.
      2. You can use this script that GitHub provides to rewrite history. Please note: this should be used only if you are very confident in your abilities and understand its impacts.
    • Whichever method you choose, I will come by to re-check the pull request once you push the fixes to this branch.

We apologize for this inconvenience, especially since it usually bites new contributors to Home Assistant. We hope you understand the need for us to protect ourselves and the great community we all have built legally. The best thing to come out of this is that you only need to fix this once and it benefits the entire Home Assistant and GitHub community.

Thanks, I look forward to checking this PR again soon! ❤️

Copy link

@home-assistant home-assistant bot left a comment

Choose a reason for hiding this comment

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

Hi @seevee

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

@BradleyFord
Copy link

Firstly thanks very much, Area level summation is really needed!!

My question is wit big, but should we be doing this in the frontend, or should we do this in the new backend "areas" that we then pass to the frontend?

If we do it in the backend then it will also be usable for many purposes

@seevee
Copy link
Author

seevee commented May 7, 2024

Thanks for the feedback! I haven't dived too deeply into the backend code yet, but the ideal solution may well involve both backend and frontend changes. Some kind of relation between a sensor class and a default function would be handy, and that feels like a backend task. The min/max/avg/sum/etc. operations themselves are effectively display formatters and seem like good candidates for frontend.

The more I think about how I want to use these cards, the more I think it would be nice to have the ability to specify one or more statistical display functions for a given sensor class within an area card. Might be nice to see the min/max temperature on one area card, for example.

It feels like there's some opportunity to use helpers here. That's what I usually reach for if I need to sum a bunch of sensors.

@silamon
Copy link
Contributor

silamon commented Jun 21, 2024

If you feel the PR is ready for review, be sure to mark it as ready for review. It's still in draft status right now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

"area" cards should NOT average power OR energy sensor values
3 participants