instrument-components 0.1.1

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
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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152

use crate::classes::{
    Counter, DcPowerSupply, Dmm, FunctionGenerator, Oscilloscope, PowerMeter, SpectrumAnalyzer,
    Switch,
};
use instrument_core::connect::ConnectOptions;
use instrument_core::diagnostics::{CommsObserver, DeviceHealth, Diagnostics};
use instrument_core::error::Result;
use instrument_core::kind::InstrumentKind;
use instrument_core::session::{
    ensure_kind_supported, InstrumentSession, SessionOpener, SessionPool,
};
use instrument_core::DiscoveredDevice;
use std::sync::{Arc, Mutex};

/// Handle to a catalog device — cheap to clone, opens sessions on demand.
#[derive(Clone)]
pub struct DeviceRef {
    pub(crate) device: DiscoveredDevice,
    pub(crate) opener: Arc<dyn SessionOpener>,
    pub(crate) connect_options: ConnectOptions,
    pub(crate) health: Arc<Mutex<DeviceHealth>>,
    pub(crate) observer: Option<Arc<dyn CommsObserver>>,
}

impl DeviceRef {
    pub fn discovered(&self) -> &DiscoveredDevice {
        &self.device
    }

    pub fn address(&self) -> &instrument_core::ResourceAddress {
        &self.device.address
    }

    pub fn supported_kinds(&self) -> &[InstrumentKind] {
        &self.device.supported_kinds
    }

    pub fn connect_options(&self) -> &ConnectOptions {
        &self.connect_options
    }

    pub fn health(&self) -> DeviceHealth {
        self.health.lock().unwrap().clone()
    }

    pub fn with_connect_options(mut self, opts: ConnectOptions) -> Self {
        self.connect_options = opts;
        self
    }

    fn diagnostics(&self) -> Diagnostics {
        let mut diag = Diagnostics::new(&self.device.address.raw).with_health(self.health.clone());
        if let Some(observer) = &self.observer {
            diag = diag.with_observer(observer.clone());
        }
        diag
    }

    /// Opens a new independent session to this device.
    pub fn open_session(&self) -> Result<InstrumentSession> {
        let transport = self
            .opener
            .open(&self.device.address, &self.connect_options)?;
        InstrumentSession::new_with_diagnostics(
            self.device.address.clone(),
            transport,
            self.connect_options.clone(),
            self.device.identity.clone(),
            Some(self.diagnostics()),
        )
    }

    pub fn session_pool(&self) -> Result<SessionPool> {
        Ok(SessionPool::new(self.open_session()?))
    }

    pub fn open_dmm(&self) -> Result<Dmm> {
        ensure_kind_supported(
            &self.device.address,
            InstrumentKind::Dmm,
            &self.device.supported_kinds,
        )?;
        Ok(Dmm::new(self.open_session()?))
    }

    pub fn open_dc_power_supply(&self) -> Result<DcPowerSupply> {
        ensure_kind_supported(
            &self.device.address,
            InstrumentKind::DcPowerSupply,
            &self.device.supported_kinds,
        )?;
        Ok(DcPowerSupply::new(self.open_session()?))
    }

    pub fn open_function_generator(&self) -> Result<FunctionGenerator> {
        ensure_kind_supported(
            &self.device.address,
            InstrumentKind::FunctionGenerator,
            &self.device.supported_kinds,
        )?;
        Ok(FunctionGenerator::new(self.open_session()?))
    }

    pub fn open_oscilloscope(&self) -> Result<Oscilloscope> {
        ensure_kind_supported(
            &self.device.address,
            InstrumentKind::Oscilloscope,
            &self.device.supported_kinds,
        )?;
        Ok(Oscilloscope::new(self.open_session()?))
    }

    pub fn open_switch(&self) -> Result<Switch> {
        ensure_kind_supported(
            &self.device.address,
            InstrumentKind::Switch,
            &self.device.supported_kinds,
        )?;
        Ok(Switch::new(self.open_session()?))
    }

    pub fn open_counter(&self) -> Result<Counter> {
        ensure_kind_supported(
            &self.device.address,
            InstrumentKind::Counter,
            &self.device.supported_kinds,
        )?;
        Ok(Counter::new(self.open_session()?))
    }

    pub fn open_power_meter(&self) -> Result<PowerMeter> {
        ensure_kind_supported(
            &self.device.address,
            InstrumentKind::PowerMeter,
            &self.device.supported_kinds,
        )?;
        Ok(PowerMeter::new(self.open_session()?))
    }

    pub fn open_spectrum_analyzer(&self) -> Result<SpectrumAnalyzer> {
        ensure_kind_supported(
            &self.device.address,
            InstrumentKind::SpectrumAnalyzer,
            &self.device.supported_kinds,
        )?;
        Ok(SpectrumAnalyzer::new(self.open_session()?))
    }

    pub fn open_untyped(&self) -> Result<InstrumentSession> {
        self.open_session()
    }
}