esphome::text::Text Class Reference

Base-class for all text inputs. More...

#include <text.h>

Inheritance diagram for esphome::text::Text:

Public Member Functions
void	publish_state (const std::string &state)
void	publish_state (const char *state)
void	publish_state (const char *state, size_t len)
TextCall	make_call ()
	Instantiate a TextCall object to modify this text component's state.
template<typename F >
void	add_on_state_callback (F &&callback)
Public Member Functions inherited from esphome::EntityBase
const StringRef &	get_name () const
bool	has_own_name () const
uint32_t	get_object_id_hash () const
StringRef	get_object_id_to (std::span< char, OBJECT_ID_MAX_LEN > buf) const
	Get object_id with zero heap allocation For static case: returns StringRef to internal storage (buffer unused) For dynamic case: formats into buffer and returns StringRef to buffer.
size_t	write_object_id_to (char *buf, size_t buf_size) const
	Write object_id directly to buffer, returns length written (excluding null) Useful for building compound strings without intermediate buffer.
bool	is_internal () const
	ESPDEPRECATED ("set_internal() is undefined behavior at runtime — components and Home Assistant are NOT " "notified. Use the 'internal:' YAML key instead. Will be removed in 2027.3.0.", "2026.3.0") void set_internal(bool internal)
bool	is_disabled_by_default () const
EntityCategory	get_entity_category () const
const char *	get_device_class_to (std::span< char, MAX_DEVICE_CLASS_LENGTH > buffer) const
StringRef	get_unit_of_measurement_ref () const
const char *	get_icon_to (std::span< char, MAX_ICON_LENGTH > buffer) const
uint32_t	get_device_id () const
Device *	get_device () const
bool	has_state () const
void	set_has_state (bool state)
	ESPDEPRECATED ("Use make_entity_preference<T>() instead, or preferences won't be migrated. " "See https://github.com/esphome/backlog/issues/85. Will be removed in 2027.1.0.", "2026.7.0") uint32_t get_preference_hash()
	Get a unique hash for storing preferences/settings for this entity.
template<typename T >
ESPPreferenceObject	make_entity_preference (uint32_t version=0)
	Create a preference object for storing this entity's state/settings.

Data Fields
std::string	state
TextTraits	traits

Protected Member Functions
virtual void	control (const std::string &value)=0
	Set the value of the text input, this is a virtual method that each text input integration must implement.
Protected Member Functions inherited from esphome::EntityBase
friend	void::setup ()
friend	void::original_setup ()
void	configure_entity_ (const char *name, uint32_t object_id_hash, uint32_t entity_fields)
	Combined entity setup from codegen: set name, object_id hash, entity string indices, and flags.
void	set_device_ (Device *device)
ESPPreferenceObject	make_entity_preference_ (size_t size, uint32_t version)
	Non-template helper for make_entity_preference() to avoid code bloat.
void	calc_object_id_ ()

Protected Attributes
LazyCallbackManager< void(const std::string &)>	state_callback_
Protected Attributes inherited from esphome::EntityBase
StringRef	name_
uint32_t	object_id_hash_ {}
Device *	device_ {}
struct esphome::EntityBase::EntityFlags	flags_
uint8_t	device_class_idx_ {}
uint8_t	uom_idx_ {}
uint8_t	icon_idx_ {}

Detailed Description

Base-class for all text inputs.

A text input can use publish_state to send out a new value.

Definition at line 21 of file text.h.

Member Function Documentation

add_on_state_callback()

template<typename F >

void esphome::text::Text::add_on_state_callback ( F && callback )

inline

Definition at line 33 of file text.h.

control()

virtual void esphome::text::Text::control ( const std::string & value )

protectedpure virtual

Set the value of the text input, this is a virtual method that each text input integration must implement.

This method is called by the TextCall.

Parameters

value

The value as validated by the TextCall.

Implemented in esphome::copy::CopyText, esphome::demo::DemoText, esphome::lvgl::LVGLText, and esphome::template_::TemplateText.

make_call()

TextCall esphome::text::Text::make_call ( )

inline

Instantiate a TextCall object to modify this text component's state.

Definition at line 31 of file text.h.

publish_state() [1/3]

void esphome::text::Text::publish_state ( const char * state )

inline

Definition at line 27 of file text.h.

publish_state() [2/3]

void esphome::text::Text::publish_state	(	const char *	state,
		size_t	len )

Definition at line 11 of file text.cpp.

publish_state() [3/3]

void esphome::text::Text::publish_state ( const std::string & state )

inline

Definition at line 26 of file text.h.

Field Documentation

state

std::string esphome::text::Text::state

Definition at line 23 of file text.h.

state_callback_

LazyCallbackManager<void(const std::string &)> esphome::text::Text::state_callback_

protected

Definition at line 48 of file text.h.

traits

TextTraits esphome::text::Text::traits

Definition at line 24 of file text.h.

---

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

• esphome/components/text/text.h
• esphome/components/text/text.cpp