ESPHome  2024.2.0
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::template_::TemplateText Class Reference

#include <template_text.h>

Inheritance diagram for esphome::template_::TemplateText:
esphome::text::Text esphome::PollingComponent esphome::EntityBase esphome::Component

Public Member Functions

void set_template (std::function< optional< std::string >()> &&f)
 
void setup () override
 
void update () override
 
void dump_config () override
 
float get_setup_priority () const override
 
Trigger< std::string > * get_set_trigger () const
 
void set_optimistic (bool optimistic)
 
void set_initial_value (const std::string &initial_value)
 
void set_value_saver (TemplateTextSaverBase *restore_value_saver)
 
- Public Member Functions inherited from esphome::text::Text
void publish_state (const std::string &state)
 
bool has_state () const
 Return whether this text input has gotten a full state yet. More...
 
TextCall make_call ()
 Instantiate a TextCall object to modify this text component's state. More...
 
void add_on_state_callback (std::function< void(std::string)> &&callback)
 
- Public Member Functions inherited from esphome::EntityBase
const StringRefget_name () const
 
void set_name (const char *name)
 
bool has_own_name () const
 
std::string get_object_id () const
 
void set_object_id (const char *object_id)
 
uint32_t get_object_id_hash ()
 
bool is_internal () const
 
void set_internal (bool internal)
 
bool is_disabled_by_default () const
 
void set_disabled_by_default (bool disabled_by_default)
 
EntityCategory get_entity_category () const
 
void set_entity_category (EntityCategory entity_category)
 
std::string get_icon () const
 
void set_icon (const char *icon)
 
- Public Member Functions inherited from esphome::PollingComponent
 PollingComponent ()
 
 PollingComponent (uint32_t update_interval)
 Initialize this polling component with the given update interval in ms. More...
 
virtual void set_update_interval (uint32_t update_interval)
 Manually set the update interval in ms for this polling object. More...
 
void call_setup () override
 
virtual uint32_t get_update_interval () const
 Get the update interval in ms of this sensor. More...
 
void start_poller ()
 
void stop_poller ()
 
- Public Member Functions inherited from esphome::Component
virtual void loop ()
 This method will be called repeatedly. More...
 
float get_actual_setup_priority () const
 
void set_setup_priority (float priority)
 
virtual float get_loop_priority () const
 priority of loop(). More...
 
void call ()
 
virtual void on_shutdown ()
 
virtual void on_safe_shutdown ()
 
uint32_t get_component_state () const
 
virtual void mark_failed ()
 Mark this component as failed. More...
 
bool is_failed ()
 
bool is_ready ()
 
virtual bool can_proceed ()
 
bool status_has_warning ()
 
bool status_has_error ()
 
void status_set_warning ()
 
void status_set_error ()
 
void status_clear_warning ()
 
void status_clear_error ()
 
void status_momentary_warning (const std::string &name, uint32_t length=5000)
 
void status_momentary_error (const std::string &name, uint32_t length=5000)
 
bool has_overridden_loop () const
 
void set_component_source (const char *source)
 Set where this component was loaded from for some debug messages. More...
 
const char * get_component_source () const
 Get the integration where this component was declared as a string. More...
 

Protected Member Functions

void control (const std::string &value) override
 
- Protected Member Functions inherited from esphome::EntityBase
virtual uint32_t hash_base ()
 The hash_base() function has been deprecated. More...
 
void calc_object_id_ ()
 
- Protected Member Functions inherited from esphome::Component
virtual void call_loop ()
 
virtual void call_dump_config ()
 
void set_interval (const std::string &name, uint32_t interval, std::function< void()> &&f)
 Set an interval function with a unique name. More...
 
void set_interval (uint32_t interval, std::function< void()> &&f)
 
bool cancel_interval (const std::string &name)
 Cancel an interval function. More...
 
void set_retry (const std::string &name, uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)
 Set an retry function with a unique name. More...
 
void set_retry (uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)
 
bool cancel_retry (const std::string &name)
 Cancel a retry function. More...
 
void set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a unique name. More...
 
