Configuration for transmitting a packet: carrier frequency, preamble length, wake-up level and clear-channel check. More...

#include <radio_interface.h>

Collaboration diagram for esphome::home_io_control::RadioTxConfig:

Public Attributes
uint32_t	freq_hz {FREQ_CH2}
	Carrier frequency in Hz.
uint16_t	preamble_len {SHORT_PREAMBLE}
	Preamble length in symbol periods (bytes).
TxWake	wake {TxWake::NONE}
	Wake-up level the receiver needs (tx_wake_for()).
std::optional< int16_t >	cca_threshold_dbm
	If set, send only if the energy on freq_hz, measured right before the first transmitted symbol, is below this level (dBm); otherwise send_packet() reports CHANNEL_BUSY and sends nothing.

Detailed Description

Configuration for transmitting a packet: carrier frequency, preamble length, wake-up level and clear-channel check.

Definition at line 111 of file radio_interface.h.

Member Data Documentation

◆ cca_threshold_dbm

std::optional<int16_t> esphome::home_io_control::RadioTxConfig::cca_threshold_dbm

If set, send only if the energy on freq_hz, measured right before the first transmitted symbol, is below this level (dBm); otherwise send_packet() reports CHANNEL_BUSY and sends nothing.

Unset: send without a check.

Definition at line 120 of file radio_interface.h.

◆ freq_hz

uint32_t esphome::home_io_control::RadioTxConfig::freq_hz {FREQ_CH2}

Carrier frequency in Hz.

Definition at line 112 of file radio_interface.h.

◆ preamble_len

uint16_t esphome::home_io_control::RadioTxConfig::preamble_len {SHORT_PREAMBLE}

Preamble length in symbol periods (bytes).

Definition at line 113 of file radio_interface.h.

◆ wake

TxWake esphome::home_io_control::RadioTxConfig::wake {TxWake::NONE}

Wake-up level the receiver needs (tx_wake_for()).

A driver whose receivers are woken by the preamble length alone may ignore it: preamble_len already carries the same decision.

Definition at line 116 of file radio_interface.h.

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

components/home_io_control/radio_interface.h