Classes
class	MinMaxSensor

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

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

tuple[str\|None, float\|None]	calc_max (list[tuple[str, Any]] sensor_values)

float\|None	calc_mean (list[tuple[str, Any]] sensor_values, int round_digits)

float\|None	calc_median (list[tuple[str, Any]] sensor_values, int round_digits)

tuple[str\|None, float\|None]	calc_min (list[tuple[str, Any]] sensor_values)

float\|None	calc_range (list[tuple[str, Any]] sensor_values, int round_digits)

float\|None	calc_sum (list[tuple[str, Any]] sensor_values, int round_digits)

Variables
	_LOGGER = logging.getLogger(__name__)

string	ATTR_LAST = "last"

string	ATTR_LAST_ENTITY_ID = "last_entity_id"

string	ATTR_MAX_ENTITY_ID = "max_entity_id"

string	ATTR_MAX_VALUE = "max_value"

string	ATTR_MEAN = "mean"

string	ATTR_MEDIAN = "median"

string	ATTR_MIN_ENTITY_ID = "min_entity_id"

string	ATTR_MIN_VALUE = "min_value"

string	ATTR_RANGE = "range"

string	ATTR_SUM = "sum"

string	ICON = "mdi:calculator"

	PLATFORM_SCHEMA

dictionary	SENSOR_TYPE_TO_ATTR = {v: k for k, v in SENSOR_TYPES.items()}

dictionary	SENSOR_TYPES

Detailed Description

Support for displaying minimal, maximal, mean or median values.

Function Documentation

◆ async_setup_entry()

None homeassistant.components.min_max.sensor.async_setup_entry	(	HomeAssistant	hass,
		ConfigEntry	config_entry,
		AddEntitiesCallback	async_add_entities
	)

Initialize min/max/mean config entry.

Definition at line 75 of file sensor.py.

◆ async_setup_platform()

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

Set up the min/max/mean sensor.

Definition at line 101 of file sensor.py.

◆ calc_max()

tuple[str | None, float | None] homeassistant.components.min_max.sensor.calc_max ( list[tuple[str, Any]] sensor_values )

Calculate max value, honoring unknown states.

Definition at line 133 of file sensor.py.

◆ calc_mean()

float \| None homeassistant.components.min_max.sensor.calc_mean	(	list[tuple[str, Any]]	sensor_values,
		int	round_digits
	)

Calculate mean value, honoring unknown states.

Definition at line 145 of file sensor.py.

◆ calc_median()

float \| None homeassistant.components.min_max.sensor.calc_median	(	list[tuple[str, Any]]	sensor_values,
		int	round_digits
	)

Calculate median value, honoring unknown states.

Definition at line 159 of file sensor.py.

◆ calc_min()

tuple[str | None, float | None] homeassistant.components.min_max.sensor.calc_min ( list[tuple[str, Any]] sensor_values )

Calculate min value, honoring unknown states.

Definition at line 121 of file sensor.py.

◆ calc_range()

float \| None homeassistant.components.min_max.sensor.calc_range	(	list[tuple[str, Any]]	sensor_values,
		int	round_digits
	)

Calculate range value, honoring unknown states.

Definition at line 175 of file sensor.py.

◆ calc_sum()

float \| None homeassistant.components.min_max.sensor.calc_sum	(	list[tuple[str, Any]]	sensor_values,
		int	round_digits
	)

Calculate a sum of values, not honoring unknown states.

Definition at line 189 of file sensor.py.

Variable Documentation

◆ _LOGGER

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

private

Definition at line 36 of file sensor.py.

◆ ATTR_LAST

string homeassistant.components.min_max.sensor.ATTR_LAST = "last"

Definition at line 44 of file sensor.py.

◆ ATTR_LAST_ENTITY_ID

string homeassistant.components.min_max.sensor.ATTR_LAST_ENTITY_ID = "last_entity_id"

Definition at line 45 of file sensor.py.

◆ ATTR_MAX_ENTITY_ID

string homeassistant.components.min_max.sensor.ATTR_MAX_ENTITY_ID = "max_entity_id"

Definition at line 41 of file sensor.py.

◆ ATTR_MAX_VALUE

string homeassistant.components.min_max.sensor.ATTR_MAX_VALUE = "max_value"

Definition at line 40 of file sensor.py.

◆ ATTR_MEAN

string homeassistant.components.min_max.sensor.ATTR_MEAN = "mean"

Definition at line 42 of file sensor.py.

◆ ATTR_MEDIAN

string homeassistant.components.min_max.sensor.ATTR_MEDIAN = "median"

Definition at line 43 of file sensor.py.

◆ ATTR_MIN_ENTITY_ID

string homeassistant.components.min_max.sensor.ATTR_MIN_ENTITY_ID = "min_entity_id"

Definition at line 39 of file sensor.py.

◆ ATTR_MIN_VALUE

string homeassistant.components.min_max.sensor.ATTR_MIN_VALUE = "min_value"

Definition at line 38 of file sensor.py.

◆ ATTR_RANGE

string homeassistant.components.min_max.sensor.ATTR_RANGE = "range"

Definition at line 46 of file sensor.py.

◆ ATTR_SUM

string homeassistant.components.min_max.sensor.ATTR_SUM = "sum"

Definition at line 47 of file sensor.py.

◆ ICON

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

Definition at line 49 of file sensor.py.

◆ PLATFORM_SCHEMA

homeassistant.components.min_max.sensor.PLATFORM_SCHEMA

Initial value:

 =  SENSOR_PLATFORM_SCHEMA.extend(
     {
         vol.Optional(CONF_TYPE, default=SENSOR_TYPES[ATTR_MAX_VALUE]): vol.All(
             cv.string, vol.In(SENSOR_TYPES.values())
         ),
         vol.Optional(CONF_NAME): cv.string,
         vol.Required(CONF_ENTITY_IDS): cv.entity_ids,
         vol.Optional(CONF_ROUND_DIGITS, default=2): vol.Coerce(int),
         vol.Optional(CONF_UNIQUE_ID): cv.string,
     }
 )

Definition at line 62 of file sensor.py.

◆ SENSOR_TYPE_TO_ATTR

dictionary homeassistant.components.min_max.sensor.SENSOR_TYPE_TO_ATTR = {v: k for k, v in SENSOR_TYPES.items()}

Definition at line 60 of file sensor.py.

◆ SENSOR_TYPES

dictionary homeassistant.components.min_max.sensor.SENSOR_TYPES