Struct lora_phy::LoRa

pub struct LoRa<RK, DLY>where
    RK: RadioKind,
    DLY: DelayUs,{ /* private fields */ }

Provides the physical layer API to support LoRa chips

Implementations

impl<RK, DLY> LoRa<RK, DLY>where RK: RadioKind, DLY: DelayUs,

pub async fn new( radio_kind: RK, enable_public_network: bool, delay: DLY ) -> Result<Self, RadioError>

Build and return a new instance of the LoRa physical layer API to control an initialized LoRa radio

pub fn get_board_type(&self) -> BoardType

Get the board type of the LoRa board

pub fn create_modulation_params( &mut self, spreading_factor: SpreadingFactor, bandwidth: Bandwidth, coding_rate: CodingRate, frequency_in_hz: u32 ) -> Result<ModulationParams, RadioError>

Create modulation parameters for a communication channel

pub fn create_tx_packet_params( &mut self, preamble_length: u16, implicit_header: bool, crc_on: bool, iq_inverted: bool, modulation_params: &ModulationParams ) -> Result<PacketParams, RadioError>

Create packet parameters for a send operation on a communication channel

pub fn create_rx_packet_params( &mut self, preamble_length: u16, implicit_header: bool, max_payload_length: u8, crc_on: bool, iq_inverted: bool, modulation_params: &ModulationParams ) -> Result<PacketParams, RadioError>

Create packet parameters for a receive operation on a communication channel

pub async fn init(&mut self) -> Result<(), RadioError>

Initialize a Semtech chip as the radio for LoRa physical layer communications

pub async fn sleep( &mut self, warm_start_if_possible: bool ) -> Result<(), RadioError>

Place the LoRa physical layer in low power mode, specifying cold or warm start (if the Semtech chip supports it)

pub async fn prepare_for_tx( &mut self, mdltn_params: &ModulationParams, output_power: i32, tx_boosted_if_possible: bool ) -> Result<(), RadioError>

Prepare the Semtech chip for a send operation

pub async fn tx( &mut self, mdltn_params: &ModulationParams, tx_pkt_params: &mut PacketParams, buffer: &[u8], timeout_in_ms: u32 ) -> Result<(), RadioError>

Execute a send operation

pub async fn prepare_for_rx( &mut self, mdltn_params: &ModulationParams, rx_pkt_params: &PacketParams, window_in_secs: Option<u8>, duty_cycle_params: Option<&DutyCycleParams>, rx_boosted_if_supported: bool ) -> Result<(), RadioError>

Prepare the Semtech chip for a receive operation (single shot, continuous, or duty cycled) and initiate the operation

pub async fn rx( &mut self, rx_pkt_params: &PacketParams, receiving_buffer: &mut [u8] ) -> Result<(u8, PacketStatus), RadioError>

Obtain the results of a read operation

pub async fn prepare_for_cad( &mut self, mdltn_params: &ModulationParams, rx_boosted_if_supported: bool ) -> Result<(), RadioError>

Prepare the Semtech chip for a channel activity detection operation and initiate the operation

pub async fn cad(&mut self) -> Result<bool, RadioError>

Obtain the results of a channel activity detection operation

Trait Implementations

impl<RK, DLY> AsyncRng for LoRa<RK, DLY>where RK: RngRadio, DLY: DelayUs,

async fn get_random_number(&mut self) -> Result<u32, RadioError>

Generate a 32 bit random value.