ESPHome  2024.12.2
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::uponor_smatrix::UponorSmatrixComponent Class Reference

#include <uponor_smatrix.h>

Inheritance diagram for esphome::uponor_smatrix::UponorSmatrixComponent:
esphome::uart::UARTDevice esphome::Component

Public Member Functions

 UponorSmatrixComponent ()=default
 
void setup () override
 
void dump_config () override
 
void loop () override
 
void set_system_address (uint16_t address)
 
void register_device (UponorSmatrixDevice *device)
 
bool send (uint16_t device_address, const UponorSmatrixData *data, size_t data_len)
 
void set_time_id (time::RealTimeClock *time_id)
 
void set_time_device_address (uint16_t address)
 
void send_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 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...
 
- 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 () 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="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...
 

Protected Member Functions

bool parse_byte_ (uint8_t byte)
 
bool do_send_time_ ()
 
- 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 Attributes

uint16_t address_
 
std::vector< UponorSmatrixDevice * > devices_
 
std::set< uint16_t > unknown_devices_
 
std::vector< uint8_t > rx_buffer_
 
std::queue< std::vector< uint8_t > > tx_queue_
 
uint32_t last_rx_
 
uint32_t last_tx_
 
time::RealTimeClocktime_id_ {nullptr}
 
uint16_t time_device_address_
 
bool send_time_requested_
 
- Protected Attributes inherited from esphome::uart::UARTDevice
UARTComponentparent_ {nullptr}
 
- 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}
 

Detailed Description

Definition at line 66 of file uponor_smatrix.h.

Constructor & Destructor Documentation

◆ UponorSmatrixComponent()

esphome::uponor_smatrix::UponorSmatrixComponent::UponorSmatrixComponent ( )
default

Member Function Documentation

◆ do_send_time_()

bool esphome::uponor_smatrix::UponorSmatrixComponent::do_send_time_ ( )
protected

Definition at line 197 of file uponor_smatrix.cpp.

◆ dump_config()

void esphome::uponor_smatrix::UponorSmatrixComponent::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 17 of file uponor_smatrix.cpp.

◆ loop()

void esphome::uponor_smatrix::UponorSmatrixComponent::loop ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 37 of file uponor_smatrix.cpp.

◆ parse_byte_()

bool esphome::uponor_smatrix::UponorSmatrixComponent::parse_byte_ ( uint8_t  byte)
protected

Definition at line 80 of file uponor_smatrix.cpp.

◆ register_device()

void esphome::uponor_smatrix::UponorSmatrixComponent::register_device ( UponorSmatrixDevice device)
inline

Definition at line 75 of file uponor_smatrix.h.

◆ send()

bool esphome::uponor_smatrix::UponorSmatrixComponent::send ( uint16_t  device_address,
const UponorSmatrixData data,
size_t  data_len 
)

Definition at line 169 of file uponor_smatrix.cpp.

◆ send_time()

void esphome::uponor_smatrix::UponorSmatrixComponent::send_time ( )
inline

Definition at line 82 of file uponor_smatrix.h.

◆ set_system_address()

void esphome::uponor_smatrix::UponorSmatrixComponent::set_system_address ( uint16_t  address)
inline

Definition at line 74 of file uponor_smatrix.h.

◆ set_time_device_address()

void esphome::uponor_smatrix::UponorSmatrixComponent::set_time_device_address ( uint16_t  address)
inline

Definition at line 81 of file uponor_smatrix.h.

◆ set_time_id()

void esphome::uponor_smatrix::UponorSmatrixComponent::set_time_id ( time::RealTimeClock time_id)
inline

Definition at line 80 of file uponor_smatrix.h.

◆ setup()

void esphome::uponor_smatrix::UponorSmatrixComponent::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 9 of file uponor_smatrix.cpp.

Field Documentation

◆ address_

uint16_t esphome::uponor_smatrix::UponorSmatrixComponent::address_
protected

Definition at line 88 of file uponor_smatrix.h.

◆ devices_

std::vector<UponorSmatrixDevice *> esphome::uponor_smatrix::UponorSmatrixComponent::devices_
protected

Definition at line 89 of file uponor_smatrix.h.

◆ last_rx_

uint32_t esphome::uponor_smatrix::UponorSmatrixComponent::last_rx_
protected

Definition at line 94 of file uponor_smatrix.h.

◆ last_tx_

uint32_t esphome::uponor_smatrix::UponorSmatrixComponent::last_tx_
protected

Definition at line 95 of file uponor_smatrix.h.

◆ rx_buffer_

std::vector<uint8_t> esphome::uponor_smatrix::UponorSmatrixComponent::rx_buffer_
protected

Definition at line 92 of file uponor_smatrix.h.

◆ send_time_requested_

bool esphome::uponor_smatrix::UponorSmatrixComponent::send_time_requested_
protected

Definition at line 100 of file uponor_smatrix.h.

◆ time_device_address_

uint16_t esphome::uponor_smatrix::UponorSmatrixComponent::time_device_address_
protected

Definition at line 99 of file uponor_smatrix.h.

◆ time_id_

time::RealTimeClock* esphome::uponor_smatrix::UponorSmatrixComponent::time_id_ {nullptr}
protected

Definition at line 98 of file uponor_smatrix.h.

◆ tx_queue_

std::queue<std::vector<uint8_t> > esphome::uponor_smatrix::UponorSmatrixComponent::tx_queue_
protected

Definition at line 93 of file uponor_smatrix.h.

◆ unknown_devices_

std::set<uint16_t> esphome::uponor_smatrix::UponorSmatrixComponent::unknown_devices_
protected

Definition at line 90 of file uponor_smatrix.h.


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