Struct LoraModulation 

pub struct LoraModulation {
    pub spreading_factor: u8,
    pub bandwidth: LoraBandwidth,
    pub coding_rate_denominator: u8,
    pub explicit_header: bool,
    pub crc: bool,
    pub low_data_rate_optimization: bool,
}

The LoRa modem settings of a link, as RegModemConfig1 to 3 and the SF6 detection registers carry them.

Examples

use pamoja_lora::LinkSettings;
use pamoja_radios::sx127x::config::LoraModulation;

// SF7 at 125 kHz, coding rate 4/5, an explicit header, and a CRC.
let modulation = LoraModulation::from_link(&LinkSettings::new(7, 125_000)).unwrap();
assert_eq!(modulation.modem_config_1(), 0x72);
assert_eq!(modulation.modem_config_2(0), 0x74);
assert_eq!(modulation.modem_config_3(), 0x04);

Fields

spreading_factor: u8

The spreading factor, 6 to 12.

bandwidth: LoraBandwidth

The signal bandwidth.

coding_rate_denominator: u8

The coding rate denominator, 5 to 8 for 4/5 to 4/8.

explicit_header: bool

Whether packets carry an explicit header.

crc: bool

Whether packets carry a payload CRC.

low_data_rate_optimization: bool

Whether low data rate optimization is on.

Implementations

impl LoraModulation

pub fn from_link(link: &LinkSettings) -> Result<LoraModulation, ModulationError>

Builds the modem settings of a link.

Arguments

• link - the link settings, whose spreading factor, bandwidth, coding rate, header, CRC, and low data rate optimization the radio must match.

Returns

The settings.

Errors

Returns ModulationError::Bandwidth for a bandwidth the SX127x does not offer, ModulationError::SpreadingFactor below SF6, and ModulationError::ExplicitHeaderAtSf6 for SF6 with an explicit header.

pub const fn modem_config_1(&self) -> u8

Returns RegModemConfig1: the bandwidth in bits 7 to 4, the coding rate in bits 3 to 1, and ImplicitHeaderModeOn in bit 0.

Returns

The register value.

pub const fn modem_config_2(&self, symbol_timeout: u16) -> u8

Returns RegModemConfig2: the spreading factor in bits 7 to 4, RxPayloadCrcOn in bit 2, and the top two bits of the symbol timeout in bits 1 and 0.

Arguments

• symbol_timeout - the single reception timeout in symbols, from symbol_timeout.

Returns

The register value; TxContinuousMode is off.

pub const fn modem_config_3(&self) -> u8

Returns RegModemConfig3: LowDataRateOptimize in bit 3, and AgcAutoOn in bit 2 so the automatic gain control sets the LNA gain.

Returns

The register value.

pub const fn detect_optimize(&self, current: u8) -> u8

Returns RegDetectOptimize with the DetectionOptimize bits set for the spreading factor: 0x05 for SF6 and 0x03 for SF7 to SF12.

Arguments

• current - the register’s current value, whose other bits are kept.

Returns

The register value.

pub const fn detection_threshold(&self) -> u8

Returns RegDetectionThreshold for the spreading factor: 0x0C for SF6 and 0x0A for SF7 to SF12.

Returns

The register value.

Trait Implementations

impl Clone for LoraModulation

fn clone(&self) -> LoraModulation

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for LoraModulation

impl Debug for LoraModulation

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for LoraModulation

impl Hash for LoraModulation

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for LoraModulation

fn eq(&self, other: &LoraModulation) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for LoraModulation