Struct nrf52833_hal::ieee802154::Radio

pub struct Radio<'c> { /* private fields */ }

IEEE 802.15.4 radio

Implementations

impl<'c> Radio<'c>

pub fn init<L, LSTAT>( radio: RADIO, _clocks: &'c Clocks<ExternalOscillator, L, LSTAT> ) -> Radio<'c>

Initializes the radio for IEEE 802.15.4 operation

pub fn set_channel(&mut self, channel: Channel)

Changes the radio channel

pub fn set_cca(&mut self, cca: Cca)

Changes the Clear Channel Assessment method

pub fn set_sfd(&mut self, sfd: u8)

Changes the Start of Frame Delimiter

pub fn set_txpower(&mut self, power: TxPower)

Changes the TX power

pub fn energy_detection_scan(&mut self, sample_cycles: u32) -> u8

Sample the received signal power (i.e. the presence of possibly interfering signals) within the bandwidth of the currently used channel for sample_cycles iterations. Note that one iteration has a sample time of 128μs, and that each iteration produces the average RSSI value measured during this sample time.

Returns the maximum measurement recorded during sampling as reported by the hardware (not in dBm!). The result can be used to find a suitable ED threshold for Energy Detection-based CCA mechanisms.

For details, see Section 6.20.12.3 Energy detection (ED) of the PS. RSSI samples are averaged over a measurement time of 8 symbol periods (128 μs).

pub fn recv(&mut self, packet: &mut Packet) -> Result<u16, u16>

Receives one radio packet and copies its contents into the given packet buffer

This methods returns the Ok variant if the CRC included the packet was successfully validated by the hardware; otherwise it returns the Err variant. In either case, packet will be updated with the received packet’s data

pub fn recv_timeout<I>( &mut self, packet: &mut Packet, timer: &mut Timer<I>, microseconds: u32 ) -> Result<u16, Error>

where I: Instance,

Listens for a packet for no longer than the specified amount of microseconds and copies its contents into the given packet buffer

If no packet is received within the specified time then the Timeout error is returned

If a packet is received within the time span then the packet CRC is checked. If the CRC is incorrect then the Crc error is returned; otherwise the Ok variant is returned. Note that packet will contain the packet in any case, even if the CRC check failed.

Note that the time it takes to switch the radio to RX mode is included in the timeout count. This transition may take up to a hundred of microseconds; see the section 6.20.15.8 in the Product Specification for more details about timing

pub fn try_send(&mut self, packet: &mut Packet) -> Result<(), ()>

Tries to send the given packet

This method performs Clear Channel Assessment (CCA) first and sends the packet only if the channel is observed to be clear (no transmission is currently ongoing), otherwise no packet is transmitted and the Err variant is returned

NOTE this method will not modify the packet argument. The mutable reference is used to ensure the packet buffer is allocated in RAM, which is required by the RADIO peripheral

pub fn send(&mut self, packet: &mut Packet)

Sends the given packet

This is utility method that consecutively calls the try_send method until it succeeds. Note that this approach is not IEEE spec compliant – there must be delay between failed CCA attempts to be spec compliant

NOTE this method will not modify the packet argument. The mutable reference is used to ensure the packet buffer is allocated in RAM, which is required by the RADIO peripheral

pub fn send_no_cca(&mut self, packet: &mut Packet)

Sends the specified packet without first performing CCA

Acknowledgment packets must be sent using this method

NOTE this method will not modify the packet argument. The mutable reference is used to ensure the packet buffer is allocated in RAM, which is required by the RADIO peripheral