ESPHome  2024.11.0
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::lightwaverf::LightWaveRF Class Reference

#include <lightwaverf.h>

Inheritance diagram for esphome::lightwaverf::LightWaveRF:
esphome::PollingComponent esphome::Component

Public Member Functions

void set_pin (InternalGPIOPin *pin_tx, InternalGPIOPin *pin_rx)
 
void update () override
 
void setup () override
 
void dump_config () override
 
void read_tx ()
 
void send_rx (const std::vector< uint8_t > &msg, uint8_t repeats, bool inverted, int u_sec)
 
- Public Member Functions inherited from esphome::PollingComponent
 PollingComponent ()
 
 PollingComponent (uint32_t update_interval)
 Initialize this polling component with the given update interval in ms. More...
 
virtual void set_update_interval (uint32_t update_interval)
 Manually set the update interval in ms for this polling object. More...
 
void call_setup () override
 
virtual uint32_t get_update_interval () const
 Get the update interval in ms of this sensor. More...
 
void start_poller ()
 
void stop_poller ()
 
- Public Member Functions inherited from esphome::Component
virtual void loop ()
 This method will be called repeatedly. 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 print_msg_ (uint8_t *msg, uint8_t len)
 
- Protected Member Functions inherited from esphome::Component
virtual void call_loop ()
 
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

uint8_t msg_ [10]
 
uint8_t msglen_ = 10
 
InternalGPIOPinpin_tx_
 
InternalGPIOPinpin_rx_
 
LwRx lwrx_
 
LwTx lwtx_
 
- Protected Attributes inherited from esphome::PollingComponent
uint32_t update_interval_
 
- 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 19 of file lightwaverf.h.

Member Function Documentation

◆ dump_config()

void esphome::lightwaverf::LightWaveRF::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 58 of file lightwaverf.cpp.

◆ print_msg_()

void esphome::lightwaverf::LightWaveRF::print_msg_ ( uint8_t *  msg,
uint8_t  len 
)
protected

Definition at line 48 of file lightwaverf.cpp.

◆ read_tx()

void esphome::lightwaverf::LightWaveRF::read_tx ( )

Definition at line 25 of file lightwaverf.cpp.

◆ send_rx()

void esphome::lightwaverf::LightWaveRF::send_rx ( const std::vector< uint8_t > &  msg,
uint8_t  repeats,
bool  inverted,
int  u_sec 
)

Definition at line 32 of file lightwaverf.cpp.

◆ set_pin()

void esphome::lightwaverf::LightWaveRF::set_pin ( InternalGPIOPin pin_tx,
InternalGPIOPin pin_rx 
)
inline

Definition at line 21 of file lightwaverf.h.

◆ setup()

void esphome::lightwaverf::LightWaveRF::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 16 of file lightwaverf.cpp.

◆ update()

void esphome::lightwaverf::LightWaveRF::update ( )
overridevirtual

Implements esphome::PollingComponent.

Definition at line 23 of file lightwaverf.cpp.

Field Documentation

◆ lwrx_

LwRx esphome::lightwaverf::LightWaveRF::lwrx_
protected

Definition at line 37 of file lightwaverf.h.

◆ lwtx_

LwTx esphome::lightwaverf::LightWaveRF::lwtx_
protected

Definition at line 38 of file lightwaverf.h.

◆ msg_

uint8_t esphome::lightwaverf::LightWaveRF::msg_[10]
protected

Definition at line 33 of file lightwaverf.h.

◆ msglen_

uint8_t esphome::lightwaverf::LightWaveRF::msglen_ = 10
protected

Definition at line 34 of file lightwaverf.h.

◆ pin_rx_

InternalGPIOPin* esphome::lightwaverf::LightWaveRF::pin_rx_
protected

Definition at line 36 of file lightwaverf.h.

◆ pin_tx_

InternalGPIOPin* esphome::lightwaverf::LightWaveRF::pin_tx_
protected

Definition at line 35 of file lightwaverf.h.


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