ESPHome  2024.4.2
Data Structures | Public Member Functions | Protected Attributes
esphome::micronova::MicroNova Class Reference

#include <micronova.h>

Inheritance diagram for esphome::micronova::MicroNova:
esphome::PollingComponent esphome::uart::UARTDevice esphome::Component

Data Structures

struct  MicroNovaSerialTransmission
 

Public Member Functions

 MicroNova ()
 
void setup () override
 
void loop () override
 
void update () override
 
void dump_config () override
 
void register_micronova_listener (MicroNovaSensorListener *l)
 
void request_address (uint8_t location, uint8_t address, MicroNovaSensorListener *listener)
 
void write_address (uint8_t location, uint8_t address, uint8_t data)
 
int read_stove_reply ()
 
void set_enable_rx_pin (GPIOPin *enable_rx_pin)
 
void set_current_stove_state (uint8_t s)
 
uint8_t get_current_stove_state ()
 
void set_stove (MicroNovaSwitchListener *s)
 
MicroNovaSwitchListenerget_stove_switch ()
 
- Public Member Functions inherited from esphome::PollingComponent
 PollingComponent ()
 
 PollingComponent (uint32_t update_interval)
 Initialize this polling component with the given update interval in ms. More...
 
virtual void set_update_interval (uint32_t update_interval)
 Manually set the update interval in ms for this polling object. More...
 
void call_setup () override
 
virtual uint32_t get_update_interval () const
 Get the update interval in ms of this sensor. More...
 
void start_poller ()
 
void stop_poller ()
 
- Public Member Functions inherited from esphome::Component
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 () const
 
bool status_has_error () const
 
void status_set_warning (const char *message="unspecified")
 
void status_set_error (const char *message="unspecified")
 
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::uart::UARTDevice
 UARTDevice ()=default
 
 UARTDevice (UARTComponent *parent)
 
void set_uart_parent (UARTComponent *parent)
 
void write_byte (uint8_t data)
 
void write_array (const uint8_t *data, size_t len)
 
void write_array (const std::vector< uint8_t > &data)
 
template<size_t N>
void write_array (const std::array< uint8_t, N > &data)
 
void write_str (const char *str)
 
bool read_byte (uint8_t *data)
 
bool peek_byte (uint8_t *data)
 
bool read_array (uint8_t *data, size_t len)
 
template<size_t N>
optional< std::array< uint8_t, N > > read_array ()
 
int available ()
 
void flush ()
 
int read ()
 
size_t write (uint8_t data)
 
int peek ()
 
void check_uart_settings (uint32_t baud_rate, uint8_t stop_bits=1, UARTParityOptions parity=UART_CONFIG_PARITY_NONE, uint8_t data_bits=8)
 Check that the configuration of the UART bus matches the provided values and otherwise print a warning. More...
 

Protected Attributes

uint8_t current_stove_state_ = 0
 
GPIOPinenable_rx_pin_ {nullptr}
 
Mutex reply_pending_mutex_
 
MicroNovaSerialTransmission current_transmission_
 
std::vector< MicroNovaSensorListener * > micronova_listeners_ {}
 
MicroNovaSwitchListenerstove_switch_ {nullptr}
 
- Protected Attributes inherited from esphome::PollingComponent
uint32_t update_interval_
 
- 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::uart::UARTDevice
UARTComponentparent_ {nullptr}
 

Additional Inherited Members

- Protected Member Functions inherited from esphome::Component
virtual void call_loop ()
 
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...
 

Detailed Description

Definition at line 121 of file micronova.h.

Constructor & Destructor Documentation

◆ MicroNova()

esphome::micronova::MicroNova::MicroNova ( )
inline

Definition at line 123 of file micronova.h.

Member Function Documentation

◆ dump_config()

void esphome::micronova::MicroNova::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 20 of file micronova.cpp.

◆ get_current_stove_state()

uint8_t esphome::micronova::MicroNova::get_current_stove_state ( )
inline

Definition at line 138 of file micronova.h.

◆ get_stove_switch()

MicroNovaSwitchListener* esphome::micronova::MicroNova::get_stove_switch ( )
inline

Definition at line 141 of file micronova.h.

◆ loop()

void esphome::micronova::MicroNova::loop ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 40 of file micronova.cpp.

◆ read_stove_reply()

int esphome::micronova::MicroNova::read_stove_reply ( )

Definition at line 96 of file micronova.cpp.

◆ register_micronova_listener()

void esphome::micronova::MicroNova::register_micronova_listener ( MicroNovaSensorListener l)
inline

Definition at line 129 of file micronova.h.

◆ request_address()

void esphome::micronova::MicroNova::request_address ( uint8_t  location,
uint8_t  address,
MicroNovaSensorListener listener 
)

Definition at line 65 of file micronova.cpp.

◆ set_current_stove_state()

void esphome::micronova::MicroNova::set_current_stove_state ( uint8_t  s)
inline

Definition at line 137 of file micronova.h.

◆ set_enable_rx_pin()

void esphome::micronova::MicroNova::set_enable_rx_pin ( GPIOPin enable_rx_pin)
inline

Definition at line 135 of file micronova.h.

◆ set_stove()

void esphome::micronova::MicroNova::set_stove ( MicroNovaSwitchListener s)
inline

Definition at line 140 of file micronova.h.

◆ setup()

void esphome::micronova::MicroNova::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 7 of file micronova.cpp.

◆ update()

void esphome::micronova::MicroNova::update ( )
overridevirtual

Implements esphome::PollingComponent.

Definition at line 33 of file micronova.cpp.

◆ write_address()

void esphome::micronova::MicroNova::write_address ( uint8_t  location,
uint8_t  address,
uint8_t  data 
)

Definition at line 118 of file micronova.cpp.

Field Documentation

◆ current_stove_state_

uint8_t esphome::micronova::MicroNova::current_stove_state_ = 0
protected

Definition at line 144 of file micronova.h.

◆ current_transmission_

MicroNovaSerialTransmission esphome::micronova::MicroNova::current_transmission_
protected

Definition at line 157 of file micronova.h.

◆ enable_rx_pin_

GPIOPin* esphome::micronova::MicroNova::enable_rx_pin_ {nullptr}
protected

Definition at line 146 of file micronova.h.

◆ micronova_listeners_

std::vector<MicroNovaSensorListener *> esphome::micronova::MicroNova::micronova_listeners_ {}
protected

Definition at line 159 of file micronova.h.

◆ reply_pending_mutex_

Mutex esphome::micronova::MicroNova::reply_pending_mutex_
protected

Definition at line 156 of file micronova.h.

◆ stove_switch_

MicroNovaSwitchListener* esphome::micronova::MicroNova::stove_switch_ {nullptr}
protected

Definition at line 160 of file micronova.h.


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