Struct FrameHeader 

pub struct FrameHeader { /* private fields */ }

A frame read only as far as its unencrypted header.

Examples

use pamoja_lorawan::{FrameHeader, MessageType, Session, Uplink};

let session = Session::new(0x2601_1BDA, [0x2B; 16], [0x99; 16]);
let frame = session.encode_uplink(&Uplink::new(42, 1, b"temp=4.8"))?;

// A gateway reads the address out of the frame to find the right session.
let header = FrameHeader::parse(frame.as_bytes())?;
assert_eq!(header.message_type(), MessageType::UnconfirmedUp);
assert_eq!(header.dev_addr(), Some(0x2601_1BDA));
assert_eq!(header.fcnt(), Some(42));
assert_eq!(header.fport(), Some(1));

// Only then can it verify and decrypt.
let rx = session.decode(frame.as_bytes(), 42)?;
assert_eq!(rx.payload(), b"temp=4.8");

Implementations

impl FrameHeader

pub fn parse(bytes: &[u8]) -> Result<FrameHeader, LorawanError>

Reads a frame far enough to route it, without any key.

Arguments

• bytes - the raw frame as it came off the radio.

Returns

What the header says the frame is.

Errors

Returns LorawanError::FrameTooShort if the frame is empty or shorter than the header and MIC a data frame needs, LorawanError::UnsupportedMType if the message type is one this crate does not read, or LorawanError::MalformedFrame if the frame options run past the end of the frame.

pub fn message_type(&self) -> MessageType

Returns what kind of message the frame is.

Returns

The message type.

pub fn direction(&self) -> Option<Direction>

Returns the direction the frame travels.

Returns

The direction, or None for a join-accept.

pub fn dev_addr(&self) -> Option<u32>

Returns the device address the frame carries.

This is what a receiver looks a session up by.

Returns

The address, or None for a join frame, which carries none.

pub fn fcnt(&self) -> Option<u16>

Returns the low 16 bits of the frame counter.

Returns

The counter, or None for a join frame.

pub fn fport(&self) -> Option<u8>

Returns the port the frame was sent on.

Returns

The port, or None for a join frame or a data frame carrying only frame options.

pub fn confirmed(&self) -> bool

Reports whether the frame asks to be acknowledged.

Returns

true for a confirmed data frame.

pub fn adr(&self) -> bool

Reports whether the frame takes part in adaptive data rate.

Returns

The ADR bit.

pub fn ack(&self) -> bool

Reports whether the frame acknowledges the last confirmed one.

Returns

The ACK bit.

pub fn fpending(&self) -> bool

Reports whether the network has more downlink data waiting.

Returns

The frame-pending bit.

pub fn fopts_len(&self) -> usize

Returns how many bytes of frame options the header carries.

Returns

The length, from 0 to 15.

pub fn payload_len(&self) -> usize

Returns the length of the still-encrypted payload.

Returns

The payload length in bytes, which is 0 when the frame carries only options.

Trait Implementations

impl Clone for FrameHeader

fn clone(&self) -> FrameHeader

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for FrameHeader

impl Debug for FrameHeader

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

Formats the value using the given formatter.

impl Eq for FrameHeader

impl PartialEq for FrameHeader

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for FrameHeader