ESPHome  2022.1.2
Public Member Functions | Protected Attributes
esphome::speed::SpeedFan Class Reference

#include <speed_fan.h>

Inheritance diagram for esphome::speed::SpeedFan:
esphome::Component

Public Member Functions

 SpeedFan (fan::FanState *fan, output::FloatOutput *output, int speed_count)
 
void setup () override
 
void loop () override
 
void dump_config () override
 
float get_setup_priority () const override
 
void set_oscillating (output::BinaryOutput *oscillating)
 
void set_direction (output::BinaryOutput *direction)
 
- Public Member Functions inherited from esphome::Component
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 ()
 
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 Attributes

fan::FanStatefan_
 
output::FloatOutputoutput_
 
output::BinaryOutputoscillating_ {nullptr}
 
output::BinaryOutputdirection_ {nullptr}
 
bool next_update_ {true}
 
int speed_count_ {}
 
- 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()> &&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()> &&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 11 of file speed_fan.h.

Constructor & Destructor Documentation

◆ SpeedFan()

esphome::speed::SpeedFan::SpeedFan ( fan::FanState fan,
output::FloatOutput output,
int  speed_count 
)
inline

Definition at line 13 of file speed_fan.h.

Member Function Documentation

◆ dump_config()

void esphome::speed::SpeedFan::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 10 of file speed_fan.cpp.

◆ get_setup_priority()

float esphome::speed::SpeedFan::get_setup_priority ( ) const
overridevirtual

Reimplemented from esphome::Component.

Definition at line 62 of file speed_fan.cpp.

◆ loop()

void esphome::speed::SpeedFan::loop ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 24 of file speed_fan.cpp.

◆ set_direction()

void esphome::speed::SpeedFan::set_direction ( output::BinaryOutput direction)
inline

Definition at line 20 of file speed_fan.h.

◆ set_oscillating()

void esphome::speed::SpeedFan::set_oscillating ( output::BinaryOutput oscillating)
inline

Definition at line 19 of file speed_fan.h.

◆ setup()

void esphome::speed::SpeedFan::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 19 of file speed_fan.cpp.

Field Documentation

◆ direction_

output::BinaryOutput* esphome::speed::SpeedFan::direction_ {nullptr}
protected

Definition at line 26 of file speed_fan.h.

◆ fan_

fan::FanState* esphome::speed::SpeedFan::fan_
protected

Definition at line 23 of file speed_fan.h.

◆ next_update_

bool esphome::speed::SpeedFan::next_update_ {true}
protected

Definition at line 27 of file speed_fan.h.

◆ oscillating_

output::BinaryOutput* esphome::speed::SpeedFan::oscillating_ {nullptr}
protected

Definition at line 25 of file speed_fan.h.

◆ output_

output::FloatOutput* esphome::speed::SpeedFan::output_
protected

Definition at line 24 of file speed_fan.h.

◆ speed_count_

int esphome::speed::SpeedFan::speed_count_ {}
protected

Definition at line 28 of file speed_fan.h.


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