Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.min_max.sensor.MinMaxSensor Class Reference
Inheritance diagram for homeassistant.components.min_max.sensor.MinMaxSensor:
[legend]
Collaboration diagram for homeassistant.components.min_max.sensor.MinMaxSensor:
[legend]

Public Member Functions

None __init__ (self, list[str] entity_ids, str|None name, str sensor_type, int round_digits, str|None unique_id)
 
None async_added_to_hass (self)
 
dict[str, Any]|None extra_state_attributes (self)
 
str|None native_unit_of_measurement (self)
 
StateType|datetime native_value (self)
 
- 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)
 
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 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|None icon (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, strtranslation_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 Attributes

 count_sensors
 
 last
 
 last_entity_id
 
 max_value
 
 mean
 
 median
 
 min_value
 
 range
 
 sum
 
- Public Attributes inherited from homeassistant.components.sensor.SensorEntity
 entity_category
 
 registry_entry
 
 unit_of_measurement
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 

Private Member Functions

None _async_min_max_sensor_state_listener (self, Event[EventStateChangedData] event, bool update_state=True)
 
None _calc_values (self)
 

Private Attributes

 _attr_name
 
 _attr_unique_id
 
 _entity_ids
 
 _round_digits
 
 _sensor_attr
 
 _sensor_type
 
 _unit_of_measurement
 
 _unit_of_measurement_mismatch
 

Static Private Attributes

 _attr_icon = ICON
 
bool _attr_should_poll = False
 
 _attr_state_class = SensorStateClass.MEASUREMENT
 

Additional Inherited Members

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

Detailed Description

Representation of a min/max sensor.

Definition at line 201 of file sensor.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.min_max.sensor.MinMaxSensor.__init__ (   self,
list[str entity_ids,
str | None  name,
str  sensor_type,
int  round_digits,
str | None  unique_id 
)
Initialize the min/max sensor.

Definition at line 208 of file sensor.py.

Member Function Documentation

◆ _async_min_max_sensor_state_listener()

None homeassistant.components.min_max.sensor.MinMaxSensor._async_min_max_sensor_state_listener (   self,
Event[EventStateChangedData event,
bool   update_state = True 
)
private
Handle the sensor state changes.

Definition at line 287 of file sensor.py.

◆ _calc_values()

None homeassistant.components.min_max.sensor.MinMaxSensor._calc_values (   self)
private
Calculate the values.

Definition at line 340 of file sensor.py.

◆ async_added_to_hass()

None homeassistant.components.min_max.sensor.MinMaxSensor.async_added_to_hass (   self)
Handle added to Hass.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 242 of file sensor.py.

◆ extra_state_attributes()

dict[str, Any] | None homeassistant.components.min_max.sensor.MinMaxSensor.extra_state_attributes (   self)
Return the state attributes of the sensor.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 276 of file sensor.py.

◆ native_unit_of_measurement()

str | None homeassistant.components.min_max.sensor.MinMaxSensor.native_unit_of_measurement (   self)
Return the unit the value is expressed in.

Reimplemented from homeassistant.components.sensor.SensorEntity.

Definition at line 269 of file sensor.py.

◆ native_value()

StateType | datetime homeassistant.components.min_max.sensor.MinMaxSensor.native_value (   self)
Return the state of the sensor.

Reimplemented from homeassistant.components.sensor.SensorEntity.

Definition at line 261 of file sensor.py.

Member Data Documentation

◆ _attr_icon

homeassistant.components.min_max.sensor.MinMaxSensor._attr_icon = ICON
staticprivate

Definition at line 204 of file sensor.py.

◆ _attr_name

homeassistant.components.min_max.sensor.MinMaxSensor._attr_name
private

Definition at line 223 of file sensor.py.

◆ _attr_should_poll

bool homeassistant.components.min_max.sensor.MinMaxSensor._attr_should_poll = False
staticprivate

Definition at line 205 of file sensor.py.

◆ _attr_state_class

homeassistant.components.min_max.sensor.MinMaxSensor._attr_state_class = SensorStateClass.MEASUREMENT
staticprivate

Definition at line 206 of file sensor.py.

◆ _attr_unique_id

homeassistant.components.min_max.sensor.MinMaxSensor._attr_unique_id
private

Definition at line 217 of file sensor.py.

◆ _entity_ids

homeassistant.components.min_max.sensor.MinMaxSensor._entity_ids
private

Definition at line 218 of file sensor.py.

◆ _round_digits

homeassistant.components.min_max.sensor.MinMaxSensor._round_digits
private

Definition at line 220 of file sensor.py.

◆ _sensor_attr

homeassistant.components.min_max.sensor.MinMaxSensor._sensor_attr
private

Definition at line 226 of file sensor.py.

◆ _sensor_type

homeassistant.components.min_max.sensor.MinMaxSensor._sensor_type
private

Definition at line 219 of file sensor.py.

◆ _unit_of_measurement

homeassistant.components.min_max.sensor.MinMaxSensor._unit_of_measurement
private

Definition at line 227 of file sensor.py.

◆ _unit_of_measurement_mismatch

homeassistant.components.min_max.sensor.MinMaxSensor._unit_of_measurement_mismatch
private

Definition at line 228 of file sensor.py.

◆ count_sensors

homeassistant.components.min_max.sensor.MinMaxSensor.count_sensors

Definition at line 239 of file sensor.py.

◆ last

homeassistant.components.min_max.sensor.MinMaxSensor.last

Definition at line 326 of file sensor.py.

◆ last_entity_id

homeassistant.components.min_max.sensor.MinMaxSensor.last_entity_id

Definition at line 327 of file sensor.py.

◆ max_value

homeassistant.components.min_max.sensor.MinMaxSensor.max_value

Definition at line 348 of file sensor.py.

◆ mean

homeassistant.components.min_max.sensor.MinMaxSensor.mean

Definition at line 349 of file sensor.py.

◆ median

homeassistant.components.min_max.sensor.MinMaxSensor.median

Definition at line 350 of file sensor.py.

◆ min_value

homeassistant.components.min_max.sensor.MinMaxSensor.min_value

Definition at line 347 of file sensor.py.

◆ range

homeassistant.components.min_max.sensor.MinMaxSensor.range

Definition at line 351 of file sensor.py.

◆ sum

homeassistant.components.min_max.sensor.MinMaxSensor.sum

Definition at line 352 of file sensor.py.


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