Struct Irq 

pub struct Irq(/* private fields */);

A set of SX126x interrupts, in the layout of the IRQ register.

Examples

use pamoja_radios::sx126x::irq::Irq;

// GetIrqStatus answered 0x0202: a timeout and a received packet.
let pending = Irq::from_bytes([0x02, 0x02]);
assert!(pending.contains(Irq::RX_DONE | Irq::TIMEOUT));
assert!(!pending.contains(Irq::CRC_ERROR));

Implementations

impl Irq

pub const NONE: Irq

No interrupt.

pub const TX_DONE: Irq

Bit 0: the packet transmission completed.

pub const RX_DONE: Irq

Bit 1: a packet was received.

pub const PREAMBLE_DETECTED: Irq

Bit 2: a preamble was detected.

pub const SYNC_WORD_VALID: Irq

Bit 3: a valid sync word was detected, in FSK.

pub const HEADER_VALID: Irq

Bit 4: a valid LoRa header was received.

pub const HEADER_ERROR: Irq

Bit 5: a LoRa header failed its CRC.

pub const CRC_ERROR: Irq

Bit 6: a packet failed its CRC.

pub const CAD_DONE: Irq

Bit 7: channel activity detection finished, in LoRa.

pub const CAD_DETECTED: Irq

Bit 8: channel activity was detected, in LoRa.

pub const TIMEOUT: Irq

Bit 9: a receive or transmit timeout.

pub const LR_FHSS_HOP: Irq

Bit 14: a hop in LR-FHSS, after the power amplifier ramped up again.

pub const ALL: Irq

Every interrupt the datasheet defines: bits 0 to 9 and bit 14.

pub const fn from_bits(bits: u16) -> Irq

Creates a set from the register’s bits.

Arguments

• bits - the 16-bit register value.

Returns

The set, keeping reserved bits as they came.

pub const fn from_bytes(bytes: [u8; 2]) -> Irq

Creates a set from the two bytes the chip answers with, most significant first.

Arguments

• bytes - the IrqStatus bytes of a GetIrqStatus answer.

Returns

The set.

pub const fn bits(self) -> u16

Returns the register’s bits.

Returns

The 16-bit register value.

pub const fn to_bytes(self) -> [u8; 2]

Returns the two bytes a command carries for this set, most significant first.

Returns

The mask as it goes on the wire.

pub const fn contains(self, other: Irq) -> bool

Reports whether every interrupt of another set is in this one.

Arguments

• other - the interrupts to look for.

Returns

true when all of them are set.

pub const fn intersects(self, other: Irq) -> bool

Reports whether any interrupt of another set is in this one.

Arguments

• other - the interrupts to look for.

Returns

true when at least one of them is set.

pub const fn is_empty(self) -> bool

Reports whether the set holds no interrupt.

Returns

true when no bit is set.

Trait Implementations

impl BitAnd for Irq

type Output = Irq

The resulting type after applying the & operator.

fn bitand(self, rhs: Irq) -> Irq

Performs the & operation.

impl BitOr for Irq

type Output = Irq

The resulting type after applying the | operator.

fn bitor(self, rhs: Irq) -> Irq

Performs the | operation.

impl BitOrAssign for Irq

fn bitor_assign(&mut self, rhs: Irq)

Performs the |= operation.

impl Clone for Irq

fn clone(&self) -> Irq

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Irq

impl Debug for Irq

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

Formats the value using the given formatter.

impl Default for Irq

fn default() -> Irq

Returns the “default value” for a type.

impl Eq for Irq

impl Hash for Irq

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Irq

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for Irq