-
Notifications
You must be signed in to change notification settings - Fork 5
/
synth_hd.py
699 lines (575 loc) · 20.1 KB
/
synth_hd.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
from .device import SerialDevice
from collections.abc import Sequence
class SynthHDChannel:
def __init__(self, parent, index):
self._parent = parent
self._index = index
model = self._parent.model
if model == 'SynthHD v1.4':
self._f_range = {'start': 53.e6, 'stop': 13999.999999e6, 'step': 0.1}
self._p_range = {'start': -80., 'stop': 20., 'step': 0.01}
self._vga_range = {'start': 0, 'stop': 45000, 'step': 1}
else:
self._f_range = None
self._p_range = None
self._vga_range = None
def init(self):
"""Initialize device."""
self.enable = False
f_range = self.frequency_range
if f_range is not None:
self.frequency = f_range['start']
p_range = self.power_range
if p_range is not None:
self.power = p_range['start']
self.phase = 0.
self.temp_compensation_mode = '10 sec'
def write(self, attribute, *args):
self.select()
self._parent.write(attribute, *args)
def read(self, attribute, *args):
self.select()
return self._parent.read(attribute, *args)
def select(self):
"""Select channel."""
self._parent.write('channel', self._index)
@property
def frequency_range(self):
"""Frequency range in Hz.
Returns:
dict: frequency range or None
"""
return None if self._f_range is None else self._f_range.copy()
@property
def frequency(self):
"""Get frequency in Hz.
Returns:
float: frequency in Hz
"""
return self.read('frequency') * 1e6
@frequency.setter
def frequency(self, value):
"""Set frequency in Hz.
Args:
value (float / int): frequency in Hz
"""
if not isinstance(value, (float, int)):
raise ValueError('Expected float or int.')
f_range = self.frequency_range
if f_range is not None and not f_range['start'] <= value <= f_range['stop']:
raise ValueError('Expected float in range [{}, {}] Hz.'.format(
f_range['start'], f_range['stop']))
self.write('frequency', value / 1e6)
@property
def power_range(self):
"""Power range in dBm.
Returns:
dict: power range or None
"""
return None if self._p_range is None else self._p_range.copy()
@property
def power(self):
"""Get power in dBm.
Returns:
float: power in dBm
"""
return self.read('power')
@power.setter
def power(self, value):
"""Set power in dBm.
Args:
value (float / int): power in dBm
"""
if not isinstance(value, (float, int)):
raise TypeError('Expected float or int.')
self.write('power', value)
@property
def calibrated(self):
"""Calibration was successful on frequency or amplitude change.
Returns:
bool: calibrated
"""
return self.read('calibrated')
@property
def temp_compensation_modes(self):
"""Temperature compensation modes.
Returns:
tuple: tuple of str of modes
"""
return ('none', 'on set', '1 sec', '10 sec')
@property
def temp_compensation_mode(self):
"""Temperature compensation mode.
Returns:
str: mode
"""
return self.temp_compensation_modes[self.read('temp_comp_mode')]
@temp_compensation_mode.setter
def temp_compensation_mode(self, value):
modes = self.temp_compensation_modes
if not value in modes:
raise ValueError('Expected str in set {}.'.format(modes))
self.write('temp_comp_mode', modes.index(value))
@property
def vga_dac_range(self):
"""VGA DAC value range.
Returns:
dict: VGA DAC range or None
"""
return None if self._vga_range is None else self._vga_range.copy()
@property
def vga_dac(self):
"""Get raw VGA DAC value
Returns:
int: value
"""
return self.read('vga_dac')
@vga_dac.setter
def vga_dac(self, value):
"""Set raw VGA DAC value.
Args:
value (int): value
"""
if not isinstance(value, int):
raise TypeError('Expected int.')
self.write('vga_dac', value)
@property
def phase_range(self):
"""Phase step range.
Returns:
dict: range
"""
return {
'start': 0.,
'stop': 360.,
'step': .001,
}
@property
def phase(self):
"""Get phase step value.
Returns:
float: value in degrees
"""
return self.read('phase_step')
@phase.setter
def phase(self, value):
"""Set phase step value.
Args:
value (float / int): phase in degrees
"""
if not isinstance(value, (float, int)):
raise TypeError('Expected float or int.')
self.write('phase_step', value)
@property
def rf_enable(self):
"""RF output enable.
Returns:
bool: enable
"""
return self.read('rf_enable')
@rf_enable.setter
def rf_enable(self, value):
if not isinstance(value, bool):
raise ValueError('Expected bool.')
self.write('rf_enable', value)
@property
def pa_enable(self):
"""PA enable.
Returns:
bool: enable
"""
return self.read('pa_power_on')
@pa_enable.setter
def pa_enable(self, value):
if not isinstance(value, bool):
raise ValueError('Expected bool.')
self.write('pa_power_on', value)
@property
def pll_enable(self):
"""PLL enable.
Returns:
bool: enable
"""
return self.read('pll_power_on')
@pll_enable.setter
def pll_enable(self, value):
if not isinstance(value, bool):
raise ValueError('Expected bool.')
self.write('pll_power_on', value)
@property
def enable(self):
"""Get output enable.
Returns:
bool: enabled
"""
return self.rf_enable and self.pll_enable and self.pa_enable
@enable.setter
def enable(self, value):
"""Set output enable.
Args:
value (bool): enable
"""
if not isinstance(value, bool):
raise TypeError('Expected bool.')
self.rf_enable = value
self.pll_enable = value
self.pa_enable = value
@property
def lock_status(self):
"""PLL lock status.
Returns:
bool: locked
"""
return self.read('pll_lock')
class SynthHDv2Channel(SynthHDChannel):
def __init__(self, parent, index):
self._parent = parent
self._index = index
model = self._parent.model
if model == 'SynthHD v2':
self._f_range = {'start': 10.e6, 'stop': 15000.e6, 'step': 0.1}
self._p_range = {'start': -70., 'stop': 20., 'step': 0.01}
self._vga_range = {'start': 0, 'stop': 4000, 'step': 1}
self._cspacing_range = {'start': 0.1, 'stop': 1000., 'step': 0.1}
elif model == 'SynthHD PRO v2':
self._f_range = {'start': 10.e6, 'stop': 24000.e6, 'step': 0.1}
self._p_range = {'start': -70., 'stop': 20., 'step': 0.01}
self._vga_range = {'start': 0, 'stop': 4000, 'step': 1}
self._cspacing_range = {'start': 0.1, 'stop': 1000., 'step': 0.1}
else:
self._f_range = None
self._p_range = None
self._vga_range = None
self._cspacing_range = None
@property
def channel_spacing_range(self):
"""Channel Spacing Range in Hz.
Returns:
dict: channel spacing range or None
"""
return None if self._cspacing_range is None else self._cspacing_range.copy()
@property
def channel_spacing(self):
"""Channel Spacing in Hz
Returns:
float: Channel Spacing setting in Hz
"""
return self.read('channelspacing')
@channel_spacing.setter
def channel_spacing(self,value):
"""Set Channel Spacing in Hz.
Args:
float: Channel spacing in Hz
"""
if not isinstance(value, (float, int)):
raise ValueError('Expected float or int.')
cs_range = self.channel_spacing_range
if cs_range is not None and not cs_range['start'] <= value <= cs_range['stop']:
raise ValueError('Expected float in range [{}, {}] Hz.'.format(
cs_range['start'], cs_range['stop']))
self.write('channelspacing', value)
class SynthHD(SerialDevice, Sequence):
API = {
# name type write read
'channel': (int, 'C{}', 'C?'), # Select channel
'frequency': (float, 'f{:.8f}', 'f?'), # Frequency in MHz
'power': (float, 'W{:.3f}', 'W?'), # Power in dBm
'calibrated': (bool, None, 'V'),
'temp_comp_mode': (int, 'Z{}', 'Z?'),
'vga_dac': (int, 'a{}', 'a?'), # VGA DAC value [0, 45000]
'phase_step': (float, '~{:.3f}', '~?'), # Phase step in degrees
'rf_enable': (bool, 'h{}', 'h?'),
'pa_power_on': (bool, 'r{}', 'r?'),
'pll_power_on': (bool, 'E{}', 'E?'),
'model_type': (str, None, '+'), # Model type
'serial_number': (int, None, '-'), # Serial number
'fw_version': (str, None, 'v0'), # Firmware version
'hw_version': (str, None, 'v1'), # Hardware version
'sub_version': (str, None, 'v2'), # Sub-version: "HD" or "HDPRO". Only Synth HD >= v2.
'save': ((), 'e', None), # Program all settings to EEPROM
'reference_mode': (int, 'x{}', 'x?'),
'trig_function': (int, 'w{}', 'w?'),
'pll_lock': (bool, None, 'p'),
'temperature': (float, None, 'z'), # Temperature in Celsius
'ref_frequency': (float, '*{:.8f}', '*?'), # Reference frequency in MHz
'channelspacing': (float, 'i{:.1f}', 'i?'), # Channel spacing in Hz
'sweep_freq_low': (float, 'l{:.8f}', 'l?'), # Sweep lower frequency in MHz
'sweep_freq_high': (float, 'u{:.8f}', 'u?'), # Sweep upper frequency in MHz
'sweep_freq_step': (float, 's{:.8f}', 's?'), # Sweep frequency step in MHz
'sweep_time_step': (float, 't{:.3f}', 't?'), # Sweep time step in [4, 10000] ms
'sweep_power_low': (float, '[{:.3f}', '[?'), # Sweep lower power [-60, +20] dBm
'sweep_power_high': (float, ']{:.3f}', ']?'), # Sweep upper power [-60, +20] dBm
'sweep_direction': (int, '^{}', '^?'), # Sweep direction
'sweep_diff_freq': (float, 'k{:.8f}', 'k?'), # Sweep differential frequency in MHz
'sweep_diff_meth': (int, 'n{}', 'n?'), # Sweep differential method
'sweep_type': (int, 'X{}', 'X?'), # Sweep type {0: linear, 1: tabular}
'sweep_single': (bool, 'g{}', 'g?'),
'sweep_cont': (bool, 'c{}', 'c?'),
'am_time_step': (int, 'F{}', 'F?'), # Time step in microseconds
'am_num_samples': (int, 'q{}', 'q?'), # Number of samples in one burst
'am_cont': (bool, 'A{}', 'A?'), # Enable continuous AM modulation
'am_lookup_table': ((int, float), '@{}a{:.3f}', '@{}a?'), # Program row in lookup table in dBm
'pulse_on_time': (int, 'P{}', 'P?'), # Pulse on time in range [1, 10e6] us
'pulse_off_time': (int, 'O{}', 'O?'), # Pulse off time in range [2, 10e6] uS
'pulse_num_rep': (int, 'R{}', 'R?'), # Number of repetitions in range [1, 65500]
'pulse_invert': (bool, ':{}', ':?'), # Invert pulse polarity
'pulse_single': ((), 'G', None),
'pulse_cont': (bool, 'j{}', 'j?'),
'dual_pulse_mod': (bool, 'D{}', 'D?'),
'fm_frequency': (int, '<{}', '<?'),
'fm_deviation': (int, '>{}', '>?'),
'fm_num_samples': (int, ',{}', ',?'),
'fm_mod_type': (int, ';{}', ';?'),
'fm_cont': (bool, '/{}', '/?'),
}
def __init__(self, devpath):
super().__init__(devpath)
self._model = None
self._model = self.model
if 'v2' in self.model:
channel_type = SynthHDv2Channel
else:
channel_type = SynthHDChannel
self._channels = [channel_type(self, index) for index in range(2)]
def __getitem__(self, key):
return self._channels.__getitem__(key)
def __len__(self):
return self._channels.__len__()
def init(self):
"""Initialize device: put into a known, safe state."""
self.reference_mode = 'internal 27mhz'
self.trigger_mode = 'disabled'
self.sweep_enable = False
self.am_enable = False
self.pulse_mod_enable = False
self.dual_pulse_mod_enable = False
self.fm_enable = False
for channel in self:
channel.init()
@property
def model(self):
"""Model version. This is the binned version that dictates API support.
Returns:
str: model version or None if unsupported
"""
if self._model is not None:
return self._model
hw_ver = self.hardware_version
if 'Version 2.' in hw_ver:
sub_ver = self.read('sub_version')
if sub_ver == 'HD':
return 'SynthHD v2'
elif sub_ver == 'HDPRO':
return 'SynthHD PRO v2'
else:
# Unsupported sub-version. Return None.
return None
elif 'Version 1.4' in hw_ver:
return 'SynthHD v1.4'
else:
# Unsupported hardware version. Return None.
return None
@property
def model_type(self):
"""Model type.
Returns:
str: model
"""
return self.read('model_type')
@property
def serial_number(self):
"""Serial number
Returns:
int: serial number
"""
return self.read('serial_number')
@property
def firmware_version(self):
"""Firmware version.
Returns:
str: version
"""
return self.read('fw_version')
@property
def hardware_version(self):
"""Hardware version.
Returns:
str: version
"""
return self.read('hw_version')
def save(self):
"""Save all settings to non-volatile EEPROM."""
self.write('save')
@property
def reference_modes(self):
"""Frequency reference modes.
Returns:
tuple: tuple of str of modes
"""
return ('external', 'internal 27mhz', 'internal 10mhz')
@property
def reference_mode(self):
"""Get frequency reference mode.
Returns:
str: mode
"""
return self.reference_modes[self.read('reference_mode')]
@reference_mode.setter
def reference_mode(self, value):
"""Set frequency reference mode.
Args:
value (str): mode
"""
modes = self.reference_modes
if not value in modes:
raise ValueError('Expected str in set {}.'.format(modes))
self.write('reference_mode', modes.index(value))
@property
def trigger_modes(self):
"""Trigger modes.
Returns:
tuple: tuple of str of modes
"""
return (
'disabled',
'full frequency sweep',
'single frequency step',
'stop all',
'rf enable',
'remove interrupts',
'reserved',
'reserved',
'am modulation',
'fm modulation',
)
@property
def trigger_mode(self):
"""Get trigger mode.
Returns:
str: mode
"""
return self.trigger_modes[self.read('trig_function')]
@trigger_mode.setter
def trigger_mode(self, value):
"""Set trigger mode.
Args:
value (str): mode
"""
modes = self.trigger_modes
if not value in modes:
raise ValueError('Expected str in set {}.'.format(modes))
self.write('trig_function', modes.index(value))
@property
def temperature(self):
"""Temperature in Celsius.
Returns:
float: temperature
"""
return self.read('temperature')
@property
def reference_frequency_range(self):
"""Reference frequency range in Hz.
Returns:
dict: frequency range in Hz
"""
return {'start': 10.e6, 'stop': 100.e6, 'step': 1.e3}
@property
def reference_frequency(self):
"""Get reference frequency in Hz.
Returns:
float: frequency in Hz
"""
return self.read('ref_frequency') * 1.e6
@reference_frequency.setter
def reference_frequency(self, value):
"""Set reference frequency in Hz.
Args:
value (float / int): frequency in Hz
"""
if not isinstance(value, (float, int)):
raise ValueError('Expected float or int.')
f_range = self.reference_frequency_range
if not f_range['start'] <= value <= f_range['stop']:
raise ValueError('Expected float in range [{}, {}] Hz.'.format(
f_range['start'], f_range['stop']))
self.write('ref_frequency', value / 1.e6)
@property
def sweep_enable(self):
"""Get sweep continuously enable.
Returns:
bool: enable
"""
return self.read('sweep_cont')
@sweep_enable.setter
def sweep_enable(self, value):
"""Set sweep continuously enable.
Args:
value (bool): enable
"""
if not isinstance(value, bool):
raise ValueError('Expected bool.')
self.write('sweep_cont', value)
@property
def am_enable(self):
"""Get AM continuously enable.
Returns:
bool: enable
"""
return self.read('am_cont')
@am_enable.setter
def am_enable(self, value):
"""Set AM continuously enable.
Args:
value (bool): enable
"""
if not isinstance(value, bool):
raise ValueError('Expected bool.')
self.write('am_cont', value)
@property
def pulse_mod_enable(self):
"""Get pulse modulation continuously enable.
Returns:
bool: enable
"""
return self.read('pulse_cont')
@pulse_mod_enable.setter
def pulse_mod_enable(self, value):
"""Set pulse modulation continuously enable.
Args:
value (bool): enable
"""
if not isinstance(value, bool):
raise ValueError('Expected bool.')
self.write('pulse_cont', value)
@property
def dual_pulse_mod_enable(self):
"""Get dual pulse modulation enable.
Returns:
bool: enable
"""
return self.read('dual_pulse_mod')
@dual_pulse_mod_enable.setter
def dual_pulse_mod_enable(self, value):
"""Set dual pulse modulation enable.
Args:
value (bool): enable
"""
if not isinstance(value, bool):
raise ValueError('Expected bool.')
self.write('dual_pulse_mod', value)
@property
def fm_enable(self):
"""Get FM continuously enable.
Returns:
bool: enable
"""
return self.read('fm_cont')
@fm_enable.setter
def fm_enable(self, value):
"""Set FM continuously enable.
Args:
value (bool): enable
"""
if not isinstance(value, bool):
raise ValueError('Expected bool.')
self.write('fm_cont', value)