Struct stm32wlxx_hal::subghz::FskPacketStatus

pub struct FskPacketStatus { /* private fields */ }

(G)FSK packet status.

Returned by fsk_packet_status.

Implementations

impl FskPacketStatus

pub const fn status(&self) -> Status

Get the status.

Example

use stm32wlxx_hal::subghz::{CmdStatus, FskPacketStatus, Status, StatusMode};

let example_data_from_radio: [u8; 4] = [0x54, 0, 0, 0];
let pkt_status: FskPacketStatus = FskPacketStatus::from(example_data_from_radio);
let status: Status = pkt_status.status();
assert_eq!(status.mode(), Ok(StatusMode::Rx));
assert_eq!(status.cmd(), Ok(CmdStatus::Available));

pub const fn preamble_err(&self) -> bool

Returns true if a preamble error occurred.

pub const fn sync_err(&self) -> bool

Returns true if a synchronization error occurred.

pub const fn addr_err(&self) -> bool

Returns true if an address error occurred.

pub const fn crc_err(&self) -> bool

Returns true if an CRC error occurred.

pub const fn length_err(&self) -> bool

Returns true if a length error occurred.

pub const fn abort_err(&self) -> bool

Returns true if an abort error occurred.

pub const fn pkt_received(&self) -> bool

Returns true if a packet is received.

pub const fn pkt_sent(&self) -> bool

Returns true when a packet has been sent.

pub const fn any_err(&self) -> bool

Returns true if any error occurred.

pub fn rssi_sync(&self) -> Ratio<i16>

RSSI level when the synchronization address is detected.

Units are in dBm.

Example

use stm32wlxx_hal::{subghz::FskPacketStatus, Ratio};

let example_data_from_radio: [u8; 4] = [0, 0, 80, 0];
let pkt_status: FskPacketStatus = FskPacketStatus::from(example_data_from_radio);
assert_eq!(pkt_status.rssi_sync().to_integer(), -40);

pub fn rssi_avg(&self) -> Ratio<i16>

Return the RSSI level over the received packet.

Units are in dBm.

Example

use stm32wlxx_hal::{subghz::FskPacketStatus, Ratio};

let example_data_from_radio: [u8; 4] = [0, 0, 0, 100];
let pkt_status: FskPacketStatus = FskPacketStatus::from(example_data_from_radio);
assert_eq!(pkt_status.rssi_avg().to_integer(), -50);

Trait Implementations

impl Clone for FskPacketStatus

fn clone(&self) -> FskPacketStatus

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FskPacketStatus

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

Formats the value using the given formatter.

impl From<[u8; 4]> for FskPacketStatus

fn from(buf: [u8; 4]) -> Self

Converts to this type from the input type.

impl PartialEq for FskPacketStatus

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for FskPacketStatus

impl Eq for FskPacketStatus

impl StructuralEq for FskPacketStatus

impl StructuralPartialEq for FskPacketStatus