|
| 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.
|
| |
| void | publish_state () |
| |
| virtual FanTraits | get_traits ()=0 |
| |
| void | set_restore_mode (FanRestoreMode restore_mode) |
| | Set the restore mode of this fan.
|
| |
| StringRef | get_preset_mode () const |
| | Get the current preset mode.
|
| |
| bool | has_preset_mode () const |
| | Check if a preset mode is currently active.
|
| |
| const StringRef & | get_name () const |
| |
| bool | has_own_name () const |
| |
| ESPDEPRECATED("object_id mangles names and all object_id methods are planned for removal " "(see https://github.com/esphome/backlog/issues/76). " "Now is the time to stop using object_id. If still needed, use get_object_id_to() " "which will remain available longer. get_object_id() will be removed in 2026.7.0", "2025.12.0") std uint32_t | get_object_id_hash () |
| |
| StringRef | get_object_id_to (std::span< char, OBJECT_ID_MAX_LEN > buf) const |
| | Get object_id with zero heap allocation For static case: returns StringRef to internal storage (buffer unused) For dynamic case: formats into buffer and returns StringRef to buffer.
|
| |
| size_t | write_object_id_to (char *buf, size_t buf_size) const |
| | Write object_id directly to buffer, returns length written (excluding null) Useful for building compound strings without intermediate buffer.
|
| |
| bool | is_internal () const |
| |
| | ESPDEPRECATED ("set_internal() is undefined behavior at runtime — components and Home Assistant are NOT " "notified. Use the 'internal:' YAML key instead. Will be removed in 2027.3.0.", "2026.3.0") void set_internal(bool internal) |
| |
| bool | is_disabled_by_default () const |
| |
| EntityCategory | get_entity_category () const |
| |
| const char * | get_device_class_to (std::span< char, MAX_DEVICE_CLASS_LENGTH > buffer) const |
| |
| template<typename T = int> |
| StringRef | get_device_class_ref () const |
| |
| template<typename T = int> |
| std::string | get_device_class () const |
| |
| | ESPDEPRECATED ("Use get_device_class_to() instead. Will be removed in ESPHome 2026.9.0", "2026.3.0") StringRef get_device_class_ref() const |
| |
| ESPDEPRECATED("Use get_device_class_to() instead. Will be removed in ESPHome 2026.9.0", "2026.3.0") std StringRef | get_unit_of_measurement_ref () const |
| |
| ESPDEPRECATED("Use get_unit_of_measurement_ref() instead for better performance (avoids string copy). Will be " "removed in ESPHome 2026.9.0", "2026.3.0") std const char * | get_icon_to (std::span< char, MAX_ICON_LENGTH > buffer) const |
| | Get the unit of measurement as std::string (deprecated, prefer get_unit_of_measurement_ref())
|
| |
| template<typename T = int> |
| StringRef | get_icon_ref () const |
| |
| template<typename T = int> |
| std::string | get_icon () const |
| |
| | ESPDEPRECATED ("Use get_icon_to() instead. Will be removed in ESPHome 2026.9.0", "2026.3.0") StringRef get_icon_ref() const |
| |
| ESPDEPRECATED("Use get_icon_to() instead. Will be removed in ESPHome 2026.9.0", "2026.3.0") std uint32_t | get_device_id () const |
| |
| Device * | get_device () const |
| |
| bool | has_state () const |
| |
| void | set_has_state (bool state) |
| |
| | ESPDEPRECATED ("Use make_entity_preference<T>() instead, or preferences won't be migrated. " "See https://github.com/esphome/backlog/issues/85. Will be removed in 2027.1.0.", "2026.7.0") uint32_t get_preference_hash() |
| | Get a unique hash for storing preferences/settings for this entity.
|
| |
| template<typename T > |
| ESPPreferenceObject | make_entity_preference (uint32_t version=0) |
| | Create a preference object for storing this entity's state/settings.
|
| |
|
| virtual void | control (const FanCall &call)=0 |
| |
| optional< FanRestoreState > | restore_state_ () |
| |
| void | save_state_ () |
| |
| void | dump_traits_ (const char *tag, const char *prefix) |
| |
| bool | set_preset_mode_ (const char *preset_mode, size_t len) |
| | Set the preset mode (finds and stores pointer from traits).
|
| |
| bool | set_preset_mode_ (const char *preset_mode) |
| |
| bool | set_preset_mode_ (const std::string &preset_mode) |
| |
| bool | set_preset_mode_ (StringRef preset_mode) |
| |
| void | clear_preset_mode_ () |
| | Clear the preset mode.
|
| |
| void | apply_preset_mode_ (const FanCall &call) |
| | Apply preset mode from a FanCall (handles speed-clears-preset convention)
|
| |
| const char * | find_preset_mode_ (const char *preset_mode) |
| | Find and return the matching preset mode pointer from traits, or nullptr if not found.
|
| |
| const char * | find_preset_mode_ (const char *preset_mode, size_t len) |
| |
| friend | void::setup () |
| |
| friend | void::original_setup () |
| |
| void | configure_entity_ (const char *name, uint32_t object_id_hash, uint32_t entity_fields) |
| | Combined entity setup from codegen: set name, object_id hash, entity string indices, and flags.
|
| |
| void | set_device_ (Device *device) |
| |
| ESPPreferenceObject | make_entity_preference_ (size_t size, uint32_t version) |
| | Non-template helper for make_entity_preference() to avoid code bloat.
|
| |
| void | calc_object_id_ () |
| |
Definition at line 108 of file fan.h.
Public Member Functions inherited from esphome::EntityBase
1.12.0