ESPHome
2024.11.0
|
#include <fan.h>
Public Member Functions | |
FanCall | turn_on () |
FanCall | turn_off () |
FanCall | toggle () |
FanCall | make_call () |
void | add_on_state_callback (std::function< void()> &&callback) |
Register a callback that will be called each time the state changes. More... | |
void | publish_state () |
virtual FanTraits | get_traits ()=0 |
void | set_restore_mode (FanRestoreMode restore_mode) |
Set the restore mode of this fan. More... | |
Public Member Functions inherited from esphome::EntityBase | |
const StringRef & | get_name () const |
void | set_name (const char *name) |
bool | has_own_name () const |
std::string | get_object_id () const |
void | set_object_id (const char *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) |
std::string | get_icon () const |
void | set_icon (const char *icon) |
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 {0} |
The current fan speed level. More... | |
FanDirection | direction {FanDirection::FORWARD} |
The current direction of the fan. More... | |
std::string | preset_mode {} |
Protected Member Functions | |
virtual void | control (const FanCall &call)=0 |
optional< FanRestoreState > | restore_state_ () |
void | save_state_ () |
void | dump_traits_ (const char *tag, const char *prefix) |
Protected Member Functions inherited from esphome::EntityBase | |
virtual uint32_t | hash_base () |
The hash_base() function has been deprecated. More... | |
void | calc_object_id_ () |
Protected Attributes | |
friend | FanCall |
CallbackManager< void()> | state_callback_ {} |
ESPPreferenceObject | rtc_ |
FanRestoreMode | restore_mode_ |
Protected Attributes inherited from esphome::EntityBase | |
StringRef | name_ |
const char * | object_id_c_str_ {nullptr} |
const char * | icon_c_str_ {nullptr} |
uint32_t | object_id_hash_ |
bool | has_own_name_ {false} |
bool | internal_ {false} |
bool | disabled_by_default_ {false} |
EntityCategory | entity_category_ {ENTITY_CATEGORY_NONE} |
void esphome::fan::Fan::add_on_state_callback | ( | std::function< void()> && | callback | ) |
|
protectedpure virtual |
|
protected |
|
pure virtual |
|
protected |
|
inline |
FanDirection esphome::fan::Fan::direction {FanDirection::FORWARD} |
bool esphome::fan::Fan::oscillating {false} |
|
protected |
|
protected |
bool esphome::fan::Fan::state {false} |
|
protected |