Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.input_select.InputSelect Class Reference
Inheritance diagram for homeassistant.components.input_select.InputSelect:
[legend]
Collaboration diagram for homeassistant.components.input_select.InputSelect:
[legend]

Public Member Functions

None __init__ (self, ConfigType config)
 
None async_added_to_hass (self)
 
None async_select_option (self, str option)
 
None async_set_options (self, list[str] options)
 
None async_update_config (self, ConfigType config)
 
dict[str, boolextra_state_attributes (self)
 
Self from_storage (cls, ConfigType config)
 
Self from_yaml (cls, ConfigType config)
 
- 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)
 
str|None current_option (self)
 
list[stroptions (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)
 
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)
 

Private Attributes

 _attr_current_option
 
 _attr_icon
 
 _attr_name
 
 _attr_options
 
 _attr_unique_id
 

Static Private Attributes

bool _attr_should_poll = False
 
tuple _entity_component_unrecorded_attributes
 
 _unrecorded_attributes = frozenset({ATTR_EDITABLE})
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 
- 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 select input.

Definition at line 250 of file __init__.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.input_select.InputSelect.__init__ (   self,
ConfigType  config 
)
Initialize a select input.

Definition at line 261 of file __init__.py.

Member Function Documentation

◆ async_added_to_hass()

None homeassistant.components.input_select.InputSelect.async_added_to_hass (   self)
Run when entity about to be added.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 284 of file __init__.py.

◆ async_select_option()

None homeassistant.components.input_select.InputSelect.async_select_option (   self,
str  option 
)
Select new option.

Reimplemented from homeassistant.components.select.SelectEntity.

Definition at line 301 of file __init__.py.

◆ async_set_options()

None homeassistant.components.input_select.InputSelect.async_set_options (   self,
list[str options 
)
Set options.

Definition at line 310 of file __init__.py.

◆ async_update_config()

None homeassistant.components.input_select.InputSelect.async_update_config (   self,
ConfigType  config 
)
Handle when the config is updated.

Definition at line 328 of file __init__.py.

◆ extra_state_attributes()

dict[str, bool] homeassistant.components.input_select.InputSelect.extra_state_attributes (   self)
Return the state attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 297 of file __init__.py.

◆ from_storage()

Self homeassistant.components.input_select.InputSelect.from_storage (   cls,
ConfigType  config 
)
Return entity instance initialized from storage.

Definition at line 270 of file __init__.py.

◆ from_yaml()

Self homeassistant.components.input_select.InputSelect.from_yaml (   cls,
ConfigType  config 
)
Return entity instance initialized from yaml.

Definition at line 277 of file __init__.py.

Member Data Documentation

◆ _attr_current_option

homeassistant.components.input_select.InputSelect._attr_current_option
private

Definition at line 263 of file __init__.py.

◆ _attr_icon

homeassistant.components.input_select.InputSelect._attr_icon
private

Definition at line 264 of file __init__.py.

◆ _attr_name

homeassistant.components.input_select.InputSelect._attr_name
private

Definition at line 265 of file __init__.py.

◆ _attr_options

homeassistant.components.input_select.InputSelect._attr_options
private

Definition at line 266 of file __init__.py.

◆ _attr_should_poll

bool homeassistant.components.input_select.InputSelect._attr_should_poll = False
staticprivate

Definition at line 258 of file __init__.py.

◆ _attr_unique_id

homeassistant.components.input_select.InputSelect._attr_unique_id
private

Definition at line 267 of file __init__.py.

◆ _entity_component_unrecorded_attributes

tuple homeassistant.components.input_select.InputSelect._entity_component_unrecorded_attributes
staticprivate
Initial value:
= (
SelectEntity._entity_component_unrecorded_attributes - {ATTR_OPTIONS} # noqa: SLF001
)

Definition at line 253 of file __init__.py.

◆ _unrecorded_attributes

homeassistant.components.input_select.InputSelect._unrecorded_attributes = frozenset({ATTR_EDITABLE})
staticprivate

Definition at line 256 of file __init__.py.


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