ESPHome  2024.5.3
Public Member Functions | Protected Attributes
esphome::binary_sensor::DelayedOffFilter Class Reference

#include <filter.h>

Inheritance diagram for esphome::binary_sensor::DelayedOffFilter:
esphome::binary_sensor::Filter esphome::Component

Public Member Functions

optional< bool > new_value (bool value, bool is_initial) override
float get_setup_priority () const override
template<typename T >
void set_delay (T delay)
- Public Member Functions inherited from esphome::binary_sensor::Filter
void input (bool value, bool is_initial)
void output (bool value, bool is_initial)
- Public Member Functions inherited from esphome::Component
virtual void setup ()
 Where the component's initialization should happen. More...
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 ()
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 Attributes

TemplatableValue< uint32_t > delay_ {}
- Protected Attributes inherited from esphome::binary_sensor::Filter
friend BinarySensor
Filternext_ {nullptr}
BinarySensorparent_ {nullptr}
Deduplicator< bool > dedup_
- 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

- 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...

Detailed Description

Definition at line 57 of file filter.h.

Member Function Documentation

◆ get_setup_priority()

float esphome::binary_sensor::DelayedOffFilter::get_setup_priority ( ) const

Reimplemented from esphome::Component.

Definition at line 62 of file filter.cpp.

◆ new_value()

optional< bool > esphome::binary_sensor::DelayedOffFilter::new_value ( bool  value,
bool  is_initial 

Implements esphome::binary_sensor::Filter.

Definition at line 52 of file filter.cpp.

◆ set_delay()

template<typename T >
void esphome::binary_sensor::DelayedOffFilter::set_delay ( delay)

Definition at line 63 of file filter.h.

Field Documentation

◆ delay_

TemplatableValue<uint32_t> esphome::binary_sensor::DelayedOffFilter::delay_ {}

Definition at line 66 of file filter.h.

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