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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
use super::super::NanonisClient;
use crate::error::NanonisError;
use crate::types::NanonisValue;
impl NanonisClient {
/// Set the channel to display in the Oscilloscope 1-Channel
/// channel_index: 0-23, corresponds to signals assigned to the 24 slots in the Signals Manager
pub fn osci1t_ch_set(&mut self, channel_index: i32) -> Result<(), NanonisError> {
self.quick_send(
"Osci1T.ChSet",
vec![NanonisValue::I32(channel_index)],
vec!["i"],
vec![],
)?;
Ok(())
}
/// Get the channel displayed in the Oscilloscope 1-Channel
/// Returns: channel index (0-23)
pub fn osci1t_ch_get(&mut self) -> Result<i32, NanonisError> {
let result = self.quick_send("Osci1T.ChGet", vec![], vec![], vec!["i"])?;
match result.first() {
Some(value) => Ok(value.as_i32()?),
None => Err(NanonisError::Protocol(
"No channel index returned".to_string(),
)),
}
}
/// Set the timebase in the Oscilloscope 1-Channel
/// Use osci1t_timebase_get() first to obtain available timebases, then use the index
pub fn osci1t_timebase_set(&mut self, timebase_index: i32) -> Result<(), NanonisError> {
self.quick_send(
"Osci1T.TimebaseSet",
vec![NanonisValue::I32(timebase_index)],
vec!["i"],
vec![],
)?;
Ok(())
}
/// Get the timebase in the Oscilloscope 1-Channel
/// Returns: (timebase_index, timebases_array)
pub fn osci1t_timebase_get(&mut self) -> Result<(i32, Vec<f32>), NanonisError> {
let result = self.quick_send("Osci1T.TimebaseGet", vec![], vec![], vec!["i", "i", "*f"])?;
if result.len() >= 3 {
let timebase_index = result[0].as_i32()?;
let timebases = result[2].as_f32_array()?.to_vec();
Ok((timebase_index, timebases))
} else {
Err(NanonisError::Protocol(
"Invalid timebase response".to_string(),
))
}
}
/// Set the trigger configuration in the Oscilloscope 1-Channel.
///
/// Prefer [`osci1t_trig_set_typed`](Self::osci1t_trig_set_typed) for a
/// type-safe interface using `OsciTriggerMode` and `TriggerSlope` enums.
pub fn osci1t_trig_set(
&mut self,
trigger_mode: u16,
trigger_slope: u16,
trigger_level: f64,
trigger_hysteresis: f64,
) -> Result<(), NanonisError> {
self.quick_send(
"Osci1T.TrigSet",
vec![
NanonisValue::U16(trigger_mode),
NanonisValue::U16(trigger_slope),
NanonisValue::F64(trigger_level),
NanonisValue::F64(trigger_hysteresis),
],
vec!["H", "H", "d", "d"],
vec![],
)?;
Ok(())
}
/// Get the trigger configuration in the Oscilloscope 1-Channel (raw u16).
///
/// Returns raw protocol values. Prefer
/// [`osci1t_trig_get_typed`](Self::osci1t_trig_get_typed) for type-safe
/// `OsciTriggerMode` and `TriggerSlope` values.
pub fn osci1t_trig_get(&mut self) -> Result<(u16, u16, f64, f64), NanonisError> {
let result = self.quick_send("Osci1T.TrigGet", vec![], vec![], vec!["H", "H", "d", "d"])?;
if result.len() >= 4 {
let trigger_mode = result[0].as_u16()?;
let trigger_slope = result[1].as_u16()?;
let trigger_level = result[2].as_f64()?;
let trigger_hysteresis = result[3].as_f64()?;
Ok((
trigger_mode,
trigger_slope,
trigger_level,
trigger_hysteresis,
))
} else {
Err(NanonisError::Protocol(
"Invalid trigger configuration response".to_string(),
))
}
}
/// Set the trigger configuration using typed enums.
///
/// # Examples
/// ```no_run
/// use nanonis_rs::NanonisClient;
/// use nanonis_rs::oscilloscope::{OsciTriggerMode, TriggerSlope};
///
/// let mut client = NanonisClient::new("127.0.0.1", 6501)?;
/// client.osci1t_trig_set_typed(
/// OsciTriggerMode::Level,
/// TriggerSlope::Rising,
/// 0.5, // trigger level
/// 0.1, // hysteresis
/// )?;
/// # Ok::<(), Box<dyn std::error::Error>>(())
/// ```
pub fn osci1t_trig_set_typed(
&mut self,
mode: super::types::OsciTriggerMode,
slope: super::types::TriggerSlope,
level: f64,
hysteresis: f64,
) -> Result<(), NanonisError> {
self.osci1t_trig_set(u16::from(mode), u16::from(slope), level, hysteresis)
}
/// Get the trigger configuration as typed enums.
///
/// # Examples
/// ```no_run
/// use nanonis_rs::NanonisClient;
///
/// let mut client = NanonisClient::new("127.0.0.1", 6501)?;
/// let (mode, slope, level, hysteresis) = client.osci1t_trig_get_typed()?;
/// println!("Mode: {:?}, Slope: {:?}, Level: {}", mode, slope, level);
/// # Ok::<(), Box<dyn std::error::Error>>(())
/// ```
pub fn osci1t_trig_get_typed(
&mut self,
) -> Result<
(
super::types::OsciTriggerMode,
super::types::TriggerSlope,
f64,
f64,
),
NanonisError,
> {
let (mode_raw, slope_raw, level, hysteresis) = self.osci1t_trig_get()?;
let mode = super::types::OsciTriggerMode::try_from(mode_raw)?;
let slope = super::types::TriggerSlope::try_from(slope_raw)?;
Ok((mode, slope, level, hysteresis))
}
/// Start the Oscilloscope 1-Channel
pub fn osci1t_run(&mut self) -> Result<(), NanonisError> {
self.quick_send("Osci1T.Run", vec![], vec![], vec![])?;
Ok(())
}
/// Get the graph data from the Oscilloscope 1-Channel
/// data_to_get: 0 = Current, 1 = Next trigger, 2 = Wait 2 triggers
/// Returns: (t0, dt, size, data_values)
pub fn osci1t_data_get(
&mut self,
data_to_get: u16,
) -> Result<(f64, f64, i32, Vec<f64>), NanonisError> {
let result = self.quick_send(
"Osci1T.DataGet",
vec![NanonisValue::U16(data_to_get)],
vec!["H"],
vec!["d", "d", "i", "*d"],
)?;
if result.len() >= 4 {
let t0 = result[0].as_f64()?;
let dt = result[1].as_f64()?;
let size = result[2].as_i32()?;
let data = result[3].as_f64_array()?.to_vec();
Ok((t0, dt, size, data))
} else {
Err(NanonisError::Protocol(
"Invalid oscilloscope 1T data response".to_string(),
))
}
}
}