Struct braid_triggerbox_comms::LedInfo

pub struct LedInfo {
    pub max_duration_usec: u32,
    pub max_overall_duty_cycle: f32,
    pub nth_frame: u8,
}

Fields

max_duration_usec: u32

The duration the LED is on in each pulse (in microseceonds)

This is the maximum value. Regardless of the value specified here, the LED on time cannot be longer than the inter-frame interval. Furthermore, it may also be limited by Self::max_overall_duty_cycle.

max_overall_duty_cycle: f32

The maximum fraction of time the LED is on

This is a safety measure to reduce risk of destroying LEDs. When overdriving LEDs, it may be that they should only be on for a fraction of the time, e.g. 10% of the time. Setting this value to anything less than 1.0 will limit the LED on time to a fraction of total time. The Self::nth_frame field is taken into account within this computation.

nth_frame: u8

What interval the LED is on

0: never 1: every frame 2: every second frame 3: every third frame 4: every fourth frame

Implementations

impl LedInfo

pub fn encode(&self) -> [u8; 11]

pub fn raw_decode(buf: &[u8]) -> Result<LedInfo, Error>

Trait Implementations

impl Clone for LedInfo

fn clone(&self) -> LedInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LedInfo

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

Formats the value using the given formatter.

impl Default for LedInfo

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for LedInfo

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for LedInfo