home-assistant.io/source/_components/integration.markdown

layout, title, description, date, sidebar, comments, sharing, footer, ha_category, ha_release, ha_iot_class, logo, ha_qa_scale, redirect_from

layout	title	description	date	sidebar	comments	sharing	footer	ha_category	ha_release	ha_iot_class	logo	ha_qa_scale	redirect_from
page	Integration Sensor	Instructions on how to integrate Integration Sensor into Home Assistant.	2019-01-02	true	false	true	true	Utility Energy	0.87	Local Push	integral.png	internal	/components/sensor.integration/

The integration platform 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. In this implementation, the default is the Trapezoidal method, but Left and Right methods can optionally be used.

{% linkable_title Configuration %}

To enable 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 %} source: description: The entity ID of the sensor providing numeric readings required: true type: string name: description: Name to use in the frontend. required: false default: source entity ID meter type: string round: description: Round the calculated integration value to at most N decimal places. required: false default: 3 type: integer unit_prefix: description: Metric unit to prefix the integration result. Available units are k, M, G, T. required: false default: None type: unit unit_time: description: SI unit of time to integrate over. Available units are s, min, h, d. required: false default: h type: unit unit: description: Unit of Measurement to be used for the integration. required: false type: string method: description: Riemann sum method to be used. Available methods are trapezoidal, left, right. required: false default: trapezoidal {% endconfiguration %}

If 'unit' is set then 'unit_prefix' and 'unit_time' are ignored.

{% linkable_title 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), then you can use the integration sensor to track how much energy is being spent. Take the next 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 who will have your energy in kWh.