Skip to main content

ModemStatus

Struct ModemStatus 

Source
pub struct ModemStatus {
    pub coding_rate_denominator: Option<u8>,
    pub clear: bool,
    pub header_valid: bool,
    pub rx_ongoing: bool,
    pub signal_synchronized: bool,
    pub signal_detected: bool,
}
Expand description

The live state of the LoRa modem, from RegModemStat.

§Examples

use pamoja_radios::sx127x::status::ModemStatus;

// 0x0F: a signal detected and synchronized, a reception under way with a valid header.
let modem = ModemStatus::from_byte(0x0F);
assert!(modem.signal_detected && modem.header_valid && modem.rx_ongoing);
assert!(!modem.clear);

Fields§

§coding_rate_denominator: Option<u8>

The coding rate the last header announced, as the denominator of 4/5 to 4/8, or None for a reserved value.

§clear: bool

Bit 4: the modem is clear.

§header_valid: bool

Bit 3: the header of the packet under way is valid.

§rx_ongoing: bool

Bit 2: a reception is under way.

§signal_synchronized: bool

Bit 1: the modem has synchronized on the end of the preamble.

§signal_detected: bool

Bit 0: a LoRa preamble has been detected.

Implementations§

Source§

impl ModemStatus

Source

pub const fn from_byte(byte: u8) -> ModemStatus

Decodes RegModemStat.

§Arguments
  • byte - the register value.
§Returns

The modem’s state.

Trait Implementations§

Source§

impl Clone for ModemStatus

Source§

fn clone(&self) -> ModemStatus

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for ModemStatus

Source§

impl Debug for ModemStatus

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for ModemStatus

Source§

impl Hash for ModemStatus

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for ModemStatus

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl StructuralPartialEq for ModemStatus

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.