Struct DutyCycle 

pub struct DutyCycle { /* private fields */ }

The silence a radio owes after its transmissions under a duty-cycle limit.

Record each transmission with transmitted, then ask ready or wait_us before the next. A limit of zero forbids transmitting, and the guard never becomes ready.

Examples

use pamoja_lora::LinkSettings;
use pamoja_radios::duty::DutyCycle;

// SF12 at 125 kHz under a 1% limit.
let link = LinkSettings::new(12, 125_000);
let mut guard = DutyCycle::new(10);
assert!(guard.ready(0));

// A ten-byte reading sent at time zero holds the channel for 991,232 us, and owes
// ninety-nine times that in silence.
assert_eq!(guard.transmitted(0, &link, 10), 991_232);
assert_eq!(guard.wait_us(0), 99_123_200);
assert!(!guard.ready(99_000_000));
assert!(guard.ready(99_123_200));

Implementations

impl DutyCycle

pub const fn new(permille: u32) -> Self

Creates a guard for a duty-cycle limit, ready to transmit at once.

Arguments

• permille - the limit in parts per thousand, so 10 is 1%; 0 forbids transmitting and 1000 or more imposes no silence.

Returns

The guard.

pub fn permille(&self) -> u32

Returns the limit the guard enforces.

Returns

The limit in parts per thousand.

pub fn earliest_us(&self) -> u64

Returns the earliest time the next transmission may start.

Returns

A time in microseconds on the caller’s clock, or u64::MAX when the limit forbids transmitting.

pub fn wait_us(&self, now_us: u64) -> u64

Returns how long the radio must still stay silent.

Arguments

• now_us - the current time in microseconds on the caller’s clock.

Returns

The remaining silence in microseconds, zero when a transmission may start.

pub fn ready(&self, now_us: u64) -> bool

Reports whether a transmission may start now.

Arguments

• now_us - the current time in microseconds on the caller’s clock.

Returns

true once the silence the last transmission owed has passed.

pub fn transmitted( &mut self, started_us: u64, link: &LinkSettings, payload_len: usize, ) -> u64

Records a transmission and the silence it owes.

Arguments

• started_us - when the transmission started, in microseconds on the caller’s clock.
• link - the settings the frame was sent with.
• payload_len - the payload length in bytes.

Returns

The frame’s time on air in microseconds.

Trait Implementations

impl Clone for DutyCycle

fn clone(&self) -> DutyCycle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for DutyCycle

impl Debug for DutyCycle

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

Formats the value using the given formatter.

impl Eq for DutyCycle

impl PartialEq for DutyCycle

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