ESPHome  2024.2.0
Public Member Functions | Protected Attributes
esphome::vbus::VBus Class Reference

#include <vbus.h>

Inheritance diagram for esphome::vbus::VBus:
esphome::uart::UARTDevice esphome::Component

Public Member Functions

void dump_config () override
 
void loop () override
 
float get_setup_priority () const override
 
void register_listener (VBusListener *listener)
 
- 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 void setup ()
 Where the component's initialization should happen. 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...
 

Protected Attributes

int state_ {0}
 
std::vector< uint8_t > buffer_
 
uint8_t protocol_
 
uint16_t source_
 
uint16_t dest_
 
uint16_t command_
 
uint8_t frames_
 
uint8_t cframe_
 
uint8_t fbytes_ [6]
 
int fbcount_
 
std::vector< VBusListener * > listeners_ {}
 
- 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}
 

Additional Inherited Members

- 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...
 

Detailed Description

Definition at line 29 of file vbus.h.

Member Function Documentation

◆ dump_config()

void esphome::vbus::VBus::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 11 of file vbus.cpp.

◆ get_setup_priority()

float esphome::vbus::VBus::get_setup_priority ( ) const
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 33 of file vbus.h.

◆ loop()

void esphome::vbus::VBus::loop ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 30 of file vbus.cpp.

◆ register_listener()

void esphome::vbus::VBus::register_listener ( VBusListener listener)
inline

Definition at line 35 of file vbus.h.

Field Documentation

◆ buffer_

std::vector<uint8_t> esphome::vbus::VBus::buffer_
protected

Definition at line 39 of file vbus.h.

◆ cframe_

uint8_t esphome::vbus::VBus::cframe_
protected

Definition at line 45 of file vbus.h.

◆ command_

uint16_t esphome::vbus::VBus::command_
protected

Definition at line 43 of file vbus.h.

◆ dest_

uint16_t esphome::vbus::VBus::dest_
protected

Definition at line 42 of file vbus.h.

◆ fbcount_

int esphome::vbus::VBus::fbcount_
protected

Definition at line 47 of file vbus.h.

◆ fbytes_

uint8_t esphome::vbus::VBus::fbytes_[6]
protected

Definition at line 46 of file vbus.h.

◆ frames_

uint8_t esphome::vbus::VBus::frames_
protected

Definition at line 44 of file vbus.h.

◆ listeners_

std::vector<VBusListener *> esphome::vbus::VBus::listeners_ {}
protected

Definition at line 48 of file vbus.h.

◆ protocol_

uint8_t esphome::vbus::VBus::protocol_
protected

Definition at line 40 of file vbus.h.

◆ source_

uint16_t esphome::vbus::VBus::source_
protected

Definition at line 41 of file vbus.h.

◆ state_

int esphome::vbus::VBus::state_ {0}
protected

Definition at line 38 of file vbus.h.


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