| 1 | package Lab::Instrument::SR830; | ||
| 2 | $Lab::Instrument::SR830::VERSION = '3.899'; | ||
| 3 | #ABSTRACT: Stanford Research SR830 lock-in amplifier | ||
| 4 | |||
| 5 | use v5.20; | ||
| 6 | |||
| 7 | use strict; | ||
| 8 | use Lab::Instrument; | ||
| 9 | use Data::Dumper; | ||
| 10 | use Carp; | ||
| 11 | use Time::HiRes qw (usleep); | ||
| 12 | |||
| 13 | our @ISA = ("Lab::Instrument"); | ||
| 14 | |||
| 15 | our %fields = ( supported_connections => [ 'GPIB', 'VISA_GPIB' ], ); | ||
| 16 | |||
| 17 | sub new { | ||
| 18 | my $proto = shift; | ||
| 19 | my $class = ref($proto) || $proto; | ||
| 20 | my $self = $class->SUPER::new(@_); | ||
| 21 | $self->${ \( __PACKAGE__ . '::_construct' ) }(__PACKAGE__); | ||
| 22 | |||
| 23 | $self->empty_buffer(); | ||
| 24 | return $self; | ||
| 25 | } | ||
| 26 | |||
| 27 | # | ||
| 28 | # utility methods | ||
| 29 | # | ||
| 30 | |||
| 31 | sub empty_buffer { | ||
| 32 | my $self = shift; | ||
| 33 | my ($times) = $self->_check_args( \@_, ['times'] ); | ||
| 34 | if ($times) { | ||
| 35 | for ( my $i = 0; $i < $times; $i++ ) { | ||
| 36 | eval { $self->read( brutal => 1 ) }; | ||
| 37 | } | ||
| 38 | } | ||
| 39 | else { | ||
| 40 | while ( $self->read( brutal => 1 ) ) { | ||
| 41 | print "Cleaning buffer."; | ||
| 42 | } | ||
| 43 | } | ||
| 44 | } | ||
| 45 | |||
| 46 | sub set_frequency { | ||
| 47 | my ( $self, $freq ) = @_; | ||
| 48 | $self->write("FREQ $freq"); | ||
| 49 | } | ||
| 50 | |||
| 51 | sub set_frq { | ||
| 52 | my $self = shift; | ||
| 53 | my ($freq) = $self->_check_args( \@_, ['value'] ); | ||
| 54 | $self->set_frequency($freq); | ||
| 55 | } | ||
| 56 | |||
| 57 | sub get_frequency { | ||
| 58 | my $self = shift; | ||
| 59 | my $freq = $self->query("FREQ?"); | ||
| 60 | chomp $freq; | ||
| 61 | return $freq; # frequency in Hz | ||
| 62 | } | ||
| 63 | |||
| 64 | sub get_frq { | ||
| 65 | my $self = shift; | ||
| 66 | my $freq = $self->get_frequency(); | ||
| 67 | return $freq; | ||
| 68 | } | ||
| 69 | |||
| 70 | sub set_amplitude { | ||
| 71 | my $self = shift; | ||
| 72 | my ($ampl) = $self->_check_args( \@_, ['value'] ); | ||
| 73 | $self->write("SLVL $ampl"); | ||
| 74 | my $realampl = $self->query("SLVL?"); | ||
| 75 | chomp $realampl; | ||
| 76 | return $realampl; # amplitude in V | ||
| 77 | } | ||
| 78 | |||
| 79 | sub get_amplitude { | ||
| 80 | my $self = shift; | ||
| 81 | my $ampl = $self->query("SLVL?"); | ||
| 82 | chomp $ampl; | ||
| 83 | return $ampl; # amplitude in V | ||
| 84 | } | ||
| 85 | |||
| 86 | sub set_sens { | ||
| 87 | |||
| 88 | # set sensitivity to value equal to or greater than argument (in V), Range 2nV..1V | ||
| 89 | my ( $self, $sens ) = @_; | ||
| 90 | my $nr = 26; | ||
| 91 | |||
| 92 | if ( $sens < 2E-9 ) { $nr = 0; } | ||
| 93 | elsif ( $sens <= 5E-9 ) { $nr = 1; } | ||
| 94 | elsif ( $sens <= 1E-8 ) { $nr = 2; } | ||
| 95 | elsif ( $sens <= 2E-8 ) { $nr = 3; } | ||
| 96 | elsif ( $sens <= 5E-8 ) { $nr = 4; } | ||
| 97 | elsif ( $sens <= 1E-7 ) { $nr = 5; } | ||
| 98 | elsif ( $sens <= 2E-7 ) { $nr = 6; } | ||
| 99 | elsif ( $sens <= 5E-7 ) { $nr = 7; } | ||
| 100 | elsif ( $sens <= 1E-6 ) { $nr = 8; } | ||
| 101 | elsif ( $sens <= 2E-6 ) { $nr = 9; } | ||
| 102 | elsif ( $sens <= 5E-6 ) { $nr = 10; } | ||
| 103 | elsif ( $sens <= 1E-5 ) { $nr = 11; } | ||
| 104 | elsif ( $sens <= 2E-5 ) { $nr = 12; } | ||
| 105 | elsif ( $sens <= 5E-5 ) { $nr = 13; } | ||
| 106 | elsif ( $sens <= 1E-4 ) { $nr = 14; } | ||
| 107 | elsif ( $sens <= 2E-4 ) { $nr = 15; } | ||
| 108 | elsif ( $sens <= 5E-4 ) { $nr = 16; } | ||
| 109 | elsif ( $sens <= 1E-3 ) { $nr = 17; } | ||
| 110 | elsif ( $sens <= 2E-3 ) { $nr = 18; } | ||
| 111 | elsif ( $sens <= 5E-3 ) { $nr = 19; } | ||
| 112 | elsif ( $sens <= 1E-2 ) { $nr = 20; } | ||
| 113 | elsif ( $sens <= 2E-2 ) { $nr = 21; } | ||
| 114 | elsif ( $sens <= 5E-2 ) { $nr = 22; } | ||
| 115 | elsif ( $sens <= 1E-1 ) { $nr = 23; } | ||
| 116 | elsif ( $sens <= 2E-1 ) { $nr = 24; } | ||
| 117 | elsif ( $sens <= 5E-1 ) { $nr = 25; } | ||
| 118 | |||
| 119 | $self->write("SENS $nr"); | ||
| 120 | |||
| 121 | my $realsens = $self->query("SENS?"); | ||
| 122 | my @senses = ( | ||
| 123 | "2e-9", "5e-9", "10e-9", "20e-9", "50e-9", "100e-9", | ||
| 124 | "200e-9", "500e-9", "1e-6", "2e-6", "5e-6", "10e-6", | ||
| 125 | "20e-6", "50e-6", "100e-6", "200e-6", "500e-6", "1e-3", | ||
| 126 | "2e-3", "5e-3", "10e-3", "20e-3", "50e-3", "100e-3", | ||
| 127 | "200e-3", "500e-3", "1" | ||
| 128 | ); | ||
| 129 | return $senses[$realsens]; # in V | ||
| 130 | } | ||
| 131 | |||
| 132 | sub get_sens { | ||
| 133 | my @senses = ( | ||
| 134 | "2e-9", "5e-9", "10e-9", "20e-9", "50e-9", "100e-9", | ||
| 135 | "200e-9", "500e-9", "1e-6", "2e-6", "5e-6", "10e-6", | ||
| 136 | "20e-6", "50e-6", "100e-6", "200e-6", "500e-6", "1e-3", | ||
| 137 | "2e-3", "5e-3", "10e-3", "20e-3", "50e-3", "100e-3", | ||
| 138 | "200e-3", "500e-3", "1" | ||
| 139 | ); | ||
| 140 | my $self = shift; | ||
| 141 | my $nr = $self->query("SENS?"); | ||
| 142 | return $senses[$nr]; # in V | ||
| 143 | } | ||
| 144 | |||
| 145 | # | ||
| 146 | # Set sensitivity to 2x the current amplitude (or $minimum_sensitivity, if given) | ||
| 147 | # set_sens_auto( $minimum_sensitivity ); | ||
| 148 | # | ||
| 149 | sub set_sens_auto { | ||
| 150 | my $self = shift; | ||
| 151 | my $minsens = shift || 0; | ||
| 152 | my $V = get_amplitude(); | ||
| 153 | |||
| 154 | #print "V=$V\tminsens=$minsens\n"; | ||
| 155 | #my ($lix, $liy) = $self->read_xy(); | ||
| 156 | if ( abs($V) >= $minsens / 2 ) { | ||
| 157 | $self->set_sens( abs( $V * 2. ) ); | ||
| 158 | my ( $lix, $liy ) = $self->get_xy(); | ||
| 159 | } | ||
| 160 | else { | ||
| 161 | $self->set_sens( abs($minsens) ); | ||
| 162 | my ( $lix, $liy ) = $self->get_xy(); | ||
| 163 | } | ||
| 164 | } | ||
| 165 | |||
| 166 | sub set_tc { | ||
| 167 | |||
| 168 | # set time constant to value greater than or equal to argument given, value in s | ||
| 169 | |||
| 170 | my ( $self, $tc ) = @_; | ||
| 171 | my $nr = 19; | ||
| 172 | |||
| 173 | if ( $tc < 1E-5 ) { $nr = 0; } | ||
| 174 | elsif ( $tc < 3E-5 ) { $nr = 1; } | ||
| 175 | elsif ( $tc < 1E-4 ) { $nr = 2; } | ||
| 176 | elsif ( $tc < 3E-4 ) { $nr = 3; } | ||
| 177 | elsif ( $tc < 1E-3 ) { $nr = 4; } | ||
| 178 | elsif ( $tc < 3E-3 ) { $nr = 5; } | ||
| 179 | elsif ( $tc < 1E-2 ) { $nr = 6; } | ||
| 180 | elsif ( $tc < 3E-2 ) { $nr = 7; } | ||
| 181 | elsif ( $tc < 1E-1 ) { $nr = 8; } | ||
| 182 | elsif ( $tc < 3E-1 ) { $nr = 9; } | ||
| 183 | elsif ( $tc < 1 ) { $nr = 10; } | ||
| 184 | elsif ( $tc < 3 ) { $nr = 11; } | ||
| 185 | elsif ( $tc < 10 ) { $nr = 12; } | ||
| 186 | elsif ( $tc < 30 ) { $nr = 13; } | ||
| 187 | elsif ( $tc < 100 ) { $nr = 14; } | ||
| 188 | elsif ( $tc < 300 ) { $nr = 15; } | ||
| 189 | elsif ( $tc < 1000 ) { $nr = 16; } | ||
| 190 | elsif ( $tc < 3000 ) { $nr = 17; } | ||
| 191 | elsif ( $tc < 10000 ) { $nr = 18; } | ||
| 192 | |||
| 193 | $self->write("OFLT $nr"); | ||
| 194 | |||
| 195 | my @tc = ( | ||
| 196 | "10e-6", "30e-6", "100e-6", "300e-6", "1e-3", "3e-3", | ||
| 197 | "10e-3", "30e-3", "100e-3", "300e-3", "1", "3", | ||
| 198 | "10", "30", "100", "300", "1e3", "3e3", | ||
| 199 | "10e3", "30e3" | ||
| 200 | ); | ||
| 201 | my $realtc = $self->query("OFLT?"); | ||
| 202 | return $tc[$realtc]; # in sec | ||
| 203 | |||
| 204 | } | ||
| 205 | |||
| 206 | sub get_tc { | ||
| 207 | my @tc = ( | ||
| 208 | "10e-6", "30e-6", "100e-6", "300e-6", "1e-3", "3e-3", | ||
| 209 | "10e-3", "30e-3", "100e-3", "300e-3", "1", "3", | ||
| 210 | "10", "30", "100", "300", "1e3", "3e3", | ||
| 211 | "10e3", "30e3" | ||
| 212 | ); | ||
| 213 | |||
| 214 | my $self = shift; | ||
| 215 | my $nr = $self->query("OFLT?"); | ||
| 216 | return $tc[$nr]; # in sec | ||
| 217 | } | ||
| 218 | |||
| 219 | sub get_xy { | ||
| 220 | |||
| 221 | # get value of X and Y channel (recorded simultaneously) as array | ||
| 222 | my $self = shift; | ||
| 223 | my $tmp = $self->query("SNAP?1,2"); | ||
| 224 | chomp $tmp; | ||
| 225 | my @arr = split( /,/, $tmp ); | ||
| 226 | return @arr; | ||
| 227 | } | ||
| 228 | |||
| 229 | sub get_rphi { | ||
| 230 | |||
| 231 | # get value of amplitude and phase (recorded simultaneously) as array | ||
| 232 | my $self = shift; | ||
| 233 | my $tmp = $self->query("SNAP?3,4"); | ||
| 234 | chomp $tmp; | ||
| 235 | my @arr = split( /,/, $tmp ); | ||
| 236 | return @arr; | ||
| 237 | } | ||
| 238 | |||
| 239 | sub get_channels { | ||
| 240 | |||
| 241 | # get value of channel1 and channel2 as array | ||
| 242 | my $self = shift; | ||
| 243 | |||
| 244 | $self->query("OUTR?1"); | ||
| 245 | $self->query("OUTR?2"); | ||
| 246 | my $x = $self->query("OUTR?1"); | ||
| 247 | my $y = $self->query("OUTR?2"); | ||
| 248 | chomp $x; | ||
| 249 | chomp $y; | ||
| 250 | my @arr = ( $x, $y ); | ||
| 251 | return @arr; | ||
| 252 | } | ||
| 253 | |||
| 254 | sub id { | ||
| 255 | my $self = shift; | ||
| 256 | return $self->query('*IDN?'); | ||
| 257 | } | ||
| 258 | |||
| 259 | 1; | ||
| 260 | |||
| 261 | __END__ |