Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.text Namespace Reference

Namespaces

 const
 
 device_action
 
 reproduce_state
 

Classes

class  RestoreText
 
class  TextEntity
 
class  TextEntityDescription
 
class  TextExtraStoredData
 
class  TextMode
 

Functions

None _async_set_value (TextEntity entity, ServiceCall service_call)
 
bool async_setup (HomeAssistant hass, ConfigType config)
 
bool async_setup_entry (HomeAssistant hass, ConfigEntry entry)
 
bool async_unload_entry (HomeAssistant hass, ConfigEntry entry)
 

Variables

list __all__ = ["DOMAIN", "TextEntity", "TextEntityDescription", "TextMode"]
 
 _LOGGER = logging.getLogger(__name__)
 
dictionary CACHED_PROPERTIES_WITH_ATTR_
 
string ENTITY_ID_FORMAT = DOMAIN + ".{}"
 
 MIN_TIME_BETWEEN_SCANS = timedelta(seconds=10)
 
 PLATFORM_SCHEMA = cv.PLATFORM_SCHEMA
 
 PLATFORM_SCHEMA_BASE = cv.PLATFORM_SCHEMA_BASE
 
 SCAN_INTERVAL = timedelta(seconds=30)
 

Detailed Description

Component to allow setting text as platforms.

Function Documentation

◆ _async_set_value()

None homeassistant.components.text._async_set_value ( TextEntity  entity,
ServiceCall  service_call 
)
private
Service call wrapper to set a new value.

Definition at line 65 of file __init__.py.

◆ async_setup()

bool homeassistant.components.text.async_setup ( HomeAssistant  hass,
ConfigType  config 
)
Set up Text entities.

Definition at line 49 of file __init__.py.

◆ async_setup_entry()

bool homeassistant.components.text.async_setup_entry ( HomeAssistant  hass,
ConfigEntry  entry 
)
Set up a config entry.

Definition at line 84 of file __init__.py.

◆ async_unload_entry()

bool homeassistant.components.text.async_unload_entry ( HomeAssistant  hass,
ConfigEntry  entry 
)
Unload a config entry.

Definition at line 89 of file __init__.py.

Variable Documentation

◆ __all__

list homeassistant.components.text.__all__ = ["DOMAIN", "TextEntity", "TextEntityDescription", "TextMode"]
private

Definition at line 46 of file __init__.py.

◆ _LOGGER

homeassistant.components.text._LOGGER = logging.getLogger(__name__)
private

Definition at line 35 of file __init__.py.

◆ CACHED_PROPERTIES_WITH_ATTR_

dictionary homeassistant.components.text.CACHED_PROPERTIES_WITH_ATTR_
Initial value:
1 = {
2  "mode",
3  "native_value",
4  "native_min",
5  "native_max",
6  "pattern",
7 }

Definition at line 110 of file __init__.py.

◆ ENTITY_ID_FORMAT

string homeassistant.components.text.ENTITY_ID_FORMAT = DOMAIN + ".{}"

Definition at line 38 of file __init__.py.

◆ MIN_TIME_BETWEEN_SCANS

homeassistant.components.text.MIN_TIME_BETWEEN_SCANS = timedelta(seconds=10)

Definition at line 43 of file __init__.py.

◆ PLATFORM_SCHEMA

homeassistant.components.text.PLATFORM_SCHEMA = cv.PLATFORM_SCHEMA

Definition at line 39 of file __init__.py.

◆ PLATFORM_SCHEMA_BASE

homeassistant.components.text.PLATFORM_SCHEMA_BASE = cv.PLATFORM_SCHEMA_BASE

Definition at line 40 of file __init__.py.

◆ SCAN_INTERVAL

homeassistant.components.text.SCAN_INTERVAL = timedelta(seconds=30)

Definition at line 41 of file __init__.py.