|
| FanCall | turn_on () |
| |
| FanCall | turn_off () |
| |
| FanCall | toggle () |
| |
| FanCall | make_call () |
| |
| template<typename F > |
| void | add_on_state_callback (F &&callback) |
| | Register a callback that will be called each time the state changes.
|
| |
| void | publish_state () |
| |
| virtual FanTraits | get_traits ()=0 |
| |
| void | set_supported_preset_modes (std::initializer_list< const char * > preset_modes) |
| | Set the supported preset modes; the list is copied (stored on Fan, referenced by FanTraits).
|
| |
| void | set_supported_preset_modes (const std::vector< const char * > &preset_modes) |
| |
| void | set_supported_preset_modes (const FanPresetModes &preset_modes) |
| |
| void | set_supported_preset_modes_static (const char *const *preset_modes, size_t count) |
| | Points at a static table that outlives the fan (codegen); call before any runtime copy.
|
| |
| 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.
|
| |
| | ESPDEPRECATED ("Use get_name_to() or get_log_name() instead. Will be removed in ESPHome 2027.5.0", "2026.11.0") const StringRef &get_name() const |
| | The name is in flash here; the first call makes a RAM copy that is kept for the life of the device.
|
| |
| StringRef | get_name_to (std::span< char, ENTITY_NAME_BUF_SIZE > buffer) const |
| | Get the name of this Entity, copied out of flash into buffer.
|
| |
| | ESPDEPRECATED ("Use get_name_to() or get_log_name() instead. Will be removed in ESPHome 2027.5.0", "2026.11.0") const StringRef &get_name() const |
| |
| const StringRef & | get_name_to (std::span< char, ENTITY_NAME_BUF_SIZE >) const |
| |
| bool | name_equals (const StringRef &other) const |
| |
| const ProgmemStringRef & | get_name_progmem () const |
| | The name as stored, for consumers that read flash themselves (e.g. API progmem fields).
|
| |
| size_t | write_name_to (char *buf, size_t buf_size) const |
| | Copy the name into buf (null terminated), returns its length.
|
| |
| const LogString * | get_log_name () const |
| | Get the name for a "%s" log argument (LOG_STR_ARG).
|
| |
| bool | has_own_name () const |
| |
| uint32_t | get_object_id_hash () const |
| |
| 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 |
| |
| 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 |
| |
| ProgmemStringRef | get_device_class_progmem () const |
| | The device class as stored (in flash on ESP8266), for consumers that read flash themselves.
|
| |
| StringRef | get_unit_of_measurement_ref () const |
| |
| const char * | get_icon_to (std::span< char, MAX_ICON_LENGTH > buffer) const |
| |
| ProgmemStringRef | get_icon_progmem () const |
| | The icon as stored (in flash on ESP8266), for consumers that read flash themselves.
|
| |
| 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.
|
| |
| template<typename T > |
| ESPPreferenceObject | make_entity_preference (uint32_t version, bool in_flash) |
| | As make_entity_preference(), stored in flash or RTC memory where the backend supports the choice.
|
| |
|
| 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) |
| |
| void | wire_preset_modes_ (FanTraits &traits) |
| | Wire the Fan-owned preset modes pointer into the given traits object.
|
| |
| 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 helpers for make_entity_preference() to avoid code bloat.
|
| |
| ESPPreferenceObject | make_entity_preference_ (size_t size, uint32_t version, bool in_flash) |
| |
| uint32_t | entity_preference_key_ (uint32_t version) |
| | Key for both helpers; preference hash migration goes here.
|
| |
Definition at line 108 of file fan.h.
Public Member Functions inherited from esphome::EntityBase
1.12.0