Struct Rxpk 

pub struct Rxpk {
    pub received_at: Option<String>,
    pub gps_millis: Option<u64>,
    pub timestamp_us: Option<u32>,
    pub frequency_hz: u32,
    pub channel: u8,
    pub rf_chain: u8,
    pub crc: CrcStatus,
    pub modulation: Modulation,
    pub rssi_dbm: Decibels,
    pub snr_db: Option<Decibels>,
    pub payload: Vec<u8>,
}

A packet the gateway heard, with the metadata the protocol carries beside it.

Examples

use pamoja_gateway::udp::Rxpk;
use pamoja_lora::LinkSettings;

let heard = Rxpk::new(868_100_000, LinkSettings::new(7, 125_000), b"hello".to_vec())
    .with_rssi_dbm(-35)
    .with_snr_db(5.1);
assert!(heard.to_json().contains("\"datr\":\"SF7BW125\""));
assert!(heard.to_json().contains("\"freq\":868.1"));

Fields

received_at: Option<String>

When the packet arrived, as time::compact writes it.

gps_millis: Option<u64>

When it arrived on the GPS clock, in milliseconds since 6 January 1980.

timestamp_us: Option<u32>

The concentrator’s own timestamp of the end of reception, in microseconds.

frequency_hz: u32

The carrier the packet arrived on, in hertz.

channel: u8

The concentrator channel it arrived on.

rf_chain: u8

The radio chain it arrived on.

crc: CrcStatus

What the CRC said.

modulation: Modulation

How it was modulated.

rssi_dbm: Decibels

The received signal strength, to the decibel.

snr_db: Option<Decibels>

The signal-to-noise ratio, to a tenth of a decibel, for a LoRa packet.

payload: Vec<u8>

The packet itself.

Implementations

impl Rxpk

pub fn new(frequency_hz: u32, link: LinkSettings, payload: Vec<u8>) -> Rxpk

Describes a LoRa packet that arrived with a good CRC.

Arguments

• frequency_hz - the carrier it arrived on.
• link - the spreading factor, bandwidth, and coding rate it used.
• payload - the packet.

Returns

The description, on channel 0 and radio chain 0 with no levels yet.

pub fn with_rssi_dbm(self, dbm: i32) -> Rxpk

Returns it with the signal strength it was heard at.

Arguments

• dbm - the strength in dBm.

Returns

The description.

pub fn with_snr_db(self, db: f64) -> Rxpk

Returns it with the signal-to-noise ratio it was heard at.

Arguments

• db - the ratio in decibels, which the protocol carries to a tenth.

Returns

The description.

pub fn with_timestamp_us(self, micros: u32) -> Rxpk

Returns it with the concentrator’s timestamp of the reception.

Arguments

• micros - the counter value, which wraps every 71 minutes.

Returns

The description.

pub fn with_received_at(self, micros_since_epoch: u64) -> Rxpk

Returns it with the time it arrived.

Arguments

• micros_since_epoch - the time in microseconds since 1970-01-01 UTC.

Returns

The description.

pub fn on_channel(self, channel: u8, rf_chain: u8) -> Rxpk

Returns it on another concentrator channel and radio chain.

Arguments

• channel - the concentrator channel.
• rf_chain - the radio chain.

Returns

The description.

pub fn to_json(&self) -> String

Writes the object as the protocol carries it.

Returns

The JSON text of one rxpk entry.

Trait Implementations

impl Clone for Rxpk

fn clone(&self) -> Rxpk

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Rxpk

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

Formats the value using the given formatter.

impl From<Rxpk> for Uplink

fn from(packet: Rxpk) -> Uplink

Converts to this type from the input type.

impl PartialEq for Rxpk

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