Struct DutyCycle 

pub struct DutyCycle { /* private fields */ }

A repeating wake/sleep schedule.

Duty cycling is the simplest way to make a battery or solar node last: stay awake just long enough to do the work, then sleep through the rest of the period. The duty fraction - the share of each period spent awake - is a good first proxy for average power draw, so roughly halving it halves the energy the cycle costs.

Examples

use core::time::Duration;
use pamoja_power::DutyCycle;

// Wake for one second every minute.
let cycle = DutyCycle::new(Duration::from_secs(1), Duration::from_secs(59));
assert_eq!(cycle.period(), Duration::from_secs(60));
assert!((cycle.fraction() - 1.0 / 60.0).abs() < 1e-6);

Implementations

impl DutyCycle

pub fn new(active: Duration, sleep: Duration) -> Self

Creates a duty cycle from its awake and asleep durations.

Arguments

• active - how long to stay awake each period.
• sleep - how long to sleep each period.

Returns

The duty cycle.

pub fn from_fraction(period: Duration, fraction: f32) -> Self

Creates a duty cycle from a period and the fraction of it to stay awake.

Arguments

• period - the full wake-plus-sleep period.
• fraction - the share of the period to stay awake, clamped to [0.0, 1.0]. A fraction that is not a number keeps the node asleep for the whole period, since a budget worked out from a failed reading is no budget.

Returns

A duty cycle whose awake time is fraction of period.

pub fn active(&self) -> Duration

Returns the awake portion of each period.

pub fn sleep(&self) -> Duration

Returns the asleep portion of each period.

pub fn period(&self) -> Duration

Returns the full period, awake plus asleep, held at Duration::MAX rather than overflowing.

pub fn fraction(&self) -> f32

Returns the share of each period spent awake, in [0.0, 1.0].

Returns

The duty fraction, or 0.0 for a zero-length period.

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for DutyCycle