void set_timeout (uint32_t timeout, std::function< void()> &&f)
 
bool cancel_timeout (const std::string &name)
 Cancel a timeout function. More...
 
void defer (const std::string &name, std::function< void()> &&f)
 Defer a callback to the next loop() call. More...
 
void defer (std::function< void()> &&f)
 Defer a callback to the next loop() call. More...
 
bool cancel_defer (const std::string &name)
 Cancel a defer callback using the specified name, name must not be empty. More...
 

Protected Attributes

bool optimistic_ = false
 
std::string initial_value_
 
Trigger< std::string > * set_trigger_ = new Trigger<std::string>()
 
optional< std::function< optional< std::string >)> > f_ {nullptr}
 
TemplateTextSaverBasepref_ = nullptr
 
- Protected Attributes inherited from esphome::text::Text
CallbackManager< void(std::string)> state_callback_
 
bool has_state_ {false}
 
- Protected Attributes inherited from esphome::EntityBase
StringRef name_
 
const char * object_id_c_str_ {nullptr}
 
const char * icon_c_str_ {nullptr}
 
uint32_t object_id_hash_
 
bool has_own_name_ {false}
 
bool internal_ {false}
 
bool disabled_by_default_ {false}
 
EntityCategory entity_category_ {ENTITY_CATEGORY_NONE}
 
- Protected Attributes inherited from esphome::PollingComponent
uint32_t update_interval_
 
- Protected Attributes inherited from esphome::Component
uint32_t component_state_ {0x0000}
 State of this component. More...
 
float setup_priority_override_ {NAN}
 
const char * component_source_ {nullptr}
 

Additional Inherited Members

- Data Fields inherited from esphome::text::Text
std::string state
 
TextTraits traits
 

Detailed Description

Definition at line 62 of file template_text.h.

Member Function Documentation

◆ control()

void esphome::template_::TemplateText::control ( const std::string &  value)
overrideprotectedvirtual

Implements esphome::text::Text.

Definition at line 45 of file template_text.cpp.

◆ dump_config()

void esphome::template_::TemplateText::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 57 of file template_text.cpp.

◆ get_set_trigger()

Trigger<std::string>* esphome::template_::TemplateText::get_set_trigger ( ) const
inline

Definition at line 71 of file template_text.h.

◆ get_setup_priority()

float esphome::template_::TemplateText::get_setup_priority ( ) const
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 69 of file template_text.h.

◆ set_initial_value()

void esphome::template_::TemplateText::set_initial_value ( const std::string &  initial_value)
inline

Definition at line 73 of file template_text.h.

◆ set_optimistic()

void esphome::template_::TemplateText::set_optimistic ( bool  optimistic)
inline

Definition at line 72 of file template_text.h.

◆ set_template()

void esphome::template_::TemplateText::set_template ( std::function< optional< std::string >()> &&  f)
inline

Definition at line 64 of file template_text.h.

◆ set_value_saver()

void esphome::template_::TemplateText::set_value_saver ( TemplateTextSaverBase restore_value_saver)
inline

Definition at line 74 of file template_text.h.

◆ setup()

void esphome::template_::TemplateText::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 9 of file template_text.cpp.

◆ update()

void esphome::template_::TemplateText::update ( )
overridevirtual

Implements esphome::PollingComponent.

Definition at line 31 of file template_text.cpp.

Field Documentation

◆ f_

optional<std::function<optional<std::string>)> > esphome::template_::TemplateText::f_ {nullptr}
protected

Definition at line 81 of file template_text.h.

◆ initial_value_

std::string esphome::template_::TemplateText::initial_value_
protected

Definition at line 79 of file template_text.h.

◆ optimistic_

bool esphome::template_::TemplateText::optimistic_ = false
protected

Definition at line 78 of file template_text.h.

◆ pref_

TemplateTextSaverBase* esphome::template_::TemplateText::pref_ = nullptr
protected

Definition at line 83 of file template_text.h.

◆ set_trigger_

Trigger<std::string>* esphome::template_::TemplateText::set_trigger_ = new Trigger<std::string>()
protected

Definition at line 80 of file template_text.h.


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