-
Notifications
You must be signed in to change notification settings - Fork 4
/
PyAttoDRY.py
1113 lines (876 loc) · 33.3 KB
/
PyAttoDRY.py
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
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# This is a Python script for direct control of the AttoDRY2100 cryostat.
# It depends on the .dll files provided by Attocube (AttoDRYLib.dll) which
# has to be referred to in the dll_directory variable. Not all functions
# are implemented in the given code, since control is still maintained with
# the attoDRY labview interface. All additional function names are found in the dll_list.txt
# file.
# You need to install the 2016 labview runtime engine. Additinally, the
# script will only work with a 32 bit python version.
#
# AttoDRY2100lib.py and PyAttoDRY2100.py are written by
# Christoph Murer
# Magnetism and interface Physics, ETH Zurich
# christoph.murer@mat.ethz.ch or chmurer@gmail.com
# script started on 04-Sep-2020
# inspired by the ANC350 scrips written by Rob Heath and Brian Schaefer (https://github.com/Laukei/pyanc350)
import AttoDRYlib as ADRY
# other import items:
import os
import ctypes
# look at the header file to find the structure of a given function. This is just the implementation
# of temperature and field control without any further functionalities. All function descriptions are
# copied from the header files.
class AttoDRY:
def __init__(self):
self.begin()
def begin(setup_version=1):
"""
Starts the server that communicates with the attoDRY and loads the software
for the device specified by <B> Device </B>. This VI needs to be run before
commands can be sent or received. The <B>UI Queue</B> is an event queue for
updating the GUI. It should not be used when calling the function from a
DLL.
Setup versions:
0: attoDRY1100
1: attoDRY2100
2: attoDRY800
"""
c = ctypes.c_uint16(setup_version)
ADRY.begin(c.value)
def Connect(COMPort='COM4'):
"""
Connects to the attoDRY using the specified COM Port
"""
COMPort = COMPort.encode('utf-8')
ADRY.Connect(ctypes.c_char_p(COMPort).value)
"""
def Main():
#AttoDRY_Interface_Main
ADRY.Main()
"""
def Disconnect():
"""
Disconnects from the attoDRY, if already connected. This should be run
before the <B>end.vi</B>
"""
ADRY.Disconnect()
def end():
"""
Stops the server that is communicating with the attoDRY. The
<B>Disconnect.vi</B> should be run before this. This VI should be run
before closing your program.
"""
ADRY.end()
def Cancel():
"""
Sends a 'Cancel' Command to the attoDRY. Use this when you want to cancel
an action or respond negatively to a pop up.
"""
ADRY.Cancel()
def Confirm():
"""
Sends a 'Confirm' command to the attoDRY. Use this when you want to respond
positively to a pop up.
"""
ADRY.Confirm()
def getActionMessage(length=500):
"""
Gets the current action message. If an action is being performed, it will
be shown here. It is similar to the pop ups on the display.
"""
ActionMessage = ctypes.create_string_buffer(length)
l = ctypes.c_int(length)
ADRY.getAttodryErrorMessage(ctypes.byref(ActionMessage), l)
return ActionMessage.value.decode('utf-8')
def getAttodryErrorMessage(length=500):
"""
Returns the current error message with length 500; Change that if characters are missing
Too long should not be a problem(?)
"""
ErrorStatus = ctypes.create_string_buffer(length)
l = ctypes.c_int(length)
ADRY.getAttodryErrorMessage(ctypes.byref(ErrorStatus), l)
return ErrorStatus.value.decode('utf-8')
def getAttodryErrorStatus():
"""
Returns the current error code
"""
ErrorCode = ctypes.c_int()
ADRY.getAttodryErrorStatus(ctypes.byref(ErrorCode))
return ErrorCode.value
def isControllingField():
"""
Returns 'True' if magnetic filed control is active. This is true when the
magnetic field control icon on the touch screen is orange, and false when
the icon is white.
"""
ControllingField = ctypes.c_int()
ADRY.isControllingField(ctypes.byref(ControllingField))
return ControllingField.value
def isControllingTemperature():
"""
Returns 'True' if temperature control is active. This is true when the
temperature control icon on the touch screen is orange, and false when the
icon is white.
"""
ControllingTemperature = ctypes.c_int()
ADRY.isControllingTemperature(ctypes.byref(ControllingTemperature))
return ControllingTemperature.value
def isPersistentModeSet():
"""
Checks to see if persistant mode is set for the magnet. Note: this shows if
persistant mode is set, it does not show if the persistant switch heater is
on. The heater may be on during persistant mode when, for example, changing
the field.
"""
PersistentMode = ctypes.c_int()
ADRY.isPersistentModeSet(ctypes.byref(PersistentMode))
return PersistentMode.value
def isDeviceInitialised():
"""
Checks to see if the attoDRY has initialised. Use this VI after you have
connected and before sending any commands or getting any data from the
attoDRY
"""
DeviceInitialised = ctypes.c_int()
ADRY.isDeviceInitialised(ctypes.byref(DeviceInitialised))
return DeviceInitialised.value
def isDeviceConnected():
"""
Checks to see if the attoDRY is connected. Returns True if connected.
"""
DeviceConnected = ctypes.c_int()
ADRY.isDeviceConnected(ctypes.byref(DeviceConnected))
return DeviceConnected.value
def toggleMagneticFieldControl():
"""
Toggles persistant mode for magnet control. If it is enabled, the switch
heater will be turned off once the desired field is reached. If it is not,
the switch heater will be left on.
"""
ADRY.toggleMagneticFieldControl()
def togglePersistentMode():
"""
Starts and stops the pump. If the pump is running, it will stop it. If the
pump is not running, it will be started.
"""
ADRY.togglePersistentMode()
def toggleSampleTemperatureControl():
"""
This command only toggles the sample temperature controller. It does not
pump the volumes etc. Use <B>toggleFullTemperatureControl.vi</B> for
behaviour like the temperature control icon on the touch screen.
"""
ADRY.toggleSampleTemperatureControl()
def toggleFullTemperatureControl():
"""
This command only toggles the sample temperature controller. It does not
pump the volumes etc. Use <B>toggleFullTemperatureControl.vi</B> for
behaviour like the temperature control icon on the touch screen.
"""
ADRY.toggleFullTemperatureControl()
def goToBaseTemperature():
"""
Initiates the "Base Temperature" command, as on the touch screen
"""
ADRY.goToBaseTemperature()
def get4KStageTemperature():
"""
Gets the current magnetic fiel
"""
StageTemperature = ctypes.c_float()
ADRY.get4KStageTemperature(ctypes.byref(StageTemperature))
return StageTemperature.value
def getMagneticField():
"""
Gets the current magnetic fiel
"""
MagneticField = ctypes.c_float()
ADRY.getMagneticField(ctypes.byref(MagneticField))
return MagneticField.value
def getMagneticFieldSetPoint():
"""
Gets the current magnetic field set point
"""
MagneticField = ctypes.c_float()
ADRY.getMagneticFieldSetPoint(ctypes.byref(MagneticField))
return MagneticField.value
def getSampleTemperature():
"""
Gets the sample temperature in Kelvin. This value is updated whenever a
status message is received from the attoDRY.
"""
Temperature = ctypes.c_float()
ADRY.getSampleTemperature(ctypes.byref(Temperature))
return Temperature.value
def getUserTemperature():
"""
Gets the user set point temperature, in Kelvin. This value is updated
whenever a status message is received from the attoDRY.
"""
Temperature = ctypes.c_float()
ADRY.getUserTemperature(ctypes.byref(Temperature))
return Temperature.value
def setUserMagneticField(MagneticField):
"""
Sets the user magntic field. This is used as the set point when field
control is active
"""
ADRY.setUserMagneticField(ctypes.c_float(MagneticField))
def setUserTemperature(Temperature):
"""
Sets the user temperature. This is the temperature used when temperature
control is enabled.
"""
ADRY.setUserTemperature(ctypes.c_float(Temperature))
##################################################################################
##### Functions below this line were not tested!
##### TODO: test the following functions
##################################################################################
def downloadSampleTemperatureSensorCalibrationCurve(savepath):
"""
Starts the download of the <B>Sample Temperature Sensor Calibration
Curve</B>. The curve will be saved to <B>Save Path</B>
"""
Savepath = savepath.encode('utf-8')
ADRY.downloadSampleTemperatureSensorCalibrationCurve(ctypes.c_char_p(Savepath).value)
def downloadTemperatureSensorCalibrationCurve(UserCurveNumber,savepath):
"""
Starts the download of the Temperature Sensor Calibration Curve at <b>User
Curve Number</B> on the temperature monitor. The curve will be saved to
<B>Path</B>
"""
Savepath = savepath.encode('utf-8')
ADRY.downloadTemperatureSensorCalibrationCurve(ctypes.c_int(UserCurveNumber),ctypes.c_char_p(Savepath).value)
def getDerivativeGain():
"""
Gets the Derivative gain. The gain retrieved depends on which heater is
active:
- If no heaters are on or the sample heater is on, the <B>Sample Heater</B>
gain is returned
- If the VTI heater is on and a sample temperature sensor is connected, the
<B>VTI Heater</B> gain is returned
- If the VTI heater is on and no sample temperature sensor is connected,
the <B>Exchange Heater</B> gain is returned
"""
DerivativeGain = ctypes.c_float()
ADRY.getDerivativeGain(ctypes.byref(DerivativeGain))
return DerivativeGain.value
def getIntegralGain():
"""
Gets the Integral gain. The gain retrieved depends on which heater is
active:
- If no heaters are on or the sample heater is on, the <B>Sample Heater</B>
gain is returned
- If the VTI heater is on and a sample temperature sensor is connected, the
<B>VTI Heater</B> gain is returned
- If the VTI heater is on and no sample temperature sensor is connected,
the <B>Exchange Heater</B> gain is returned
"""
IntegralGain = ctypes.c_float()
ADRY.getIntegralGain(ctypes.byref(IntegralGain))
return IntegralGain.value
def getProportionalGain():
"""
Gets the Proportional gain. The gain retrieved depends on which heater is
active:
- If no heaters are on or the sample heater is on, the <B>Sample Heater</B>
gain is returned
- If the VTI heater is on and a sample temperature sensor is connected, the
<B>VTI Heater</B> gain is returned
- If the VTI heater is on and no sample temperature sensor is connected,
the <B>Exchange Heater</B> gain is returned
"""
ProportionalGain = ctypes.c_float()
ADRY.getProportionalGain(ctypes.byref(ProportionalGain))
return ProportionalGain.value
def getSampleHeaterMaximumPower():
"""
Gets the maximum power limit of the sample heater in Watts. This value, is
the one stored in memory on the computer, not the one on the attoDRY. You
should first use the appropriate <B>query VI</B> to request the value from
the attoDRY.
The output power of the heater will not exceed this value. It is stored in
non-volatile memory, this means that the value will not be lost, even if
the attoDRY is turned off.
"""
SampleHeaterMaximumPower = ctypes.c_float()
ADRY.getSampleHeaterMaximumPower(ctypes.byref(SampleHeaterMaximumPower))
return SampleHeaterMaximumPower.value
def getSampleHeaterPower():
"""
Gets the current Sample Heater power, in Watts
"""
SampleHeaterPower = ctypes.c_float()
ADRY.getSampleHeaterPower(ctypes.byref(SampleHeaterPower))
return SampleHeaterPower.value
def getSampleHeaterResistance():
"""
Gets the resistance of the sample heater in Ohms. This value, is the one
stored in memory on the computer, not the one on the attoDRY. You should
first use the appropriate <B>query VI</B> to request the value from the
attoDRY.
This value, along with the heater wire resistance, is used in calculating
the output power of the heater. It is stored in non-volatile memory, this
means that the value will not be lost, even if the attoDRY is turned off.
Power = Voltage^2/((HeaterResistance + WireResistance)^2) *
HeaterResistance
"""
SampleHeaterResistance = ctypes.c_float()
ADRY.getSampleHeaterResistance(ctypes.byref(SampleHeaterResistance))
return SampleHeaterResistance.value
def getSampleHeaterWireResistance():
"""
Gets the resistance of the sample heater wires in Ohms. This value, is the
one stored in memory on the computer, not the one on the attoDRY. You
should first use the appropriate <B>query VI</B> to request the value from
the attoDRY.
This value, along with the heater resistance, is used in calculating the
output power of the heater. It is stored in non-volatile memory, this means
that the value will not be lost, even if the attoDRY is turned off.
Power = Voltage^2/((HeaterResistance + WireResistance)^2) *
HeaterResistance
"""
SampleHeaterWireResistance = ctypes.c_float()
ADRY.getSampleHeaterWireResistance(ctypes.byref(SampleHeaterWireResistance))
return SampleHeaterWireResistance.value
def getVtiHeaterPower():
"""
Returns the VTI Heater power, in Watts
"""
VtiHeaterPower = ctypes.c_float()
ADRY.getVtiHeaterPower(ctypes.byref(VtiHeaterPower))
return VtiHeaterPower.value
def getVtiTemperature():
"""
Returns the temperature of the VTI
"""
VtiTemperature = ctypes.c_float()
ADRY.getVtiTemperature(ctypes.byref(VtiTemperature))
return VtiTemperature.value
def isGoingToBaseTemperature():
"""
Returns 'True' if the base temperature process is active. This is true when
the base temperature button on the touch screen is orange, and false when
the button is white.
"""
GoingToBaseTemperature = ctypes.c_int()
ADRY.isGoingToBaseTemperature(ctypes.byref(GoingToBaseTemperature))
return GoingToBaseTemperature.value
def isPumping():
"""
Returns true if the pump is running
"""
Pumping = ctypes.c_int()
ADRY.isPumping(ctypes.byref(Pumping))
return Pumping.value
def isSampleExchangeInProgress():
"""
Returns 'True' if the sample exchange process is active. This is true when
the sample exchange button on the touch screen is orange, and false when
the button is white.
"""
SampleExchangeInProgress = ctypes.c_int()
ADRY.isSampleExchangeInProgress(ctypes.byref(SampleExchangeInProgress))
return SampleExchangeInProgress.value
def isSampleHeaterOn():
"""
Checks to see if the sample heater is on. 'On' is defined as PID control is
active or a contant heater power is set.
"""
SampleHeaterOn = ctypes.c_int()
ADRY.isSampleHeaterOn(ctypes.byref(SampleHeaterOn))
return SampleHeaterOn.value
def isSampleReadyToExchange():
"""
This will return true when the sample stick is ready to be removed or
inserted.
"""
SampleReadyToExchange = ctypes.c_int()
ADRY.isSampleReadyToExchange(ctypes.byref(SampleReadyToExchange))
return SampleReadyToExchange.value
def isSystemRunning():
"""
This will return true when the sample stick is ready to be removed or
inserted.
"""
SystemRunning = ctypes.c_int()
ADRY.isSystemRunning(ctypes.byref(SystemRunning))
return SystemRunning.value
def isZeroingField():
"""
This will return true when the sample stick is ready to be removed or
inserted.
"""
ZeroingField = ctypes.c_int()
ADRY.isZeroingField(ctypes.byref(ZeroingField))
return ZeroingField.value
def lowerError():
"""
Lowers any raised errors
"""
ADRY.lowerError()
def querySampleHeaterMaximumPower():
"""
Requests the maximum power limit of the sample heater in Watts from the
attoDRY. After running this command, use the appropriate <B>get VI</B> to
get the value stored on the computer.
The output power of the heater will not exceed this value. It is stored in
non-volatile memory, this means that the value will not be lost, even if
the attoDRY is turned off.
"""
ADRY.querySampleHeaterMaximumPower()
def querySampleHeaterResistance():
"""
Requests the resistance of the sample heater in Ohms from the attoDRY.
After running this command, use the appropriate <B>get VI</B> to get the
value stored on the computer.
This value, along with the heater wire resistance, is used in calculating
the output power of the heater. It is stored in non-volatile memory, this
means that the value will not be lost, even if the attoDRY is turned off.
Power = Voltage^2/((HeaterResistance + WireResistance)^2) *
HeaterResistance
"""
ADRY.querySampleHeaterResistance()
def querySampleHeaterWireResistance():
"""
Requests the resistance of the sample wires heater in Ohms from the
attoDRY. After running this command, use the appropriate <B>get VI</B> to
get the value stored on the computer.
This value, along with the heater resistance, is used in calculating the
output power of the heater. It is stored in non-volatile memory, this means
that the value will not be lost, even if the attoDRY is turned off.
Power = Voltage^2/((HeaterResistance + WireResistance)^2) *
HeaterResistance
"""
ADRY.querySampleHeaterWireResistance()
def setDerivativeGain(DerivativeGain):
"""
Sets the Derivative gain. The controller that is updated depends on which
heater is active:
- If no heaters are on or the sample heater is on, the <B>Sample Heater</B>
gain is set
- If the VTI heater is on and a sample temperature sensor is connected, the
<B>VTI Heater</B> gain is set
- If the VTI heater is on and no sample temperature sensor is connected,
the <B>Exchange Heater</B> gain is set
"""
ADRY.setDerivativeGain(ctypes.c_float(DerivativeGain))
def setIntegralGain(IntegralGain):
"""
Sets the Integral gain. The controller that is updated depends on which
heater is active:
- If no heaters are on or the sample heater is on, the <B>Sample Heater</B>
gain is set
- If the VTI heater is on and a sample temperature sensor is connected, the
<B>VTI Heater</B> gain is set
- If the VTI heater is on and no sample temperature sensor is connected,
the <B>Exchange Heater</B> gain is set
"""
ADRY.setIntegralGain(ctypes.c_float(IntegralGain))
def setProportionalGain(ProportionalGain):
"""
Sets the Proportional gain. The controller that is updated depends on which
heater is active:
- If no heaters are on or the sample heater is on, the <B>Sample Heater</B>
gain is set
- If the VTI heater is on and a sample temperature sensor is connected, the
<B>VTI Heater</B> gain is set
- If the VTI heater is on and no sample temperature sensor is connected,
the <B>Exchange Heater</B> gain is set
"""
ADRY.setProportionalGain(ctypes.c_float(ProportionalGain))
def setSampleHeaterMaximumPower(MaximumPower):
"""
Sets the maximum power limit of the sample heater in Watts. After running
this command, use the appropriate <B>request</B> and <B>get</B> VIs to
check the value was stored on the attoDRY.
The output power of the heater will not exceed this value.
It is stored in non-volatile memory, this means that the value will not be
lost, even if the attoDRY is turned off. Note: the non-volatile memory has
a specified life of 100,000 write/erase cycles, so you may need to be
careful about how often you set this value.
"""
ADRY.setSampleHeaterMaximumPower(ctypes.c_float(MaximumPower))
def setSampleHeaterWireResistance(WireResistance):
"""
Sets the resistance of the sample heater wires in Ohms. After running this
command, use the appropriate <B>request</B> and <B>get</B> VIs to check the
value was stored on the attoDRY.
This value, along with the heater resistance, is used in calculating the
output power of the heater. It is stored in non-volatile memory, this means
that the value will not be lost, even if the attoDRY is turned off.
Power = Voltage^2/((HeaterResistance + WireResistance)^2) *
HeaterResistance
It is stored in non-volatile memory, this means that the value will not be
lost, even if the attoDRY is turned off. Note: the non-volatile memory has
a specified life of 100,000 write/erase cycles, so you may need to be
careful about how often you set this value.
"""
ADRY.setSampleHeaterWireResistance(ctypes.c_float(WireResistance))
def setSampleHeaterPower(HeaterPowerW):
"""
Sets the sample heater value to the specified value
"""
ADRY.setSampleHeaterPower(ctypes.c_float(HeaterPowerW))
def setSampleHeaterResistance(HeaterResistance):
"""
Sets the resistance of the sample heater in Ohms. After running this
command, use the appropriate <B>request</B> and <B>get</B> VIs to check the
value was stored on the attoDRY.
This value, along with the heater wire resistance, is used in calculating
the output power of the heater. It is stored in non-volatile memory, this
means that the value will not be lost, even if the attoDRY is turned off.
Power = Voltage^2/((HeaterResistance + WireResistance)^2) *
HeaterResistance
It is stored in non-volatile memory, this means that the value will not be
lost, even if the attoDRY is turned off. Note: the non-volatile memory has
a specified life of 100,000 write/erase cycles, so you may need to be
careful about how often you set this value.
"""
ADRY.setSampleHeaterResistance(ctypes.c_float(HeaterResistance))
def startLogging(savepath,TimeSelection,Append):
"""
Starts logging data to the file specifed by <B>Path</B>.
If the file does not exist, it will be created.
The TimeSelection is given as
#define Enum__1Second 0
#define Enum__5Seconds 1
#define Enum__30Seconds 2
#define Enum__1Minute 3
#define Enum__5Minutes 4
"""
Savepath = savepath.encode('utf-8')
ADRY.startLogging(ctypes.c_char_p(Savepath).value,ctypes.c_int(TimeSelection).value,ctypes.c_int(Append).value)
def startSampleExchange():
"""
Starts the sample exchange procedure
"""
ADRY.startSampleExchange()
def stopLogging():
"""
Stops logging data
"""
ADRY.stopLogging()
def sweepFieldToZero():
"""
Initiates the "Zero Field" command, as on the touch screen
"""
ADRY.sweepFieldToZero()
def togglePump():
"""
Starts and stops the pump. If the pump is running, it will stop it. If the
pump is not running, it will be started.
"""
ADRY.togglePump()
def toggleStartUpShutdown():
"""
Toggles the start up/shutdown procedure. If the attoDRY is started up, the
shut down procedure will be run and vice versa
"""
ADRY.toggleStartUpShutdown()
def uploadSampleTemperatureCalibrationCurve(loadpath):
"""
Starts the upload of a <B>.crv calibration curve file</B> to the <B>sample
temperature sensor</B>
"""
Loadpath = loadpath.encode('utf-8')
ADRY.uploadSampleTemperatureCalibrationCurve(ctypes.c_char_p(Loadpath).value)
def uploadTemperatureCalibrationCurve(loadpath,UserCurveNumber):
"""
Starts the upload of a <B>.crv calibration curve file</B> to the specified
<B>User Curve Number</B> on the temperature monitor. Use a curve number of
1 to 8, inclusive
"""
Loadpath = loadpath.encode('utf-8')
ADRY.uploadTemperatureCalibrationCurve(ctypes.c_int(UserCurveNumber).value,ctypes.c_char_p(Loadpath).value)
def setVTIHeaterPower(VTIHeaterPowerW):
"""
AttoDRY_Interface_setVTIHeaterPower
"""
ADRY.setVTIHeaterPower(ctypes.c_float(VTIHeaterPowerW))
def queryReservoirTsetColdSample():
"""
AttoDRY_Interface_queryReservoirTsetColdSample
"""
ADRY.queryReservoirTsetColdSample()
def getReservoirTsetColdSample():
"""
AttoDRY_Interface_getReservoirTsetColdSample
"""
ReservoirTsetColdSampleK = ctypes.c_float()
ADRY.getReservoirTsetColdSample(ctypes.byref(ReservoirTsetColdSampleK))
return ReservoirTsetColdSampleK.value
def setReservoirTsetWarmMagnet(ReservoirTsetWarmMagnetW):
"""
AttoDRY_Interface_setReservoirTsetWarmMagnet
"""
ADRY.setReservoirTsetWarmMagnet(ctypes.c_float(ReservoirTsetWarmMagnetW))
def setReservoirTsetColdSample(SetReservoirTsetColdSampleK):
"""
AttoDRY_Interface_setReservoirTsetColdSample
"""
ADRY.setReservoirTsetColdSample(ctypes.c_float(SetReservoirTsetColdSampleK))
def setReservoirTsetWarmSample(ReservoirTsetWarmSampleW):
"""
AttoDRY_Interface_setReservoirTsetWarmSample
"""
ADRY.setReservoirTsetWarmSample(ctypes.c_float(ReservoirTsetWarmSampleW))
def queryReservoirTsetWarmSample():
"""
AttoDRY_Interface_queryReservoirTsetWarmSample
"""
ADRY.queryReservoirTsetWarmSample()
def queryReservoirTsetWarmMagnet():
"""
AttoDRY_Interface_queryReservoirTsetWarmMagnet
"""
ADRY.queryReservoirTsetWarmMagnet()
def getReservoirTsetWarmSample():
"""
AttoDRY_Interface_getReservoirTsetWarmSample
"""
ReservoirTsetWarmSampleK = ctypes.c_float()
ADRY.getReservoirTsetWarmSample(ctypes.byref(ReservoirTsetWarmSampleK))
return ReservoirTsetWarmSampleK.value
def getReservoirTsetWarmMagnet():
"""
AttoDRY_Interface_getReservoirTsetWarmMagnet
"""
ReservoirTsetWarmMagnetK = ctypes.c_float()
ADRY.getReservoirTsetWarmMagnet(ctypes.byref(ReservoirTsetWarmMagnetK))
return ReservoirTsetWarmMagnetK.value
def getCryostatInPressure():
"""
ATTODRY2100 ONLY. Gets the pressure at the Cryostat Inlet
"""
CryostatInPressureMbar = ctypes.c_float()
ADRY.getCryostatInPressure(ctypes.byref(CryostatInPressureMbar))
return CryostatInPressureMbar.value
def getCryostatInValve():
"""
ATTODRY2100 ONLY. Gets the current status of the Cryostat In valve.
"""
valveStatus = ctypes.c_int()
ADRY.getCryostatInValve(ctypes.byref(valveStatus))
return valveStatus.value
def getCryostatOutPressure():
"""
Gets the Cryostat Outlet pressure
"""
CryostatOutPressureMbar = ctypes.c_float()
ADRY.getCryostatOutPressure(ctypes.byref(CryostatOutPressureMbar))
return CryostatOutPressureMbar.value
def getCryostatOutValve():
"""
ATTODRY2100 ONLY. Gets the current status of the Cryostat Out valve.
"""
valveStatus = ctypes.c_int()
ADRY.getCryostatOutValve(ctypes.byref(valveStatus))
return valveStatus.value
def getDumpInValve():
"""
ATTODRY2100 ONLY. Gets the current status of the Dump In volume valve.
"""
valveStatus = ctypes.c_int()
ADRY.getDumpInValve(ctypes.byref(valveStatus))
return valveStatus.value
def getDumpOutValve():
"""
ATTODRY2100 ONLY. Gets the current status of the outer volume valve.
"""
valveStatus = ctypes.c_int()
ADRY.getDumpOutValve(ctypes.byref(valveStatus))
return valveStatus.value
def getDumpPressure():
"""
ATTODRY2100 ONLY. Gets the pressure at the Dump
"""
DumpPressureMbar = ctypes.c_float()
ADRY.getDumpPressure(ctypes.byref(DumpPressureMbar))
return DumpPressureMbar.value
def getReservoirHeaterPower():
"""
ATTODRY2100 ONLY. Gets the pressure at the Dump
"""
ReservoirHeaterPowerW = ctypes.c_float()
ADRY.getReservoirHeaterPower(ctypes.byref(ReservoirHeaterPowerW))
return ReservoirHeaterPowerW.value
def getReservoirTemperature():
"""
ATTODRY2100 ONLY. Gets the pressure at the Dump
"""
ReservoirTemperatureK = ctypes.c_float()
ADRY.getReservoirTemperature(ctypes.byref(ReservoirTemperatureK))
return ReservoirTemperatureK.value
def toggleCryostatInValve():
"""
ATTODRY2100 ONLY. Toggles the Cryostat In valve. If it is closed, it will
open and if it is open, it will close.
"""
ADRY.toggleCryostatInValve()
def toggleCryostatOutValve():
"""
ATTODRY2100 ONLY. Toggles the Cryostat Out valve. If it is closed, it will
open and if it is open, it will close.
"""
ADRY.toggleCryostatOutValve()
def toggleDumpInValve():
"""
ATTODRY2100 ONLY. Toggles the inner volume valve. If it is closed, it will
open and if it is open, it will close.
"""
ADRY.toggleDumpInValve()
def toggleDumpOutValve():
"""
ATTODRY2100 ONLY. Toggles the outer volume valve. If it is closed, it will
open and if it is open, it will close.
"""
ADRY.toggleDumpOutValve()
def get40KStageTemperature():
"""
ATTODRY1100 ONLY. Gets the current temperature of the 40K Stage, in Kelvin
"""
StageTemperatureK = ctypes.c_float()
ADRY.get40KStageTemperature(ctypes.byref(StageTemperatureK))
return StageTemperatureK.value
def getHeliumValve():
"""
ATTODRY1100 ONLY. Gets the current status of the helium valve. True is
opened, false is closed.
"""
valveStatus = ctypes.c_int()
ADRY.getHeliumValve(ctypes.byref(valveStatus))
return valveStatus.value
def getInnerVolumeValve():
"""
ATTODRY1100 ONLY. Gets the current status of the inner volume valve. True
is opened, false is closed.
"""
valveStatus = ctypes.c_int()
ADRY.getInnerVolumeValve(ctypes.byref(valveStatus))
return valveStatus.value
def getOuterVolumeValve():
"""
ATTODRY1100 ONLY. Gets the current status of the outer volume valve. True
is opened, false is closed.
"""
valveStatus = ctypes.c_int()
ADRY.getOuterVolumeValve(ctypes.byref(valveStatus))
return valveStatus.value
def getPressure():
"""
ATTODRY1100 ONLY. Gets the current presure in the valve junction block, in
mbar.
"""
PressureMbar = ctypes.c_float()
ADRY.getPressure(ctypes.byref(PressureMbar))
return PressureMbar.value
def getPumpValve():
"""
ATTODRY1100 ONLY. Gets the current status of the pump valve. True is
opened, false is closed.
"""
valveStatus = ctypes.c_int()
ADRY.getPumpValve(ctypes.byref(valveStatus))
return valveStatus.value
def getTurbopumpFrequency():
"""
ATTODRY1100 ONLY. Gets the current frequency of the turbopump.
"""
TurbopumpFrequencyHz = ctypes.c_float()
ADRY.getTurbopumpFrequency(ctypes.byref(TurbopumpFrequencyHz))
return TurbopumpFrequencyHz.value
def isExchangeHeaterOn():
"""
Checks to see if the exchange/vti heater is on. 'On' is defined as PID
control is active or a constant heater power is set.
"""
ExchangeHeaterStatus = ctypes.c_int()