nanonis-rs 0.4.0

Rust client library for Nanonis SPM system control via TCP
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

// ==================== Lock-In Amplifier Types ====================

/// Demodulator RT signal output mode.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
pub enum RTSignalMode {
    /// X/Y (Cartesian) output
    #[default]
    XY = 0,
    /// R/phi (Polar) output
    RPhi = 1,
}

impl From<RTSignalMode> for u32 {
    fn from(mode: RTSignalMode) -> Self {
        mode as u32
    }
}

impl TryFrom<u32> for RTSignalMode {
    type Error = crate::error::NanonisError;

    fn try_from(value: u32) -> Result<Self, Self::Error> {
        match value {
            0 => Ok(RTSignalMode::XY),
            1 => Ok(RTSignalMode::RPhi),
            _ => Err(crate::error::NanonisError::Protocol(format!(
                "Invalid RTSignalMode value: {}",
                value
            ))),
        }
    }
}

/// Lock-in modulator configuration.
#[derive(Debug, Clone)]
pub struct ModulatorConfig {
    /// Modulator number (1-8)
    pub number: i32,
    /// Whether modulator is on
    pub enabled: bool,
    /// Signal index being modulated
    pub signal_index: i32,
    /// Phase register index (1-8)
    pub phase_register: i32,
    /// Harmonic number (1 = base frequency)
    pub harmonic: i32,
    /// Phase offset in degrees
    pub phase_deg: f32,
    /// Modulation amplitude
    pub amplitude: f32,
    /// Frequency in Hz
    pub frequency_hz: f64,
}

impl Default for ModulatorConfig {
    fn default() -> Self {
        Self {
            number: 1,
            enabled: false,
            signal_index: 0,
            phase_register: 1,
            harmonic: 1,
            phase_deg: 0.0,
            amplitude: 0.0,
            frequency_hz: 1000.0,
        }
    }
}

/// Lock-in demodulator configuration.
#[derive(Debug, Clone)]
pub struct DemodulatorConfig {
    /// Demodulator number (1-8)
    pub number: i32,
    /// Signal index being demodulated
    pub signal_index: i32,
    /// Harmonic number (1 = base frequency)
    pub harmonic: i32,
    /// High-pass filter order (0 = off, 1-8)
    pub hp_filter_order: i32,
    /// High-pass filter cutoff frequency in Hz
    pub hp_filter_cutoff_hz: f32,
    /// Low-pass filter order (0 = off, 1-8)
    pub lp_filter_order: i32,
    /// Low-pass filter cutoff frequency in Hz
    pub lp_filter_cutoff_hz: f32,
    /// Phase register index (1-8)
    pub phase_register: i32,
    /// Reference phase in degrees
    pub phase_deg: f32,
    /// Sync filter enabled
    pub sync_filter: bool,
    /// RT signal mode (X/Y or R/phi)
    pub rt_signal_mode: RTSignalMode,
}

impl Default for DemodulatorConfig {
    fn default() -> Self {
        Self {
            number: 1,
            signal_index: 0,
            harmonic: 1,
            hp_filter_order: 0,
            hp_filter_cutoff_hz: 10.0,
            lp_filter_order: 4,
            lp_filter_cutoff_hz: 100.0,
            phase_register: 1,
            phase_deg: 0.0,
            sync_filter: false,
            rt_signal_mode: RTSignalMode::XY,
        }
    }
}

/// High-pass or low-pass filter configuration.
#[derive(Debug, Clone, Copy)]
pub struct FilterConfig {
    /// Filter order (0 = off, 1-8 active)
    pub order: i32,
    /// Cutoff frequency in Hz
    pub cutoff_hz: f32,
}

impl Default for FilterConfig {
    fn default() -> Self {
        Self {
            order: 0,
            cutoff_hz: 100.0,
        }
    }
}