Classes
class	StatisticsSensor

Functions
None	async_setup_entry (HomeAssistant hass, ConfigEntry entry, AddEntitiesCallback async_add_entities)

None	async_setup_platform (HomeAssistant hass, ConfigType config, AddEntitiesCallback async_add_entities, DiscoveryInfoType\|None discovery_info=None)

dict[str, Any]	valid_boundary_configuration (dict[str, Any] config)

dict[str, Any]	valid_keep_last_sample (dict[str, Any] config)

dict[str, Any]	valid_state_characteristic_configuration (dict[str, Any] config)

Variables
	_LOGGER = logging.getLogger(__name__)

	_PLATFORM_SCHEMA_BASE

string	CONF_KEEP_LAST_SAMPLE = "keep_last_sample"

string	CONF_MAX_AGE = "max_age"

string	CONF_PERCENTILE = "percentile"

string	CONF_PRECISION = "precision"

string	CONF_SAMPLES_MAX_BUFFER_SIZE = "sampling_size"

string	CONF_STATE_CHARACTERISTIC = "state_characteristic"

string	DEFAULT_NAME = "Statistical characteristic"

int	DEFAULT_PRECISION = 2

string	ICON = "mdi:calculator"

	PLATFORM_SCHEMA

string	STAT_AGE_COVERAGE_RATIO = "age_coverage_ratio"

string	STAT_AVERAGE_LINEAR = "average_linear"

string	STAT_AVERAGE_STEP = "average_step"

string	STAT_AVERAGE_TIMELESS = "average_timeless"

string	STAT_BUFFER_USAGE_RATIO = "buffer_usage_ratio"

string	STAT_CHANGE = "change"

string	STAT_CHANGE_SAMPLE = "change_sample"

string	STAT_CHANGE_SECOND = "change_second"

string	STAT_COUNT = "count"

string	STAT_COUNT_BINARY_OFF = "count_off"

string	STAT_COUNT_BINARY_ON = "count_on"

string	STAT_DATETIME_NEWEST = "datetime_newest"

string	STAT_DATETIME_OLDEST = "datetime_oldest"

string	STAT_DATETIME_VALUE_MAX = "datetime_value_max"

string	STAT_DATETIME_VALUE_MIN = "datetime_value_min"

string	STAT_DISTANCE_95P = "distance_95_percent_of_values"

string	STAT_DISTANCE_99P = "distance_99_percent_of_values"

string	STAT_DISTANCE_ABSOLUTE = "distance_absolute"

string	STAT_MEAN = "mean"

string	STAT_MEAN_CIRCULAR = "mean_circular"

string	STAT_MEDIAN = "median"

string	STAT_NOISINESS = "noisiness"

string	STAT_PERCENTILE = "percentile"

string	STAT_SOURCE_VALUE_VALID = "source_value_valid"

string	STAT_STANDARD_DEVIATION = "standard_deviation"

string	STAT_SUM = "sum"

string	STAT_SUM_DIFFERENCES = "sum_differences"

string	STAT_SUM_DIFFERENCES_NONNEGATIVE = "sum_differences_nonnegative"

string	STAT_TOTAL = "total"

string	STAT_VALUE_MAX = "value_max"

string	STAT_VALUE_MIN = "value_min"

string	STAT_VARIANCE = "variance"

dictionary	STATS_BINARY_PERCENTAGE

dictionary	STATS_BINARY_SUPPORT

dictionary	STATS_DATETIME

dictionary	STATS_NOT_A_NUMBER

dictionary	STATS_NUMERIC_RETAIN_UNIT

dictionary	STATS_NUMERIC_SUPPORT

Detailed Description

Support for statistics for sensor values.

Function Documentation

◆ async_setup_entry()

None homeassistant.components.statistics.sensor.async_setup_entry	(	HomeAssistant	hass,
		ConfigEntry	entry,
		AddEntitiesCallback	async_add_entities
	)

Set up the Statistics sensor entry.

Definition at line 290 of file sensor.py.

◆ async_setup_platform()

None homeassistant.components.statistics.sensor.async_setup_platform	(	HomeAssistant	hass,
		ConfigType	config,
		AddEntitiesCallback	async_add_entities,
		DiscoveryInfoType \| None	discovery_info = `None`
	)

