Enum SyncWord 

pub enum SyncWord {
    Public,
    Private,
    Custom(u8),
}

The LoRa sync word, which keeps one network’s frames apart from another’s.

Both families carry it as one byte. The SX127x writes the byte to RegSyncWord. The SX126x spreads its two nibbles over its two sync word registers with a 4 after each, so 0x34 is written as 0x3444 and 0x12 as 0x1424, which are the chip’s own public and private values, and any other byte takes the same layout, the one RadioLib’s setSyncWord writes.

Examples

use pamoja_radios::radio::SyncWord;
use pamoja_radios::sx126x::config::SyncWord as Sx126xSyncWord;

assert_eq!(SyncWord::from_byte(0x34), SyncWord::Public);
assert_eq!(SyncWord::Custom(0x2B).sx126x(), Sx126xSyncWord::Custom(0x24B4));

Variants

Public

0x34, for a public network such as LoRaWAN.

Private

0x12, for a private network, and both families’ reset value.

Custom(u8)

Another byte.

Implementations

impl SyncWord

pub const fn to_byte(self) -> u8

Returns the byte.

Returns

0x34 for a public network, 0x12 for a private one, or the custom byte.

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

Names a byte.

Arguments

• byte - the sync word byte.

Returns

SyncWord::Public for 0x34, SyncWord::Private for 0x12, and a custom word for any other byte.

pub const fn sx126x(self) -> SyncWord

Returns the word as the SX126x takes it.

Returns

The two-byte word, each nibble of the byte followed by a 4.

pub const fn sx127x(self) -> SyncWord

Returns the word as the SX127x takes it.

Returns

The RegSyncWord value.

Trait Implementations

impl Clone for SyncWord

fn clone(&self) -> SyncWord

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SyncWord

impl Debug for SyncWord

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

Formats the value using the given formatter.

impl Eq for SyncWord

impl Hash for SyncWord

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 SyncWord

fn eq(&self, other: &SyncWord) -> 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 SyncWord