idfxx 1.0.0
Modern C++23 components for ESP-IDF
Loading...
Searching...
No Matches
idfxx::radio::rx_duty_cycle Struct Reference

Listen/sleep windows for duty-cycled receive. More...

Public Member Functions

constexpr bool operator== (const rx_duty_cycle &) const noexcept=default
 Compares two listen/sleep window pairs for equality.
 

Public Attributes

std::chrono::microseconds rx_period
 Time to listen in each cycle.
 
std::chrono::microseconds sleep_period
 Time to sleep in each cycle.
 

Detailed Description

Listen/sleep windows for duty-cycled receive.

Describes one period of a duty-cycled receive: the radio listens for rx_period, sleeps for sleep_period, and repeats until a packet arrives or the mode is changed. Pass to lora_transceiver::start_listening, either built directly or computed from the modulation with rx_duty_cycle_for (<idfxx/radio/duty_cycle>).

Definition at line 194 of file types.hpp.

Member Function Documentation

◆ operator==()

constexpr bool idfxx::radio::rx_duty_cycle::operator== ( const rx_duty_cycle ) const
constexprdefaultnoexcept

Compares two listen/sleep window pairs for equality.

Member Data Documentation

◆ rx_period

std::chrono::microseconds idfxx::radio::rx_duty_cycle::rx_period

Time to listen in each cycle.

Definition at line 195 of file types.hpp.

Referenced by idfxx::radio::lora_transceiver::try_start_listening().

◆ sleep_period

std::chrono::microseconds idfxx::radio::rx_duty_cycle::sleep_period

Time to sleep in each cycle.

Definition at line 196 of file types.hpp.

Referenced by idfxx::radio::lora_transceiver::try_start_listening().


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