ESPHome  2024.11.3
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::lvgl::LVGLSwitch Class Reference

#include <lvgl_switch.h>

Inheritance diagram for esphome::lvgl::LVGLSwitch:
esphome::switch_::Switch esphome::EntityBase esphome::EntityBase_DeviceClass

Public Member Functions

void set_control_lambda (std::function< void(bool)> state_lambda)
 
- 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. More...
 
void turn_on ()
 Turn this switch on. More...
 
void turn_off ()
 Turn this switch off. More...
 
void toggle ()
 Toggle this switch. More...
 
void set_inverted (bool inverted)
 Set whether the state should be treated as inverted. More...
 
void add_on_state_callback (std::function< void(bool)> &&callback)
 Set callback for state changes. More...
 
optional< bool > get_initial_state ()
 Returns the initial state of the switch, as persisted previously, or empty if never persisted. More...
 
optional< bool > get_initial_state_with_restore_mode ()
 Returns the initial state of the switch, after applying restore mode rules. More...
 
virtual bool assumed_state ()
 Return whether this switch uses an assumed state - i.e. More...
 
bool is_inverted () const
 
void set_restore_mode (SwitchRestoreMode restore_mode)
 
- Public Member Functions inherited from esphome::EntityBase
const StringRefget_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)
 
- Public Member Functions inherited from esphome::EntityBase_DeviceClass
std::string get_device_class ()
 Get the device class, using the manual override if set. More...
 
void set_device_class (const char *device_class)
 Manually set the device class. More...
 

Protected Member Functions

void write_state (bool value) override
 
- 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

std::function< void(bool)> state_lambda_ {}
 
optional< bool > initial_state_ {}
 
- Protected Attributes inherited from esphome::switch_::Switch
CallbackManager< void(bool)> state_callback_ {}
 
bool inverted_ {false}
 
Deduplicator< bool > publish_dedup_
 
ESPPreferenceObject rtc_
 
- 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}
 
- Protected Attributes inherited from esphome::EntityBase_DeviceClass
const char * device_class_ {nullptr}
 Device class override. More...
 

Additional Inherited Members

- Data Fields inherited from esphome::switch_::Switch
bool state
 The current reported state of the binary sensor. More...
 
SwitchRestoreMode restore_mode {SWITCH_RESTORE_DEFAULT_OFF}
 Indicates whether or not state is to be retrieved from flash and how. More...
 

Detailed Description

Definition at line 13 of file lvgl_switch.h.

Member Function Documentation

◆ set_control_lambda()

void esphome::lvgl::LVGLSwitch::set_control_lambda ( std::function< void(bool)>  state_lambda)
inline

Definition at line 15 of file lvgl_switch.h.

◆ write_state()

void esphome::lvgl::LVGLSwitch::write_state ( bool  value)
inlineoverrideprotectedvirtual

Implements esphome::switch_::Switch.

Definition at line 24 of file lvgl_switch.h.

Field Documentation

◆ initial_state_

optional<bool> esphome::lvgl::LVGLSwitch::initial_state_ {}
protected

Definition at line 32 of file lvgl_switch.h.

◆ state_lambda_

std::function<void(bool)> esphome::lvgl::LVGLSwitch::state_lambda_ {}
protected

Definition at line 31 of file lvgl_switch.h.


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