Home IO Control
ESPHome add-on for IO-Homecontrol devices
Loading...
Searching...
No Matches
esphome::home_io_control::TransmitObserver Class Reference

Receives transmit events from ExchangeEngine::transmit_frame(). More...

#include <transmit_observer.h>

Inheritance diagram for esphome::home_io_control::TransmitObserver:
Collaboration diagram for esphome::home_io_control::TransmitObserver:

Public Member Functions

virtual ~TransmitObserver ()=default
virtual void on_lbt_defer (int16_t rssi_dbm)
 The channel was busy, so transmit_frame() backs off once before trying again.
virtual void on_transmit (const IoFrame &frame, const RadioTxConfig &config, uint8_t wire_len)
 The radio accepted a frame for transmission (send_packet() returned true).

Detailed Description

Receives transmit events from ExchangeEngine::transmit_frame().

Both callbacks default to no-ops, so an observer overrides only what it records. They run synchronously inside transmit_frame(), on the main loop: keep them cheap and never transmit from one.

Definition at line 25 of file transmit_observer.h.

Constructor & Destructor Documentation

◆ ~TransmitObserver()

virtual esphome::home_io_control::TransmitObserver::~TransmitObserver ( )
virtualdefault

Member Function Documentation

◆ on_lbt_defer()

virtual void esphome::home_io_control::TransmitObserver::on_lbt_defer ( int16_t rssi_dbm)
inlinevirtual

The channel was busy, so transmit_frame() backs off once before trying again.

Parameters
rssi_dbmThe RSSI reading that deferred the transmit.

Reimplemented in esphome::home_io_control::PairingTelemetry.

Definition at line 31 of file transmit_observer.h.

◆ on_transmit()

virtual void esphome::home_io_control::TransmitObserver::on_transmit ( const IoFrame & frame,
const RadioTxConfig & config,
uint8_t wire_len )
inlinevirtual

The radio accepted a frame for transmission (send_packet() returned true).

Not called when serialization or send_packet() fails.

Parameters
frameThe logical frame that was sent.
configThe TX shape it was sent with (frequency, preamble length).
wire_lenSerialized length in bytes as handed to the radio.

Reimplemented in esphome::home_io_control::PairingTelemetry.

Definition at line 38 of file transmit_observer.h.


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