Struct Uplink 

pub struct Uplink<'a> { /* private fields */ }

An uplink data frame to encode, built up from the fields a sender sets.

Construct one with new and turn on whatever applies; the rest default off. A higher port carries application data; port 0 carries MAC commands. A frame with nothing to carry but its header and frame options, such as an answer to a MAC command with no reading to go with it, is built with empty and has no port.

Examples

use pamoja_lorawan::Uplink;

let uplink = Uplink::new(7, 2, b"reading").confirmed().with_adr();

Implementations

impl<'a> Uplink<'a>

pub fn new(fcnt: u32, fport: u8, payload: &'a [u8]) -> Self

Creates an unconfirmed uplink with no options set.

Arguments

• fcnt - the frame counter for this uplink.
• fport - the port; 0 for MAC commands, otherwise an application port.
• payload - the application payload to carry.

Returns

The uplink.

pub fn empty(fcnt: u32) -> Self

Creates an uplink with no port and no payload.

TS001-1.0.4 section 4.3.2 makes the port optional when there is no payload. What such a frame carries is its header: the counter, the flags, and whatever frame options it is given.

Arguments

• fcnt - the frame counter for this uplink.

Returns

The uplink.

Examples

use pamoja_lorawan::mac::MacCommand;
use pamoja_lorawan::{Session, Uplink};

// A device answering a status request and nothing else: on mains power it cannot
// measure a battery, and it heard the request 10 dB above the noise.
let session = Session::new(0x2601_1BDA, [0x2B; 16], [0x99; 16]);
let mut answer = [0u8; 3];
MacCommand::DevStatusAns { battery: 255, margin: 10 }.encode(&mut answer)?;
let frame = session.encode_uplink(&Uplink::empty(3).with_fopts(&answer))?;

// It goes up with no port and no payload, the answer in the frame options.
let heard = session.decode(frame.as_bytes(), 3)?;
assert_eq!(heard.fport(), None);
assert_eq!(heard.fopts(), &answer);

pub fn confirmed(self) -> Self

Marks the uplink as confirmed, asking the network to acknowledge it.

Returns

The uplink, for chaining.

pub fn with_adr(self) -> Self

Sets the adaptive-data-rate bit, letting the network manage the data rate.

Returns

The uplink, for chaining.

pub fn with_adr_ack_req(self) -> Self

Sets the ADR acknowledgment request bit, asking the network to send something back.

A device sets it once it has gone ADR_ACK_LIMIT uplinks without hearing anything, and Backoff says when.

Returns

The uplink, for chaining.

pub fn with_ack(self) -> Self

Sets the acknowledgment bit, confirming a previously received downlink.

Returns

The uplink, for chaining.

pub fn with_fopts(self, fopts: &'a [u8]) -> Self

Carries MAC command options in the frame header.

Arguments

• fopts - the frame options, up to 15 bytes.

Returns

The uplink, for chaining.

Trait Implementations

impl<'a> Clone for Uplink<'a>

fn clone(&self) -> Uplink<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for Uplink<'a>

impl<'a> Debug for Uplink<'a>

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

Formats the value using the given formatter.