Set up the Statistics sensor.

Definition at line 261 of file sensor.py.

◆ valid_boundary_configuration()

dict[str, Any] homeassistant.components.statistics.sensor.valid_boundary_configuration ( dict[str, Any] config )

Validate that max_age, sampling_size, or both are provided.

Definition at line 213 of file sensor.py.

◆ valid_keep_last_sample()

dict[str, Any] homeassistant.components.statistics.sensor.valid_keep_last_sample ( dict[str, Any] config )

Validate that if keep_last_sample is set, max_age must also be set.

Definition at line 226 of file sensor.py.

◆ valid_state_characteristic_configuration()

dict[str, Any] homeassistant.components.statistics.sensor.valid_state_characteristic_configuration ( dict[str, Any] config )

Validate that the characteristic selected is valid for the source sensor type, throw if it isn't.

Definition at line 199 of file sensor.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.statistics.sensor._LOGGER = logging.getLogger(__name__)

private

Definition at line 62 of file sensor.py.

◆ _PLATFORM_SCHEMA_BASE

homeassistant.components.statistics.sensor._PLATFORM_SCHEMA_BASE

private

Initial value:

 =  SENSOR_PLATFORM_SCHEMA.extend(
     {
         vol.Required(CONF_ENTITY_ID): cv.entity_id,
         vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
         vol.Optional(CONF_UNIQUE_ID): cv.string,
         vol.Required(CONF_STATE_CHARACTERISTIC): cv.string,
         vol.Optional(CONF_SAMPLES_MAX_BUFFER_SIZE): vol.All(
             vol.Coerce(int), vol.Range(min=1)
         ),
         vol.Optional(CONF_MAX_AGE): cv.time_period,
         vol.Optional(CONF_KEEP_LAST_SAMPLE, default=False): cv.boolean,
         vol.Optional(CONF_PRECISION, default=DEFAULT_PRECISION): vol.Coerce(int),
         vol.Optional(CONF_PERCENTILE, default=50): vol.All(
             vol.Coerce(int), vol.Range(min=1, max=99)
         ),
     }
 )

Definition at line 236 of file sensor.py.

◆ CONF_KEEP_LAST_SAMPLE

string homeassistant.components.statistics.sensor.CONF_KEEP_LAST_SAMPLE = "keep_last_sample"

Definition at line 190 of file sensor.py.

◆ CONF_MAX_AGE

string homeassistant.components.statistics.sensor.CONF_MAX_AGE = "max_age"

Definition at line 189 of file sensor.py.

◆ CONF_PERCENTILE

string homeassistant.components.statistics.sensor.CONF_PERCENTILE = "percentile"

Definition at line 192 of file sensor.py.

◆ CONF_PRECISION

string homeassistant.components.statistics.sensor.CONF_PRECISION = "precision"

Definition at line 191 of file sensor.py.

◆ CONF_SAMPLES_MAX_BUFFER_SIZE

string homeassistant.components.statistics.sensor.CONF_SAMPLES_MAX_BUFFER_SIZE = "sampling_size"

Definition at line 188 of file sensor.py.

◆ CONF_STATE_CHARACTERISTIC

string homeassistant.components.statistics.sensor.CONF_STATE_CHARACTERISTIC = "state_characteristic"

Definition at line 187 of file sensor.py.

◆ DEFAULT_NAME

string homeassistant.components.statistics.sensor.DEFAULT_NAME = "Statistical characteristic"

Definition at line 194 of file sensor.py.

◆ DEFAULT_PRECISION

int homeassistant.components.statistics.sensor.DEFAULT_PRECISION = 2

Definition at line 195 of file sensor.py.

◆ ICON

string homeassistant.components.statistics.sensor.ICON = "mdi:calculator"

Definition at line 196 of file sensor.py.

◆ PLATFORM_SCHEMA

homeassistant.components.statistics.sensor.PLATFORM_SCHEMA

Initial value:

 =  vol.All(
     _PLATFORM_SCHEMA_BASE,
     valid_state_characteristic_configuration,
     valid_boundary_configuration,
     valid_keep_last_sample,
 )

Definition at line 253 of file sensor.py.

◆ STAT_AGE_COVERAGE_RATIO

