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
use super::NanonisClient;
use crate::error::NanonisError;
use crate::types::NanonisValue;
/// Deflection signal type for beam deflection module.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
pub enum DeflectionSignal {
#[default]
Horizontal = 0,
Vertical = 1,
Intensity = 2,
}
impl From<DeflectionSignal> for u16 {
fn from(sig: DeflectionSignal) -> Self {
sig as u16
}
}
/// Beam deflection configuration.
#[derive(Debug, Clone, Default)]
pub struct BeamDeflConfig {
/// Signal name
pub name: String,
/// Physical units
pub units: String,
/// Calibration value
pub calibration: f32,
/// Offset value
pub offset: f32,
}
impl NanonisClient {
// ==================== Beam Deflection ====================
/// Set the horizontal deflection configuration.
///
/// # Arguments
/// * `config` - Beam deflection configuration
///
/// # Errors
/// Returns `NanonisError` if communication fails.
pub fn beam_defl_hor_config_set(&mut self, config: &BeamDeflConfig) -> Result<(), NanonisError> {
self.quick_send(
"BeamDefl.HorConfigSet",
vec![
NanonisValue::String(config.name.clone()),
NanonisValue::String(config.units.clone()),
NanonisValue::F32(config.calibration),
NanonisValue::F32(config.offset),
],
vec!["+*c", "+*c", "f", "f"],
vec![],
)?;
Ok(())
}
/// Get the horizontal deflection configuration.
///
/// # Returns
/// Beam deflection configuration.
///
/// # Errors
/// Returns `NanonisError` if communication fails.
pub fn beam_defl_hor_config_get(&mut self) -> Result<BeamDeflConfig, NanonisError> {
let result = self.quick_send(
"BeamDefl.HorConfigGet",
vec![],
vec![],
vec!["i", "*-c", "i", "*-c", "f", "f"],
)?;
Ok(BeamDeflConfig {
name: result[1].as_string()?.to_string(),
units: result[3].as_string()?.to_string(),
calibration: result[4].as_f32()?,
offset: result[5].as_f32()?,
})
}
/// Set the vertical deflection configuration.
///
/// # Arguments
/// * `config` - Beam deflection configuration
///
/// # Errors
/// Returns `NanonisError` if communication fails.
pub fn beam_defl_ver_config_set(&mut self, config: &BeamDeflConfig) -> Result<(), NanonisError> {
self.quick_send(
"BeamDefl.VerConfigSet",
vec![
NanonisValue::String(config.name.clone()),
NanonisValue::String(config.units.clone()),
NanonisValue::F32(config.calibration),
NanonisValue::F32(config.offset),
],
vec!["+*c", "+*c", "f", "f"],
vec![],
)?;
Ok(())
}
/// Get the vertical deflection configuration.
///
/// # Returns
/// Beam deflection configuration.
///
/// # Errors
/// Returns `NanonisError` if communication fails.
pub fn beam_defl_ver_config_get(&mut self) -> Result<BeamDeflConfig, NanonisError> {
let result = self.quick_send(
"BeamDefl.VerConfigGet",
vec![],
vec![],
vec!["i", "*-c", "i", "*-c", "f", "f"],
)?;
Ok(BeamDeflConfig {
name: result[1].as_string()?.to_string(),
units: result[3].as_string()?.to_string(),
calibration: result[4].as_f32()?,
offset: result[5].as_f32()?,
})
}
/// Set the intensity signal configuration.
///
/// # Arguments
/// * `config` - Beam deflection configuration
///
/// # Errors
/// Returns `NanonisError` if communication fails.
pub fn beam_defl_int_config_set(&mut self, config: &BeamDeflConfig) -> Result<(), NanonisError> {
self.quick_send(
"BeamDefl.IntConfigSet",
vec![
NanonisValue::String(config.name.clone()),
NanonisValue::String(config.units.clone()),
NanonisValue::F32(config.calibration),
NanonisValue::F32(config.offset),
],
vec!["+*c", "+*c", "f", "f"],
vec![],
)?;
Ok(())
}
/// Get the intensity signal configuration.
///
/// # Returns
/// Beam deflection configuration.
///
/// # Errors
/// Returns `NanonisError` if communication fails.
pub fn beam_defl_int_config_get(&mut self) -> Result<BeamDeflConfig, NanonisError> {
let result = self.quick_send(
"BeamDefl.IntConfigGet",
vec![],
vec![],
vec!["i", "*-c", "i", "*-c", "f", "f"],
)?;
Ok(BeamDeflConfig {
name: result[1].as_string()?.to_string(),
units: result[3].as_string()?.to_string(),
calibration: result[4].as_f32()?,
offset: result[5].as_f32()?,
})
}
/// Auto-offset the beam deflection signal.
///
/// Adds the current deflection value to the offset so the signal is close to 0.
///
/// # Arguments
/// * `signal` - Which deflection signal to offset
///
/// # Errors
/// Returns `NanonisError` if communication fails.
pub fn beam_defl_auto_offset(&mut self, signal: DeflectionSignal) -> Result<(), NanonisError> {
self.quick_send(
"BeamDefl.AutoOffset",
vec![NanonisValue::U16(signal.into())],
vec!["H"],
vec![],
)?;
Ok(())
}
}