km003c_lib/
adc.rs

1use num_enum::{IntoPrimitive, TryFromPrimitive};
2use std::fmt;
3use strum_macros::Display;
4use uom::si::electric_current::{ampere, microampere};
5use uom::si::electric_potential::{microvolt, millivolt, volt};
6use uom::si::f64::{ElectricCurrent, ElectricPotential, Frequency, Power, ThermodynamicTemperature};
7use uom::si::frequency::hertz;
8use uom::si::power::watt;
9use uom::si::thermodynamic_temperature::degree_celsius;
10use zerocopy::byteorder::little_endian::{I16, I32, U16};
11use zerocopy::{FromBytes, Immutable, IntoBytes, KnownLayout, Unaligned};
12
13#[cfg(feature = "serde")]
14use serde::{Deserialize, Serialize};
15
16#[derive(Debug, Clone, Copy, PartialEq, Eq, Display, Default, TryFromPrimitive, IntoPrimitive)]
17#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
18#[cfg_attr(feature = "python", pyo3::pyclass(eq, skip_from_py_object, name = "SampleRate"))]
19#[repr(u8)]
20pub enum SampleRate {
21    #[default]
22    #[strum(to_string = "2 SPS")]
23    Sps2 = 0,
24    #[strum(to_string = "10 SPS")]
25    Sps10 = 1,
26    #[strum(to_string = "50 SPS")]
27    Sps50 = 2,
28    #[strum(to_string = "1 kSPS")]
29    Sps1000 = 3,
30    #[strum(to_string = "10 kSPS")]
31    Sps10000 = 4,
32}
33
34impl SampleRate {
35    /// Get the sample rate in samples per second
36    pub fn frequency(self) -> Frequency {
37        Frequency::new::<hertz>(match self {
38            Self::Sps2 => 2.0,
39            Self::Sps10 => 10.0,
40            Self::Sps50 => 50.0,
41            Self::Sps1000 => 1_000.0,
42            Self::Sps10000 => 10_000.0,
43        })
44    }
45}
46
47#[cfg(feature = "python")]
48#[pyo3::pymethods]
49impl SampleRate {
50    #[getter]
51    fn hz(&self) -> f64 {
52        self.frequency().get::<hertz>()
53    }
54
55    #[getter]
56    fn name(&self) -> String {
57        self.to_string()
58    }
59
60    fn __repr__(&self) -> String {
61        format!("SampleRate({})", self)
62    }
63
64    fn __str__(&self) -> String {
65        self.to_string()
66    }
67}
68
69#[derive(Debug, Clone, Copy, FromBytes, IntoBytes, KnownLayout, Immutable, Unaligned)]
70#[repr(C)]
71pub struct AdcDataRaw {
72    pub vbus_uv: I32,          // Microvolts (µV)
73    pub ibus_ua: I32,          // Microamps (µA)
74    pub vbus_avg_uv: I32,      // Microvolts (µV)
75    pub ibus_avg_ua: I32,      // Microamps (µA)
76    pub vbus_ori_avg_raw: I32, // Uncalibrated
77    pub ibus_ori_avg_raw: I32, // Uncalibrated
78    // Temperature register, LSB = 1/128 °C (7.8125 m°C)
79    pub temp_raw: I16,
80    pub vcc1_tenth_mv: U16,    // 0.1 millivolts
81    pub vcc2_raw: U16,         // 0.1 millivolts (instantaneous)
82    pub vdp_mv: U16,           // 0.1 millivolts (instantaneous)
83    pub vdm_mv: U16,           // 0.1 millivolts (instantaneous)
84    pub internal_vdd_raw: U16, // Internal VDD (0.1 millivolts)
85    pub rate_raw: u8,          // Sample rate index
86    pub reserved: u8,          // Vendor flags (observed 128)
87    pub vcc2_avg_raw: U16,     // 1 millivolt (averaged)
88    pub vdp_avg_mv: U16,       // 1 millivolt (averaged)
89    pub vdm_avg_mv: U16,       // 1 millivolt (averaged)
90}
91
92#[derive(Debug, Clone, Copy, PartialEq)]
93#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
94#[cfg_attr(feature = "python", pyo3::pyclass(skip_from_py_object, name = "AdcData"))]
95pub struct AdcDataSimple {
96    // Main measurements
97    pub vbus: ElectricPotential,
98    /// Current in amperes. Sign indicates power flow direction through the tester:
99    /// - Positive: Power flows from USB female (input) to USB male (output)
100    /// - Negative: Power flows from USB male (input) to USB female (output)
101    pub ibus: ElectricCurrent,
102    /// Power in watts. Sign indicates power flow direction through the tester:
103    /// - Positive: Power flows from USB female (input) to USB male (output)
104    /// - Negative: Power flows from USB male (input) to USB female (output)
105    pub power: Power,
106
107    // Averaged measurements
108    pub vbus_average: ElectricPotential,
109    pub ibus_average: ElectricCurrent,
110
111    // Temperature
112    pub temperature: ThermodynamicTemperature,
113
114    // USB data lines
115    pub vdp: ElectricPotential,
116    pub vdm: ElectricPotential,
117    pub vdp_average: ElectricPotential,
118    pub vdm_average: ElectricPotential,
119
120    // USB CC lines
121    pub cc1: ElectricPotential,
122    pub cc2: ElectricPotential,
123    pub cc2_average: ElectricPotential,
124
125    // Internal voltage
126    pub internal_vdd: ElectricPotential,
127
128    // Sample rate
129    pub sample_rate: SampleRate, // Sample rate as enum
130}
131
132impl From<AdcDataRaw> for AdcDataSimple {
133    fn from(raw: AdcDataRaw) -> Self {
134        let vbus = ElectricPotential::new::<microvolt>(f64::from(raw.vbus_uv.get()));
135        let ibus = ElectricCurrent::new::<microampere>(f64::from(raw.ibus_ua.get()));
136
137        // Convert raw sample rate to enum (safely, fallback to 2 SPS if invalid)
138        let sample_rate = SampleRate::try_from(raw.rate_raw).unwrap_or(SampleRate::Sps2);
139
140        AdcDataSimple {
141            vbus,
142            ibus,
143            power: vbus * ibus,
144            vbus_average: ElectricPotential::new::<microvolt>(f64::from(raw.vbus_avg_uv.get())),
145            ibus_average: ElectricCurrent::new::<microampere>(f64::from(raw.ibus_avg_ua.get())),
146            temperature: ThermodynamicTemperature::new::<degree_celsius>(f64::from(raw.temp_raw.get()) / 128.0),
147            vdp: ElectricPotential::new::<millivolt>(f64::from(raw.vdp_mv.get()) / 10.0),
148            vdm: ElectricPotential::new::<millivolt>(f64::from(raw.vdm_mv.get()) / 10.0),
149            vdp_average: ElectricPotential::new::<millivolt>(f64::from(raw.vdp_avg_mv.get())),
150            vdm_average: ElectricPotential::new::<millivolt>(f64::from(raw.vdm_avg_mv.get())),
151            cc1: ElectricPotential::new::<millivolt>(f64::from(raw.vcc1_tenth_mv.get()) / 10.0),
152            cc2: ElectricPotential::new::<millivolt>(f64::from(raw.vcc2_raw.get()) / 10.0),
153            cc2_average: ElectricPotential::new::<millivolt>(f64::from(raw.vcc2_avg_raw.get())),
154            internal_vdd: ElectricPotential::new::<millivolt>(f64::from(raw.internal_vdd_raw.get()) / 10.0),
155            sample_rate,
156        }
157    }
158}
159
160impl From<AdcDataSimple> for AdcDataRaw {
161    fn from(data: AdcDataSimple) -> Self {
162        AdcDataRaw {
163            vbus_uv: I32::new(data.vbus.get::<microvolt>() as i32),
164            ibus_ua: I32::new(data.ibus.get::<microampere>() as i32),
165            vbus_avg_uv: I32::new(data.vbus_average.get::<microvolt>() as i32),
166            ibus_avg_ua: I32::new(data.ibus_average.get::<microampere>() as i32),
167            vbus_ori_avg_raw: I32::new(0), // We don't have this information
168            ibus_ori_avg_raw: I32::new(0), // We don't have this information
169            // Encode temperature back to raw register: °C * 128
170            temp_raw: I16::new((data.temperature.get::<degree_celsius>() * 128.0) as i16),
171            vcc1_tenth_mv: U16::new((data.cc1.get::<millivolt>() * 10.0) as u16),
172            vcc2_raw: U16::new((data.cc2.get::<millivolt>() * 10.0) as u16),
173            vdp_mv: U16::new((data.vdp.get::<millivolt>() * 10.0) as u16),
174            vdm_mv: U16::new((data.vdm.get::<millivolt>() * 10.0) as u16),
175            internal_vdd_raw: U16::new((data.internal_vdd.get::<millivolt>() * 10.0) as u16),
176            rate_raw: data.sample_rate as u8,
177            reserved: 0,
178            // Store averaged fields in 1 mV units
179            vcc2_avg_raw: U16::new(data.cc2_average.get::<millivolt>() as u16),
180            vdp_avg_mv: U16::new(data.vdp_average.get::<millivolt>() as u16),
181            vdm_avg_mv: U16::new(data.vdm_average.get::<millivolt>() as u16),
182        }
183    }
184}
185
186impl AdcDataSimple {
187    /// Get the absolute current in amperes (magnitude regardless of direction)
188    pub fn current_abs(&self) -> ElectricCurrent {
189        self.ibus.abs()
190    }
191
192    /// Get the absolute power in watts (magnitude regardless of direction)
193    pub fn power_abs(&self) -> Power {
194        self.power.abs()
195    }
196}
197
198impl fmt::Display for AdcDataSimple {
199    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
200        write!(
201            f,
202            "VBUS: {:.3} V, IBUS: {:.3} A, Power: {:.3} W, Temp: {:.1} °C, Rate: {}",
203            self.vbus.get::<volt>(),
204            self.ibus.get::<ampere>(),
205            self.power.get::<watt>(),
206            self.temperature.get::<degree_celsius>(),
207            self.sample_rate
208        )
209    }
210}
211
212#[cfg(feature = "python")]
213#[pyo3::pymethods]
214impl AdcDataSimple {
215    #[getter]
216    fn vbus_v(&self) -> f64 {
217        self.vbus.get::<volt>()
218    }
219    #[getter]
220    fn ibus_a(&self) -> f64 {
221        self.ibus.get::<ampere>()
222    }
223    #[getter]
224    fn power_w(&self) -> f64 {
225        self.power.get::<watt>()
226    }
227    #[getter]
228    fn vbus_avg_v(&self) -> f64 {
229        self.vbus_average.get::<volt>()
230    }
231    #[getter]
232    fn ibus_avg_a(&self) -> f64 {
233        self.ibus_average.get::<ampere>()
234    }
235    #[getter]
236    fn temp_c(&self) -> f64 {
237        self.temperature.get::<degree_celsius>()
238    }
239    #[getter]
240    fn vdp_v(&self) -> f64 {
241        self.vdp.get::<volt>()
242    }
243    #[getter]
244    fn vdm_v(&self) -> f64 {
245        self.vdm.get::<volt>()
246    }
247    #[getter]
248    fn vdp_avg_v(&self) -> f64 {
249        self.vdp_average.get::<volt>()
250    }
251    #[getter]
252    fn vdm_avg_v(&self) -> f64 {
253        self.vdm_average.get::<volt>()
254    }
255    #[getter]
256    fn cc1_v(&self) -> f64 {
257        self.cc1.get::<volt>()
258    }
259    #[getter]
260    fn cc2_v(&self) -> f64 {
261        self.cc2.get::<volt>()
262    }
263    #[getter]
264    fn cc2_avg_v(&self) -> f64 {
265        self.cc2_average.get::<volt>()
266    }
267    #[getter]
268    fn internal_vdd_v(&self) -> f64 {
269        self.internal_vdd.get::<volt>()
270    }
271    #[getter]
272    fn sample_rate(&self) -> SampleRate {
273        self.sample_rate
274    }
275
276    fn __repr__(&self) -> String {
277        format!(
278            "AdcData(vbus={:.3}V, ibus={:.3}A, power={:.3}W, temp={:.1}°C)",
279            self.vbus.get::<volt>(),
280            self.ibus.get::<ampere>(),
281            self.power.get::<watt>(),
282            self.temperature.get::<degree_celsius>()
283        )
284    }
285
286    fn __str__(&self) -> String {
287        self.__repr__()
288    }
289}
km003c_lib/adc.rs

km003c_lib/
adc.rs
