Struct radio_sx127x::Sx127x

pub struct Sx127x<Base, CommsError, PinError> { /* fields omitted */ }

Sx127x device object

Operating functions are implemented as traits from the radio package

Methods

impl<Base, CommsError, PinError> Sx127x<Base, CommsError, PinError> where
    Base: Sx127xBase<CommsError, PinError>, 

pub fn fsk_configure(
    &mut self,
    config: &FskConfig,
    channel: &FskChannel
) -> Result<(), Error<CommsError, PinError>>

impl<Base, CommsError, PinError> Sx127x<Base, CommsError, PinError> where
    Base: Sx127xBase<CommsError, PinError>, 

pub fn lora_configure(
    &mut self,
    config: &LoRaConfig,
    channel: &LoRaChannel
) -> Result<(), Error<CommsError, PinError>>

Configure the radio in lora mode with the provided configuration and channel

impl<Spi, CommsError, Output, Input, PinError, Delay> Sx127x<SpiWrapper<Spi, CommsError, Output, Input, PinError, Delay>, CommsError, PinError> where
    Spi: Transfer<u8, Error = CommsError> + Write<u8, Error = CommsError>,
    Output: OutputPin<Error = PinError>,
    Input: InputPin<Error = PinError>,
    Delay: DelayMs<u32>, 

pub fn spi(
    spi: Spi,
    cs: Output,
    busy: Input,
    sdn: Output,
    delay: Delay,
    config: &Config
) -> Result<Self, Error<CommsError, PinError>>

Create an Sx127x with the provided SPI implementation and pins

impl<Base, CommsError, PinError> Sx127x<Base, CommsError, PinError> where
    Base: Base<CommsError, PinError>, 

pub fn new(
    hal: Base,
    config: &Config
) -> Result<Self, Error<CommsError, PinError>>

Create a new radio instance over an arbitrary base::Base implementation

pub fn configure(
    &mut self,
    config: &Config
) -> Result<(), Error<CommsError, PinError>>

(re)apply device configuration

pub fn silicon_version(&mut self) -> Result<u8, Error<CommsError, PinError>>

Fetch device silicon version

impl<Base, CommsError, PinError> Sx127x<Base, CommsError, PinError> where
    Base: Base<CommsError, PinError>, 

pub fn read_reg<R>(&mut self, reg: R) -> Result<u8, Error<CommsError, PinError>> where
    R: Copy + Clone + Into<u8>, 

Read a u8 value from the specified register

pub fn write_reg<R>(
    &mut self,
    reg: R,
    value: u8
) -> Result<(), Error<CommsError, PinError>> where
    R: Copy + Clone + Into<u8>, 

Write a u8 value to the specified register

pub fn update_reg<R>(
    &mut self,
    reg: R,
    mask: u8,
    value: u8
) -> Result<u8, Error<CommsError, PinError>> where
    R: Copy + Clone + Into<u8>, 

Update the specified register with the provided (value & mask)

Trait Implementations

impl<Base, CommsError, PinError> DelayMs<u32> for Sx127x<Base, CommsError, PinError> where
    Base: Base<CommsError, PinError>, 

fn delay_ms(&mut self, t: u32)

Pauses execution for ms milliseconds

impl<Base, CommsError, PinError> Transmit for Sx127x<Base, CommsError, PinError> where
    Base: Base<CommsError, PinError>, 

type Error = Error<CommsError, PinError>

Radio error

fn start_transmit(&mut self, data: &[u8]) -> Result<(), Self::Error>

Start sending a packet

fn check_transmit(&mut self) -> Result<bool, Error<CommsError, PinError>>

Check for transmission completion This method should be polled (or checked following and interrupt) to indicate sending has completed

impl<Base, CommsError, PinError> Power for Sx127x<Base, CommsError, PinError> where
    Base: Base<CommsError, PinError>, 

type Error = Error<CommsError, PinError>

Radio error type

fn set_power(&mut self, power: i8) -> Result<(), Error<CommsError, PinError>>

Set transmit power (using the existing PaConfig)

impl<Base, CommsError, PinError> Receive for Sx127x<Base, CommsError, PinError> where
    Base: Base<CommsError, PinError>, 

type Info = PacketInfo

Packet received info

type Error = Error<CommsError, PinError>

Radio error

fn start_receive(&mut self) -> Result<(), Self::Error>

Start receive mode

fn check_receive(&mut self, restart: bool) -> Result<bool, Self::Error>

Check receive state

This returns true if a boolean indicating whether a packet has been received. The restart option specifies whether transient timeout or CRC errors should be internally handled (returning Ok(false)) or passed back to the caller as errors.

fn get_received(
    &mut self,
    info: &mut Self::Info,
    data: &mut [u8]
) -> Result<usize, Self::Error>

Fetch a received message

This copies data into the provided slice, updates the provided information object, and returns the number of bytes received on success

impl<Base, CommsError, PinError> State for Sx127x<Base, CommsError, PinError> where
    Base: Base<CommsError, PinError>, 

type State = State

Channel information

type Error = Error<CommsError, PinError>

Radio error type

fn get_state(&mut self) -> Result<Self::State, Self::Error>

Fetch device state

fn set_state(&mut self, state: Self::State) -> Result<(), Self::Error>

Set device state

impl<Base, CommsError, PinError> Channel for Sx127x<Base, CommsError, PinError> where
    Base: Base<CommsError, PinError>, 

type Channel = Channel

Channel information

type Error = Error<CommsError, PinError>

Radio error type

fn set_channel(
    &mut self,
    channel: &Self::Channel
) -> Result<(), Error<CommsError, PinError>>

Set the LoRa mode channel for future receive or transmit operations

impl<Base, CommsError, PinError> Rssi for Sx127x<Base, CommsError, PinError> where
    Base: Base<CommsError, PinError>, 

type Error = Error<CommsError, PinError>

Radio error

fn poll_rssi(&mut self) -> Result<i16, Error<CommsError, PinError>>

Poll for the current channel RSSI This should only be called in receive mode

impl<Base, CommsError, PinError> Interrupts for Sx127x<Base, CommsError, PinError> where
    Base: Base<CommsError, PinError>, 

type Irq = Interrupts

Interrupt object

type Error = Error<CommsError, PinError>

Radio error

fn get_interrupts(&mut self, clear: bool) -> Result<Self::Irq, Self::Error>

Fetch pending interrupts from the device If the clear option is set, this will also clear any pending flags