Adds a trending_towards attribute when period is set

[AnderzL7]

Breaking change

Proposed change

This adds a new trending_towards attribute that has the value of the expected average at the end of the period if the monitored entities keeps their current states. This is calculated by the following script block where current_average is the current average of the monitored entities:

current_average = round(
                sum(current_values) / len(current_values), self._precision
            )
if self._precision < 1:
    current_average = int(current_average)
part_of_period = (now_ts - start_ts) / (actual_end_ts - start_ts)
to_now = self._attr_native_value * part_of_period
to_end = current_average * (1 - part_of_period)
self.trending_towards = to_now + to_end

This new attribute can be used to predict what the resulting average of this period will be or in my case to programmatically limit my power usage below a limit i have set by using automations.

Type of change

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

Example entry for configuration.yaml:

# Example configuration.yaml
- platform: average
  name: Average power this hour
  entities:
    - sensor.emi_power
  start: "{{ now().replace(minute=0, second=0, microsecond=0) }}"
  end: "{{ now().replace(minute=59, second=59, microsecond=999) }}"
  unique_id: "average_power_h_hacs-2024-01"

Additional information

• This PR fixes or closes issue: closes Add a trend attribute for sensors with a period #215

Checklist

• The code change is tested and works locally.
• There is no commented out code in this PR.
• The code has been formatted using Black (black --fast custom_components)

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

• Documentation added/updated to README.md

[Limych]

Thanks ❤️