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
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
use super::NanonisClient;
use crate::error::NanonisError;
use crate::types::{NanonisValue, SignalIndex};
impl NanonisClient {
/// Get available signal names
pub fn signal_names_get(
&mut self,
print: bool,
) -> Result<Vec<String>, NanonisError> {
let result =
self.quick_send("Signals.NamesGet", vec![], vec![], vec!["+*c"])?;
match result.first() {
Some(value) => {
let signal_names = value.as_string_array()?.to_vec();
if print {
Self::print_signal_names(&signal_names);
}
Ok(signal_names)
}
None => Err(NanonisError::Protocol(
"No signal names returned".to_string(),
)),
}
}
/// Helper function for printing signal names
fn print_signal_names(names: &[String]) {
log::info!("Available signal names ({} total):", names.len());
for (index, name) in names.iter().enumerate() {
log::info!(" {index}: {name}");
}
}
/// Get calibration and offset of a signal by index
pub fn signals_calibr_get(
&mut self,
signal_index: SignalIndex,
) -> Result<(f32, f32), NanonisError> {
let result = self.quick_send(
"Signals.CalibrGet",
vec![NanonisValue::I32(signal_index.into())],
vec!["i"],
vec!["f", "f"],
)?;
if result.len() >= 2 {
Ok((result[0].as_f32()?, result[1].as_f32()?))
} else {
Err(NanonisError::Protocol(
"Invalid calibration response".to_string(),
))
}
}
/// Get range limits of a signal by index
pub fn signals_range_get(
&mut self,
signal_index: SignalIndex,
) -> Result<(f32, f32), NanonisError> {
let result = self.quick_send(
"Signals.RangeGet",
vec![NanonisValue::I32(signal_index.into())],
vec!["i"],
vec!["f", "f"],
)?;
if result.len() >= 2 {
Ok((result[0].as_f32()?, result[1].as_f32()?)) // (max, min)
} else {
Err(NanonisError::Protocol("Invalid range response".to_string()))
}
}
/// Get current values of signals by index(es)
pub fn signals_vals_get(
&mut self,
signal_indexes: Vec<i32>,
wait_for_newest_data: bool,
) -> Result<Vec<f32>, NanonisError> {
let indexes = signal_indexes;
let wait_flag = if wait_for_newest_data { 1u32 } else { 0u32 };
let result = self.quick_send(
"Signals.ValsGet",
vec![
NanonisValue::ArrayI32(indexes),
NanonisValue::U32(wait_flag),
],
vec!["+*i", "I"],
vec!["i", "*f"],
)?;
if result.len() >= 2 {
match &result[1] {
NanonisValue::ArrayF32(values) => Ok(values.clone()),
_ => Err(NanonisError::Protocol(
"Invalid signal values response".to_string(),
)),
}
} else {
Err(NanonisError::Protocol(
"Incomplete signal values response".to_string(),
))
}
}
/// Find signal index by name (case-insensitive)
pub fn find_signal_index(
&mut self,
signal_name: &str,
) -> Result<Option<SignalIndex>, NanonisError> {
let signals = self.signal_names_get(false)?;
let signal_name_lower = signal_name.to_lowercase();
for (index, name) in signals.iter().enumerate() {
if name.to_lowercase().contains(&signal_name_lower) {
return Ok(Some(SignalIndex(index as i32)));
}
}
Ok(None)
}
/// Get the current value of a single selected signal.
///
/// Returns the current value of the selected signal, oversampled during the
/// Acquisition Period time (Tap). The signal is continuously oversampled and published
/// every Tap seconds.
///
/// # Signal Measurement Principle
/// This function waits for the next oversampled data to be published and returns its value.
/// It does not trigger a measurement but waits for data to be published. The function
/// returns a value 0 to Tap seconds after being called.
///
/// **Important**: If you change a signal and immediately call this function, you might
/// get "old" data measured before the signal change. Set `wait_for_newest_data` to `true`
/// to ensure you get only fresh data.
///
/// # Arguments
/// * `signal_index` - Signal index (0-127)
/// * `wait_for_newest_data` - If `true`, discards first value and waits for fresh data.
/// Takes Tap to 2*Tap seconds. If `false`, returns next available value (0 to Tap seconds).
///
/// # Returns
/// The signal value in physical units.
///
/// # Errors
/// Returns `NanonisError` if:
/// - Invalid signal index provided
/// - Communication timeout or protocol error
///
/// # Examples
/// ```no_run
/// use rusty_tip::{NanonisClient, SignalIndex};
///
/// let mut client = NanonisClient::new("127.0.0.1", 6501)?;
///
/// // Read bias signal immediately
/// let bias_value = client.signal_val_get(SignalIndex(24), false)?;
///
/// // Wait for fresh data after signal change
/// let fresh_value = client.signal_val_get(SignalIndex(24), true)?;
/// # Ok::<(), Box<dyn std::error::Error>>(())
/// ```
pub fn signal_val_get(
&mut self,
signal_index: impl Into<SignalIndex>,
wait_for_newest_data: bool,
) -> Result<f32, NanonisError> {
let wait_flag = if wait_for_newest_data { 1u32 } else { 0u32 };
let result = self.quick_send(
"Signals.ValGet",
vec![
NanonisValue::I32(signal_index.into().into()),
NanonisValue::U32(wait_flag),
],
vec!["i", "I"],
vec!["f"],
)?;
match result.first() {
Some(value) => Ok(value.as_f32()?),
None => Err(NanonisError::Protocol(
"No signal value returned".to_string(),
)),
}
}
/// Get the list of measurement channels names available in the software.
///
/// Returns the names of measurement channels used in sweepers and other measurement modules.
///
/// **Important Note**: Measurement channels are different from Signals. Measurement channels
/// are used in sweepers, while Signals are used by graphs and other modules. The indexes
/// returned here are used for sweeper channel configuration (e.g., `GenSwp.ChannelsGet/Set`).
///
/// # Returns
/// A vector of measurement channel names where each name corresponds to an index
/// that can be used in sweeper functions.
///
/// # Errors
/// Returns `NanonisError` if communication fails or protocol error occurs.
///
/// # Examples
/// ```no_run
/// use rusty_tip::NanonisClient;
///
/// let mut client = NanonisClient::new("127.0.0.1", 6501)?;
///
/// let meas_channels = client.signals_meas_names_get()?;
/// println!("Available measurement channels: {}", meas_channels.len());
///
/// for (index, name) in meas_channels.iter().enumerate() {
/// println!(" {}: {}", index, name);
/// }
/// # Ok::<(), Box<dyn std::error::Error>>(())
/// ```
pub fn signals_meas_names_get(&mut self) -> Result<Vec<String>, NanonisError> {
let result = self.quick_send(
"Signals.MeasNamesGet",
vec![],
vec![],
vec!["i", "i", "*+c"],
)?;
if result.len() >= 3 {
let meas_names = result[2].as_string_array()?.to_vec();
Ok(meas_names)
} else {
Err(NanonisError::Protocol(
"Invalid measurement names response".to_string(),
))
}
}
/// Get the list of additional Real-Time (RT) signals and current assignments.
///
/// Returns the list of additional RT signals available for assignment to Internal 23 and 24,
/// plus the names of signals currently assigned to these internal channels.
///
/// **Note**: This assignment in the Signals Manager doesn't automatically make them available
/// in graphs and modules. Internal 23 and 24 must be assigned to one of the 24 display slots
/// using functions like `Signals.InSlotSet` to be visible in the software.
///
/// # Returns
/// A tuple containing:
/// - `Vec<String>` - List of additional RT signals that can be assigned to Internal 23/24
/// - `String` - Name of RT signal currently assigned to Internal 23
/// - `String` - Name of RT signal currently assigned to Internal 24
///
/// # Errors
/// Returns `NanonisError` if communication fails or protocol error occurs.
///
/// # Examples
/// ```no_run
/// use rusty_tip::NanonisClient;
///
/// let mut client = NanonisClient::new("127.0.0.1", 6501)?;
///
/// let (available_signals, internal_23, internal_24) = client.signals_add_rt_get()?;
///
/// println!("Available additional RT signals: {}", available_signals.len());
/// for (i, signal) in available_signals.iter().enumerate() {
/// println!(" {}: {}", i, signal);
/// }
///
/// println!("Internal 23 assigned to: {}", internal_23);
/// println!("Internal 24 assigned to: {}", internal_24);
/// # Ok::<(), Box<dyn std::error::Error>>(())
/// ```
pub fn signals_add_rt_get(
&mut self,
) -> Result<(Vec<String>, String, String), NanonisError> {
let result = self.quick_send(
"Signals.AddRTGet",
vec![],
vec![],
vec!["i", "i", "*+c", "i", "*-c", "i", "*-c"],
)?;
if result.len() >= 7 {
let available_signals = result[2].as_string_array()?.to_vec();
let internal_23 = result[4].as_string()?.to_string();
let internal_24 = result[6].as_string()?.to_string();
Ok((available_signals, internal_23, internal_24))
} else {
Err(NanonisError::Protocol(
"Invalid additional RT signals response".to_string(),
))
}
}
/// Assign additional Real-Time (RT) signals to Internal 23 and 24 signals.
///
/// Links advanced RT signals to Internal 23 and Internal 24 in the Signals Manager.
/// This enables routing of specialized real-time signals through the internal channel system.
///
/// **Important Note**: This assignment only links the RT signals to Internal 23/24.
/// To make them visible in graphs and available for acquisition in modules, Internal 23 and 24
/// must be assigned to one of the 24 display slots using functions like `Signals.InSlotSet`.
///
/// # Arguments
/// * `additional_rt_signal_1` - Index of the RT signal to assign to Internal 23 (from `signals_add_rt_get()`)
/// * `additional_rt_signal_2` - Index of the RT signal to assign to Internal 24 (from `signals_add_rt_get()`)
///
/// # Errors
/// Returns `NanonisError` if:
/// - Invalid RT signal indices provided
/// - RT signals are not available or accessible
/// - Communication fails or protocol error occurs
///
/// # Examples
/// ```no_run
/// use rusty_tip::NanonisClient;
///
/// let mut client = NanonisClient::new("127.0.0.1", 6501)?;
///
/// // First, get the available RT signals
/// let (available_signals, current_23, current_24) = client.signals_add_rt_get()?;
///
/// println!("Available RT signals:");
/// for (i, signal) in available_signals.iter().enumerate() {
/// println!(" {}: {}", i, signal);
/// }
///
/// // Assign RT signal index 0 to Internal 23 and index 1 to Internal 24
/// client.signals_add_rt_set(0, 1)?;
///
/// // Verify the assignment
/// let (_, new_23, new_24) = client.signals_add_rt_get()?;
/// println!("Internal 23 now assigned to: {}", new_23);
/// println!("Internal 24 now assigned to: {}", new_24);
/// # Ok::<(), Box<dyn std::error::Error>>(())
/// ```
pub fn signals_add_rt_set(
&mut self,
additional_rt_signal_1: i32,
additional_rt_signal_2: i32,
) -> Result<(), NanonisError> {
self.quick_send(
"Signals.AddRTSet",
vec![
NanonisValue::I32(additional_rt_signal_1),
NanonisValue::I32(additional_rt_signal_2),
],
vec!["i", "i"],
vec![],
)?;
Ok(())
}
/// Read a signal by name (finds index automatically)
pub fn read_signal_by_name(
&mut self,
signal_name: &str,
wait_for_newest: bool,
) -> Result<f32, NanonisError> {
match self.find_signal_index(signal_name)? {
Some(index) => {
let values =
self.signals_vals_get(vec![index.into()], wait_for_newest)?;
values.first().copied().ok_or_else(|| {
NanonisError::Protocol("No signal value returned".to_string())
})
}
None => Err(NanonisError::InvalidCommand(format!(
"Signal '{signal_name}' not found"
))),
}
}
}