ESPHome 2025.10.0-dev
Loading...
Searching...
No Matches
esphome::zwave_proxy::ZWaveProxy Class Reference

#include <zwave_proxy.h>

Inheritance diagram for esphome::zwave_proxy::ZWaveProxy:
esphome::uart::UARTDevice esphome::Component

Public Member Functions

 ZWaveProxy ()
 
void setup () override
 
void loop () override
 
void dump_config () override
 
float get_setup_priority () const override
 
bool can_proceed () override
 
void zwave_proxy_request (api::APIConnection *api_connection, api::enums::ZWaveProxyRequestType type)
 
api::APIConnectionget_api_connection ()
 
uint32_t get_feature_flags () const
 
uint32_t get_home_id ()
 
void send_frame (const uint8_t *data, size_t length)
 
- 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 ()
 
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.
 
- Public Member Functions inherited from esphome::Component
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.
 
virtual void mark_failed ()
 Mark this component as failed.
 
void mark_failed (const char *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
 
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 (const char *message=nullptr)
 
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 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)
 

Protected Member Functions

void send_simple_command_ (uint8_t command_id)
 
bool parse_byte_ (uint8_t byte)
 
void parse_start_ (uint8_t byte)
 
bool response_handler_ ()
 
void process_uart_ ()
 
- Protected Member Functions inherited from esphome::Component
virtual void call_loop ()
 
virtual void call_setup ()
 
virtual void call_dump_config ()
 
void set_component_state_ (uint8_t state)
 Helper to set component state (clears state bits and sets new state)
 
void set_interval (const std::string &name, uint32_t interval, std::function< void()> &&f)
 Set an interval function with a unique name.
 
void set_interval (const char *name, uint32_t interval, std::function< void()> &&f)
 Set an interval function with a const char* name.
 
void set_interval (uint32_t interval, std::function< void()> &&f)
 
bool cancel_interval (const std::string &name)
 Cancel an interval function.
 
bool cancel_interval (const char *name)
 
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.
 
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.
 
void set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a unique name.
 
