-
Notifications
You must be signed in to change notification settings - Fork 12
/
LS372_agent.py
671 lines (529 loc) · 27.9 KB
/
LS372_agent.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
import os
import random
import argparse
import time
import numpy as np
import txaio
import threading
from contextlib import contextmanager
from socs.Lakeshore.Lakeshore372 import LS372
ON_RTD = os.environ.get('READTHEDOCS') == 'True'
if not ON_RTD:
from ocs import ocs_agent, site_config
from ocs.ocs_twisted import TimeoutLock
class YieldingLock:
"""A lock protected by a lock. This braided arrangement guarantees
that a thread waiting on the lock will get priority over a thread
that has just released the lock and wants to reacquire it.
The typical use case is a Process that wants to hold the lock as
much as possible, but occasionally release the lock (without
sleeping for long) so another thread can access a resource. The
method release_and_acquire() is provided to make this a one-liner.
"""
def __init__(self, default_timeout=None):
self.job = None
self._next = threading.Lock()
self._active = threading.Lock()
self._default_timeout = default_timeout
def acquire(self, timeout=None, job=None):
if timeout is None:
timeout = self._default_timeout
if timeout is None or timeout == 0.:
kw = {'blocking': False}
else:
kw = {'blocking': True, 'timeout': timeout}
result = False
if self._next.acquire(**kw):
if self._active.acquire(**kw):
self.job = job
result = True
self._next.release()
return result
def release(self):
self.job = None
return self._active.release()
def release_and_acquire(self, timeout=None):
job = self.job
self.release()
return self.acquire(timeout=timeout, job=job)
@contextmanager
def acquire_timeout(self, timeout=None, job='unnamed'):
result = self.acquire(timeout=timeout, job=job)
if result:
try:
yield result
finally:
self.release()
else:
yield result
class LS372_Agent:
"""Agent to connect to a single Lakeshore 372 device.
Args:
name (ApplicationSession): ApplicationSession for the Agent.
ip (str): IP Address for the 372 device.
fake_data (bool, optional): generates random numbers without connecting
to LS if True.
dwell_time_delay (int, optional): Amount of time, in seconds, to
delay data collection after switching channels. Note this time
should not include the change pause time, which is automatically
accounted for. Will automatically be reduced to dwell_time - 1
second if it is set longer than a channel's dwell time. This
ensures at least one second of data collection at the end of a scan.
"""
def __init__(self, agent, name, ip, fake_data=False, dwell_time_delay=0):
# self._acq_proc_lock is held for the duration of the acq Process.
# Tasks that require acq to not be running, at all, should use
# this lock.
self._acq_proc_lock = TimeoutLock()
# self._lock is held by the acq Process only when accessing
# the hardware but released occasionally so that (short) Tasks
# may run. Use a YieldingLock to guarantee that a waiting
# Task gets activated preferentially, even if the acq thread
# immediately tries to reacquire.
self._lock = YieldingLock(default_timeout=5)
self.name = name
self.ip = ip
self.fake_data = fake_data
self.dwell_time_delay = dwell_time_delay
self.module = None
self.thermometers = []
self.log = agent.log
self.initialized = False
self.take_data = False
self.agent = agent
# Registers temperature feeds
agg_params = {
'frame_length': 10*60 #[sec]
}
self.agent.register_feed('temperatures',
record=True,
agg_params=agg_params,
buffer_time=1)
def init_lakeshore_task(self, session, params=None):
"""init_lakeshore_task(params=None)
Perform first time setup of the Lakeshore 372 communication.
Args:
params (dict): Parameters dictionary for passing parameters to
task.
Parameters:
auto_acquire (bool, optional): Default is False. Starts data
acquisition after initialization if True.
"""
if params is None:
params = {}
if self.initialized and not params.get('force', False):
self.log.info("Lakeshore already initialized. Returning...")
return True, "Already initialized"
with self._lock.acquire_timeout(job='init') as acquired1, \
self._acq_proc_lock.acquire_timeout(timeout=0., job='init') \
as acquired2:
if not acquired1:
self.log.warn(f"Could not start init because "
f"{self._lock.job} is already running")
return False, "Could not acquire lock"
if not acquired2:
self.log.warn(f"Could not start init because "
f"{self._acq_proc_lock.job} is already running")
return False, "Could not acquire lock"
session.set_status('running')
if self.fake_data:
self.res = random.randrange(1, 1000)
session.add_message("No initialization since faking data")
self.thermometers = ["thermA", "thermB"]
else:
self.module = LS372(self.ip)
print("Initialized Lakeshore module: {!s}".format(self.module))
session.add_message("Lakeshore initilized with ID: %s"%self.module.id)
self.thermometers = [channel.name for channel in self.module.channels]
self.initialized = True
# Start data acquisition if requested
if params.get('auto_acquire', False):
self.agent.start('acq')
return True, 'Lakeshore module initialized.'
def start_acq(self, session, params=None):
with self._acq_proc_lock.acquire_timeout(timeout=0, job='acq') \
as acq_acquired, \
self._lock.acquire_timeout(job='acq') as acquired:
if not acq_acquired:
self.log.warn(f"Could not start Process because "
f"{self._acq_proc_lock.job} is already running")
return False, "Could not acquire lock"
if not acquired:
self.log.warn(f"Could not start Process because "
f"{self._lock.job} is holding the lock")
return False, "Could not acquire lock"
session.set_status('running')
self.log.info("Starting data acquisition for {}".format(self.agent.agent_address))
previous_channel = None
last_release = time.time()
self.take_data = True
while self.take_data:
# Relinquish sampling lock occasionally.
if time.time() - last_release > 1.:
last_release = time.time()
if not self._lock.release_and_acquire(timeout=10):
self.log.warn(f"Failed to re-acquire sampling lock, "
f"currently held by {self._lock.job}.")
continue
if self.fake_data:
data = {
'timestamp': time.time(),
'block_name': 'fake-data',
'data': {}
}
for therm in self.thermometers:
reading = np.random.normal(self.res, 20)
data['data'][therm] = reading
time.sleep(.1)
else:
active_channel = self.module.get_active_channel()
# The 372 reports the last updated measurement repeatedly
# during the "pause change time", this results in several
# stale datapoints being recorded. To get around this we
# query the pause time and skip data collection during it
# if the channel has changed (as it would if autoscan is
# enabled.)
if previous_channel != active_channel:
if previous_channel is not None:
pause_time = active_channel.get_pause()
self.log.debug("Pause time for {c}: {p}",
c=active_channel.channel_num,
p=pause_time)
dwell_time = active_channel.get_dwell()
self.log.debug("User set dwell_time_delay: {p}",
p=self.dwell_time_delay)
# Check user set dwell time isn't too long
if self.dwell_time_delay > dwell_time:
self.log.warn("WARNING: User set dwell_time_delay of " + \
"{delay} s is larger than channel " + \
"dwell time of {chan_time} s. If " + \
"you are autoscanning this will " + \
"cause no data to be collected. " + \
"Reducing dwell time delay to {s} s.",
delay=self.dwell_time_delay,
chan_time=dwell_time,
s=dwell_time - 1)
total_time = pause_time + dwell_time - 1
else:
total_time = pause_time + self.dwell_time_delay
for i in range(total_time):
self.log.debug("Sleeping for {t} more seconds...",
t=total_time-i)
time.sleep(1)
# Track the last channel we measured
previous_channel = self.module.get_active_channel()
data = {
'timestamp': time.time(),
'block_name': active_channel.name,
'data': {}
}
# Collect both temperature and resistance values from each Channel
data['data'][active_channel.name + ' T'] = \
self.module.get_temp(unit='kelvin', chan=active_channel.channel_num)
data['data'][active_channel.name + ' R'] = \
self.module.get_temp(unit='ohms', chan=active_channel.channel_num)
session.app.publish_to_feed('temperatures', data)
return True, 'Acquisition exited cleanly.'
def stop_acq(self, session, params=None):
"""
Stops acq process.
"""
if self.take_data:
self.take_data = False
return True, 'requested to stop taking data.'
else:
return False, 'acq is not currently running'
def set_heater_range(self, session, params):
"""
Adjust the heater range for servoing cryostat. Wait for a specified
amount of time after the change.
:param params: dict with 'range', 'wait' keys
:type params: dict
range - the heater range value to change to
wait - time in seconds after changing the heater value to wait, allows
the servo to adjust to the new heater range, typical value of
~600 seconds
"""
with self._lock.acquire_timeout(job='set_heater_range') as acquired:
if not acquired:
self.log.warn(f"Could not start Task because "
f"{self._lock.job} is already running")
return False, "Could not acquire lock"
session.set_status('running')
heater_string = params.get('heater', 'sample')
if heater_string.lower() == 'sample':
heater = self.module.sample_heater
elif heater_string.lower() == 'still':
heater = self.module.still_heater
current_range = heater.get_heater_range()
if params['range'] == current_range:
print("Current heater range matches commanded value. Proceeding unchanged.")
else:
heater.set_heater_range(params['range'])
time.sleep(params['wait'])
return True, f'Set {heater_string} heater range to {params["range"]}'
def set_excitation_mode(self, session, params):
"""
Set the excitation mode of a specified channel.
:param params: dict with "channel" and "mode" keys for Channel.set_excitation_mode()
:type params: dict
"""
with self._lock.acquire_timeout(job='set_excitation_mode') as acquired:
if not acquired:
self.log.warn(f"Could not start Task because "
f"{self._lock.job} is already running")
return False, "Could not acquire lock"
session.set_status('running')
self.module.channels[params['channel']].set_excitation_mode(params['mode'])
session.add_message(f'post message in agent for Set channel {params["channel"]} excitation mode to {params["mode"]}')
print(f'print statement in agent for Set channel {params["channel"]} excitation mode to {params["mode"]}')
return True, f'return text for Set channel {params["channel"]} excitation mode to {params["mode"]}'
def set_excitation(self, session, params):
"""
Set the excitation voltage/current value of a specified channel.
:param params: dict with "channel" and "value" keys for Channel.set_excitation()
:type params: dict
"""
with self._lock.acquire_timeout(job='set_excitation') as acquired:
if not acquired:
self.log.warn(f"Could not start Task because "
f"{self._lock.job} is already running")
return False, "Could not acquire lock"
session.set_status('running')
current_excitation = self.module.channels[params['channel']].get_excitation()
if params['value'] == current_excitation:
print(f'Channel {params["channel"]} excitation already set to {params["value"]}')
else:
self.module.channels[params['channel']].set_excitation(params['value'])
session.add_message(f'Set channel {params["channel"]} excitation to {params["value"]}')
print(f'Set channel {params["channel"]} excitation to {params["value"]}')
return True, f'Set channel {params["channel"]} excitation to {params["value"]}'
def set_pid(self, session, params):
"""
Set the PID parameters for servo control of fridge.
:param params: dict with "P", "I", and "D" keys for Heater.set_pid()
:type params: dict
"""
with self._lock.acquire_timeout(job='set_pid') as acquired:
if not acquired:
self.log.warn(f"Could not start Task because "
f"{self._lock.job} is already running")
return False, "Could not acquire lock"
session.set_status('running')
self.module.sample_heater.set_pid(params["P"], params["I"], params["D"])
session.add_message(f'post message text for Set PID to {params["P"]}, {params["I"]}, {params["D"]}')
print(f'print text for Set PID to {params["P"]}, {params["I"]}, {params["D"]}')
return True, f'return text for Set PID to {params["P"]}, {params["I"]}, {params["D"]}'
def set_active_channel(self, session, params):
"""
Set the active channel on the LS372.
:param params: dict with "channel" number
:type params: dict
"""
with self._lock.acquire_timeout(job='set_active_channel') as acquired:
if not acquired:
self.log.warn(f"Could not start Task because "
f"{self._lock.job} is already running")
return False, "Could not acquire lock"
session.set_status('running')
self.module.set_active_channel(params["channel"])
session.add_message(f'post message text for set channel to {params["channel"]}')
print(f'print text for set channel to {params["channel"]}')
return True, f'return text for set channel to {params["channel"]}'
def set_autoscan(self, session, params):
"""
Sets autoscan on the LS372.
:param params: dict with "autoscan" value
"""
with self._lock.acquire_timeout(job='set_autoscan') as acquired:
if not acquired:
self.log.warn(f"Could not start Task because "
f"{self._lock.job} is already running")
return False, "Could not acquire lock"
session.set_status('running')
if params['autoscan']:
self.module.enable_autoscan()
self.log.info('enabled autoscan')
else:
self.module.disable_autoscan()
self.log.info('disabled autoscan')
return True, 'Set autoscan to {}'.format(params['autoscan'])
def servo_to_temperature(self, session, params):
"""Servo to temperature passed into params.
:param params: dict with "temperature" Heater.set_setpoint() in unites of K
:type params: dict
"""
with self._lock.acquire_timeout(job='servo_to_temperature') as acquired:
if not acquired:
self.log.warn(f"Could not start Task because "
f"{self._lock.job} is already running")
return False, "Could not acquire lock"
session.set_status('running')
# Check we're in correct control mode for servo.
if self.module.sample_heater.mode != 'Closed Loop':
session.add_message(f'Changing control to Closed Loop mode for servo.')
self.module.sample_heater.set_mode("Closed Loop")
# Check we aren't autoscanning.
if self.module.get_autoscan() is True:
session.add_message(f'Autoscan is enabled, disabling for PID control on dedicated channel.')
self.module.disable_autoscan()
# Check we're scanning same channel expected by heater for control.
if self.module.get_active_channel().channel_num != int(self.module.sample_heater.input):
session.add_message(f'Changing active channel to expected heater control input')
self.module.set_active_channel(int(self.module.sample_heater.input))
# Check we're setup to take correct units.
if self.module.get_active_channel().units != 'kelvin':
session.add_message(f'Setting preferred units to Kelvin on heater control input.')
self.module.get_active_channel().set_units('kelvin')
# Make sure we aren't servoing too high in temperature.
if params["temperature"] > 1:
return False, f'Servo temperature is set above 1K. Aborting.'
self.module.sample_heater.set_setpoint(params["temperature"])
return True, f'Setpoint now set to {params["temperature"]} K'
def check_temperature_stability(self, session, params):
"""Check servo temperature stability is within threshold.
:param params: dict with "measurements" and "threshold" parameters
:type params: dict
measurements - number of measurements to average for stability check
threshold - amount within which the average needs to be to the setpoint for stability
"""
with self._lock.acquire_timeout(job='check_temp_stability') as acquired:
if not acquired:
self.log.warn(f"Could not start Task because "
f"{self._lock.job} is already running")
return False, "Could not acquire lock"
session.set_status('running')
setpoint = float(self.module.sample_heater.get_setpoint())
if params is None:
params = {'measurements': 10, 'threshold': 0.5e-3}
test_temps = []
for i in range(params['measurements']):
test_temps.append(self.module.get_temp())
time.sleep(.1) # sampling rate is 10 readings/sec, so wait 0.1 s for a new reading
mean = np.mean(test_temps)
session.add_message(f'Average of {params["measurements"]} measurements is {mean} K.')
print(f'Average of {params["measurements"]} measurements is {mean} K.')
if np.abs(mean - setpoint) < params['threshold']:
print("passed threshold")
session.add_message(f'Setpoint Difference: ' + str(mean - setpoint))
session.add_message(f'Average is within {params["threshold"]} K threshold. Proceeding with calibration.')
return True, f"Servo temperature is stable within {params['threshold']} K"
else:
print("we're in the else")
#adjust_heater(t,rest)
return False, f"Temperature not stable within {params['threshold']}."
def set_output_mode(self, session, params=None):
"""
Set output mode of the heater.
:param params: dict with "heater" and "mode" parameters
:type params: dict
heater - Specifies which heater to control. Either 'sample' or 'still'
mode - Specifies mode of heater. Can be "Off", "Monitor Out", "Open Loop",
"Zone", "Still", "Closed Loop", or "Warm up"
"""
with self._lock.acquire_timeout(job='set_output_mode') as acquired:
if not acquired:
self.log.warn(f"Could not start Task because "
f"{self._lock.job} is already running")
return False, "Could not acquire lock"
session.set_status('running')
if params['heater'].lower() == 'still':
self.module.still_heater.set_mode(params['mode'])
if params['heater'].lower() == 'sample':
self.module.sample_heater.set_mode(params['mode'])
self.log.info("Set {} output mode to {}".format(params['heater'], params['mode']))
return True, "Set {} output mode to {}".format(params['heater'], params['mode'])
def set_heater_output(self, session, params=None):
"""
Set display type and output of the heater.
:param params: dict with "heater", "display", and "output" parameters
:type params: dict
heater - Specifies which heater to control. Either 'sample' or 'still'
output - Specifies heater output value.
If display is set to "Current" or heater is "still", can be any number between 0 and 100.
If display is set to "Power", can be any number between 0 and the maximum allowed power.
display (opt)- Specifies heater display type. Can be "Current" or "Power".
If None, heater display is not reset before setting output.
"""
with self._lock.acquire_timeout(job='set_heater_output') as acquired:
if not acquired:
self.log.warn(f"Could not start Task because "
f"{self._lock.job} is already running")
return False, "Could not acquire lock"
heater = params['heater'].lower()
output = params['output']
display = params.get('display', None)
if heater == 'still':
self.module.still_heater.set_heater_output(output, display_type=display)
if heater.lower() == 'sample':
self.log.info("display: {}\toutput: {}".format(display, output))
self.module.sample_heater.set_heater_output(output, display_type=display)
self.log.info("Set {} heater display to {}, output to {}".format(heater, display, output))
session.set_status('running')
data = {'timestamp': time.time(),
'block_name': '{}_heater_out'.format(heater),
'data': {'{}_heater_out'.format(heater): output}
}
session.app.publish_to_feed('temperatures', data)
return True, "Set {} display to {}, output to {}".format(heater, display, output)
def make_parser(parser=None):
"""Build the argument parser for the Agent. Allows sphinx to automatically
build documentation based on this function.
"""
if parser is None:
parser = argparse.ArgumentParser()
# Add options specific to this agent.
pgroup = parser.add_argument_group('Agent Options')
pgroup.add_argument('--ip-address')
pgroup.add_argument('--serial-number')
pgroup.add_argument('--mode')
pgroup.add_argument('--fake-data', type=int, default=0,
help='Set non-zero to fake data, without hardware.')
pgroup.add_argument('--dwell-time-delay', type=int, default=0,
help="Amount of time, in seconds, to delay data\
collection after switching channels. Note this\
time should not include the change pause time,\
which is automatically accounted for.\
Will automatically be reduced to dwell_time - 1\
second if it is set longer than a channel's dwell\
time. This ensures at least one second of data\
collection at the end of a scan.")
pgroup.add_argument('--auto-acquire', type=bool, default=True,
help='Automatically start data acquisition on startup')
return parser
if __name__ == '__main__':
# For logging
txaio.use_twisted()
LOG = txaio.make_logger()
# Start logging
txaio.start_logging(level=os.environ.get("LOGLEVEL", "info"))
# Get the default ocs argument parser.
site_parser = site_config.add_arguments()
parser = make_parser(site_parser)
# Parse comand line.
args = parser.parse_args()
# Automatically acquire data if requested (default)
init_params = False
if args.auto_acquire:
init_params = {'auto_acquire': True}
# Interpret options in the context of site_config.
site_config.reparse_args(args, 'Lakeshore372Agent')
print('I am in charge of device with serial number: %s' % args.serial_number)
agent, runner = ocs_agent.init_site_agent(args)
lake_agent = LS372_Agent(agent, args.serial_number, args.ip_address,
fake_data=args.fake_data,
dwell_time_delay=args.dwell_time_delay)
agent.register_task('init_lakeshore', lake_agent.init_lakeshore_task,
startup=init_params)
agent.register_task('set_heater_range', lake_agent.set_heater_range)
agent.register_task('set_excitation_mode', lake_agent.set_excitation_mode)
agent.register_task('set_excitation', lake_agent.set_excitation)
agent.register_task('set_pid', lake_agent.set_pid)
agent.register_task('set_autoscan', lake_agent.set_autoscan)
agent.register_task('set_active_channel', lake_agent.set_active_channel)
agent.register_task('servo_to_temperature', lake_agent.servo_to_temperature)
agent.register_task('check_temperature_stability', lake_agent.check_temperature_stability)
agent.register_task('set_output_mode', lake_agent.set_output_mode)
agent.register_task('set_heater_output', lake_agent.set_heater_output)
agent.register_process('acq', lake_agent.start_acq, lake_agent.stop_acq)
runner.run(agent, auto_reconnect=True)