Classes
class	SensorGroup

Functions
bool	_has_numeric_state (HomeAssistant hass, str entity_id)

SensorGroup	async_create_preview_sensor (HomeAssistant hass, str name, dict[str, Any] validated_config)

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[dict[str, str\|None], float\|None]	calc_last (list[tuple[str, float, State]] sensor_values)

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

tuple[dict[str, str\|None], float\|None]	calc_mean (list[tuple[str, float, State]] sensor_values)

tuple[dict[str, str\|None], float\|None]	calc_median (list[tuple[str, float, State]] sensor_values)

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

tuple[dict[str, str\|None], float]	calc_product (list[tuple[str, float, State]] sensor_values)

tuple[dict[str, str\|None], float]	calc_range (list[tuple[str, float, State]] sensor_values)

tuple[dict[str, str\|None], float]	calc_stdev (list[tuple[str, float, State]] sensor_values)

tuple[dict[str, str\|None], float]	calc_sum (list[tuple[str, float, State]] sensor_values)

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_PRODUCT = "product"

string	ATTR_RANGE = "range"

string	ATTR_STDEV = "stdev"

string	ATTR_SUM = "sum"

string	DEFAULT_NAME = "Sensor Group"

int	PARALLEL_UPDATES = 0

	PLATFORM_SCHEMA

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

dictionary	SENSOR_TYPES

Detailed Description

Platform allowing several sensors to be grouped into one sensor to provide numeric combinations.

Function Documentation

◆ _has_numeric_state()

bool homeassistant.components.group.sensor._has_numeric_state	(	HomeAssistant	hass,
		str	entity_id
	)

private

Test if state is numeric.

Definition at line 175 of file sensor.py.

◆ async_create_preview_sensor()

SensorGroup homeassistant.components.group.sensor.async_create_preview_sensor	(	HomeAssistant	hass,
		str	name,
		dict[str, Any]	validated_config
	)

Create a preview sensor.

Definition at line 158 of file sensor.py.

◆ async_setup_entry()

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

Initialize Switch Group config entry.

Definition at line 130 of file sensor.py.

◆ async_setup_platform()

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

Set up the Switch Group platform.

Definition at line 106 of file sensor.py.

◆ calc_last()

tuple[dict[str, str | None], float | None] homeassistant.components.group.sensor.calc_last ( list[tuple[str, float, State]] sensor_values )

Calculate last value.

Definition at line 238 of file sensor.py.

◆ calc_max()

tuple[dict[str, str | None], float | None] homeassistant.components.group.sensor.calc_max ( list[tuple[str, float, State]] sensor_values )

Calculate max value.

Definition at line 202 of file sensor.py.

◆ calc_mean()

tuple[dict[str, str | None], float | None] homeassistant.components.group.sensor.calc_mean ( list[tuple[str, float, State]] sensor_values )

Calculate mean value.

Definition at line 218 of file sensor.py.

◆ calc_median()

tuple[dict[str, str | None], float | None] homeassistant.components.group.sensor.calc_median ( list[tuple[str, float, State]] sensor_values )

Calculate median value.

Definition at line 228 of file sensor.py.

◆ calc_min()

tuple[dict[str, str | None], float | None] homeassistant.components.group.sensor.calc_min ( list[tuple[str, float, State]] sensor_values )

Calculate min value.

Definition at line 186 of file sensor.py.

◆ calc_product()

tuple[dict[str, str | None], float] homeassistant.components.group.sensor.calc_product ( list[tuple[str, float, State]] sensor_values )

Calculate a product of values.

Definition at line 287 of file sensor.py.

◆ calc_range()

tuple[dict[str, str | None], float] homeassistant.components.group.sensor.calc_range ( list[tuple[str, float, State]] sensor_values )

Calculate range value.

Definition at line 255 of file sensor.py.

◆ calc_stdev()

tuple[dict[str, str | None], float] homeassistant.components.group.sensor.calc_stdev ( list[tuple[str, float, State]] sensor_values )

Calculate standard deviation value.

Definition at line 266 of file sensor.py.

◆ calc_sum()

tuple[dict[str, str | None], float] homeassistant.components.group.sensor.calc_sum ( list[tuple[str, float, State]] sensor_values )

Calculate a sum of values.

Definition at line 276 of file sensor.py.

Variable Documentation

◆ _LOGGER

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

private

Definition at line 103 of file sensor.py.

◆ ATTR_LAST

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

Definition at line 66 of file sensor.py.

◆ ATTR_LAST_ENTITY_ID

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

Definition at line 67 of file sensor.py.

◆ ATTR_MAX_ENTITY_ID

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

Definition at line 63 of file sensor.py.

◆ ATTR_MAX_VALUE

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

Definition at line 62 of file sensor.py.

◆ ATTR_MEAN

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

Definition at line 64 of file sensor.py.

◆ ATTR_MEDIAN

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

Definition at line 65 of file sensor.py.

◆ ATTR_MIN_ENTITY_ID

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

Definition at line 61 of file sensor.py.

◆ ATTR_MIN_VALUE

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

Definition at line 60 of file sensor.py.

◆ ATTR_PRODUCT

string homeassistant.components.group.sensor.ATTR_PRODUCT = "product"

Definition at line 71 of file sensor.py.

◆ ATTR_RANGE

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

Definition at line 68 of file sensor.py.

◆ ATTR_STDEV

string homeassistant.components.group.sensor.ATTR_STDEV = "stdev"

Definition at line 69 of file sensor.py.

◆ ATTR_SUM

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

Definition at line 70 of file sensor.py.

◆ DEFAULT_NAME

string homeassistant.components.group.sensor.DEFAULT_NAME = "Sensor Group"

Definition at line 58 of file sensor.py.

◆ PARALLEL_UPDATES

int homeassistant.components.group.sensor.PARALLEL_UPDATES = 0

Definition at line 86 of file sensor.py.

◆ PLATFORM_SCHEMA

homeassistant.components.group.sensor.PLATFORM_SCHEMA

Initial value:

 =  SENSOR_PLATFORM_SCHEMA.extend(
     {
         vol.Required(CONF_ENTITIES): cv.entities_domain(
             [SENSOR_DOMAIN, NUMBER_DOMAIN, INPUT_NUMBER_DOMAIN]
         ),
         vol.Required(CONF_TYPE): vol.All(cv.string, vol.In(SENSOR_TYPES.values())),
         vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
         vol.Optional(CONF_UNIQUE_ID): cv.string,
         vol.Optional(CONF_IGNORE_NON_NUMERIC, default=False): cv.boolean,
         vol.Optional(CONF_UNIT_OF_MEASUREMENT): str,
         vol.Optional(CONF_DEVICE_CLASS): DEVICE_CLASSES_SCHEMA,
         vol.Optional(CONF_STATE_CLASS): STATE_CLASSES_SCHEMA,
     }
 )

Definition at line 88 of file sensor.py.

◆ SENSOR_TYPE_TO_ATTR

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

Definition at line 83 of file sensor.py.

◆ SENSOR_TYPES

dictionary homeassistant.components.group.sensor.SENSOR_TYPES