string homeassistant.components.statistics.sensor.STAT_AGE_COVERAGE_RATIO = "age_coverage_ratio"

Definition at line 65 of file sensor.py.

◆ STAT_AVERAGE_LINEAR

string homeassistant.components.statistics.sensor.STAT_AVERAGE_LINEAR = "average_linear"

Definition at line 70 of file sensor.py.

◆ STAT_AVERAGE_STEP

string homeassistant.components.statistics.sensor.STAT_AVERAGE_STEP = "average_step"

Definition at line 71 of file sensor.py.

◆ STAT_AVERAGE_TIMELESS

string homeassistant.components.statistics.sensor.STAT_AVERAGE_TIMELESS = "average_timeless"

Definition at line 72 of file sensor.py.

◆ STAT_BUFFER_USAGE_RATIO

string homeassistant.components.statistics.sensor.STAT_BUFFER_USAGE_RATIO = "buffer_usage_ratio"

Definition at line 66 of file sensor.py.

◆ STAT_CHANGE

string homeassistant.components.statistics.sensor.STAT_CHANGE = "change"

Definition at line 73 of file sensor.py.

◆ STAT_CHANGE_SAMPLE

string homeassistant.components.statistics.sensor.STAT_CHANGE_SAMPLE = "change_sample"

Definition at line 74 of file sensor.py.

◆ STAT_CHANGE_SECOND

string homeassistant.components.statistics.sensor.STAT_CHANGE_SECOND = "change_second"

Definition at line 75 of file sensor.py.

◆ STAT_COUNT

string homeassistant.components.statistics.sensor.STAT_COUNT = "count"

Definition at line 76 of file sensor.py.

◆ STAT_COUNT_BINARY_OFF

string homeassistant.components.statistics.sensor.STAT_COUNT_BINARY_OFF = "count_off"

Definition at line 78 of file sensor.py.

◆ STAT_COUNT_BINARY_ON

string homeassistant.components.statistics.sensor.STAT_COUNT_BINARY_ON = "count_on"

Definition at line 77 of file sensor.py.

◆ STAT_DATETIME_NEWEST

string homeassistant.components.statistics.sensor.STAT_DATETIME_NEWEST = "datetime_newest"

Definition at line 79 of file sensor.py.

◆ STAT_DATETIME_OLDEST

string homeassistant.components.statistics.sensor.STAT_DATETIME_OLDEST = "datetime_oldest"

Definition at line 80 of file sensor.py.

◆ STAT_DATETIME_VALUE_MAX

string homeassistant.components.statistics.sensor.STAT_DATETIME_VALUE_MAX = "datetime_value_max"

Definition at line 81 of file sensor.py.

◆ STAT_DATETIME_VALUE_MIN

string homeassistant.components.statistics.sensor.STAT_DATETIME_VALUE_MIN = "datetime_value_min"

Definition at line 82 of file sensor.py.

◆ STAT_DISTANCE_95P

string homeassistant.components.statistics.sensor.STAT_DISTANCE_95P = "distance_95_percent_of_values"

Definition at line 83 of file sensor.py.

◆ STAT_DISTANCE_99P

string homeassistant.components.statistics.sensor.STAT_DISTANCE_99P = "distance_99_percent_of_values"

Definition at line 84 of file sensor.py.

◆ STAT_DISTANCE_ABSOLUTE

string homeassistant.components.statistics.sensor.STAT_DISTANCE_ABSOLUTE = "distance_absolute"

Definition at line 85 of file sensor.py.

◆ STAT_MEAN

string homeassistant.components.statistics.sensor.STAT_MEAN = "mean"

Definition at line 86 of file sensor.py.

◆ STAT_MEAN_CIRCULAR

string homeassistant.components.statistics.sensor.STAT_MEAN_CIRCULAR = "mean_circular"

Definition at line 87 of file sensor.py.

◆ STAT_MEDIAN

string homeassistant.components.statistics.sensor.STAT_MEDIAN = "median"

Definition at line 88 of file sensor.py.

◆ STAT_NOISINESS

string homeassistant.components.statistics.sensor.STAT_NOISINESS = "noisiness"

Definition at line 89 of file sensor.py.

◆ STAT_PERCENTILE

