ESPHome  2024.12.2
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::sensor::ValueRangeTrigger Class Reference

#include <automation.h>

Inheritance diagram for esphome::sensor::ValueRangeTrigger:
esphome::Trigger< float > esphome::Component

Public Member Functions

 ValueRangeTrigger (Sensor *parent)
 
template<typename V >
void set_min (V min)
 
template<typename V >
void set_max (V max)
 
void setup () override
 
float get_setup_priority () const override
 
- Public Member Functions inherited from esphome::Trigger< float >
void trigger (Ts... x)
 Inform the parent automation that the event has triggered. More...
 
void set_automation_parent (Automation< Ts... > *automation_parent)
 
void stop_action ()
 Stop any action connected to this trigger. More...
 
bool is_action_running ()
 Returns true if any action connected to this trigger is running. More...
 
- Public Member Functions inherited from esphome::Component
virtual void loop ()
 This method will be called repeatedly. More...
 
virtual void dump_config ()
 
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 () const
 
bool is_ready () const
 
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 on_state_ (float state)
 
- Protected Member Functions inherited from esphome::Component
virtual void call_loop ()
 
virtual void call_setup ()
 
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

Sensorparent_
 
ESPPreferenceObject rtc_
 
bool previous_in_range_ {false}
 
TemplatableValue< float, float > min_ {NAN}
 
TemplatableValue< float, float > max_ {NAN}
 
- Protected Attributes inherited from esphome::Trigger< float >
Automation< Ts... > * automation_parent_
 
- 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}
 

Detailed Description

Definition at line 35 of file automation.h.

Constructor & Destructor Documentation

◆ ValueRangeTrigger()

esphome::sensor::ValueRangeTrigger::ValueRangeTrigger ( Sensor parent)
inlineexplicit

Definition at line 37 of file automation.h.

Member Function Documentation

◆ get_setup_priority()

float esphome::sensor::ValueRangeTrigger::get_setup_priority ( ) const
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 51 of file automation.h.

◆ on_state_()

void esphome::sensor::ValueRangeTrigger::on_state_ ( float  state)
inlineprotected

Definition at line 54 of file automation.h.

◆ set_max()

template<typename V >
void esphome::sensor::ValueRangeTrigger::set_max ( max)
inline

Definition at line 40 of file automation.h.

◆ set_min()

template<typename V >
void esphome::sensor::ValueRangeTrigger::set_min ( min)
inline

Definition at line 39 of file automation.h.

◆ setup()

void esphome::sensor::ValueRangeTrigger::setup ( )
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 42 of file automation.h.

Field Documentation

◆ max_

TemplatableValue<float, float> esphome::sensor::ValueRangeTrigger::max_ {NAN}
protected

Definition at line 84 of file automation.h.

◆ min_

TemplatableValue<float, float> esphome::sensor::ValueRangeTrigger::min_ {NAN}
protected

Definition at line 83 of file automation.h.

◆ parent_

Sensor* esphome::sensor::ValueRangeTrigger::parent_
protected

Definition at line 80 of file automation.h.

◆ previous_in_range_

bool esphome::sensor::ValueRangeTrigger::previous_in_range_ {false}
protected

Definition at line 82 of file automation.h.

◆ rtc_

ESPPreferenceObject esphome::sensor::ValueRangeTrigger::rtc_
protected

Definition at line 81 of file automation.h.


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