Add support for weighted average in min/max integration

[MaJerle]

Integration name

Min/Max

Link to integration documentation on our website

https://www.home-assistant.io/integrations/min_max/

Describe the enhancement

Currently, the Min/Max integration supports the average (mean) of all the listed entities, with the formula:

result = sum(entities) / count(entities)

With configuration:

# Example configuration.yaml entry
sensor:
  - platform: min_max
    type: mean
    entity_ids:
      - sensor.kitchen_temperature
      - sensor.living_room_temperature
      - sensor.office_temperature

New proposal

The proposal is to allow the weight average entities by providing the weight number. The new sum would be calculated with the following math:

result = sum(entity_value * entity_weight) / sum(entity_weights)

with configuration:

# Example configuration.yaml entry
sensor:
  - platform: min_max
    type: mean
    # If YAML parser allows us to have keys and/or values, then we could keep the entity_ids key instead.
    entities:
      - entity_id: sensor.kitchen_temperature
        weight: 10
      - entity_id: sensor.living_room_temperature
        weight: 20
      - entity_id: sensor.office_temperature
        weight: 30

Which would calculate the average like:

average = (kitchen_temp * 10 + ligin_room_temp * 20 + office_temp * 30) / (10+20+30)

In case one of the entities is not available, its value and weight is simply removed from the picture.

For YAML structure, user must provide the weight number. I see some options:

1. Upgrade the existing setup to enter weight:

sensor:
  - platform: min_max
    type: mean
    entity_ids:
      # Weight is 1 if not specified
      - sensor.kitchen_temperature
      - sensor.living_room_temperature
      - entity_id: sensor.office_temperature
        weight: 30
    weights:
      - 10
      - 20
      - 30

2. Add new field to the existing setup, for weight, in the same order as entity order list:

sensor:
  - platform: min_max
    type: mean
    entity_ids:
      - sensor.kitchen_temperature
      - sensor.living_room_temperature
      - sensor.office_temperature
    weights:
      - 10
      - 20
      - 30

3. Introduce the new field entities where each value has entity_id and weight:

sensor:
  - platform: min_max
    type: mean
    # If YAML parser allows us to have keys and/or values, then we could keep the entity_ids key instead.
    entities:
      - entity_id: sensor.kitchen_temperature
        weight: 10
      - entity_id: sensor.living_room_temperature
        weight: 20
      - entity_id: sensor.office_temperature
        weight: 30

Use cases

Use case involves the average temperature in the room or home. The weight distribution shall be performed according to the room size or the overall impact room has to the total temperature.

The solution today is to use the template sensor and implement a loop to:

• Filter out non-functional sensors
• Multiply with sensors' weight
• Return the final state

Anything else?

No response

[github-actions[bot]]

🏷️ I've automatically added the integration: min_max label to help categorize this feature request.

[Petro31]

platform: xxx are deprecated yaml methods. If this were to be introduced into the min_max integration, it would need to move to it's own integration as a setup before introducing new features.

E.g.

min_max:
- sensor:
  - name: ....
    entities:
      - sensor.kitchen_temperature
      - sensor.living_room_temperature
      - sensor.office_temperature

As for the feature in this request, the only option for grouped information is a list of dictionaries.

min_max:
- sensor:
  - name: ....
    entities:
      - entity_id: sensor.kitchen_temperature
        weight: 10
      - entity_id: sensor.living_room_temperature
        weight: 20
      - entity_id: sensor.office_temperature
        weight: 30

[MaJerle]

1. I agree with you on the new syntax first. If one takes the lead, that'd be good
2. I agree on the dictionary style

If this were to be introduced into the min_max integration, it would need to move to it's own integration as a setup before introducing new features

As it is the deprecated syntax, is there a milestone target release version/date on this integration to see the new syntax for setup?

[Petro31]

As it is the deprecated syntax, is there a milestone target release version/date on this integration to see the new syntax for setup?

No, it's up to volunteers and/or code owner to update legacy syntax. Typically, if you want a new feature, you'd likely have to tackle the syntax change as well as your feature.

[gjohansson-ST]

Min/max is a helper so no issue with the yaml format.
But I doubt this request makes sense to bring in.