idfxx 1.0.0
Modern C++23 components for ESP-IDF
Loading...
Searching...
No Matches
types.hpp File Reference

Chip-agnostic LoRa modulation and packet types. More...

#include <chrono>
#include <cstdint>
#include <electro/decibel>
#include <frequency/frequency>

Go to the source code of this file.

Classes

struct  idfxx::radio::lora_modulation
 LoRa modulation parameters. More...
 
struct  idfxx::radio::lora_packet_params
 LoRa packet framing parameters. More...
 
struct  idfxx::radio::lora_link
 Complete LoRa link configuration. More...
 
struct  idfxx::radio::rx_duty_cycle
 Listen/sleep windows for duty-cycled receive. More...
 
struct  idfxx::radio::rx_info
 Information about a received packet. More...
 
struct  idfxx::radio::cad_info
 Result of a channel-activity-detection operation. More...
 
struct  idfxx::radio::packet_status
 Detailed status for the most recent packet. More...
 

Namespaces

namespace  idfxx
 
namespace  idfxx::radio
 LoRa radio types and driver classes.
 

Enumerations

enum class  idfxx::radio::chip_mode : uint8_t {
  idfxx::radio::sleep ,
  idfxx::radio::stdby ,
  idfxx::radio::tx ,
  idfxx::radio::rx ,
  idfxx::radio::cad
}
 Top-level radio operating mode. More...
 
enum class  idfxx::radio::spreading_factor : uint8_t {
  idfxx::radio::sf5 = 5 ,
  idfxx::radio::sf6 = 6 ,
  idfxx::radio::sf7 = 7 ,
  idfxx::radio::sf8 = 8 ,
  idfxx::radio::sf9 = 9 ,
  idfxx::radio::sf10 = 10 ,
  idfxx::radio::sf11 = 11 ,
  idfxx::radio::sf12 = 12
}
 LoRa spreading factor. More...
 
enum class  idfxx::radio::bandwidth : uint8_t {
  idfxx::radio::bw_7_8 ,
  idfxx::radio::bw_10_4 ,
  idfxx::radio::bw_15_6 ,
  idfxx::radio::bw_20_8 ,
  idfxx::radio::bw_31_25 ,
  idfxx::radio::bw_41_7 ,
  idfxx::radio::bw_62_5 ,
  idfxx::radio::bw_125 ,
  idfxx::radio::bw_250 ,
  idfxx::radio::bw_500
}
 LoRa channel bandwidth. More...
 
enum class  idfxx::radio::coding_rate : uint8_t {
  idfxx::radio::cr_4_5 = 5 ,
  idfxx::radio::cr_4_6 = 6 ,
  idfxx::radio::cr_4_7 = 7 ,
  idfxx::radio::cr_4_8 = 8
}
 LoRa forward-error-correction coding rate. More...
 
enum class  idfxx::radio::lora_network : uint8_t {
  idfxx::radio::private_network ,
  idfxx::radio::public_network
}
 LoRa network selection. More...
 
enum class  idfxx::radio::header_type : uint8_t {
  idfxx::radio::variable ,
  idfxx::radio::fixed
}
 LoRa packet header mode. More...
 
enum class  idfxx::radio::ramp_time : uint8_t {
  idfxx::radio::us_10 ,
  idfxx::radio::us_40 ,
  idfxx::radio::us_200 ,
  idfxx::radio::us_800 ,
  idfxx::radio::us_3400
}
 Power-amplifier ramp-time bucket. More...
 

Detailed Description

Chip-agnostic LoRa modulation and packet types.

Definition in file types.hpp.