homeassistant.components.group.sensor.SensorGroup Class Reference

Inheritance diagram for homeassistant.components.group.sensor.SensorGroup:

Collaboration diagram for homeassistant.components.group.sensor.SensorGroup:

Public Member Functions
None	__init__ (self, HomeAssistant hass, str|None unique_id, str name, list[str] entity_ids, bool ignore_non_numeric, str sensor_type, str|None unit_of_measurement, SensorStateClass|None state_class, SensorDeviceClass|None device_class)
None	async_update_group_state (self)
None	calculate_state_attributes (self, list[str] valid_state_entities)
dict[str, Any]	extra_state_attributes (self)
str|None	icon (self)
Public Member Functions inherited from homeassistant.components.group.entity.GroupEntity
None	async_added_to_hass (self)
None	async_defer_or_update_ha_state (self)
CALLBACK_TYPE	async_start_preview (self, Callable[[str, Mapping[str, Any]], None] preview_callback)
None	async_update_supported_features (self, str entity_id, State|None new_state)
Public Member Functions inherited from homeassistant.helpers.entity.Entity
None	__init_subclass__ (cls, **Any kwargs)
str	__repr__ (self)
None	add_to_platform_abort (self)
None	add_to_platform_finish (self)
bool	assumed_state (self)
None	async_device_update (self, bool warning=True)
None	async_internal_will_remove_from_hass (self)
None	async_on_remove (self, CALLBACK_TYPE func)
None	async_remove (self, *bool force_remove=False)
None	async_removed_from_registry (self)
None	async_schedule_update_ha_state (self, bool force_refresh=False)
None	async_set_context (self, Context context)
None	async_update_ha_state (self, bool force_refresh=False)
None	async_will_remove_from_hass (self)
None	async_write_ha_state (self)
str|None	attribution (self)
bool	available (self)
DeviceInfo|None	device_info (self)
bool	enabled (self)
EntityCategory|None	entity_category (self)
str|None	entity_picture (self)
bool	entity_registry_enabled_default (self)
bool	entity_registry_visible_default (self)
bool	force_update (self)
HassJobType	get_hassjob_type (self, str function_name)
bool	has_entity_name (self)
str|UndefinedType|None	name (self)
None	schedule_update_ha_state (self, bool force_refresh=False)
bool	should_poll (self)
str|None	suggested_object_id (self)
int|None	supported_features (self)
str|None	translation_key (self)
Mapping[str, str]	translation_placeholders (self)
str|None	unique_id (self)
bool	use_device_name (self)
Public Member Functions inherited from homeassistant.helpers.entity.CachedProperties
None	__init__ (cls, str name, tuple[type,...] bases, dict[Any, Any] namespace, **Any kwargs)
Any	__new__ (mcs, str name, tuple[type,...] bases, dict[Any, Any] namespace, set[str]|None cached_properties=None, **Any kwargs)
Public Member Functions inherited from homeassistant.components.sensor.SensorEntity
None	add_to_platform_start (self, HomeAssistant hass, EntityPlatform platform, asyncio.Semaphore|None parallel_updates)
None	async_internal_added_to_hass (self)
None	async_registry_entry_updated (self)
dict[str, Any]|None	capability_attributes (self)
SensorDeviceClass|None	device_class (self)
er.EntityOptionsType|None	get_initial_entity_options (self)
datetime|None	last_reset (self)
str|None	native_unit_of_measurement (self)
StateType|date|datetime|Decimal	native_value (self)
list[str]|None	options (self)
Any	state (self)
dict[str, Any]|None	state_attributes (self)
SensorStateClass|str|None	state_class (self)
int|None	suggested_display_precision (self)
str|None	suggested_unit_of_measurement (self)
str|None	unit_of_measurement (self)

Public Attributes
	hass
	mode
Public Attributes inherited from homeassistant.helpers.entity.Entity
	device_entry
	entity_id
	hass
	parallel_updates
	platform
	registry_entry
Public Attributes inherited from homeassistant.components.sensor.SensorEntity
	entity_category
	registry_entry
	unit_of_measurement

Private Member Functions
SensorDeviceClass|None	_calculate_device_class (self, SensorDeviceClass|None device_class, list[str] valid_state_entities)
SensorStateClass|None	_calculate_state_class (self, SensorStateClass|None state_class, list[str] valid_state_entities)
str|None	_calculate_unit_of_measurement (self, str|None unit_of_measurement, list[str] valid_state_entities)
list[str]	_get_valid_entities (self)
set[str|None]	_get_valid_units (self)

Private Attributes
	_attr_available
	_attr_device_class
	_attr_extra_state_attributes
	_attr_name
	_attr_native_unit_of_measurement
	_attr_native_value
	_attr_state_class
	_attr_unique_id
	_can_convert
	_configured_device_class
	_configured_state_class
	_configured_unit_of_measurement
	_entity_ids
	_ignore_non_numeric
	_sensor_type
	_valid_units

Static Private Attributes
bool	_attr_available = False
bool	_attr_should_poll = False

Additional Inherited Members
Static Public Attributes inherited from homeassistant.helpers.entity.Entity
	bool
	EntityPlatform
	HomeAssistant
	None
	StateInfo
	StateType
	str
Static Public Attributes inherited from homeassistant.components.sensor.SensorEntity
	Decimal
	None
	UndefinedType

Detailed Description

Representation of a sensor group.

Definition at line 316 of file sensor.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.group.sensor.SensorGroup.__init__	(		self,
		HomeAssistant	hass,
		str | None	unique_id,
		str	name,
		list[str]	entity_ids,
		bool	ignore_non_numeric,
		str	sensor_type,
		str | None	unit_of_measurement,
		SensorStateClass | None	state_class,
		SensorDeviceClass | None	device_class
	)

