ESPHome 2025.7.1
Loading...
Searching...
No Matches
esphome::sx126x::SX126xTransport Class Reference

#include <sx126x_transport.h>

Inheritance diagram for esphome::sx126x::SX126xTransport:
esphome::packet_transport::PacketTransport esphome::Parented< SX126x > esphome::sx126x::SX126xListener esphome::PollingComponent esphome::Component

Public Member Functions

void setup () override
 
void update () override
 
void on_packet (const std::vector< uint8_t > &packet, float rssi, float snr) override
 
float get_setup_priority () const override
 
- Public Member Functions inherited from esphome::packet_transport::PacketTransport
void loop () override
 
void dump_config () override
 
void add_sensor (const char *id, sensor::Sensor *sensor)
 
void add_remote_sensor (const char *hostname, const char *remote_id, sensor::Sensor *sensor)
 
void add_binary_sensor (const char *id, binary_sensor::BinarySensor *sensor)
 
void add_remote_binary_sensor (const char *hostname, const char *remote_id, binary_sensor::BinarySensor *sensor)
 
void add_provider (const char *hostname)
 
void set_encryption_key (std::vector< uint8_t > key)
 
void set_rolling_code_enable (bool enable)
 
void set_ping_pong_enable (bool enable)
 
void set_ping_pong_recycle_time (uint32_t recycle_time)
 
void set_provider_encryption (const char *name, std::vector< uint8_t > key)
 
void set_provider_status_sensor (const char *name, binary_sensor::BinarySensor *sensor)
 
void set_platform_name (const char *name)
 
- Public Member Functions inherited from esphome::PollingComponent
 PollingComponent ()
 
 PollingComponent (uint32_t update_interval)
 Initialize this polling component with the given update interval in ms.
 
virtual void set_update_interval (uint32_t update_interval)
 Manually set the update interval in ms for this polling object.
 
void call_setup () override
 
virtual uint32_t get_update_interval () const
 Get the update interval in ms of this sensor.
 
void start_poller ()
 
void stop_poller ()
 
- 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
 
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.
 
const char * get_component_source () const
 Get the integration where this component was declared as a string.
 
bool should_warn_of_blocking (uint32_t blocking_time)
 
- Public Member Functions inherited from esphome::Parented< SX126x >
 Parented ()
 
 Parented (SX126x *parent)
 
SX126x * get_parent () const
 Get the parent of this object.
 
void set_parent (SX126x *parent)
 Set the parent of this object.
 
- Public Member Functions inherited from esphome::sx126x::SX126xListener

Protected Member Functions

void send_packet (const std::vector< uint8_t > &buf) const override
 
bool should_send () override
 
size_t get_max_packet_size () override
 
- Protected Member Functions inherited from esphome::packet_transport::PacketTransport
void process_ (const std::vector< uint8_t > &data)
 Process a received packet.
 
void send_data_ (bool all)
 
void flush_ ()
 
void add_data_ (uint8_t key, const char *id, float data)
 
void add_data_ (uint8_t key, const char *id, uint32_t data)
 
void increment_code_ ()
 
void add_binary_data_ (uint8_t key, const char *id, bool data)
 
void init_data_ ()
 
void add_key_ (const char *name, uint32_t key)
 
void send_ping_pong_request_ ()
 
bool is_encrypted_ ()
 
- 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.
 
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.
 

Additional Inherited Members

- Protected Attributes inherited from esphome::packet_transport::PacketTransport
bool updated_ {}
 
uint32_t ping_key_ {}
 
uint32_t rolling_code_ [2] {}
 
bool rolling_code_enable_ {}
 
bool ping_pong_enable_ {}
 
uint32_t ping_pong_recyle_time_ {}
 
uint32_t last_key_time_ {}
 
bool resend_ping_key_ {}
 
bool resend_data_ {}
 
const char * name_ {}
 
ESPPreferenceObject pref_ {}
 
std::vector< uint8_t > encryption_key_ {}
 
std::vector< Sensorsensors_ {}
 
std::map< std::string, std::map< std::string, sensor::Sensor * > > remote_sensors_ {}
 
std::vector< BinarySensorbinary_sensors_ {}
 
std::map< std::string, std::map< std::string, binary_sensor::BinarySensor * > > remote_binary_sensors_ {}
 
std::map< std::string, Providerproviders_ {}
 
std::vector< uint8_t > ping_header_ {}
 
std::vector< uint8_t > header_ {}
 
std::vector< uint8_t > data_ {}
 
std::map< const char *, uint32_t > ping_keys_ {}
 
const char * platform_name_ {""}
 
- Protected Attributes inherited from esphome::PollingComponent
uint32_t update_interval_
 
- Protected Attributes inherited from esphome::Component
const char * 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-1: Component state (0x00=CONSTRUCTION, 0x01=SETUP, 0x02=LOOP, 0x03=FAILED) Bit 2: STATUS_LED_WARNING Bit 3: STATUS_LED_ERROR Bits 4-7: Unused - reserved for future expansion (50% of the bits are free)
 
volatile bool pending_enable_loop_ {false}
 ISR-safe flag for enable_loop_soon_any_context.
 
- Protected Attributes inherited from esphome::Parented< SX126x >
SX126x * parent_
 

Detailed Description

Definition at line 11 of file sx126x_transport.h.

Member Function Documentation

◆ get_max_packet_size()

size_t esphome::sx126x::SX126xTransport::get_max_packet_size ( )
inlineoverrideprotectedvirtual

Implements esphome::packet_transport::PacketTransport.

Definition at line 21 of file sx126x_transport.h.

◆ get_setup_priority()

float esphome::sx126x::SX126xTransport::get_setup_priority ( ) const
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 16 of file sx126x_transport.h.

◆ on_packet()

void esphome::sx126x::SX126xTransport::on_packet ( const std::vector< uint8_t > & packet,
float rssi,
float snr )
overridevirtual

Implements esphome::sx126x::SX126xListener.

Definition at line 23 of file sx126x_transport.cpp.

◆ send_packet()

void esphome::sx126x::SX126xTransport::send_packet ( const std::vector< uint8_t > & buf) const
overrideprotectedvirtual

Implements esphome::packet_transport::PacketTransport.

Definition at line 21 of file sx126x_transport.cpp.

◆ setup()

void esphome::sx126x::SX126xTransport::setup ( )
overridevirtual

Reimplemented from esphome::packet_transport::PacketTransport.

Definition at line 10 of file sx126x_transport.cpp.

◆ should_send()

bool esphome::sx126x::SX126xTransport::should_send ( )
inlineoverrideprotectedvirtual

Reimplemented from esphome::packet_transport::PacketTransport.

Definition at line 20 of file sx126x_transport.h.

◆ update()

void esphome::sx126x::SX126xTransport::update ( )
overridevirtual

Reimplemented from esphome::packet_transport::PacketTransport.

Definition at line 15 of file sx126x_transport.cpp.


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