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

Public Member Functions

None __init__ (self, SourceAdapter adapter, Mapping[str, Any] config)
 
None add_to_platform_abort (self)
 
None async_added_to_hass (self)
 
None async_will_remove_from_hass (self)
 
str|None native_unit_of_measurement (self)
 
str|None unique_id (self)
 
None update_config (self, Mapping[str, Any] config)
 
- 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)
 
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 Member Functions inherited from homeassistant.helpers.entity.Entity
None __init_subclass__ (cls, **Any kwargs)
 
str __repr__ (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)
 
Mapping[str, Any]|None extra_state_attributes (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)
 
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
 
- 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_state_changed_listener (self, *Any _)
 
None _reset (self, State energy_state)
 
None _update_cost (self)
 

Private Attributes

 _adapter
 
 _attr_device_class
 
 _attr_last_reset
 
 _attr_name
 
 _attr_native_value
 
 _attr_state_class
 
 _config
 
 _last_energy_sensor_state
 
 _wrong_state_class_reported
 
 _wrong_unit_reported
 

Static Private Attributes

bool _attr_entity_registry_visible_default = False
 
bool _attr_should_poll = False
 
bool _wrong_state_class_reported = False
 
bool _wrong_unit_reported = False
 

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

Calculate costs incurred by consuming energy.

This is intended as a fallback for when no specific cost sensor is available for the
utility.

Definition at line 226 of file sensor.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.energy.sensor.EnergyCostSensor.__init__ (   self,
SourceAdapter  adapter,
Mapping[str, Any]  config 
)
Initialize the sensor.

Definition at line 239 of file sensor.py.

Member Function Documentation

◆ _async_state_changed_listener()

None homeassistant.components.energy.sensor.EnergyCostSensor._async_state_changed_listener (   self,
*Any  _ 
)
private
Handle child updates.

Definition at line 438 of file sensor.py.

◆ _reset()

None homeassistant.components.energy.sensor.EnergyCostSensor._reset (   self,
State  energy_state 
)
private
Reset the cost sensor.

Definition at line 259 of file sensor.py.

◆ _update_cost()

None homeassistant.components.energy.sensor.EnergyCostSensor._update_cost (   self)
private
Update incurred costs.

Definition at line 267 of file sensor.py.

◆ add_to_platform_abort()

None homeassistant.components.energy.sensor.EnergyCostSensor.add_to_platform_abort (   self)
Abort adding an entity to a platform.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 444 of file sensor.py.

◆ async_added_to_hass()

None homeassistant.components.energy.sensor.EnergyCostSensor.async_added_to_hass (   self)
Register callbacks.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 409 of file sensor.py.

◆ async_will_remove_from_hass()

None homeassistant.components.energy.sensor.EnergyCostSensor.async_will_remove_from_hass (   self)
Handle removing from hass.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 449 of file sensor.py.

◆ native_unit_of_measurement()

str | None homeassistant.components.energy.sensor.EnergyCostSensor.native_unit_of_measurement (   self)
Return the units of measurement.

Reimplemented from homeassistant.components.sensor.SensorEntity.

Definition at line 462 of file sensor.py.

◆ unique_id()

str | None homeassistant.components.energy.sensor.EnergyCostSensor.unique_id (   self)
Return the unique ID of the sensor.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 467 of file sensor.py.

◆ update_config()

None homeassistant.components.energy.sensor.EnergyCostSensor.update_config (   self,
Mapping[str, Any]  config 
)
Update the config.

Definition at line 457 of file sensor.py.

Member Data Documentation

◆ _adapter

homeassistant.components.energy.sensor.EnergyCostSensor._adapter
private

Definition at line 247 of file sensor.py.

◆ _attr_device_class

homeassistant.components.energy.sensor.EnergyCostSensor._attr_device_class
private

Definition at line 249 of file sensor.py.

◆ _attr_entity_registry_visible_default

bool homeassistant.components.energy.sensor.EnergyCostSensor._attr_entity_registry_visible_default = False
staticprivate

Definition at line 233 of file sensor.py.

◆ _attr_last_reset

homeassistant.components.energy.sensor.EnergyCostSensor._attr_last_reset
private

Definition at line 262 of file sensor.py.

◆ _attr_name

homeassistant.components.energy.sensor.EnergyCostSensor._attr_name
private

Definition at line 419 of file sensor.py.

◆ _attr_native_value

homeassistant.components.energy.sensor.EnergyCostSensor._attr_native_value
private

Definition at line 261 of file sensor.py.

◆ _attr_should_poll

bool homeassistant.components.energy.sensor.EnergyCostSensor._attr_should_poll = False
staticprivate

Definition at line 234 of file sensor.py.

◆ _attr_state_class

homeassistant.components.energy.sensor.EnergyCostSensor._attr_state_class
private

Definition at line 250 of file sensor.py.

◆ _config

homeassistant.components.energy.sensor.EnergyCostSensor._config
private

Definition at line 251 of file sensor.py.

◆ _last_energy_sensor_state

homeassistant.components.energy.sensor.EnergyCostSensor._last_energy_sensor_state
private

Definition at line 263 of file sensor.py.

◆ _wrong_state_class_reported [1/2]

bool homeassistant.components.energy.sensor.EnergyCostSensor._wrong_state_class_reported = False
staticprivate

Definition at line 236 of file sensor.py.

◆ _wrong_state_class_reported [2/2]

homeassistant.components.energy.sensor.EnergyCostSensor._wrong_state_class_reported
private

Definition at line 295 of file sensor.py.

◆ _wrong_unit_reported [1/2]

bool homeassistant.components.energy.sensor.EnergyCostSensor._wrong_unit_reported = False
staticprivate

Definition at line 237 of file sensor.py.

◆ _wrong_unit_reported [2/2]

homeassistant.components.energy.sensor.EnergyCostSensor._wrong_unit_reported
private

Definition at line 356 of file sensor.py.

◆ entity_id

homeassistant.components.energy.sensor.EnergyCostSensor.entity_id

Definition at line 248 of file sensor.py.


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