ESPHome  2024.2.0
Public Member Functions | Protected Member Functions
esphome::micronova::MicroNovaSwitch Class Reference

#include <micronova_switch.h>

Inheritance diagram for esphome::micronova::MicroNovaSwitch:
esphome::Component esphome::switch_::Switch esphome::micronova::MicroNovaSwitchListener esphome::EntityBase esphome::EntityBase_DeviceClass esphome::micronova::MicroNovaBaseListener

Public Member Functions

 MicroNovaSwitch (MicroNova *m)
 
void dump_config () override
 
void set_stove_state (bool v) override
 
bool get_stove_state () override
 
void set_memory_data_on (uint8_t f)
 
uint8_t get_memory_data_on ()
 
void set_memory_data_off (uint8_t f)
 
uint8_t get_memory_data_off ()
 
- Public Member Functions inherited from esphome::Component
virtual void setup ()
 Where the component's initialization should happen. More...
 
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 ()
 
bool is_ready ()
 
virtual bool can_proceed ()
 
bool status_has_warning ()
 
bool status_has_error ()
 
void status_set_warning ()
 
void status_set_error ()
 
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::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...
 
- Public Member Functions inherited from esphome::micronova::MicroNovaSwitchListener
 MicroNovaSwitchListener (MicroNova *m)
 
- Public Member Functions inherited from esphome::micronova::MicroNovaBaseListener
 MicroNovaBaseListener ()
 
 MicroNovaBaseListener (MicroNova *m)
 
void set_micronova_object (MicroNova *m)
 
void set_function (MicroNovaFunctions f)
 
MicroNovaFunctions get_function ()
 
void set_memory_location (uint8_t l)
 
uint8_t get_memory_location ()
 
void set_memory_address (uint8_t a)
 
uint8_t get_memory_address ()
 

Protected Member Functions

void write_state (bool state) 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::EntityBase
virtual uint32_t hash_base ()
 The hash_base() function has been deprecated. More...
 
void calc_object_id_ ()
 

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...
 
- 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::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...
 
- Protected Attributes inherited from esphome::micronova::MicroNovaSwitchListener
uint8_t memory_data_on_ = 0
 
uint8_t memory_data_off_ = 0
 
- Protected Attributes inherited from esphome::micronova::MicroNovaBaseListener
MicroNovamicronova_ {nullptr}
 
MicroNovaFunctions function_ = MicroNovaFunctions::STOVE_FUNCTION_VOID
 
uint8_t memory_location_ = 0
 
uint8_t memory_address_ = 0
 

Detailed Description

Definition at line 10 of file micronova_switch.h.

Constructor & Destructor Documentation

◆ MicroNovaSwitch()

esphome::micronova::MicroNovaSwitch::MicroNovaSwitch ( MicroNova m)
inline

Definition at line 12 of file micronova_switch.h.

Member Function Documentation

◆ dump_config()

void esphome::micronova::MicroNovaSwitch::dump_config ( )
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 13 of file micronova_switch.h.

◆ get_memory_data_off()

uint8_t esphome::micronova::MicroNovaSwitch::get_memory_data_off ( )
inline

Definition at line 22 of file micronova_switch.h.

◆ get_memory_data_on()

uint8_t esphome::micronova::MicroNovaSwitch::get_memory_data_on ( )
inline

Definition at line 19 of file micronova_switch.h.

◆ get_stove_state()

bool esphome::micronova::MicroNovaSwitch::get_stove_state ( )
inlineoverridevirtual

Implements esphome::micronova::MicroNovaSwitchListener.

Definition at line 16 of file micronova_switch.h.

◆ set_memory_data_off()

void esphome::micronova::MicroNovaSwitch::set_memory_data_off ( uint8_t  f)
inline

Definition at line 21 of file micronova_switch.h.

◆ set_memory_data_on()

void esphome::micronova::MicroNovaSwitch::set_memory_data_on ( uint8_t  f)
inline

Definition at line 18 of file micronova_switch.h.

◆ set_stove_state()

void esphome::micronova::MicroNovaSwitch::set_stove_state ( bool  v)
inlineoverridevirtual

Implements esphome::micronova::MicroNovaSwitchListener.

Definition at line 15 of file micronova_switch.h.

◆ write_state()

void esphome::micronova::MicroNovaSwitch::write_state ( bool  state)
overrideprotectedvirtual

Implements esphome::switch_::Switch.

Definition at line 6 of file micronova_switch.cpp.


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