homeassistant.components.knx.text.KNXText Class Reference

Inheritance diagram for homeassistant.components.knx.text.KNXText:

Collaboration diagram for homeassistant.components.knx.text.KNXText:

Public Member Functions
None	__init__ (self, KNXModule knx_module, ConfigType config)
None	async_added_to_hass (self)
None	async_set_value (self, str value)
str|None	native_value (self)
Public Member Functions inherited from homeassistant.components.knx.entity.KnxYamlEntity
None	__init__ (self, KNXModule knx_module, XknxDevice device)
Public Member Functions inherited from homeassistant.components.knx.entity._KnxEntityBase
None	after_update_callback (self, XknxDevice _device)
None	async_update (self)
None	async_will_remove_from_hass (self)
bool	available (self)
str	name (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_write_ha_state (self)
str|None	attribution (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)
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)
Public Member Functions inherited from homeassistant.components.text.TextEntity
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	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.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_entity_category
	_attr_mode
	_attr_pattern
	_attr_unique_id

Static Private Attributes
int	_attr_native_max = 14

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
Static Public Attributes inherited from homeassistant.components.text.TextEntity
	None

Detailed Description

Representation of a KNX text.

Definition at line 54 of file text.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.knx.text.KNXText.__init__	(		self,
		KNXModule	knx_module,
		ConfigType	config
	)

Initialize a KNX text.

Definition at line 60 of file text.py.

Member Function Documentation

async_added_to_hass()

None homeassistant.components.knx.text.KNXText.async_added_to_hass

(

self

)

Restore last state.

Reimplemented from homeassistant.components.knx.entity._KnxEntityBase.

Definition at line 75 of file text.py.

async_set_value()

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

Change the value.

Reimplemented from homeassistant.components.text.TextEntity.

Definition at line 89 of file text.py.

native_value()

str | None homeassistant.components.knx.text.KNXText.native_value

(

self

)

Return the value reported by the text.

Reimplemented from homeassistant.components.text.TextEntity.

Definition at line 85 of file text.py.

Member Data Documentation

_attr_entity_category

homeassistant.components.knx.text.KNXText._attr_entity_category

private

Definition at line 72 of file text.py.

_attr_mode

homeassistant.components.knx.text.KNXText._attr_mode

private

Definition at line 66 of file text.py.

_attr_native_max

int homeassistant.components.knx.text.KNXText._attr_native_max = 14

staticprivate

Definition at line 58 of file text.py.

_attr_pattern

homeassistant.components.knx.text.KNXText._attr_pattern

private

Definition at line 67 of file text.py.

_attr_unique_id

homeassistant.components.knx.text.KNXText._attr_unique_id

private

Definition at line 73 of file text.py.

---

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

• core/homeassistant/components/knx/text.py