ESPHome  2024.7.1
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::rf_bridge::RFBridgeComponent Class Reference

#include <rf_bridge.h>

Inheritance diagram for esphome::rf_bridge::RFBridgeComponent:
esphome::uart::UARTDevice esphome::Component

Public Member Functions

void loop () override
void dump_config () override
void add_on_code_received_callback (std::function< void(RFBridgeData)> callback)
void add_on_advanced_code_received_callback (std::function< void(RFBridgeAdvancedData)> callback)
void send_code (RFBridgeData data)
void send_advanced_code (const RFBridgeAdvancedData &data)
void learn ()
void start_advanced_sniffing ()
void stop_advanced_sniffing ()
void start_bucket_sniffing ()
void send_raw (const std::string &code)
void beep (uint16_t ms)
- 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...
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

void ack_ ()
void decode_ ()
bool parse_bridge_byte_ (uint8_t byte)
void write_byte_str_ (const std::string &codes)
- 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

std::vector< uint8_t > rx_buffer_
uint32_t last_bridge_byte_ {0}
CallbackManager< void(RFBridgeData)> data_callback_
CallbackManager< void(RFBridgeAdvancedData)> advanced_data_callback_
- 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 47 of file rf_bridge.h.

Member Function Documentation

◆ ack_()

void esphome::rf_bridge::RFBridgeComponent::ack_ ( )

Definition at line 11 of file rf_bridge.cpp.

◆ add_on_advanced_code_received_callback()

void esphome::rf_bridge::RFBridgeComponent::add_on_advanced_code_received_callback ( std::function< void(RFBridgeAdvancedData)>  callback)

Definition at line 54 of file rf_bridge.h.

◆ add_on_code_received_callback()

void esphome::rf_bridge::RFBridgeComponent::add_on_code_received_callback ( std::function< void(RFBridgeData)>  callback)

Definition at line 51 of file rf_bridge.h.

◆ beep()

void esphome::rf_bridge::RFBridgeComponent::beep ( uint16_t  ms)

Definition at line 223 of file rf_bridge.cpp.

◆ decode_()

void esphome::rf_bridge::RFBridgeComponent::decode_ ( )

◆ dump_config()

void esphome::rf_bridge::RFBridgeComponent::dump_config ( )

Reimplemented from esphome::Component.

Definition at line 187 of file rf_bridge.cpp.

◆ learn()

void esphome::rf_bridge::RFBridgeComponent::learn ( )

Definition at line 179 of file rf_bridge.cpp.

◆ loop()

void esphome::rf_bridge::RFBridgeComponent::loop ( )

Reimplemented from esphome::Component.

Definition at line 130 of file rf_bridge.cpp.

◆ parse_bridge_byte_()

bool esphome::rf_bridge::RFBridgeComponent::parse_bridge_byte_ ( uint8_t  byte)

Definition at line 19 of file rf_bridge.cpp.

◆ send_advanced_code()

void esphome::rf_bridge::RFBridgeComponent::send_advanced_code ( const RFBridgeAdvancedData data)

Definition at line 167 of file rf_bridge.cpp.

◆ send_code()

void esphome::rf_bridge::RFBridgeComponent::send_code ( RFBridgeData  data)

Definition at line 149 of file rf_bridge.cpp.

◆ send_raw()

void esphome::rf_bridge::RFBridgeComponent::send_raw ( const std::string &  code)

Definition at line 216 of file rf_bridge.cpp.

◆ start_advanced_sniffing()

void esphome::rf_bridge::RFBridgeComponent::start_advanced_sniffing ( )

Definition at line 192 of file rf_bridge.cpp.

◆ start_bucket_sniffing()

void esphome::rf_bridge::RFBridgeComponent::start_bucket_sniffing ( )

Definition at line 208 of file rf_bridge.cpp.

◆ stop_advanced_sniffing()

void esphome::rf_bridge::RFBridgeComponent::stop_advanced_sniffing ( )

Definition at line 200 of file rf_bridge.cpp.

◆ write_byte_str_()

void esphome::rf_bridge::RFBridgeComponent::write_byte_str_ ( const std::string &  codes)

Definition at line 121 of file rf_bridge.cpp.

Field Documentation

◆ advanced_data_callback_

CallbackManager<void(RFBridgeAdvancedData)> esphome::rf_bridge::RFBridgeComponent::advanced_data_callback_

Definition at line 76 of file rf_bridge.h.

◆ data_callback_

CallbackManager<void(RFBridgeData)> esphome::rf_bridge::RFBridgeComponent::data_callback_

Definition at line 75 of file rf_bridge.h.

◆ last_bridge_byte_

uint32_t esphome::rf_bridge::RFBridgeComponent::last_bridge_byte_ {0}

Definition at line 73 of file rf_bridge.h.

◆ rx_buffer_

std::vector<uint8_t> esphome::rf_bridge::RFBridgeComponent::rx_buffer_

Definition at line 72 of file rf_bridge.h.

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