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

Public Member Functions

def __init__ (self, *cron_pattern, delta_values, meter_offset, meter_type, name, net_consumption, parent_meter, periodically_resetting, source_entity, tariff_entity, tariff, unique_id, sensor_always_available, suggested_entity_id=None, device_info=None)
 
def async_added_to_hass (self)
 
def async_calibrate (self, value)
 
UtilitySensorExtraStoredData|None async_get_last_sensor_data (self)
 
None async_reading (self, Event[EventStateChangedData] event)
 
def async_reset_meter (self, entity_id)
 
None async_tariff_change (self, Event[EventStateChangedData] event)
 
None async_will_remove_from_hass (self)
 
Decimal|None calculate_adjustment (self, State|None old_state, State new_state)
 
def device_class (self)
 
UtilitySensorExtraStoredData extra_restore_state_data (self)
 
def extra_state_attributes (self)
 
None start (self, Mapping[str, Any] attributes)
 
def state_class (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)
 
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)
 
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_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

 entity_id
 
 scheduler
 
- 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

def _async_reset_meter (self, event)
 
None _change_status (self, str tariff)
 
def _config_scheduler (self)
 
def _program_reset (self)
 

Static Private Member Functions

Decimal|None _validate_state (State|None state)
 

Private Attributes

 _attr_available
 
 _attr_device_info
 
 _attr_name
 
 _attr_native_unit_of_measurement
 
 _attr_native_value
 
 _attr_unique_id
 
 _collecting
 
 _cron_pattern
 
 _current_tz
 
 _input_device_class
 
 _last_period
 
 _last_reset
 
 _last_valid_state
 
 _next_reset
 
 _parent_meter
 
 _period
 
 _sensor_always_available
 
 _sensor_delta_values
 
 _sensor_net_consumption
 
 _sensor_periodically_resetting
 
 _sensor_source_id
 
 _tariff
 
 _tariff_entity
 

Static Private Attributes

bool _attr_should_poll = False
 
string _attr_translation_key = "utility_meter"
 
 _unrecorded_attributes = frozenset({ATTR_NEXT_RESET})
 

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 an utility meter sensor.

Definition at line 351 of file sensor.py.

Constructor & Destructor Documentation

◆ __init__()

def homeassistant.components.utility_meter.sensor.UtilityMeterSensor.__init__ (   self,
cron_pattern,
  delta_values,
  meter_offset,
  meter_type,
  name,
  net_consumption,
  parent_meter,
  periodically_resetting,
  source_entity,
  tariff_entity,
  tariff,
  unique_id,
  sensor_always_available,
  suggested_entity_id = None,
  device_info = None 
)
Initialize the Utility Meter sensor.

Definition at line 358 of file sensor.py.

Member Function Documentation

◆ _async_reset_meter()

def homeassistant.components.utility_meter.sensor.UtilityMeterSensor._async_reset_meter (   self,
  event 
)
private
Reset the utility meter status.

Definition at line 575 of file sensor.py.

◆ _change_status()

None homeassistant.components.utility_meter.sensor.UtilityMeterSensor._change_status (   self,
str  tariff 
)
private

Definition at line 536 of file sensor.py.

◆ _config_scheduler()

def homeassistant.components.utility_meter.sensor.UtilityMeterSensor._config_scheduler (   self)
private

Definition at line 411 of file sensor.py.

◆ _program_reset()

def homeassistant.components.utility_meter.sensor.UtilityMeterSensor._program_reset (   self)
private
Program the reset of the utility meter.

Definition at line 560 of file sensor.py.

◆ _validate_state()

Decimal | None homeassistant.components.utility_meter.sensor.UtilityMeterSensor._validate_state ( State | None  state)
staticprivate
Parse the state as a Decimal if available. Throws DecimalException if the state is not a number.

Definition at line 431 of file sensor.py.

◆ async_added_to_hass()

def homeassistant.components.utility_meter.sensor.UtilityMeterSensor.async_added_to_hass (   self)
Handle entity which will be added.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 606 of file sensor.py.

