ppk2 0.1.3

A driver for Nordic's Power Profiler Kit 2
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134

//! Command definitions
use crate::types::{DevicePower, MeasurementMode, SourceVoltage};

#[repr(u8)]
/// Serial command opcodes
/// Most commands are not used yet in the current version.
#[allow(missing_docs)]
pub enum Command {
    NoOp,
    TriggerSet,
    AvgNumSet,
    TriggerWindowSet,
    TriggerIntervalSet,
    TriggerSingleSet,
    AverageStart,
    AverageStop,
    RangeSet,
    LcdSet,
    TriggerStop,
    /// Enable or disable device
    DeviceRunningSet(DevicePower),
    /// Set device source voltage
    RegulatorSet(SourceVoltage),
    SwitchPointDown,
    SwitchPointUp,
    TriggerExtToggle,
    /// Set measurement mode
    SetPowerMode(MeasurementMode),
    ResUserSet,
    SpikeFilteringOn,
    SpikeFilteringOff,
    /// Fetch device metadata
    GetMetaData,
    /// Reset the device
    Reset,
    SetUserGains,
}

impl Command {
    /// The expected length of the response, as a hint
    /// indicating how much space we should allocate for a buffer.
    /// If no specific branch for the command is defined in
    /// Command::response_complete, the expected response length
    /// is used to check whether we received the whole response.
    pub fn expected_response_len(&self) -> usize {
        match self {
            Command::NoOp => 0,
            Command::TriggerSet => 0,
            Command::AvgNumSet => 0,
            Command::TriggerWindowSet => 0,
            Command::TriggerIntervalSet => 0,
            Command::TriggerSingleSet => 0,
            Command::AverageStart => 0,
            Command::AverageStop => 0,
            Command::RangeSet => 0,
            Command::LcdSet => 0,
            Command::TriggerStop => 0,
            Command::DeviceRunningSet(_) => 0,
            Command::RegulatorSet(_) => 0,
            Command::SwitchPointDown => 0,
            Command::SwitchPointUp => 0,
            Command::TriggerExtToggle => 0,
            Command::SetPowerMode(_) => 0,
            Command::ResUserSet => 0,
            Command::SpikeFilteringOn => 0,
            Command::SpikeFilteringOff => 0,
            Command::GetMetaData => 512,
            Command::Reset => 0,
            Command::SetUserGains => 0,
        }
    }

    pub(crate) fn response_complete(&self, response: &[u8]) -> bool {
        match self {
            Command::GetMetaData => response.ends_with(b"END\n"),
            _ => self.expected_response_len() >= response.len(),
        }
    }
}

impl Command {
    /// Get raw command bytes iterator
    pub fn bytes(&self) -> CommandBytes<'_> {
        CommandBytes {
            cmd: self,
            index: 0,
        }
    }
}

/// Iterator that iterates over the raw command bytes
pub struct CommandBytes<'c> {
    cmd: &'c Command,
    index: usize,
}

impl<'c> Iterator for CommandBytes<'c> {
    type Item = u8;

    fn next(&mut self) -> Option<Self::Item> {
        use Command::*;
        let b = match (self.cmd, self.index) {
            (NoOp, 0) => Some(0x00),
            (TriggerSet, 0) => Some(0x01),
            (AvgNumSet, 0) => Some(0x02),
            (TriggerWindowSet, 0) => Some(0x03),
            (TriggerIntervalSet, 0) => Some(0x04),
            (TriggerSingleSet, 0) => Some(0x05),
            (AverageStart, 0) => Some(0x06),
            (AverageStop, 0) => Some(0x07),
            (RangeSet, 0) => Some(0x08),
            (LcdSet, 0) => Some(0x09),
            (TriggerStop, 0) => Some(0x0A),
            (DeviceRunningSet(_), 0) => Some(0x0C),
            (DeviceRunningSet(pwr), 1) => Some((*pwr).into()),
            (RegulatorSet(_), 0) => Some(0x0D),
            (RegulatorSet(vdd), i) if (1..=2).contains(&i) => Some(vdd.raw()[i - 1]),
            (SwitchPointDown, 0) => Some(0x0E),
            (SwitchPointUp, 0) => Some(0x0F),
            (TriggerExtToggle, 0) => Some(0x10),
            (SetPowerMode(_), 0) => Some(0x11),
            (SetPowerMode(mode), 1) => Some((*mode).into()),
            (ResUserSet, 0) => Some(0x12),
            (SpikeFilteringOn, 0) => Some(0x15),
            (SpikeFilteringOff, 0) => Some(0x16),
            (GetMetaData, 0) => Some(0x19),
            (Reset, 0) => Some(0x20),
            (SetUserGains, 0) => Some(0x25),
            _ => None,
        };
        self.index += 1;
        b
    }
}