From 9a45ffc7dcdc72ceca62e1aa9317a0892d7fc0a1 Mon Sep 17 00:00:00 2001 From: Erik Montnemery Date: Wed, 13 Oct 2021 11:25:45 +0200 Subject: [PATCH] Clarify state class total (#1082) --- docs/core/entity/sensor.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/core/entity/sensor.md b/docs/core/entity/sensor.md index dc30e8e9..303dec52 100644 --- a/docs/core/entity/sensor.md +++ b/docs/core/entity/sensor.md @@ -59,7 +59,7 @@ If specifying a device class, your sensor entity will need to also return the co | Type | Description | ---- | ----------- | measurement | The state represents _a measurement in present time_, not a historical aggregation such as statistics or a prediction of the future. Examples of what should be classified `measurement` are: current temperature, humidify or electric power. Examples of what should not be classified as `measurement`: Forecasted temperature for tomorrow, yesterday's energy consumption or anything else that doesn't include the _current_ measurement. For supported sensors, statistics of hourly min, max and average sensor readings is updated every 5 minutes. -| total | The state represents a total amount that can both increase and decrease, e.g. a net energy meter. Statistics of the accumulated growth or decline of the sensor's value since it was first added is updated every 5 minutes. +| total | The state represents a total amount that can both increase and decrease, e.g. a net energy meter. Statistics of the accumulated growth or decline of the sensor's value since it was first added is updated every 5 minutes. This state class should not be used for sensors where the absolute value is interesting instead of the accumulated growth or decline, for example remaining battery capacity or CPU load; in such cases state class `measurement` should be used instead. | total_increasing | Similar to `total`, with the restriction that the state represents a monotonically increasing positive total, e.g. a daily amount of consumed gas, weekly water consumption or lifetime energy consumption. Statistics of the accumulated growth of the sensor's value since it was first added is updated every 5 minutes.