ESPHome 2026.3.3
Loading...
Searching...
No Matches
esphome::micronova::MicroNova Class Reference

#include <micronova.h>

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

Public Member Functions

 MicroNova (GPIOPin *enable_rx_pin)
 
void setup () override
 
void loop () override
 
void dump_config () override
 
void register_micronova_listener (MicroNovaListener *listener)
 
void queue_read_request (uint8_t location, uint8_t address)
 Queue a read request to the stove (low priority - added at back) All listeners registered for this address will be notified with the result.
 
bool queue_write_command (uint8_t location, uint8_t address, uint8_t data)
 Queue a write command to the stove (processed before reads)
 
- Public Member Functions inherited from esphome::Component
virtual float get_setup_priority () const
 priority of setup().
 
float get_actual_setup_priority () const
 
void set_setup_priority (float priority)
 
virtual float get_loop_priority () const
 priority of loop().
 
void call ()
 
virtual void on_shutdown ()
 
virtual void on_safe_shutdown ()
 
virtual bool teardown ()
 Called during teardown to allow component to gracefully finish operations.
 
virtual void on_powerdown ()
 Called after teardown is complete to power down hardware.
 
uint8_t get_component_state () const
 
void reset_to_construction_state ()
 Reset this component back to the construction state to allow setup to run again.
 
bool is_in_loop_state () const
 Check if this component has completed setup and is in the loop state.
 
bool is_idle () const
 Check if this component is idle.
 
void mark_failed ()
 Mark this component as failed.
 
 ESPDEPRECATED ("Use mark_failed(LOG_STR(\"static string literal\")) instead. Do NOT use .c_str() from temporary " "strings. Will stop working in 2026.6.0", "2025.12.0") void mark_failed(const char *message)
 
void mark_failed (const LogString *message)
 
void disable_loop ()
 Disable this component's loop.
 
void enable_loop ()
 Enable this component's loop.
 
void enable_loop_soon_any_context ()
 Thread and ISR-safe version of enable_loop() that can be called from any context.
 
bool is_failed () const
 
bool is_ready () const
 
virtual bool can_proceed ()
 
bool status_has_warning () const
 
bool status_has_error () const
 
void status_set_warning (const char *message=nullptr)
 
void status_set_warning (const LogString *message)
 
void status_set_error ()
 
 ESPDEPRECATED ("Use status_set_error(LOG_STR(\"static string literal\")) instead. Do NOT use .c_str() from temporary " "strings. Will stop working in 2026.6.0", "2025.12.0") void status_set_error(const char *message)
 
void status_set_error (const LogString *message)
 
void status_clear_warning ()
 
void status_clear_error ()
 
void status_momentary_warning (const char *name, uint32_t length=5000)
 Set warning status flag and automatically clear it after a timeout.
 
void status_momentary_error (const char *name, uint32_t length=5000)
 Set error status flag and automatically clear it after a timeout.
 
bool has_overridden_loop () const
 
void set_component_source (const LogString *source)
 Set where this component was loaded from for some debug messages.
 
const LogString * get_component_log_str () const
 Get the integration where this component was declared as a LogString for logging.
 
bool should_warn_of_blocking (uint32_t blocking_time)
 
- 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 set_rx_full_threshold (size_t rx_full_threshold)
 
void set_rx_full_threshold_ms (size_t time)
 
size_t get_rx_full_threshold ()
 
void set_rx_timeout (size_t rx_timeout)
 
size_t get_rx_timeout ()
 
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 ()
 
size_t available ()
 
FlushResult 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.
 

Protected Member Functions

void send_current_command_ ()
 
int read_stove_reply_ ()
 
void request_update_listeners_ ()
 
- Protected Member Functions inherited from esphome::Component
void call_loop_ ()
 
virtual void call_setup ()
 
void call_dump_config_ ()
 
void set_component_state_ (uint8_t state)
 Helper to set component state (clears state bits and sets new state)
 
bool set_status_flag_ (uint8_t flag)
 Helper to set a status LED flag on both this component and the app.
 
