esphome::home_io_control::TxResult Struct Reference

What send_packet() did with a frame. More...

#include <radio_interface.h>

Collaboration diagram for esphome::home_io_control::TxResult:

Public Types
enum class	Status : uint8_t { SENT , CHANNEL_BUSY , FAILED }

Public Member Functions
bool	sent () const

Static Public Member Functions
static TxResult	ok ()
static TxResult	failed ()
static TxResult	channel_busy (int16_t level_dbm)

Public Attributes
Status	status {Status::FAILED}
int16_t	cca_level_dbm {0}
	The level the clear-channel check measured; set with CHANNEL_BUSY.

Detailed Description

What send_packet() did with a frame.

Definition at line 124 of file radio_interface.h.

Member Enumeration Documentation

Status

enum class esphome::home_io_control::TxResult::Status : uint8_t

strong

Enumerator
SENT	The frame went out.
CHANNEL_BUSY	The clear-channel check found the channel busy; nothing was sent.
FAILED	The radio could not send (invalid frame, TX timeout).

Definition at line 125 of file radio_interface.h.

Member Function Documentation

channel_busy()

TxResult esphome::home_io_control::TxResult::channel_busy ( int16_t level_dbm )

inlinestaticnodiscard

Definition at line 136 of file radio_interface.h.

failed()

TxResult esphome::home_io_control::TxResult::failed ( )

inlinestaticnodiscard

Definition at line 135 of file radio_interface.h.

ok()

TxResult esphome::home_io_control::TxResult::ok ( )

inlinestaticnodiscard

Definition at line 134 of file radio_interface.h.

sent()

bool esphome::home_io_control::TxResult::sent ( ) const

inlinenodiscard

Definition at line 133 of file radio_interface.h.

Member Data Documentation

cca_level_dbm

int16_t esphome::home_io_control::TxResult::cca_level_dbm {0}

The level the clear-channel check measured; set with CHANNEL_BUSY.

Definition at line 131 of file radio_interface.h.

status

Status esphome::home_io_control::TxResult::status {Status::FAILED}

Definition at line 130 of file radio_interface.h.

---

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

• components/home_io_control/radio_interface.h