Home Assistant Home Assistant

Integration - Riemann sum integral

This integrations provides the Riemann sum of the values provided by a source sensor. The Riemann sum is an approximation of an integral by a finite sum.

The integration sensors are updated upon changes of the source. Fast sampling source sensors provide more accurate results. In this implementation, the default is the Trapezoidal method, but Left and Right methods can optionally be used.

Configuration

Adding Integration - Riemann sum integral to your Home Assistant instance can be done via the user interface, by using this My button:

Manual configuration steps
Name

The name the sensor should have. You can change it again later.

Input sensor

The entity providing numeric readings to integrate.

Integral method

Riemann sum method to be used.

Precision

Round the calculated integration value to at most N decimal places.

Metric prefix

Metric unit to prefix the integration result.

Integration time

SI unit of time to integrate over.

YAML Configuration

Alternatively, this integration can be configured and set up manually via YAML as well. To enable the Integration sensor in your installation, add the following to your configuration.yaml file:

# Example configuration.yaml entry
sensor:
  - platform: integration
    source: sensor.current_power

Configuration Variables

Looking for your configuration file?
source string Required

The entity ID of the sensor providing numeric readings.

name string (Optional)

Name to use in the frontend.

Default:

source entity ID integral

unique_id string (Optional)

An ID that uniquely identifies the integration sensor. Set this to a unique value to allow customization through the UI.

round integer (Optional, default: 3)

Round the calculated integration value to at most N decimal places.

unit_prefix string (Optional, default: None)

Metric unit to prefix the integration result. Available units are k, M, G and T.

unit_time string (Optional, default: h)

SI unit of time to integrate over. Available units are s, min, h and d.

method string (Optional, default: trapezoidal)

Riemann sum method to be used. Available methods are trapezoidal, left and right.

In case you expect that your source sensor will provide several subsequent values that are equal, you should opt for the left method to get accurate readings.

The unit of source together with unit_prefix and unit_time is used to generate a unit for the integral product (e.g. a source in W with prefix k and time h would result in kWh). Note that unit_prefix and unit_time are also relevant to the Riemann sum calculation.

Energy

An integration sensor is quite useful in energy billing scenarios since energy is generally billed in kWh and many sensors provide power in W (Watts).

If you have a sensor that provides you with power readings in Watts (uses W as unit_of_measurement, device_class of power), then you can use the integration sensor to track how much energy is being spent. Take the next manual YAML configuration as an example:

sensor:
  - platform: integration
    source: sensor.current_power
    name: energy_spent
    unit_prefix: k
    round: 2

This configuration will provide you with sensor.energy_spent which will have your energy in kWh, as a device_class of energy.