esphome::api::TextEntity Class Reference

Handle to a Text entity. More...

#include <entity_handles.hpp>

Inheritance diagram for esphome::api::TextEntity:

Collaboration diagram for esphome::api::TextEntity:

Public Member Functions
std::optional< TextInfo >	info () const
std::optional< TextState >	state () const
std::uint32_t	min_length () const
std::uint32_t	max_length () const
std::string	pattern () const
TextMode	mode () const
bool	missing_state () const
void	command (TextCommand c) const
	Send a fully-specified command (its key is set automatically).
void	set (const std::string &v) const
Public Member Functions inherited from esphome::api::TypedEntity< TextEntity >
std::string	icon () const
bool	disabled_by_default () const
EntityCategory	entity_category () const
std::uint32_t	device_id () const
	Entity (Client &client, const std::uint32_t key, std::string object_id, std::string name)
Public Member Functions inherited from esphome::api::Entity
	Entity (Client &client, const std::uint32_t key, std::string object_id, std::string name)
std::uint32_t	key () const noexcept
const std::string &	object_id () const noexcept
const std::string &	name () const noexcept

Static Public Member Functions
static constexpr EntityType	type ()

Additional Inherited Members
Protected Attributes inherited from esphome::api::Entity
Client *	client_
std::uint32_t	key_
std::string	object_id_
std::string	name_

Detailed Description

Handle to a Text entity.

Member Function Documentation

command()

void esphome::api::TextEntity::command ( TextCommand  c ) const

inline

Send a fully-specified command (its key is set automatically).

info()

std::optional< TextInfo > esphome::api::TextEntity::info ( ) const

inline

max_length()

std::uint32_t esphome::api::TextEntity::max_length ( ) const

inline

min_length()

std::uint32_t esphome::api::TextEntity::min_length ( ) const

inline

missing_state()

bool esphome::api::TextEntity::missing_state ( ) const

inline

mode()

TextMode esphome::api::TextEntity::mode ( ) const

inline

pattern()

std::string esphome::api::TextEntity::pattern ( ) const

inline

set()

void esphome::api::TextEntity::set ( const std::string &  v ) const

inline

state()

std::optional< TextState > esphome::api::TextEntity::state ( ) const

inline

type()

static constexpr EntityType esphome::api::TextEntity::type ( )

inlinestaticconstexpr

---

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

• include/esphome/api/model/entity_handles.hpp