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

Public Member Functions

None __init__ (self, name, list[str] tariffs, *str|None yaml_slug=None, str|None unique_id=None, DeviceInfo|None device_info=None)
 
None async_added_to_hass (self)
 
None async_select_option (self, str option)
 
str|None current_option (self)
 
list[stroptions (self)
 
- Public Member Functions inherited from homeassistant.components.select.SelectEntity
None async_first (self)
 
None async_handle_select_option (self, str option)
 
None async_last (self)
 
None async_next (self, bool cycle)
 
None async_previous (self, bool cycle)
 
dict[str, Any] capability_attributes (self)
 
None select_option (self, str option)
 
str|None state (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)
 
None add_to_platform_start (self, HomeAssistant hass, EntityPlatform platform, asyncio.Semaphore|None parallel_updates)
 
bool assumed_state (self)
 
None async_device_update (self, bool warning=True)
 
None async_on_remove (self, CALLBACK_TYPE func)
 
None async_registry_entry_updated (self)
 
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)
 
str|None device_class (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)
 
er.EntityOptionsType|None get_initial_entity_options (self)
 
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)
 
dict[str, Any]|None state_attributes (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)
 
str|None unit_of_measurement (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.helpers.restore_state.RestoreEntity
ExtraStoredData|None async_get_last_extra_data (self)
 
State|None async_get_last_state (self)
 
None async_internal_added_to_hass (self)
 
None async_internal_will_remove_from_hass (self)
 
ExtraStoredData|None extra_restore_state_data (self)
 

Public Attributes

 entity_id
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 

Private Attributes

 _attr_device_info
 
 _attr_name
 
 _attr_should_poll
 
 _attr_unique_id
 
 _current_tariff
 
 _tariffs
 

Static Private Attributes

string _attr_translation_key = "tariff"
 

Additional Inherited Members

- Static Public Attributes inherited from homeassistant.components.select.SelectEntity
 None
 
- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 

Detailed Description

Representation of a Tariff selector.

Definition at line 79 of file select.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.utility_meter.select.TariffSelect.__init__ (   self,
  name,
list[str tariffs,
*str | None   yaml_slug = None,
str | None   unique_id = None,
DeviceInfo | None   device_info = None 
)
Initialize a tariff selector.

Definition at line 84 of file select.py.

Member Function Documentation

◆ async_added_to_hass()

None homeassistant.components.utility_meter.select.TariffSelect.async_added_to_hass (   self)
Run when entity about to be added.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 113 of file select.py.

◆ async_select_option()

None homeassistant.components.utility_meter.select.TariffSelect.async_select_option (   self,
str  option 
)
Select new tariff (option).

Reimplemented from homeassistant.components.select.SelectEntity.

Definition at line 123 of file select.py.

◆ current_option()

str | None homeassistant.components.utility_meter.select.TariffSelect.current_option (   self)
Return current tariff.

Reimplemented from homeassistant.components.select.SelectEntity.

Definition at line 109 of file select.py.

◆ options()

list[str] homeassistant.components.utility_meter.select.TariffSelect.options (   self)
Return the available tariffs.

Reimplemented from homeassistant.components.select.SelectEntity.

Definition at line 104 of file select.py.

Member Data Documentation

◆ _attr_device_info

homeassistant.components.utility_meter.select.TariffSelect._attr_device_info
private

Definition at line 98 of file select.py.

◆ _attr_name

homeassistant.components.utility_meter.select.TariffSelect._attr_name
private

Definition at line 94 of file select.py.

◆ _attr_should_poll

homeassistant.components.utility_meter.select.TariffSelect._attr_should_poll
private

Definition at line 101 of file select.py.

◆ _attr_translation_key

string homeassistant.components.utility_meter.select.TariffSelect._attr_translation_key = "tariff"
staticprivate

Definition at line 82 of file select.py.

◆ _attr_unique_id

homeassistant.components.utility_meter.select.TariffSelect._attr_unique_id
private

Definition at line 97 of file select.py.

◆ _current_tariff

homeassistant.components.utility_meter.select.TariffSelect._current_tariff
private

Definition at line 119 of file select.py.

◆ _tariffs

homeassistant.components.utility_meter.select.TariffSelect._tariffs
private

Definition at line 100 of file select.py.

◆ entity_id

homeassistant.components.utility_meter.select.TariffSelect.entity_id

Definition at line 96 of file select.py.


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