void set_interval (uint32_t id, uint32_t interval, std::function< void()> &&f)
 Set an interval function with a numeric ID (zero heap allocation).
 
void set_interval (InternalSchedulerID id, uint32_t interval, std::function< void()> &&f)
 
void set_interval (uint32_t interval, std::function< void()> &&f)
 
bool cancel_interval (uint32_t id)
 
bool cancel_interval (InternalSchedulerID id)
 
ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std ESPDEPRECATED ("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const char *name
 
 ESPDEPRECATED ("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(uint32_t id
 
 ESPDEPRECATED ("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(uint32_t initial_wait_time
 
ESPDEPRECATED("cancel_retry is deprecated and will be removed in 2026.8.0.", "2026.2.0") bool cancel_retry(const std ESPDEPRECATED ("cancel_retry is deprecated and will be removed in 2026.8.0.", "2026.2.0") bool cancel_retry(const char *name)
 
 ESPDEPRECATED ("cancel_retry is deprecated and will be removed in 2026.8.0.", "2026.2.0") bool cancel_retry(uint32_t id)
 
void set_timeout (uint32_t id, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a numeric ID (zero heap allocation).
 
void set_timeout (InternalSchedulerID id, uint32_t timeout, std::function< void()> &&f)
 
void set_timeout (uint32_t timeout, std::function< void()> &&f)
 
bool cancel_timeout (uint32_t id)
 
bool cancel_timeout (InternalSchedulerID id)
 
void defer (std::function< void()> &&f)
 Defer a callback to the next loop() call.
 
void defer (uint32_t id, std::function< void()> &&f)
 Defer a callback with a numeric ID (zero heap allocation)
 
bool cancel_defer (uint32_t id)
 
void status_clear_warning_slow_path_ ()
 
void status_clear_error_slow_path_ ()
 

Protected Attributes

GPIOPinenable_rx_pin_
 
StaticRingBuffer< MicroNovaCommand, WRITE_QUEUE_SIZE > write_queue_
 
StaticRingBuffer< MicroNovaCommand, MICRONOVA_LISTENER_COUNT > read_queue_
 
MicroNovaCommand current_command_ {}
 
uint32_t transmission_time_ {0}
 Time when current command was sent.
 
bool reply_pending_ {false}
 True if we are waiting for a reply from the stove.
 
StaticVector< MicroNovaListener *, MICRONOVA_LISTENER_COUNT > listeners_
 
- Protected Attributes inherited from esphome::Component
ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") void set_interval(const std voi set_interval )(const char *name, uint32_t interval, std::function< void()> &&f)
 Set an interval function with a unique name.
 
ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") bool cancel_interval(const std boo cancel_interval )(const char *name)
 Cancel an interval function.
 
ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t initial_wait_time
 
ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t uint8_t max_attempts
 
ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t uint8_t std::function< RetryResult(uint8_t)> && f
 
ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t uint8_t std::function< RetryResult(uint8_t)> float backoff_increase_factor = 1.0f)
 
uint32_t initial_wait_time
 
uint32_t uint8_t max_attempts
 
uint32_t uint8_t std::function< RetryResult(uint8_t)> && f
 
uint32_t uint8_t std::function< RetryResult(uint8_t)> float backoff_increase_factor = 1.0f)
 
uint8_t max_attempts
 
uint8_t std::function< RetryResult(uint8_t)> && f
 
uint8_t std::function< RetryResult(uint8_t)> float backoff_increase_factor = 1.0f)
 
ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") void set_timeout(const std voi set_timeout )(const char *name, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a unique name.
 
ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") bool cancel_timeout(const std boo cancel_timeout )(const char *name)
 Cancel a timeout function.
 
ESPDEPRECATED("Use const char* overload instead. Removed in 2026.7.0", "2026.1.0") void defer(const std voi defer )(const char *name, std::function< void()> &&f)
 Defer a callback to the next loop() call.
 
ESPDEPRECATED("Use const char* overload instead. Removed in 2026.7.0", "2026.1.0") bool cancel_defer(const std boo cancel_defer )(const char *name)
 Cancel a defer callback using the specified name, name must not be empty.
 
const LogString * component_source_ {nullptr}
 
uint16_t warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_MS}
 Warn if blocked for this many ms (max 65.5s)
 
uint8_t component_state_ {0x00}
 State of this component - each bit has a purpose: Bits 0-2: Component state (0x00=CONSTRUCTION, 0x01=SETUP, 0x02=LOOP, 0x03=FAILED, 0x04=LOOP_DONE) Bit 3: STATUS_LED_WARNING Bit 4: STATUS_LED_ERROR Bit 5: Has overridden loop() (set at registration time) Bits 6-7: Unused - reserved for future expansion.
 
volatile bool pending_enable_loop_ {false}
 ISR-safe flag for enable_loop_soon_any_context.
 
- Protected Attributes inherited from esphome::uart::UARTDevice
UARTComponentparent_ {nullptr}
 

Detailed Description

Definition at line 61 of file micronova.h.

Constructor & Destructor Documentation

◆ MicroNova()

esphome::micronova::MicroNova::MicroNova ( GPIOPin * enable_rx_pin)
inline

Definition at line 63 of file micronova.h.

Member Function Documentation

◆ dump_config()

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

Reimplemented from esphome::Component.

Definition at line 35 of file micronova.cpp.

◆ loop()

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

Reimplemented from esphome::Component.

Definition at line 55 of file micronova.cpp.

◆ queue_read_request()

void esphome::micronova::MicroNova::queue_read_request ( uint8_t location,
uint8_t address )

Queue a read request to the stove (low priority - added at back) All listeners registered for this address will be notified with the result.

Parameters
locationMemory location on the stove
addressMemory address on the stove

Definition at line 109 of file micronova.cpp.

◆ queue_write_command()

bool esphome::micronova::MicroNova::queue_write_command ( uint8_t location,
uint8_t address,
uint8_t data )

Queue a write command to the stove (processed before reads)

Parameters
locationMemory location on the stove
addressMemory address on the stove
dataData to write
Returns
true if command was queued, false if queue was full

Definition at line 182 of file micronova.cpp.

◆ read_stove_reply_()

int esphome::micronova::MicroNova::read_stove_reply_ ( )
protected

Definition at line 164 of file micronova.cpp.

◆ register_micronova_listener()

void esphome::micronova::MicroNova::register_micronova_listener ( MicroNovaListener * listener)

Definition at line 41 of file micronova.cpp.

◆ request_update_listeners_()

void esphome::micronova::MicroNova::request_update_listeners_ ( )
protected

Definition at line 47 of file micronova.cpp.

◆ send_current_command_()

void esphome::micronova::MicroNova::send_current_command_ ( )
protected

Definition at line 131 of file micronova.cpp.

◆ setup()

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

Reimplemented from esphome::Component.

Definition at line 29 of file micronova.cpp.

Field Documentation

◆ current_command_

MicroNovaCommand esphome::micronova::MicroNova::current_command_ {}
protected

Definition at line 103 of file micronova.h.

◆ enable_rx_pin_

GPIOPin* esphome::micronova::MicroNova::enable_rx_pin_
protected

Definition at line 95 of file micronova.h.

◆ listeners_

StaticVector<MicroNovaListener *, MICRONOVA_LISTENER_COUNT> esphome::micronova::MicroNova::listeners_
protected

Definition at line 108 of file micronova.h.

◆ read_queue_

StaticRingBuffer<MicroNovaCommand, MICRONOVA_LISTENER_COUNT> esphome::micronova::MicroNova::read_queue_
protected

Definition at line 101 of file micronova.h.

◆ reply_pending_

bool esphome::micronova::MicroNova::reply_pending_ {false}
protected

True if we are waiting for a reply from the stove.

Definition at line 105 of file micronova.h.

◆ transmission_time_

uint32_t esphome::micronova::MicroNova::transmission_time_ {0}
protected

Time when current command was sent.

Definition at line 104 of file micronova.h.

◆ write_queue_

StaticRingBuffer<MicroNovaCommand, WRITE_QUEUE_SIZE> esphome::micronova::MicroNova::write_queue_
protected

Definition at line 98 of file micronova.h.


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