ESPHome  2022.1.1
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::hbridge::HBridgeFan Class Reference

#include <hbridge_fan.h>

Inheritance diagram for esphome::hbridge::HBridgeFan:
esphome::fan::FanState esphome::EntityBase esphome::Component

Public Member Functions

 HBridgeFan (int speed_count, DecayMode decay_mode)
 
void set_pin_a (output::FloatOutput *pin_a)
 
void set_pin_b (output::FloatOutput *pin_b)
 
void set_enable_pin (output::FloatOutput *enable)
 
void setup () override
 
void loop () override
 
void dump_config () override
 
float get_setup_priority () const override
 
fan::FanStateCall brake ()
 
int get_speed_count ()
 
void internal_update ()
 
- Public Member Functions inherited from esphome::fan::FanState
 FanState ()=default
 
 FanState (const std::string &name)
 Construct the fan state with name. More...
 
void add_on_state_callback (std::function< void()> &&callback)
 Register a callback that will be called each time the state changes. More...
 
const FanTraitsget_traits () const
 Get the traits of this fan (i.e. what features it supports). More...
 
void set_traits (const FanTraits &traits)
 Set the traits of this fan (i.e. what features it supports). More...
 
FanStateCall turn_on ()
 
FanStateCall turn_off ()
 
FanStateCall toggle ()
 
FanStateCall make_call ()
 
- Public Member Functions inherited from esphome::EntityBase
 EntityBase ()
 
 EntityBase (std::string name)
 
const std::string & get_name () const
 
void set_name (const std::string &name)
 
const std::string & get_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)
 
const std::string & get_icon () const
 
void set_icon (const std::string &name)
 
- 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 Member Functions

void set_hbridge_levels_ (float a_level, float b_level)
 
void set_hbridge_levels_ (float a_level, float b_level, float enable)
 
- Protected Member Functions inherited from esphome::fan::FanState
uint32_t hash_base () override
 
- Protected Member Functions inherited from esphome::EntityBase
void calc_object_id_ ()
 
- 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...
 

Protected Attributes

output::FloatOutputpin_a_
 
output::FloatOutputpin_b_
 
output::FloatOutputenable_ {nullptr}
 
output::BinaryOutputoscillating_ {nullptr}
 
bool next_update_ {true}
 
int speed_count_ {}
 
DecayMode decay_mode_ {DECAY_MODE_SLOW}
 
- Protected Attributes inherited from esphome::fan::FanState
friend FanStateCall
 
FanTraits traits_ {}
 
CallbackManager< void()> state_callback_ {}
 
ESPPreferenceObject rtc_
 
- Protected Attributes inherited from esphome::EntityBase
std::string name_
 
std::string object_id_
 
std::string icon_
 
uint32_t object_id_hash_
 
bool internal_ {false}
 
bool disabled_by_default_ {false}
 
EntityCategory entity_category_ {ENTITY_CATEGORY_NONE}
 
- 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::fan::FanState
bool state {false}
 The current ON/OFF state of the fan. More...
 
bool oscillating {false}
 The current oscillation state of the fan. More...
 
int speed {}
 The current fan speed level. More...
 
FanDirection direction {FAN_DIRECTION_FORWARD}
 The current direction of the fan. More...
 

Detailed Description

Definition at line 16 of file hbridge_fan.h.

Constructor & Destructor Documentation

◆ HBridgeFan()

esphome::hbridge::HBridgeFan::HBridgeFan ( int  speed_count,
DecayMode  decay_mode 
)
inline

Definition at line 18 of file hbridge_fan.h.

Member Function Documentation

◆ brake()

fan::FanStateCall esphome::hbridge::HBridgeFan::brake ( )

Definition at line 25 of file hbridge_fan.cpp.

◆ dump_config()

void esphome::hbridge::HBridgeFan::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 31 of file hbridge_fan.cpp.

◆ get_setup_priority()

float esphome::hbridge::HBridgeFan::get_setup_priority ( ) const
inlineoverridevirtual

Reimplemented from esphome::fan::FanState.

Definition at line 27 of file hbridge_fan.h.

◆ get_speed_count()

int esphome::hbridge::HBridgeFan::get_speed_count ( )
inline

Definition at line 31 of file hbridge_fan.h.

◆ internal_update()

void esphome::hbridge::HBridgeFan::internal_update ( )
inline

Definition at line 33 of file hbridge_fan.h.

◆ loop()

void esphome::hbridge::HBridgeFan::loop ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 50 of file hbridge_fan.cpp.

◆ set_enable_pin()

void esphome::hbridge::HBridgeFan::set_enable_pin ( output::FloatOutput enable)
inline

Definition at line 22 of file hbridge_fan.h.

◆ set_hbridge_levels_() [1/2]

void esphome::hbridge::HBridgeFan::set_hbridge_levels_ ( float  a_level,
float  b_level 
)
protected

Definition at line 10 of file hbridge_fan.cpp.

◆ set_hbridge_levels_() [2/2]

void esphome::hbridge::HBridgeFan::set_hbridge_levels_ ( float  a_level,
float  b_level,
float  enable 
)
protected

Definition at line 18 of file hbridge_fan.cpp.

◆ set_pin_a()

void esphome::hbridge::HBridgeFan::set_pin_a ( output::FloatOutput pin_a)
inline

Definition at line 20 of file hbridge_fan.h.

◆ set_pin_b()

void esphome::hbridge::HBridgeFan::set_pin_b ( output::FloatOutput pin_b)
inline

Definition at line 21 of file hbridge_fan.h.

◆ setup()

void esphome::hbridge::HBridgeFan::setup ( )
overridevirtual

Reimplemented from esphome::fan::FanState.

Definition at line 45 of file hbridge_fan.cpp.

Field Documentation

◆ decay_mode_

DecayMode esphome::hbridge::HBridgeFan::decay_mode_ {DECAY_MODE_SLOW}
protected

Definition at line 42 of file hbridge_fan.h.

◆ enable_

output::FloatOutput* esphome::hbridge::HBridgeFan::enable_ {nullptr}
protected

Definition at line 38 of file hbridge_fan.h.

◆ next_update_

bool esphome::hbridge::HBridgeFan::next_update_ {true}
protected

Definition at line 40 of file hbridge_fan.h.

◆ oscillating_

output::BinaryOutput* esphome::hbridge::HBridgeFan::oscillating_ {nullptr}
protected

Definition at line 39 of file hbridge_fan.h.

◆ pin_a_

output::FloatOutput* esphome::hbridge::HBridgeFan::pin_a_
protected

Definition at line 36 of file hbridge_fan.h.

◆ pin_b_

output::FloatOutput* esphome::hbridge::HBridgeFan::pin_b_
protected

Definition at line 37 of file hbridge_fan.h.

◆ speed_count_

int esphome::hbridge::HBridgeFan::speed_count_ {}
protected

Definition at line 41 of file hbridge_fan.h.


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