Statistics Sensor


The statistics sensor platform consumes the state from other sensors. It exports the mean value as state and the following values as attributes: count, mean, median, stdev, variance, total, min, max, min_age, max_age, change, average_change and change_rate. If it’s a binary sensor then only state changes are counted.

If you are running the recorder component, on startup the data is read from the database. So after a restart of the platform, you will immediately have data available. If you’re using the history component, this will automatically also start the recorder component on startup. If you are not running the recorder component, it can take time till the sensor starts to work because a couple of attributes need more than one value to do the calculation.

Configuration

To enable the statistics sensor, add the following lines to your configuration.yaml:

# enable the recorder component (optional)
recorder:

# Example configuration.yaml entry
sensor:
  - platform: statistics
    entity_id: sensor.cpu
  - platform: statistics
    entity_id: binary_sensor.movement
    max_age:
      minutes: 30

Configuration variables:

  • entity_id (Required): The entity to monitor. Only sensors and binary sensor.
  • name (Optional): Name of the sensor to use in the frontend. Defaults to Stats.
  • sampling_size (Optional): Size of the sampling. If the limit is reached then the values are rotated. Defaults to 20.
  • max_age (Optional): Maximum age of measurements. Setting this to a time interval will cause older values to be discarded.
  • precision (Optional): Defines the precision of the calculated values, through the argument of round(). Defaults to 2.