◆ async_calibrate()

def homeassistant.components.utility_meter.sensor.UtilityMeterSensor.async_calibrate (   self,
  value 
)
Calibrate the Utility Meter with a given value.

Definition at line 600 of file sensor.py.

◆ async_get_last_sensor_data()

UtilitySensorExtraStoredData | None homeassistant.components.utility_meter.sensor.UtilityMeterSensor.async_get_last_sensor_data (   self)
Restore Utility Meter Sensor Extra Stored Data.

Reimplemented from homeassistant.components.sensor.RestoreSensor.

Definition at line 743 of file sensor.py.

◆ async_reading()

None homeassistant.components.utility_meter.sensor.UtilityMeterSensor.async_reading (   self,
Event[EventStateChangedData event 
)
Handle the sensor state changes.

Definition at line 474 of file sensor.py.

◆ async_reset_meter()

def homeassistant.components.utility_meter.sensor.UtilityMeterSensor.async_reset_meter (   self,
  entity_id 
)
Reset meter.

Definition at line 582 of file sensor.py.

◆ async_tariff_change()

None homeassistant.components.utility_meter.sensor.UtilityMeterSensor.async_tariff_change (   self,
Event[EventStateChangedData event 
)
Handle tariff changes.

Definition at line 529 of file sensor.py.

◆ async_will_remove_from_hass()

None homeassistant.components.utility_meter.sensor.UtilityMeterSensor.async_will_remove_from_hass (   self)
Run when entity will be removed from hass.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 681 of file sensor.py.

◆ calculate_adjustment()

Decimal | None homeassistant.components.utility_meter.sensor.UtilityMeterSensor.calculate_adjustment (   self,
State | None  old_state,
State   new_state 
)
Calculate the adjustment based on the old and new state.

Definition at line 442 of file sensor.py.

◆ device_class()

def homeassistant.components.utility_meter.sensor.UtilityMeterSensor.device_class (   self)
Return the device class of the sensor.

Reimplemented from homeassistant.components.sensor.SensorEntity.

Definition at line 688 of file sensor.py.

◆ extra_restore_state_data()

UtilitySensorExtraStoredData homeassistant.components.utility_meter.sensor.UtilityMeterSensor.extra_restore_state_data (   self)
Return sensor specific state data to be restored.

Reimplemented from homeassistant.components.sensor.RestoreSensor.

Definition at line 731 of file sensor.py.

◆ extra_state_attributes()

def homeassistant.components.utility_meter.sensor.UtilityMeterSensor.extra_state_attributes (   self)
Return the state attributes of the sensor.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 709 of file sensor.py.

◆ start()

None homeassistant.components.utility_meter.sensor.UtilityMeterSensor.start (   self,
Mapping[str, Any]  attributes 
)
Initialize unit and state upon source initial update.

Definition at line 423 of file sensor.py.

◆ state_class()

def homeassistant.components.utility_meter.sensor.UtilityMeterSensor.state_class (   self)
Return the device class of the sensor.

Reimplemented from homeassistant.components.sensor.SensorEntity.

Definition at line 700 of file sensor.py.

Member Data Documentation

◆ _attr_available

homeassistant.components.utility_meter.sensor.UtilityMeterSensor._attr_available
private

Definition at line 480 of file sensor.py.

◆ _attr_device_info

homeassistant.components.utility_meter.sensor.UtilityMeterSensor._attr_device_info
private

Definition at line 379 of file sensor.py.

◆ _attr_name

homeassistant.components.utility_meter.sensor.UtilityMeterSensor._attr_name
private

Definition at line 387 of file sensor.py.

◆ _attr_native_unit_of_measurement

homeassistant.components.utility_meter.sensor.UtilityMeterSensor._attr_native_unit_of_measurement
private

Definition at line 389 of file sensor.py.

◆ _attr_native_value

homeassistant.components.utility_meter.sensor.UtilityMeterSensor._attr_native_value
private

Definition at line 427 of file sensor.py.

◆ _attr_should_poll

bool homeassistant.components.utility_meter.sensor.UtilityMeterSensor._attr_should_poll = False
staticprivate

Definition at line 355 of file sensor.py.

◆ _attr_translation_key

string homeassistant.components.utility_meter.sensor.UtilityMeterSensor._attr_translation_key = "utility_meter"
staticprivate

Definition at line 354 of file sensor.py.

◆ _attr_unique_id

homeassistant.components.utility_meter.sensor.UtilityMeterSensor._attr_unique_id
private

Definition at line 378 of file sensor.py.

◆ _collecting

homeassistant.components.utility_meter.sensor.UtilityMeterSensor._collecting
private

Definition at line 386 of file sensor.py.

◆ _cron_pattern

homeassistant.components.utility_meter.sensor.UtilityMeterSensor._cron_pattern
private

Definition at line 393 of file sensor.py.

◆ _current_tz

homeassistant.components.utility_meter.sensor.UtilityMeterSensor._current_tz
private

Definition at line 408 of file sensor.py.

◆ _input_device_class

homeassistant.components.utility_meter.sensor.UtilityMeterSensor._input_device_class
private

Definition at line 388 of file sensor.py.

◆ _last_period

homeassistant.components.utility_meter.sensor.UtilityMeterSensor._last_period
private

Definition at line 383 of file sensor.py.

◆ _last_reset

homeassistant.components.utility_meter.sensor.UtilityMeterSensor._last_reset
private

Definition at line 384 of file sensor.py.

◆ _last_valid_state

homeassistant.components.utility_meter.sensor.UtilityMeterSensor._last_valid_state
private

Definition at line 385 of file sensor.py.

◆ _next_reset

homeassistant.components.utility_meter.sensor.UtilityMeterSensor._next_reset
private

Definition at line 407 of file sensor.py.

◆ _parent_meter

homeassistant.components.utility_meter.sensor.UtilityMeterSensor._parent_meter
private

Definition at line 381 of file sensor.py.

◆ _period

homeassistant.components.utility_meter.sensor.UtilityMeterSensor._period
private

Definition at line 390 of file sensor.py.

◆ _sensor_always_available

homeassistant.components.utility_meter.sensor.UtilityMeterSensor._sensor_always_available
private

Definition at line 401 of file sensor.py.

◆ _sensor_delta_values

homeassistant.components.utility_meter.sensor.UtilityMeterSensor._sensor_delta_values
private

Definition at line 402 of file sensor.py.

◆ _sensor_net_consumption

homeassistant.components.utility_meter.sensor.UtilityMeterSensor._sensor_net_consumption
private

Definition at line 403 of file sensor.py.

◆ _sensor_periodically_resetting

homeassistant.components.utility_meter.sensor.UtilityMeterSensor._sensor_periodically_resetting
private

Definition at line 404 of file sensor.py.

◆ _sensor_source_id

homeassistant.components.utility_meter.sensor.UtilityMeterSensor._sensor_source_id
private

Definition at line 382 of file sensor.py.

◆ _tariff

homeassistant.components.utility_meter.sensor.UtilityMeterSensor._tariff
private

Definition at line 405 of file sensor.py.

◆ _tariff_entity

homeassistant.components.utility_meter.sensor.UtilityMeterSensor._tariff_entity
private

Definition at line 406 of file sensor.py.

◆ _unrecorded_attributes

homeassistant.components.utility_meter.sensor.UtilityMeterSensor._unrecorded_attributes = frozenset({ATTR_NEXT_RESET})
staticprivate

Definition at line 356 of file sensor.py.

◆ entity_id

homeassistant.components.utility_meter.sensor.UtilityMeterSensor.entity_id

Definition at line 380 of file sensor.py.

◆ scheduler

homeassistant.components.utility_meter.sensor.UtilityMeterSensor.scheduler

Definition at line 412 of file sensor.py.


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