ESPHome
2024.11.3
|
#include <template_fan.h>
Public Member Functions | |
TemplateFan () | |
void | setup () override |
void | dump_config () override |
void | set_has_direction (bool has_direction) |
void | set_has_oscillating (bool has_oscillating) |
void | set_speed_count (int count) |
void | set_preset_modes (const std::set< std::string > &presets) |
fan::FanTraits | get_traits () override |
Public Member Functions inherited from esphome::Component | |
virtual void | loop () |
This method will be called repeatedly. More... | |
virtual float | get_setup_priority () const |
priority of setup(). More... | |
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 () const |
bool | is_ready () const |
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... | |
Public Member Functions inherited from esphome::fan::Fan | |
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 () |
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) |
Protected Member Functions | |
void | control (const fan::FanCall &call) override |
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... | |
Protected Member Functions inherited from esphome::fan::Fan | |
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 | |
bool | has_oscillating_ {false} |
bool | has_direction_ {false} |
int | speed_count_ {0} |
fan::FanTraits | traits_ |
std::set< std::string > | preset_modes_ {} |
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} |
Protected Attributes inherited from esphome::fan::Fan | |
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} |
Additional Inherited Members | |
Data Fields inherited from esphome::fan::Fan | |
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 {} |
Definition at line 11 of file template_fan.h.
|
inline |
Definition at line 13 of file template_fan.h.
|
overrideprotectedvirtual |
Implements esphome::fan::Fan.
Definition at line 23 of file template_fan.cpp.
|
overridevirtual |
Reimplemented from esphome::Component.
Definition at line 21 of file template_fan.cpp.
|
inlineoverridevirtual |
Implements esphome::fan::Fan.
Definition at line 20 of file template_fan.h.
|
inline |
Definition at line 16 of file template_fan.h.
|
inline |
Definition at line 17 of file template_fan.h.
|
inline |
Definition at line 19 of file template_fan.h.
|
inline |
Definition at line 18 of file template_fan.h.
|
overridevirtual |
Reimplemented from esphome::Component.
Definition at line 9 of file template_fan.cpp.
|
protected |
Definition at line 26 of file template_fan.h.
|
protected |
Definition at line 25 of file template_fan.h.
|
protected |
Definition at line 29 of file template_fan.h.
|
protected |
Definition at line 27 of file template_fan.h.
|
protected |
Definition at line 28 of file template_fan.h.