void set_timeout (const char *name, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a const char* name.
 
void set_timeout (uint32_t timeout, std::function< void()> &&f)
 
bool cancel_timeout (const std::string &name)
 Cancel a timeout function.
 
bool cancel_timeout (const char *name)
 
void defer (const std::string &name, std::function< void()> &&f)
 Defer a callback to the next loop() call.
 
void defer (const char *name, std::function< void()> &&f)
 Defer a callback to the next loop() call with a const char* name.
 
void defer (std::function< void()> &&f)
 Defer a callback to the next loop() call.
 
bool cancel_defer (const std::string &name)
 Cancel a defer callback using the specified name, name must not be empty.
 

Protected Attributes

api::ZWaveProxyFrame outgoing_proto_msg_
 
std::array< uint8_t, MAX_ZWAVE_FRAME_SIZE > buffer_
 
std::array< uint8_t, 4 > home_id_ {0, 0, 0, 0}
 
api::APIConnectionapi_connection_ {nullptr}
 
uint32_t setup_time_ {0}
 
uint8_t buffer_index_ {0}
 
uint8_t end_frame_after_ {0}
 
uint8_t last_response_ {0}
 
ZWaveParsingState parsing_state_ {ZWAVE_PARSING_STATE_WAIT_START}
 
bool in_bootloader_ {false}
 
bool home_id_ready_ {false}
 
- Protected Attributes inherited from esphome::uart::UARTDevice
UARTComponentparent_ {nullptr}
 
- Protected Attributes inherited from esphome::Component
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 Bits 5-7: Unused - reserved for future expansion.
 
volatile bool pending_enable_loop_ {false}
 ISR-safe flag for enable_loop_soon_any_context.
 

Detailed Description

Definition at line 42 of file zwave_proxy.h.

Constructor & Destructor Documentation

◆ ZWaveProxy()

esphome::zwave_proxy::ZWaveProxy::ZWaveProxy ( )

Definition at line 29 of file zwave_proxy.cpp.

Member Function Documentation

◆ can_proceed()

bool esphome::zwave_proxy::ZWaveProxy::can_proceed ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 41 of file zwave_proxy.cpp.

◆ dump_config()

void esphome::zwave_proxy::ZWaveProxy::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 123 of file zwave_proxy.cpp.

◆ get_api_connection()

api::APIConnection * esphome::zwave_proxy::ZWaveProxy::get_api_connection ( )
inline

Definition at line 53 of file zwave_proxy.h.

◆ get_feature_flags()

uint32_t esphome::zwave_proxy::ZWaveProxy::get_feature_flags ( ) const
inline

Definition at line 55 of file zwave_proxy.h.

◆ get_home_id()

uint32_t esphome::zwave_proxy::ZWaveProxy::get_home_id ( )
inline

Definition at line 56 of file zwave_proxy.h.

◆ get_setup_priority()

float esphome::zwave_proxy::ZWaveProxy::get_setup_priority ( ) const
overridevirtual

Reimplemented from esphome::Component.

Definition at line 36 of file zwave_proxy.cpp.

◆ loop()

void esphome::zwave_proxy::ZWaveProxy::loop ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 70 of file zwave_proxy.cpp.

◆ parse_byte_()

bool esphome::zwave_proxy::ZWaveProxy::parse_byte_ ( uint8_t byte)
protected

Definition at line 166 of file zwave_proxy.cpp.

◆ parse_start_()

void esphome::zwave_proxy::ZWaveProxy::parse_start_ ( uint8_t byte)
protected

Definition at line 235 of file zwave_proxy.cpp.

◆ process_uart_()

void esphome::zwave_proxy::ZWaveProxy::process_uart_ ( )
protected

Definition at line 83 of file zwave_proxy.cpp.

◆ response_handler_()

bool esphome::zwave_proxy::ZWaveProxy::response_handler_ ( )
protected

Definition at line 283 of file zwave_proxy.cpp.

◆ send_frame()

void esphome::zwave_proxy::ZWaveProxy::send_frame ( const uint8_t * data,
size_t length )

Definition at line 148 of file zwave_proxy.cpp.

◆ send_simple_command_()

void esphome::zwave_proxy::ZWaveProxy::send_simple_command_ ( uint8_t command_id)
protected

Definition at line 157 of file zwave_proxy.cpp.

◆ setup()

void esphome::zwave_proxy::ZWaveProxy::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 31 of file zwave_proxy.cpp.

◆ zwave_proxy_request()

void esphome::zwave_proxy::ZWaveProxy::zwave_proxy_request ( api::APIConnection * api_connection,
api::enums::ZWaveProxyRequestType type )

Definition at line 125 of file zwave_proxy.cpp.

Field Documentation

◆ api_connection_

api::APIConnection* esphome::zwave_proxy::ZWaveProxy::api_connection_ {nullptr}
protected

Definition at line 75 of file zwave_proxy.h.

◆ buffer_

std::array<uint8_t, MAX_ZWAVE_FRAME_SIZE> esphome::zwave_proxy::ZWaveProxy::buffer_
protected

Definition at line 71 of file zwave_proxy.h.

◆ buffer_index_

uint8_t esphome::zwave_proxy::ZWaveProxy::buffer_index_ {0}
protected

Definition at line 79 of file zwave_proxy.h.

◆ end_frame_after_

uint8_t esphome::zwave_proxy::ZWaveProxy::end_frame_after_ {0}
protected

Definition at line 80 of file zwave_proxy.h.

◆ home_id_

std::array<uint8_t, 4> esphome::zwave_proxy::ZWaveProxy::home_id_ {0, 0, 0, 0}
protected

Definition at line 72 of file zwave_proxy.h.

◆ home_id_ready_

bool esphome::zwave_proxy::ZWaveProxy::home_id_ready_ {false}
protected

Definition at line 84 of file zwave_proxy.h.

◆ in_bootloader_

bool esphome::zwave_proxy::ZWaveProxy::in_bootloader_ {false}
protected

Definition at line 83 of file zwave_proxy.h.

◆ last_response_

uint8_t esphome::zwave_proxy::ZWaveProxy::last_response_ {0}
protected

Definition at line 81 of file zwave_proxy.h.

◆ outgoing_proto_msg_

api::ZWaveProxyFrame esphome::zwave_proxy::ZWaveProxy::outgoing_proto_msg_
protected

Definition at line 70 of file zwave_proxy.h.

◆ parsing_state_

ZWaveParsingState esphome::zwave_proxy::ZWaveProxy::parsing_state_ {ZWAVE_PARSING_STATE_WAIT_START}
protected

Definition at line 82 of file zwave_proxy.h.

◆ setup_time_

uint32_t esphome::zwave_proxy::ZWaveProxy::setup_time_ {0}
protected

Definition at line 76 of file zwave_proxy.h.


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