Initialize a sensor group.

Definition at line 322 of file sensor.py.

Member Function Documentation

_calculate_device_class()

SensorDeviceClass | None homeassistant.components.group.sensor.SensorGroup._calculate_device_class (   self, SensorDeviceClass | None  device_class, list[str]  valid_state_entities  )

private

Calculate device class.

If user has configured a device class we will use that.
If a device class is not set then test if same device class
on source entities and use that.
Otherwise return no device class.

Definition at line 523 of file sensor.py.

_calculate_state_class()

SensorStateClass | None homeassistant.components.group.sensor.SensorGroup._calculate_state_class (   self, SensorStateClass | None  state_class, list[str]  valid_state_entities  )

private

Calculate state class.

If user has configured a state class we will use that.
If a state class is not set then test if same state class
on source entities and use that.
Otherwise return no state class.

Definition at line 468 of file sensor.py.

_calculate_unit_of_measurement()

str | None homeassistant.components.group.sensor.SensorGroup._calculate_unit_of_measurement (   self, str | None  unit_of_measurement, list[str]  valid_state_entities  )

private

Calculate the unit of measurement.

If user has configured a unit of measurement we will use that.
If a device class is set then test if unit of measurements are compatible.
If no device class or uom's not compatible we will use no unit of measurement.

Definition at line 580 of file sensor.py.

_get_valid_entities()

list[str] homeassistant.components.group.sensor.SensorGroup._get_valid_entities (   self )

private

Return list of valid entities.

Definition at line 707 of file sensor.py.

_get_valid_units()

set[str | None] homeassistant.components.group.sensor.SensorGroup._get_valid_units (   self )

private

Return valid units.

If device class is set and compatible unit of measurements.
If device class is not set, use one unit of measurement.
Only calculate valid units if there are no valid units set.

Definition at line 684 of file sensor.py.

async_update_group_state()

None homeassistant.components.group.sensor.SensorGroup.async_update_group_state

(

self

)

Query all members and determine the sensor group state.

Reimplemented from homeassistant.components.group.entity.GroupEntity.

Definition at line 371 of file sensor.py.

calculate_state_attributes()

None homeassistant.components.group.sensor.SensorGroup.calculate_state_attributes	(		self,
		list[str]	valid_state_entities
	)

Calculate state attributes.

Definition at line 357 of file sensor.py.

extra_state_attributes()

dict[str, Any] homeassistant.components.group.sensor.SensorGroup.extra_state_attributes

(

self

)

Return the state attributes of the sensor.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 454 of file sensor.py.

icon()

str | None homeassistant.components.group.sensor.SensorGroup.icon

(

self

)

Return the icon.

Only override the icon if the device class is not set.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 459 of file sensor.py.

Member Data Documentation

_attr_available [1/2]

bool homeassistant.components.group.sensor.SensorGroup._attr_available = False

staticprivate

Definition at line 319 of file sensor.py.

_attr_available [2/2]

homeassistant.components.group.sensor.SensorGroup._attr_available

private

Definition at line 437 of file sensor.py.

_attr_device_class

homeassistant.components.group.sensor.SensorGroup._attr_device_class

private

Definition at line 362 of file sensor.py.

_attr_extra_state_attributes

homeassistant.components.group.sensor.SensorGroup._attr_extra_state_attributes

private

Definition at line 346 of file sensor.py.

_attr_name

homeassistant.components.group.sensor.SensorGroup._attr_name

private

Definition at line 343 of file sensor.py.

_attr_native_unit_of_measurement

homeassistant.components.group.sensor.SensorGroup._attr_native_unit_of_measurement

private

Definition at line 365 of file sensor.py.

_attr_native_value

homeassistant.components.group.sensor.SensorGroup._attr_native_value

private

Definition at line 445 of file sensor.py.

_attr_should_poll

bool homeassistant.components.group.sensor.SensorGroup._attr_should_poll = False

staticprivate

Definition at line 320 of file sensor.py.

_attr_state_class

homeassistant.components.group.sensor.SensorGroup._attr_state_class

private

Definition at line 359 of file sensor.py.

_attr_unique_id

homeassistant.components.group.sensor.SensorGroup._attr_unique_id

private

Definition at line 347 of file sensor.py.

_can_convert

homeassistant.components.group.sensor.SensorGroup._can_convert

private

Definition at line 698 of file sensor.py.

_configured_device_class

homeassistant.components.group.sensor.SensorGroup._configured_device_class

private

Definition at line 339 of file sensor.py.

_configured_state_class

homeassistant.components.group.sensor.SensorGroup._configured_state_class

private

Definition at line 338 of file sensor.py.

_configured_unit_of_measurement

homeassistant.components.group.sensor.SensorGroup._configured_unit_of_measurement

private

Definition at line 340 of file sensor.py.

_entity_ids

homeassistant.components.group.sensor.SensorGroup._entity_ids

private

Definition at line 336 of file sensor.py.

_ignore_non_numeric

homeassistant.components.group.sensor.SensorGroup._ignore_non_numeric

private

Definition at line 348 of file sensor.py.

_sensor_type

homeassistant.components.group.sensor.SensorGroup._sensor_type

private

Definition at line 337 of file sensor.py.

_valid_units

homeassistant.components.group.sensor.SensorGroup._valid_units

private

Definition at line 368 of file sensor.py.

hass

homeassistant.components.group.sensor.SensorGroup.hass

Definition at line 335 of file sensor.py.

mode

homeassistant.components.group.sensor.SensorGroup.mode

Definition at line 349 of file sensor.py.

---

The documentation for this class was generated from the following file:

• core/homeassistant/components/group/sensor.py