Inheritance diagram for homeassistant.components.text.TextEntity:

Collaboration diagram for homeassistant.components.text.TextEntity:

Public Member Functions
None	async_set_value (self, str value)

dict[str, Any]	capability_attributes (self)

int	max (self)

int	min (self)

TextMode	mode (self)

int	native_max (self)

int	native_min (self)

str\|None	native_value (self)

str\|None	pattern (self)

re.Pattern\|None	pattern_cmp (self)

None	set_value (self, str value)

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_added_to_hass (self)

None	async_device_update (self, bool warning=True)

None	async_internal_added_to_hass (self)

None	async_internal_will_remove_from_hass (self)

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

Static Public Attributes
	None

Static Public Attributes inherited from homeassistant.helpers.entity.Entity
	bool

	EntityPlatform

	HomeAssistant

	None

	StateInfo

	StateType

	str

Private Attributes
	__pattern_cmp

Static Private Attributes
	_entity_component_unrecorded_attributes

Additional Inherited Members
Public Attributes inherited from homeassistant.helpers.entity.Entity
	device_entry

	entity_id

	hass

	parallel_updates

	platform

	registry_entry

Detailed Description

Representation of a Text entity.

Definition at line 119 of file __init__.py.

Member Function Documentation

◆ async_set_value()

None homeassistant.components.text.TextEntity.async_set_value	(		self,
		str	value
	)

Change the value.

Reimplemented in homeassistant.components.unifiprotect.text.ProtectDeviceText, homeassistant.components.shelly.text.RpcText, homeassistant.components.mysensors.text.MySensorsText, homeassistant.components.mqtt.text.MqttTextEntity, homeassistant.components.knx.text.KNXText, homeassistant.components.esphome.text.EsphomeText, and homeassistant.components.demo.text.DemoText.

Definition at line 236 of file __init__.py.

◆ capability_attributes()

dict[str, Any] homeassistant.components.text.TextEntity.capability_attributes ( self )

Return capability attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 136 of file __init__.py.

◆ max()

int homeassistant.components.text.TextEntity.max ( self )

Return the maximum length of the value.

Definition at line 203 of file __init__.py.

◆ min()

int homeassistant.components.text.TextEntity.min ( self )

Return the minimum length of the value.

Definition at line 188 of file __init__.py.

◆ mode()

TextMode homeassistant.components.text.TextEntity.mode ( self )

Return the mode of the entity.

Definition at line 169 of file __init__.py.

◆ native_max()

int homeassistant.components.text.TextEntity.native_max ( self )

Return the maximum length of the value.

Definition at line 193 of file __init__.py.

◆ native_min()

int homeassistant.components.text.TextEntity.native_min ( self )

Return the minimum length of the value.

Definition at line 178 of file __init__.py.

◆ native_value()

str | None homeassistant.components.text.TextEntity.native_value ( self )

Return the value reported by the text.

Reimplemented in homeassistant.components.shelly.text.RpcText, homeassistant.components.mysensors.text.MySensorsText, homeassistant.components.knx.text.KNXText, and homeassistant.components.esphome.text.EsphomeText.

Definition at line 228 of file __init__.py.

◆ pattern()

str | None homeassistant.components.text.TextEntity.pattern ( self )

Return the regex pattern that the value must match.

Definition at line 219 of file __init__.py.

◆ pattern_cmp()

re.Pattern | None homeassistant.components.text.TextEntity.pattern_cmp ( self )

Return a compiled pattern.

Definition at line 209 of file __init__.py.

◆ set_value()

None homeassistant.components.text.TextEntity.set_value	(		self,
		str	value
	)

Change the value.

Definition at line 232 of file __init__.py.

◆ state()

str | None homeassistant.components.text.TextEntity.state ( self )

Return the entity state.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 147 of file __init__.py.

Member Data Documentation

◆ __pattern_cmp

homeassistant.components.text.TextEntity.__pattern_cmp

private

Definition at line 212 of file __init__.py.

◆ _entity_component_unrecorded_attributes

homeassistant.components.text.TextEntity._entity_component_unrecorded_attributes

staticprivate

Initial value:

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

Definition at line 122 of file __init__.py.

◆ None

homeassistant.components.text.TextEntity.None

static

Definition at line 132 of file __init__.py.

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

core/homeassistant/components/text/__init__.py

Home Assistant Unofficial Reference 2024.12.1

Public Member Functions

Static Public Attributes

Private Attributes

Static Private Attributes

Additional Inherited Members