ESPHome 2026.11.0b6
Loading...
Searching...
No Matches
esphome::switch_::ApplySwitch< Fn > Class Template Referencefinal

Calls the codegen-generated Fn(this, state) on a state write; the hub and any publish are baked into Fn. More...

#include <switch.h>

Inheritance diagram for esphome::switch_::ApplySwitch< Fn >:
esphome::switch_::Switch esphome::EntityBase

Public Member Functions

 ApplySwitch ()
 
- Public Member Functions inherited from esphome::switch_::Switch
 Switch ()
 
void publish_state (bool state)
 Publish a state to the front-end from the back-end.
 
void control (bool target_state)
 Control this switch using a boolean state value.
 
void turn_on ()
 Turn this switch on.
 
void turn_off ()
 Turn this switch off.
 
void toggle ()
 Toggle this switch.
 
void set_inverted (bool inverted)
 Set whether the state should be treated as inverted.
 
template<typename F >
void add_on_state_callback (F &&callback)
 Set callback for state changes.
 
optional< bool > get_initial_state ()
 Returns the initial state of the switch, as persisted previously, or empty if never persisted.
 
optional< bool > get_initial_state_with_restore_mode ()
 Returns the initial state of the switch, after applying restore mode rules.
 
optional< bool > get_initial_write_state ()
 get_initial_state_with_restore_mode() with inverted applied: the level write_state() takes.
 
void restore ()
 Drive the switch to the state its restore mode yields, through control(), so inversion and write_state() apply; a disabled restore mode drives when_disabled, or nothing without one.
 
void restore (bool when_disabled)
 
virtual bool assumed_state ()
 Return whether this switch uses an assumed state - i.e.
 
bool is_inverted () const
 
void set_restore_mode (SwitchRestoreMode restore_mode)
 
- Public Member Functions inherited from esphome::EntityBase
 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.
 

Protected Member Functions

void write_state (bool state) override
 
- Protected Member Functions inherited from esphome::switch_::Switch
- Protected Member Functions inherited from esphome::EntityBase
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.
 

Additional Inherited Members

- Data Fields inherited from esphome::switch_::Switch
SwitchRestoreMode restore_mode {SWITCH_RESTORE_DEFAULT_OFF}
 Indicates whether or not state is to be retrieved from flash and how.
 
bool state
 The current reported state of the binary sensor.
 
- Protected Attributes inherited from esphome::switch_::Switch
ESPPreferenceObject rtc_
 
LazyCallbackManager< void(bool)> state_callback_ {}
 
Deduplicator< bool > publish_dedup_
 
bool inverted_ {false}
 
- Protected Attributes inherited from esphome::EntityBase
ProgmemStringRef name_
 
uint32_t object_id_hash_ {}
 
Device * device_ {}
 
struct esphome::EntityBase::EntityFlags flags_
 
uint8_t device_class_idx_ {}
 
uint8_t uom_idx_ {}
 
uint8_t icon_idx_ {}
 

Detailed Description

template<auto Fn>
class esphome::switch_::ApplySwitch< Fn >

Calls the codegen-generated Fn(this, state) on a state write; the hub and any publish are baked into Fn.

Definition at line 163 of file switch.h.

Constructor & Destructor Documentation

◆ ApplySwitch()

template<auto Fn>
esphome::switch_::ApplySwitch< Fn >::ApplySwitch ( )
inline

Definition at line 166 of file switch.h.

Member Function Documentation

◆ write_state()

template<auto Fn>
void esphome::switch_::ApplySwitch< Fn >::write_state ( bool state)
inlineoverrideprotectedvirtual

Implements esphome::switch_::Switch.

Definition at line 169 of file switch.h.


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