Inheritance diagram for homeassistant.components.input_text.InputText:

Collaboration diagram for homeassistant.components.input_text.InputText:

Public Member Functions
None	__init__ (self, ConfigType config)

None	async_added_to_hass (self)

None	async_set_value (self, str value)

None	async_update_config (self, ConfigType config)

dict[str, Any]	extra_state_attributes (self)

Self	from_storage (cls, ConfigType config)

Self	from_yaml (cls, ConfigType config)

str\|None	icon (self)

str\|None	name (self)

str\|None	state (self)

str	unique_id (self)

str\|None	unit_of_measurement (self)

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 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)

dict[str, Any]\|None	capability_attributes (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)

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, str]	translation_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)

Private Member Functions
int	_maximum (self)

int	_minimum (self)

Private Attributes
	_config

	_current_value

Static Private Attributes
bool	_attr_should_poll = False

	_unrecorded_attributes

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.helpers.entity.Entity
	bool

	EntityPlatform

	HomeAssistant

	None

	StateInfo

	StateType

	str

Detailed Description

Represent a text box.

Definition at line 183 of file __init__.py.

Constructor & Destructor Documentation

◆ init()

None homeassistant.components.input_text.InputText.__init__	(		self,
		ConfigType	config
	)

Initialize a text input.

Definition at line 194 of file __init__.py.

Member Function Documentation

◆ _maximum()

int homeassistant.components.input_text.InputText._maximum ( self )

private

Return max len of the text.

Definition at line 225 of file __init__.py.

◆ _minimum()

int homeassistant.components.input_text.InputText._minimum ( self )

private

Return min len of the text.

Definition at line 230 of file __init__.py.

◆ async_added_to_hass()

None homeassistant.components.input_text.InputText.async_added_to_hass ( self )

Run when entity about to be added to hass.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 260 of file __init__.py.

◆ async_set_value()

None homeassistant.components.input_text.InputText.async_set_value	(		self,
		str	value
	)

Select new value.

Definition at line 273 of file __init__.py.

◆ async_update_config()

None homeassistant.components.input_text.InputText.async_update_config	(		self,
		ConfigType	config
	)

Handle when the config is updated.

Definition at line 286 of file __init__.py.

◆ extra_state_attributes()

dict[str, Any] homeassistant.components.input_text.InputText.extra_state_attributes ( self )

Return the state attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 250 of file __init__.py.

◆ from_storage()

Self homeassistant.components.input_text.InputText.from_storage	(		cls,
		ConfigType	config
	)

Return entity instance initialized from storage.

Definition at line 200 of file __init__.py.

◆ from_yaml()

Self homeassistant.components.input_text.InputText.from_yaml	(		cls,
		ConfigType	config
	)

Return entity instance initialized from yaml.

Definition at line 207 of file __init__.py.

◆ icon()

str | None homeassistant.components.input_text.InputText.icon ( self )

Return the icon to be used for this entity.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 220 of file __init__.py.

◆ name()

str | None homeassistant.components.input_text.InputText.name ( self )

Return the name of the text input entity.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 215 of file __init__.py.

◆ state()

str | None homeassistant.components.input_text.InputText.state ( self )

Return the state of the component.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 235 of file __init__.py.

◆ unique_id()

str homeassistant.components.input_text.InputText.unique_id ( self )

Return unique id for the entity.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 245 of file __init__.py.

◆ unit_of_measurement()

str | None homeassistant.components.input_text.InputText.unit_of_measurement ( self )

Return the unit the value is expressed in.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 240 of file __init__.py.

Member Data Documentation

◆ _attr_should_poll

bool homeassistant.components.input_text.InputText._attr_should_poll = False

staticprivate

Definition at line 190 of file __init__.py.

◆ _config

homeassistant.components.input_text.InputText._config

private

Definition at line 196 of file __init__.py.

◆ _current_value

homeassistant.components.input_text.InputText._current_value

private

Definition at line 197 of file __init__.py.

◆ _unrecorded_attributes

homeassistant.components.input_text.InputText._unrecorded_attributes

staticprivate

Initial value:

=  frozenset(
        {ATTR_EDITABLE, ATTR_MAX, ATTR_MIN, ATTR_MODE, ATTR_PATTERN}
    )

Definition at line 186 of file __init__.py.

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

core/homeassistant/components/input_text/__init__.py

Home Assistant Unofficial Reference 2024.12.1

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ _maximum()

◆ _minimum()

◆ async_added_to_hass()

◆ async_set_value()

◆ async_update_config()

◆ extra_state_attributes()

◆ from_storage()

◆ from_yaml()

◆ icon()

◆ name()

◆ state()

◆ unique_id()

◆ unit_of_measurement()

Member Data Documentation

◆ _attr_should_poll

◆ _config

◆ _current_value

◆ _unrecorded_attributes

◆ init()