Integral
This integrations provides the Riemann sum
The integration sensors are updated whenever the source changes and, optionally, based on a predefined time interval. Source sensors with higher sampling frequency provide more accurate results.
Configuration
To add the Integral helper to your Home Assistant instance, use this My button:
Manual configuration steps
If the above My button doesn’t work, you can also perform the following steps manually:
-
Browse to your Home Assistant instance.
-
At the top of the screen, select the tab: Helpers.
-
In the bottom right corner, select the
Create helper button. -
From the list, select Integral.
-
Follow the instructions on screen to complete the setup.
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
The configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file:
# Example configuration.yaml entry
sensor:
- platform: integration
source: sensor.current_power
Configuration Variables
An ID that uniquely identifies the integration sensor. Set this to a unique value to allow customization through the UI.
Round the calculated integration value to at most N decimal places.
Metric unit to prefix the integration result. Available units are k
, M
, G
and T
.
SI unit of time to integrate over. Available units are s
, min
, h
and d
.
Riemann sum method to be used. Available methods are trapezoidal
, left
and right
.
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.
Integration method
The Riemann Sum is an approximation of an integral by a finite sum and is therefore intrinsically inaccurate. Nonetheless, depending on the method used, values can be more or less accurate.
The integration method defines how to calculate the area under the source sensor when it changes. Regardless of the method used, the integration will be more accurate if the source updates more often. The config max_sub_interval
can be used to trigger integration when the source sensor is constant.
Trapezoidal
The trapezoidal
method follows the Trapezoidal rule
Left
The left
method follows the Left ruletrapezoidal
.
Right
The right
method follows the Right rule
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
max_sub_interval:
minutes: 5
This configuration will provide you with sensor.energy_spent
which will have your energy in kWh, as a device_class
of energy
.