string homeassistant.components.statistics.sensor.STAT_PERCENTILE = "percentile"

Definition at line 90 of file sensor.py.

◆ STAT_SOURCE_VALUE_VALID

string homeassistant.components.statistics.sensor.STAT_SOURCE_VALUE_VALID = "source_value_valid"

Definition at line 67 of file sensor.py.

◆ STAT_STANDARD_DEVIATION

string homeassistant.components.statistics.sensor.STAT_STANDARD_DEVIATION = "standard_deviation"

Definition at line 91 of file sensor.py.

◆ STAT_SUM

string homeassistant.components.statistics.sensor.STAT_SUM = "sum"

Definition at line 92 of file sensor.py.

◆ STAT_SUM_DIFFERENCES

string homeassistant.components.statistics.sensor.STAT_SUM_DIFFERENCES = "sum_differences"

Definition at line 93 of file sensor.py.

◆ STAT_SUM_DIFFERENCES_NONNEGATIVE

string homeassistant.components.statistics.sensor.STAT_SUM_DIFFERENCES_NONNEGATIVE = "sum_differences_nonnegative"

Definition at line 94 of file sensor.py.

◆ STAT_TOTAL

string homeassistant.components.statistics.sensor.STAT_TOTAL = "total"

Definition at line 95 of file sensor.py.

◆ STAT_VALUE_MAX

string homeassistant.components.statistics.sensor.STAT_VALUE_MAX = "value_max"

Definition at line 96 of file sensor.py.

◆ STAT_VALUE_MIN

string homeassistant.components.statistics.sensor.STAT_VALUE_MIN = "value_min"

Definition at line 97 of file sensor.py.

◆ STAT_VARIANCE

string homeassistant.components.statistics.sensor.STAT_VARIANCE = "variance"

Definition at line 98 of file sensor.py.

◆ STATS_BINARY_PERCENTAGE

dictionary homeassistant.components.statistics.sensor.STATS_BINARY_PERCENTAGE

Initial value:

 =  {
     STAT_AVERAGE_STEP,
     STAT_AVERAGE_TIMELESS,
     STAT_MEAN,
 }

Definition at line 181 of file sensor.py.

◆ STATS_BINARY_SUPPORT

dictionary homeassistant.components.statistics.sensor.STATS_BINARY_SUPPORT

Initial value:

 =  {
     STAT_AVERAGE_STEP,
     STAT_AVERAGE_TIMELESS,
     STAT_COUNT,
     STAT_COUNT_BINARY_ON,
     STAT_COUNT_BINARY_OFF,
     STAT_DATETIME_NEWEST,
     STAT_DATETIME_OLDEST,
     STAT_MEAN,
 }

Definition at line 132 of file sensor.py.

◆ STATS_DATETIME

dictionary homeassistant.components.statistics.sensor.STATS_DATETIME

Initial value:

 =  {
     STAT_DATETIME_NEWEST,
     STAT_DATETIME_OLDEST,
     STAT_DATETIME_VALUE_MAX,
     STAT_DATETIME_VALUE_MIN,
 }

Definition at line 150 of file sensor.py.

◆ STATS_NOT_A_NUMBER

dictionary homeassistant.components.statistics.sensor.STATS_NOT_A_NUMBER

Initial value:

 =  {
     STAT_DATETIME_NEWEST,
     STAT_DATETIME_OLDEST,
     STAT_DATETIME_VALUE_MAX,
     STAT_DATETIME_VALUE_MIN,
 }

Definition at line 143 of file sensor.py.

◆ STATS_NUMERIC_RETAIN_UNIT

dictionary homeassistant.components.statistics.sensor.STATS_NUMERIC_RETAIN_UNIT

Initial value:

 =  {
     STAT_AVERAGE_LINEAR,
     STAT_AVERAGE_STEP,
     STAT_AVERAGE_TIMELESS,
     STAT_CHANGE,
     STAT_DISTANCE_95P,
     STAT_DISTANCE_99P,
     STAT_DISTANCE_ABSOLUTE,
     STAT_MEAN,
     STAT_MEAN_CIRCULAR,
     STAT_MEDIAN,
     STAT_NOISINESS,
     STAT_PERCENTILE,
     STAT_STANDARD_DEVIATION,
     STAT_SUM,
     STAT_SUM_DIFFERENCES,
     STAT_SUM_DIFFERENCES_NONNEGATIVE,
     STAT_TOTAL,
     STAT_VALUE_MAX,
     STAT_VALUE_MIN,
 }

