ESPHome  2024.5.1
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::template_::TemplateNumber Class Reference

#include <template_number.h>

Inheritance diagram for esphome::template_::TemplateNumber:
esphome::number::Number esphome::PollingComponent esphome::EntityBase esphome::Component

Public Member Functions

void set_template (std::function< optional< float >()> &&f)
void setup () override
void update () override
void dump_config () override
float get_setup_priority () const override
Trigger< float > * get_set_trigger () const
void set_optimistic (bool optimistic)
void set_initial_value (float initial_value)
void set_restore_value (bool restore_value)
- Public Member Functions inherited from esphome::number::Number
void publish_state (float state)
NumberCall make_call ()
void add_on_state_callback (std::function< void(float)> &&callback)
bool has_state () const
 Return whether this number has gotten a full state yet. More...
- 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 () const
bool status_has_error () const
void status_set_warning (const char *message="unspecified")
void status_set_error (const char *message="unspecified")
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 (float 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}
float initial_value_ {NAN}
bool restore_value_ {false}
Trigger< float > * set_trigger_ = new Trigger<float>()
optional< std::function< optional< float >)> > f_
ESPPreferenceObject pref_
- Protected Attributes inherited from esphome::number::Number
CallbackManager< void(float)> 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::number::Number
float state
NumberTraits traits

Detailed Description

Definition at line 11 of file template_number.h.

Member Function Documentation

◆ control()

void esphome::template_::TemplateNumber::control ( float  value)

Implements esphome::number::Number.

Definition at line 40 of file template_number.cpp.

◆ dump_config()

void esphome::template_::TemplateNumber::dump_config ( )

Reimplemented from esphome::Component.

Definition at line 49 of file template_number.cpp.

◆ get_set_trigger()

Trigger<float>* esphome::template_::TemplateNumber::get_set_trigger ( ) const

Definition at line 20 of file template_number.h.

◆ get_setup_priority()

float esphome::template_::TemplateNumber::get_setup_priority ( ) const

Reimplemented from esphome::Component.

Definition at line 18 of file template_number.h.

◆ set_initial_value()

void esphome::template_::TemplateNumber::set_initial_value ( float  initial_value)

Definition at line 22 of file template_number.h.

◆ set_optimistic()

void esphome::template_::TemplateNumber::set_optimistic ( bool  optimistic)

Definition at line 21 of file template_number.h.

◆ set_restore_value()

void esphome::template_::TemplateNumber::set_restore_value ( bool  restore_value)

Definition at line 23 of file template_number.h.

◆ set_template()

void esphome::template_::TemplateNumber::set_template ( std::function< optional< float >()> &&  f)

Definition at line 13 of file template_number.h.

◆ setup()

void esphome::template_::TemplateNumber::setup ( )

Reimplemented from esphome::Component.

Definition at line 9 of file template_number.cpp.

◆ update()

void esphome::template_::TemplateNumber::update ( )

Implements esphome::PollingComponent.

Definition at line 29 of file template_number.cpp.

Field Documentation

◆ f_

optional<std::function<optional<float>)> > esphome::template_::TemplateNumber::f_

Definition at line 31 of file template_number.h.

◆ initial_value_

float esphome::template_::TemplateNumber::initial_value_ {NAN}

Definition at line 28 of file template_number.h.

◆ optimistic_

bool esphome::template_::TemplateNumber::optimistic_ {false}

Definition at line 27 of file template_number.h.

◆ pref_

ESPPreferenceObject esphome::template_::TemplateNumber::pref_

Definition at line 33 of file template_number.h.

◆ restore_value_

bool esphome::template_::TemplateNumber::restore_value_ {false}

Definition at line 29 of file template_number.h.

◆ set_trigger_

Trigger<float>* esphome::template_::TemplateNumber::set_trigger_ = new Trigger<float>()

Definition at line 30 of file template_number.h.

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