instrument-components 0.1.0

High-level instrument discovery and typed IVI-inspired classes over VISA
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

use instrument_core::error::Result;
use instrument_core::scpi::ScpiSession;
use instrument_core::InstrumentSession;

/// Digital multimeter session view (IVI-inspired / SCPI :MEASure).
pub struct Dmm {
    session: InstrumentSession,
}

impl Dmm {
    pub fn new(session: InstrumentSession) -> Self {
        Self { session }
    }

    pub fn from_session(_session: &InstrumentSession) -> Result<Self> {
        // Shared session pattern requires caller to manage locking via SessionPool
        Err(instrument_core::Error::Unsupported(
            "use SessionPool for shared session views",
        ))
    }

    pub fn session(&self) -> &InstrumentSession {
        &self.session
    }

    pub fn session_mut(&mut self) -> &mut InstrumentSession {
        &mut self.session
    }

    /// Measures DC voltage in volts (SI).
    pub fn measure_voltage_dc(&mut self, range: Option<f64>) -> Result<f64> {
        let cmd = match range {
            Some(r) => format!(":MEAS:VOLT:DC? {r}"),
            None => ":MEAS:VOLT:DC?".into(),
        };
        self.query_f64(&cmd)
    }

    /// Measures AC voltage in volts (SI).
    pub fn measure_voltage_ac(&mut self, range: Option<f64>) -> Result<f64> {
        let cmd = match range {
            Some(r) => format!(":MEAS:VOLT:AC? {r}"),
            None => ":MEAS:VOLT:AC?".into(),
        };
        self.query_f64(&cmd)
    }

    /// Measures DC current in amps (SI).
    pub fn measure_current_dc(&mut self, range: Option<f64>) -> Result<f64> {
        let cmd = match range {
            Some(r) => format!(":MEAS:CURR:DC? {r}"),
            None => ":MEAS:CURR:DC?".into(),
        };
        self.query_f64(&cmd)
    }

    /// Measures resistance in ohms (SI).
    pub fn measure_resistance(&mut self, range: Option<f64>) -> Result<f64> {
        let cmd = match range {
            Some(r) => format!(":MEAS:RES? {r}"),
            None => ":MEAS:RES?".into(),
        };
        self.query_f64(&cmd)
    }

    /// Configures DC voltage measurement for faster repeated reads.
    pub fn configure_voltage_dc(
        &mut self,
        range: Option<f64>,
        resolution: Option<f64>,
    ) -> Result<()> {
        let mut cmd = String::from(":CONF:VOLT:DC");
        match (range, resolution) {
            (Some(r), Some(res)) => cmd = format!("{cmd} {r},{res}"),
            (Some(r), None) => cmd = format!("{cmd} {r}"),
            (None, Some(res)) => cmd = format!("{cmd} DEF,{res}"),
            (None, None) => {}
        }
        self.session.scpi_mut().write(&cmd)
    }

    fn query_f64(&mut self, cmd: &str) -> Result<f64> {
        let resp = self.session.scpi_mut().query(cmd)?;
        ScpiSession::parse_f64(&resp)
    }
}