ESPHome  2021.11.3
Public Member Functions | Data Fields | Protected Member Functions | Protected Attributes
esphome::fan::FanState Class Reference

#include <fan_state.h>

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

Public Member Functions

 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 ()
 
void setup () override
 
float get_setup_priority () const override
 
- 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
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 ()
 
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...
 

Data Fields

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

Protected Member Functions

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_timeout (uint32_t timeout, std::function< void()> &&f)
 
void set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a unique name. More...
 
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

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
 

Detailed Description

Definition at line 70 of file fan_state.h.

Constructor & Destructor Documentation

◆ FanState() [1/2]

esphome::fan::FanState::FanState ( )
default

◆ FanState() [2/2]

esphome::fan::FanState::FanState ( const std::string &  name)
explicit

Construct the fan state with name.

Definition at line 15 of file fan_state.cpp.

Member Function Documentation

◆ add_on_state_callback()

void esphome::fan::FanState::add_on_state_callback ( std::function< void()> &&  callback)

Register a callback that will be called each time the state changes.

Definition at line 12 of file fan_state.cpp.

◆ get_setup_priority()

float esphome::fan::FanState::get_setup_priority ( ) const
overridevirtual

Reimplemented from esphome::Component.

Reimplemented in esphome::hbridge::HBridgeFan.

Definition at line 42 of file fan_state.cpp.

◆ get_traits()

const FanTraits & esphome::fan::FanState::get_traits ( ) const

Get the traits of this fan (i.e. what features it supports).

Definition at line 10 of file fan_state.cpp.

◆ hash_base()

uint32_t esphome::fan::FanState::hash_base ( )
overrideprotectedvirtual

Implements esphome::EntityBase.

Definition at line 43 of file fan_state.cpp.

◆ make_call()

FanStateCall esphome::fan::FanState::make_call ( )

Definition at line 20 of file fan_state.cpp.

◆ set_traits()

void esphome::fan::FanState::set_traits ( const FanTraits traits)

Set the traits of this fan (i.e. what features it supports).

Definition at line 11 of file fan_state.cpp.

◆ setup()

void esphome::fan::FanState::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Reimplemented in esphome::hbridge::HBridgeFan.

Definition at line 29 of file fan_state.cpp.

◆ toggle()

FanStateCall esphome::fan::FanState::toggle ( )

Definition at line 19 of file fan_state.cpp.

◆ turn_off()

FanStateCall esphome::fan::FanState::turn_off ( )

Definition at line 18 of file fan_state.cpp.

◆ turn_on()

FanStateCall esphome::fan::FanState::turn_on ( )

Definition at line 17 of file fan_state.cpp.

Field Documentation

◆ direction

FanDirection esphome::fan::FanState::direction {FAN_DIRECTION_FORWARD}

The current direction of the fan.

Definition at line 91 of file fan_state.h.

◆ FanStateCall

friend esphome::fan::FanState::FanStateCall
protected

Definition at line 102 of file fan_state.h.

◆ oscillating

bool esphome::fan::FanState::oscillating {false}

The current oscillation state of the fan.

Definition at line 87 of file fan_state.h.

◆ rtc_

ESPPreferenceObject esphome::fan::FanState::rtc_
protected

Definition at line 108 of file fan_state.h.

◆ speed

int esphome::fan::FanState::speed {}

The current fan speed level.

Definition at line 89 of file fan_state.h.

◆ state

bool esphome::fan::FanState::state {false}

The current ON/OFF state of the fan.

Definition at line 85 of file fan_state.h.

◆ state_callback_

CallbackManager<void()> esphome::fan::FanState::state_callback_ {}
protected

Definition at line 107 of file fan_state.h.

◆ traits_

FanTraits esphome::fan::FanState::traits_ {}
protected

Definition at line 106 of file fan_state.h.


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