Definition at line 158 of file sensor.py.

◆ STATS_NUMERIC_SUPPORT

dictionary homeassistant.components.statistics.sensor.STATS_NUMERIC_SUPPORT

Initial value:

 =  {
     STAT_AVERAGE_LINEAR,
     STAT_AVERAGE_STEP,
     STAT_AVERAGE_TIMELESS,
     STAT_CHANGE_SAMPLE,
     STAT_CHANGE_SECOND,
     STAT_CHANGE,
     STAT_COUNT,
     STAT_DATETIME_NEWEST,
     STAT_DATETIME_OLDEST,
     STAT_DATETIME_VALUE_MAX,
     STAT_DATETIME_VALUE_MIN,
     STAT_DISTANCE_95P,
     STAT_DISTANCE_99P,
     STAT_DISTANCE_ABSOLUTE,
     STAT_MEAN,
     STAT_MEAN_CIRCULAR,
     STAT_MEDIAN,
     STAT_NOISINESS,
     STAT_PERCENTILE,
     STAT_STANDARD_DEVIATION,
     STAT_SUM,
     STAT_SUM_DIFFERENCES,
     STAT_SUM_DIFFERENCES_NONNEGATIVE,
     STAT_TOTAL,
     STAT_VALUE_MAX,
     STAT_VALUE_MIN,
     STAT_VARIANCE,
 }

Definition at line 101 of file sensor.py.

Home Assistant Unofficial Reference 2024.12.1

Classes

Functions

Variables

Detailed Description

Function Documentation

◆ async_setup_entry()

◆ async_setup_platform()

◆ valid_boundary_configuration()

◆ valid_keep_last_sample()

◆ valid_state_characteristic_configuration()

Variable Documentation

◆ _LOGGER

◆ _PLATFORM_SCHEMA_BASE

◆ CONF_KEEP_LAST_SAMPLE

◆ CONF_MAX_AGE

◆ CONF_PERCENTILE

◆ CONF_PRECISION

◆ CONF_SAMPLES_MAX_BUFFER_SIZE

◆ CONF_STATE_CHARACTERISTIC

◆ DEFAULT_NAME

◆ DEFAULT_PRECISION

◆ ICON

◆ PLATFORM_SCHEMA

◆ STAT_AGE_COVERAGE_RATIO

◆ STAT_AVERAGE_LINEAR

◆ STAT_AVERAGE_STEP

◆ STAT_AVERAGE_TIMELESS

◆ STAT_BUFFER_USAGE_RATIO

◆ STAT_CHANGE

◆ STAT_CHANGE_SAMPLE

◆ STAT_CHANGE_SECOND

◆ STAT_COUNT

◆ STAT_COUNT_BINARY_OFF

◆ STAT_COUNT_BINARY_ON

◆ STAT_DATETIME_NEWEST

◆ STAT_DATETIME_OLDEST

◆ STAT_DATETIME_VALUE_MAX

◆ STAT_DATETIME_VALUE_MIN

◆ STAT_DISTANCE_95P

◆ STAT_DISTANCE_99P

◆ STAT_DISTANCE_ABSOLUTE

◆ STAT_MEAN

◆ STAT_MEAN_CIRCULAR

◆ STAT_MEDIAN

◆ STAT_NOISINESS

◆ STAT_PERCENTILE

◆ STAT_SOURCE_VALUE_VALID

◆ STAT_STANDARD_DEVIATION

◆ STAT_SUM

◆ STAT_SUM_DIFFERENCES

◆ STAT_SUM_DIFFERENCES_NONNEGATIVE

◆ STAT_TOTAL

◆ STAT_VALUE_MAX

◆ STAT_VALUE_MIN

◆ STAT_VARIANCE

◆ STATS_BINARY_PERCENTAGE

◆ STATS_BINARY_SUPPORT

◆ STATS_DATETIME

◆ STATS_NOT_A_NUMBER

◆ STATS_NUMERIC_RETAIN_UNIT

◆ STATS_NUMERIC_SUPPORT