-
Notifications
You must be signed in to change notification settings - Fork 0
/
tewx.py
executable file
·1549 lines (1243 loc) · 57.2 KB
/
tewx.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
#!/usr/bin/env python
# -*- coding: utf-8 -*-
# =========================================================================
# Copyright (C) 2016 Tabor-Electronics Ltd <http://www.taborelec.com/>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
# =========================================================================
'''tewx -- Tabor-Electronics WX-Instruments Controller (Without VISA-NI)
Please refer to our website's tutorials section under MATLAB/How To Manage Tabor AWG's Memory.
Where you will find detailed information of how to use all binary data transfer SCPI commands.
@author: Nadav
@date: 2016-11-23
@license: GPL
@copyright: 2016 Tabor-Electronics Ltd.
@contact: <http://www.taborelec.com/>
'''
from __future__ import print_function
from builtins import input, str
#import sys
import socket
import struct
import copy
import numpy as np
import warnings
#import os
#import sys
import time
import posixpath
#import unicodedata
try:
import usbtmc
_usbtmc_supported = True
except:
_usbtmc_supported = False
__version__ = '1.0.1'
__revision__ = '$Rev: 3512 $'
__docformat__ = 'reStructuredText'
__all__ = [ 'get_device_properties', 'list_usb_devices', 'TEWXAwg']
# WX2184 Properties
_wx2184_properties = {
'model_name' : 'WX2184', # the model name
'num_parts' : 2, # number of instrument parts
'chan_per_part' : 2, # number of channels per part
'seg_quantum' : 16, # segment-length quantum
'min_seg_len' : 192, # minimal segment length
'max_arb_mem' : 32E6, # maximal arbitrary-memory (points per channel)
'min_dac_val' : 0, # minimal DAC value
'max_dac_val' : 2**14-1, # maximal DAC value
'max_num_segs' : 32E+3, # maximal number of segments
'max_seq_len' : 48*1024-2,# maximal sequencer-table length (# rows)
'min_seq_len' : 3, # minimal sequencer-table length (# rows)
'max_num_seq' : 1000, # maximal number of sequencer-table
'max_aseq_len' : 48*1024-2,# maximal advanced-sequencer table length
'min_aseq_len' : 2, # minimal advanced-sequencer table length
'min_sclk' : 75e6, # minimal sampling-rate (samples/seconds)
'max_sclk' : 2300e6, # maximal sampling-rate (samples/seconds)
'digital_support' : False, # is digital-wave supported?
}
# WX1284 Definitions
_wx1284_properties = {
'model_name' : 'WX1284', # the model name
'num_parts' : 2, # number of instrument parts
'chan_per_part' : 2, # number of channels per part
'seg_quantum' : 16, # segment-length quantum
'min_seg_len' : 192, # minimal segment length
'max_arb_mem' : 32E6, # maximal arbitrary-memory (points per channel)
'min_dac_val' : 0, # minimal DAC value
'max_dac_val' : 2**14-1, # maximal DAC value
'max_num_segs' : 32E+3, # maximal number of segments
'max_seq_len' : 48*1024-2,# maximal sequencer-table length (# rows)
'min_seq_len' : 3, # minimal sequencer-table length (# rows)
'max_num_seq' : 1000, # maximal number of sequencer-table
'max_aseq_len' : 48*1024-2,# maximal advanced-sequencer table length
'min_aseq_len' : 2, # minimal advanced-sequencer table length
'min_sclk' : 75e6, # minimal sampling-rate (samples/seconds)
'max_sclk' : 1250e6, # maximal sampling-rate (samples/seconds)
'digital_support' : False, # is digital-wave supported?
}
# WX2182C Definitions
_wx2182C_properties = {
'model_name' : 'WX2182C',# the model name
'num_parts' : 2, # number of instrument parts
'chan_per_part' : 1, # number of channels per part
'seg_quantum' : 16, # segment-length quantum
'min_seg_len' : 192, # minimal segment length
'max_arb_mem' : 32E6, # maximal arbitrary-memory (points per channel)
'min_dac_val' : 0, # minimal DAC value
'max_dac_val' : 2**14-1, # maximal DAC value
'max_num_segs' : 32E+3, # maximal number of segments
'max_seq_len' : 48*1024-2,# maximal sequencer-table length (# rows)
'min_seq_len' : 3, # minimal sequencer-table length (# rows)
'max_num_seq' : 1000, # maximal number of sequencer-table
'max_aseq_len' : 48*1024-2,# maximal advanced-sequencer table length
'min_aseq_len' : 2, # minimal advanced-sequencer table length
'min_sclk' : 10e6, # minimal sampling-rate (samples/seconds)
'max_sclk' : 2.3e9, # maximal sampling-rate (samples/seconds)
'digital_support' : False, # is digital-wave supported?
}
# WX1282C Definitions
_wx1282C_properties = {
'model_name' : 'WX1282C',# the model name
'num_parts' : 2, # number of instrument parts
'chan_per_part' : 1, # number of channels per part
'seg_quantum' : 16, # segment-length quantum
'min_seg_len' : 192, # minimal segment length
'max_arb_mem' : 32E6, # maximal arbitrary-memory (points per channel)
'min_dac_val' : 0, # minimal DAC value
'max_dac_val' : 2**14-1, # maximal DAC value
'max_num_segs' : 32E+3, # maximal number of segments
'max_seq_len' : 48*1024-2,# maximal sequencer-table length (# rows)
'min_seq_len' : 3, # minimal sequencer-table length (# rows)
'max_num_seq' : 1000, # maximal number of sequencer-table
'max_aseq_len' : 48*1024-2,# maximal advanced-sequencer table length
'min_aseq_len' : 2, # minimal advanced-sequencer table length
'min_sclk' : 10e6, # minimal sampling-rate (samples/seconds)
'max_sclk' : 1.25e9, # maximal sampling-rate (samples/seconds)
'digital_support' : False, # is digital-wave supported?
}
# dictionary of supported-models' properties
model_properties_dict = {
'WX2184' : _wx2184_properties,
'WX2184C' : _wx2184_properties,
'WX1284' : _wx2184_properties,
'WX1284C' : _wx2184_properties,
'WX2182C' : _wx2182C_properties,
'WX1282C' : _wx1282C_properties,
}
# Maps SCPI data commands to file-type IDs
# (used by send_load_file_cmd())
_file_types_dict = {
# Analog Wave Data:
'TRACE:DATA' : 1,
'TRAC:DATA' : 1,
'TRACE' : 1,
'TRAC' : 1,
# Digital Wave Data:
'DIGITAL:DATA' : 2,
'DIG:DATA' : 2,
# Segment Lengths List:
'SEGMENT:DATA' : 3,
'SEGM:DATA' : 3,
'SEGMENT' : 3,
'SEGM' : 3,
# Sequencer-Table (of the active sequencer):
'SEQUENCE:DATA' : 4,
'SEQ:DATA' : 4,
'SEQUENCE' : 4,
'SEQ' : 4,
# Sequencer-Lines (of all sequencers):
'SEQUENCE:DATA:ALL' : 5,
'SEQ:DATA:ALL' : 5,
'SEQUENCE:ALL' : 5,
'SEQ:ALL' : 5,
# Advanced-Sequencer Table:
'ASEQUENCE:DATA' : 6,
'ASEQ:DATA' : 6,
'ASEQUENCE' : 6,
'ASEQ' : 6,
# Pattern-Composer Fast (DC) Pattern Table:
'PATTERN:COMPOSER:FAST:DATA' : 7,
'PATTERN:COMPOSER:FAST' : 7,
'PATTERN:COMP:FAST:DATA' : 7,
'PATTERN:COMP:FAST' : 7,
'PATT:COMPOSER:FAST:DATA' : 7,
'PATT:COMPOSER:FAST' : 7,
'PATT:COMP:FAST:DATA' : 7,
'PATT:COMP:FAST' : 7,
# Pattern-Composer Linear Pattern Table
'PATTERN:COMPOSER:LINEAR:DATA' : 8,
'PATTERN:COMPOSER:LINEAR' : 8,
'PATTERN:COMPOSER:LIN:DATA' : 8,
'PATTERN:COMPOSER:LIN' : 8,
'PATTERN:COMP:LINEAR:DATA' : 8,
'PATTERN:COMP:LINEAR' : 8,
'PATTERN:COMP:LIN:DATA' : 8,
'PATTERN:COMP:LIN' : 8,
'PATT:COMPOSER:LINEAR:DATA' : 8,
'PATT:COMPOSER:LINEAR' : 8,
'PATT:COMPOSER:LIN:DATA' : 8,
'PATT:COMPOSER:LIN' : 8,
'PATT:COMP:LINEAR:DATA' : 8,
'PATT:COMP:LINEAR' : 8,
'PATT:COMP:LIN:DATA' : 8,
'PATT:COMP:LIN' : 8,
# Pattern Predefined Data:
'PATTERN:PREDEFINED:DATA' : 9,
'PATTERN:PRED:DATA' : 9,
'PATTERN:DATA' : 9,
'PATT:PREDEFINED:DATA' : 9,
'PATT:PRED:DATA' : 9,
'PATT:DATA' : 9,
# Digital-Pod Parameters
'DIGITAL:PARAMETERS' : 10,
'DIGITAL:PAR' : 10,
'DIG:PARAMETERS' : 10,
'DIG:PAR' : 10,
# ASK Table:
'ASK:DATA' : 11,
# FSK Table:
'FSK:DATA' : 12,
# FHOP Fixed-Time Table:
'FHOPPING:FIXED:DATA' : 13,
'FHOPPING:FIX:DATA' : 13,
'FHOP:FIXED:DATA' : 13,
'FHOP:FIX:DATA' : 13,
# FHOP Variable-Time Table:
'FHOPPING:VARIABLE:DATA' : 14,
'FHOPPING:VAR:DATA' : 14,
'FHOP:VARIABLE:DATA' : 14,
'FHOP:VAR:DATA' : 14,
# AHOP Fixed-Time Table:
'AHOPPING:FIXED:DATA' : 15,
'AHOPPING:FIX:DATA' : 15,
'AHOP:FIXED:DATA' : 15,
'AHOP:FIX:DATA' : 15,
# AHOP Variable-Time Table:
'AHOPPING:VARIABLE:DATA' : 16,
'AHOPPING:VAR:DATA' : 16,
'AHOP:VARIABLE:DATA' : 16,
'AHOP:VAR:DATA' : 16,
# PSK Table:
'PSK:DATA' : 17,
# PSK User-Defined Phases:
'PSK:USER:DATA' : 18,
# (N)QAM Table:
'QAM:DATA' : 19,
# (N)QAM User-Defined Constellation Table:
'QAM:USER:DATA' : 20,
# Firmware-Update File:
'SYSTEM:FIRMWARE:DATA' : 21,
'SYSTEM:FIRM:DATA' : 21,
'SYST:FIRMWARE:DATA' : 21,
'SYST:FIRM:DATA' : 21,
}
def get_device_properties(idn_str, opt_str):
'''Get the device-properties dictionary according to its *IDN? and *OPT?
:param idn_str: the instrument's answer to '*IDN?' query.
:param opt_str: the instrument's answer to '*OPT?' query.
:returns: dictionary of the device properties.
'''
dev_props = None
idn_parts = idn_str.split(',')
if len(idn_parts) == 4 and idn_parts[1] in model_properties_dict:
model_name = idn_parts[1]
d = model_properties_dict[model_name]
dev_props = copy.deepcopy(d)
dev_props['model_name'] = model_name
if model_name in ('WX2184', 'WX2184C', 'WX1284', 'WX1284C'):
dev_props['max_arb_mem'] = int(opt_str[2:4]) * 1E6
elif opt_str.startswith('1M', 1):
dev_props['max_arb_mem'] = 1E6
elif opt_str.startswith('2M', 1):
dev_props['max_arb_mem'] = 2E6
elif opt_str.startswith('8M', 1):
dev_props['max_arb_mem'] = 8E6
elif opt_str.startswith('16M', 1):
dev_props['max_arb_mem'] = 16E6
elif opt_str.startswith('32M', 1):
dev_props['max_arb_mem'] = 32E6
elif opt_str.startswith('64M', 1):
dev_props['max_arb_mem'] = 64E6
elif opt_str.startswith('512K', 1):
dev_props['max_arb_mem'] = 512E3
elif opt_str.startswith('116') or opt_str.startswith('216') or opt_str.startswith('416'):
dev_props['max_arb_mem'] = 16E6
elif opt_str.startswith('132') or opt_str.startswith('232') or opt_str.startswith('432'):
dev_props['max_arb_mem'] = 32E6
elif opt_str.startswith('164') or opt_str.startswith('264') or opt_str.startswith('464'):
dev_props['max_arb_mem'] = 64E6
if opt_str.endswith('D'):
dev_props['digital_support'] = True
return dev_props
def list_usb_devices():
'''List devices available via USB interface
:returns: list of the devices connection-string (NI-VISA format).
'''
resource_names = []
try:
if _usbtmc_supported:
devs = usbtmc.list_devices()
for dev in devs:
idVendor, idProduct, iSerial = None, None, None
try:
idVendor = dev.idVendor
except:
idVendor = None
try:
idProduct = dev.idProduct
except:
idProduct = None
try:
iSerial = dev.serial_number
except:
iSerial = None
if idVendor is None or idProduct is None:
continue
if iSerial is None:
resource_name = 'USB::0x{0:02x}::0x{1:02x}::INSTR'.format(idVendor, idProduct)
resource_names.append(resource_name)
else:
resource_name = 'USB::0x{0:02x}::0x{1:02x}::{2}::INSTR'.format(idVendor, idProduct, iSerial)
resource_names.append(resource_name)
except:
pass
return resource_names
class CommIntfType:
'''The supported communication interface types '''
NIL = 0
LAN = 1
USB = 2
class TEWXAwg(object):
'''Tabor-Electronics WX-Instrument Controller (Without VISA-NI)'''
def __init__(self, instr_addr=None, tcp_timeout=5.0, paranoia_level=1):
''' Initialize this `TEWWAwg` instance.
The given `instr_address` defines the instrument-address.
It can be either
- An empty string or None (meaning no address)
- IP-Address in digits and dots format (e.g. '192.168.0.170')
- TCPIP NI-VISA format: 'TCPIP::<IP-Address>::<PortNo>::SOCKET'
(for example: 'TCPIP:192.168.0.170::5025::SOCKET')
- USB NI-VISA short-format: 'USB::<VendorId>::<ProductId>::INSTR
(for example: 'USB::0x168b::0x2184::INSTR')
- USB NI-VISA long-format: 'USB::<VendorId>::<ProductId>::<SerialNo>::INSTR
(for example: 'USB::0x168b::0x2184::0000214991::INSTR')
If it is not None, then communication is opened.
In order to findout the USB-Address, use `usbtmc.usbtmc.list_devices()`.
If for example it returns: `[<DEVICE ID 168b:2184 on Bus 001 Address 002>]`
then the USB-Address is: 'USB::0x168b::0x2184::INSTR'.
In case of multiple devices, the serial-number can be added too.
For example: 'USB::0x168b::0x2184::0000214991::INSTR'
:param instr_addr: the instrument address
:param tcp_timeout: TCP-Socket time-out (in seconds)
:param paranoia_level: the `paranoia_level` (0,1 or 2)
'''
self._tcp_sock = None
self._usb_sock = None
self._intf_type = CommIntfType.NIL
self._model_name = ''
self._ip_addr = None
self._usb_addr = None
self._dev_props = None
self._instr_addr = None
self._tcp_port_nb = None
self._tcp_timeout = float(tcp_timeout)
self._paranoia_level = int(paranoia_level)
self._set_instr_address(instr_addr)
if self._instr_addr is not None:
self.open()
def __enter__(self):
return self
def __exit__(self, exc_type, exc_value, traceback):
self.close()
def open(self, instr_addr=None, tcp_timeout=None):
'''Open/Reopen Connection
The given `instr_address` defines the instrument-address.
It can be either
- An empty string or None (meaning no address)
- IP-Address in digits and dots format (e.g. '192.168.0.170')
- TCPIP NI-VISA format: 'TCPIP::<IP-Address>::<PortNo>::SOCKET'
(for example: 'TCPIP:192.168.0.170::5025::SOCKET')
- USB NI-VISA short-format: 'USB::<VendorId>::<ProductId>::INSTR
(for example: 'USB::0x168b::0x2184::INSTR')
- USB NI-VISA long-format: 'USB::<VendorId>::<ProductId>::<SerialNo>::INSTR
(for example: 'USB::0x168b::0x2184::0000214991::INSTR')
In order to findout the USB-Address, use `usbtmc.usbtmc.list_devices()`.
If for example it returns: `[<DEVICE ID 168b:2184 on Bus 001 Address 002>]`
then the USB-Address is: 'USB::0x168b::0x2184::INSTR'.
In case of multiple devices, the serial-number can be added too.
For example: 'USB::0x168b::0x2184::0000214991::INSTR'
Note: If either `instr_addr` is None or `tcp_timeout` is None,
then the the previous value of the relevant argument is used.
:param instr_addr: the instrument's address.
:param tcp_timeout: TCP-Socket time-out (in seconds)
'''
self.close()
self._dev_props = None
if instr_addr is not None:
self._set_instr_address(instr_addr)
if tcp_timeout is not None:
self._tcp_timeout = float(tcp_timeout)
if self._ip_addr is not None:
# Open TCP-IP Socket:
self._tcp_sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM, socket.IPPROTO_TCP)
self._tcp_sock.setsockopt(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)
self._tcp_sock.settimeout(self._tcp_timeout)
self._tcp_sock.connect((self._ip_addr, self._tcp_port_nb))
self._intf_type = CommIntfType.LAN
elif self._usb_addr is not None:
self._usb_sock = usbtmc.Instrument(self._usb_addr)
if self._usb_sock is None:
warn_msg ='Failed to open USB-TMC Instrument at "{0}".'.format(self._usb_addr)
warnings.warn(warn_msg)
else:
self._intf_type = CommIntfType.USB
idn = self.send_query('*IDN?')
opt = self.send_query('*OPT?')
self._dev_props = get_device_properties(idn, opt)
if self._dev_props is None and self._paranoia_level >= 2:
warn_msg = 'unsupported model: {0}.'.format(idn)
warnings.warn(warn_msg)
self._model_name = self.get_dev_property('model_name', '')
def close(self):
'''Close Connection'''
if self._tcp_sock is not None:
self._tcp_sock.close();
self._tcp_sock = None
if self._usb_sock is not None:
self._usb_sock.close()
self._usb_sock = None
self._intf_type = CommIntfType.NIL
@property
def intf_type(self):
'''Get the communication-interface type '''
return self._intf_type
@property
def tcp_sock(self):
'''Get the tcp-ip socket '''
return self._tcp_sock
@property
def usb_sock(self):
'''Get the usb-tmc socket '''
return self._usb_sock
@property
def instr_address(self):
'''Get the instrument address '''
return self._instr_addr
@property
def dev_properties(self):
'''Get dictionary of the device properties '''
return self._dev_props
def get_dev_property(self, property_name, default_value=None):
'''Get the value of the specified device-property
:param property_name: the property name.
:param default_value: default value (if the specified property is missing)
:returns: the specified property, or the default-value if it's not defined.
'''
if self._dev_props is not None and property_name in self._dev_props:
return self._dev_props[property_name]
return default_value
@property
def model_name(self):
'''Get the model name '''
return self._model_name
@property
def paranoia_level(self):
'''Get the (default) paranoia-level
The paranoia-level indicates whether and which additional query
should be sent after sending SCPI-Command to the instrument:
- 0: do not send any additional query
- 1: send '*OPC?' (recommended).
- 2: send ':SYST:ERR?' and validate the response (for debug).
'''
return self._paranoia_level
@paranoia_level.setter
def paranoia_level(self, value):
'''Set the (default) paranoia-level (0, 1 or 2)'''
self._paranoia_level = int(value)
def send_cmd(self, cmd_str, paranoia_level=None):
'''Send the given command to the instrument
The paranoia-level indicates whether and which additional query
should be sent after sending the SCPI-Command to the instrument:
- 0: do not send any additional query
- 1: send '*OPC?' (recommended).
- 2: send ':SYST:ERR?' and validate the response (for debug).
If the given `paranoia_level` is `None`, then the default level is used.
:param cmd_str: the command string (SCPI statement).
:param paranoia_level: the paranoia-level (optional)
'''
assert (self._intf_type != CommIntfType.NIL)
if paranoia_level is None:
paranoia_level = self._paranoia_level
if paranoia_level == 1:
ask_str = cmd_str.rstrip()
if len(ask_str) > 0:
ask_str += '; *OPC?'
else:
ask_str += '*OPC?'
_ = self.send_query(ask_str)
elif paranoia_level >= 2:
ask_str = cmd_str.rstrip()
if len(ask_str) > 0:
ask_str += '; :SYST:ERR?'
else:
ask_str += ':SYST:ERR?'
syst_err = self.send_query( ask_str)
if not syst_err.startswith('0'):
wrn_msg = 'CMD: \"{0}\", ERR: \"{1}\"'.format(cmd_str.rstrip(), syst_err.rstrip())
warnings.warn(wrn_msg)
_ = self.send_query('*CLS; *OPC?')
elif self._intf_type == CommIntfType.LAN:
if not cmd_str.endswith('\n'):
cmd_str = cmd_str + '\n'
self._tcp_sock.sendall(cmd_str)
elif self._intf_type == CommIntfType.USB:
self._usb_sock.write(cmd_str)
def send_query(self, query_str):
'''Send the given query to the instrument and read the response
:param query_str: the query string (SCPI statement).
:returns: the instrument's response.
'''
resp = None
assert (self._intf_type != CommIntfType.NIL)
if self._intf_type == CommIntfType.LAN:
if not query_str.endswith('\n'):
query_str = query_str + '\n'
if isinstance(query_str, str):
query_str = np.fromstring(query_str, dtype=np.uint8)
self._tcp_sock.sendall(query_str)
resp = self.read_resp()
elif self._intf_type == CommIntfType.USB:
if isinstance(query_str, str):
query_str = np.fromstring(query_str, dtype=np.uint8)
resp = self._usb_sock.ask(query_str)
return resp
def read_resp(self):
'''Read response from the instrument. '''
resp = None
assert (self._intf_type != CommIntfType.NIL)
if self._intf_type == CommIntfType.LAN:
ret = []
ch = self._tcp_sock.recv(1)
while b'\n' != ch and u'\n' != ch:
if b'\r' != ch and u'\r' != ch:
try:
ch = ch.decode('utf-8')
except:
pass
ret.append(ch)
ch = self._tcp_sock.recv(1)
resp = ''.join(ret)
elif self._intf_type == CommIntfType.USB:
resp = self._usb_sock.read()
try:
resp = resp.decode('utf-8')
except:
pass
return resp
def send_binary_data(self, pref, bin_dat, paranoia_level=None):
'''Send the given binary-data to the instrument.
:param pref: binary-data header prefix (e.g. ':TRAC:DATA')
:param bin_dat: the binary-data to send (a `numpy.ndarray`)
:param paranoia_level: paranoia-level (that overrides the default one)
'''
assert(isinstance(bin_dat, np.ndarray))
assert (self._intf_type != CommIntfType.NIL)
if pref is None:
pref = ''
bin_dat_header = self._make_bin_dat_header(pref, bin_dat.nbytes)
if paranoia_level is None:
paranoia_level = self._paranoia_level
if paranoia_level >= 1:
bin_dat_header = '*OPC?; ' + bin_dat_header
if isinstance(bin_dat_header, str):
bin_dat_header = np.fromstring(bin_dat_header, dtype=np.uint8)
if self._intf_type == CommIntfType.LAN:
self._tcp_sock.sendall(bin_dat_header)
elif self._intf_type == CommIntfType.USB:
self._usb_sock.write_raw(bin_dat_header)
_ = self._send_raw_bin_dat(bin_dat)
if paranoia_level >= 1:
_ = self.read_resp() # read the response to the *OPC? that was sent with the header
if paranoia_level >= 2:
syst_err = self.send_query(':SYST:ERR?')
if not syst_err.startswith('0'):
syst_err = syst_err.rstrip()
wrn_msg = 'ERR: "{0}" After Sending Binary-Data (pref="{1}" datLen={2}).'.format(syst_err, pref, len(bin_dat))
warnings.warn(wrn_msg)
_ = self.send_query('*CLS; *OPC?')
def download_segment_lengths(self, seg_len_list, pref=':SEGM:DATA', paranoia_level=None):
'''Download Segments-Lengths Table to Instrument
:param seg_len_list: the list of segments-lengths.
:param pref: the binary-data-header prefix.
:param paranoia_level: paranoia-level (that overrides the default one)
Example:
The fastest way to download multiple segments to the instrument
is to download the wave-data of all the segments, including the
segment-prefixes (16 idle-points) of all segments except the 1st,
into segment 1 (pseudo segment), and afterward download the
appropriate segment-lengths. Using the SEGM:DATA command this will
allow to slice the pseudo segment into the corresponding list of segments.
>>> with TEWXAwg('192.168.0.170') as inst:
>>> # Select segment 1:
>>> inst.send_cmd(':TRACe:SELect 1')
>>>
>>> # Download the wave-data of all segments:
>>> inst.send_binary_data(':TRACe:DATA', wave_data)
>>>
>>> # Download the appropriate segment-lengths list:
>>> seg_lengths = [ 1024, 1024, 384, 4096, 8192 ]
>>> inst.download_segment_lengths(seg_lengths)
'''
if isinstance(seg_len_list, np.ndarray):
if seg_len_list.ndim != 1:
seg_len_list = seg_len_list.flatten()
if seg_len_list.dtype != np.uint32:
seg_len_list = np.asarray(seg_len_list, dtype=np.uint32)
else:
seg_len_list = np.asarray(seg_len_list, dtype=np.uint32)
if seg_len_list.ndim != 1:
seg_len_list = seg_len_list.flatten()
self.send_binary_data(pref, seg_len_list, paranoia_level=paranoia_level)
def download_sequencer_table(self, seq_table, pref=':SEQ:DATA', paranoia_level=None):
'''Download Sequencer-Table to Instrument
The sequencer-table, `seq_table`, is a list of 3-tuples
of the form: (<repeats>, <segment no.>, <jump-flag>)
:param seq_table: the sequencer-table (list of 3-tuples)
:param pref: the binary-data-header prefix.
:param paranoia_level: paranoia-level (that overrides the default one)
Example:
>>> # Create Sequencer-Table:
>>> repeats = [ 1, 1, 100, 4, 1 ]
>>> seg_nb = [ 2, 3, 5, 1, 4 ]
>>> jump = [ 0, 0, 1, 0, 0 ]
>>> sequencer_table = zip(repeats, seg_nb, jump)
>>>
>>> # Select sequencer no. 1, and write its table:
>>> with TEWXAwg('192.168.0.170') as inst:
>>> inst.send_cmd(':SEQ:SELect 1')
>>> inst.download_sequencer_table(sequencer_table)
'''
m = self.pack_sequencer_table(seq_table)
self.send_binary_data(pref, m, paranoia_level=paranoia_level)
def download_adv_seq_table(self, seq_table, pref=':ASEQ:DATA', paranoia_level=None):
'''Download Advanced-Sequencer-Table to Instrument
The sequencer-table, `seq_table`, is a list of 3-tuples
of the form: (<repeats>, <sequence no.>, <jump-flag>)
:param seq_table: the sequencer-table (list of 3-tuples)
:param pref: the binary-data-header prefix.
:param paranoia_level: paranoia-level (that overrides the default one)
Example:
>>> # Create advanced-sequencer table:
>>> repeats = [ 1, 1, 100, 4, 1 ]
>>> seq_nb = [ 2, 3, 5, 1, 4 ]
>>> jump = [ 0, 0, 1, 0, 0 ]
>>> adv_sequencer_table = zip(repeats, seq_nb, jump)
>>>
>>> # Download it to instrument
>>> with TEWXAwg('192.168.0.170') as inst:
>>> inst.download_adv_seq_table(adv_sequencer_table)
'''
m = self.pack_sequencer_table(seq_table)
self.send_binary_data(pref, m, paranoia_level=paranoia_level)
def download_fast_pattern_table(self, patt_table, pref=':PATT:COMP:FAST:DATA', paranoia_level=None):
'''Download Fast (Piecewise-flat) Pulse-Pattern Table to Instrument
The pattern-table, `patt_table`, is a list of 2-tuples
of the form: (<voltage-level (volt)>, <dwell-time (sec)>)
:param patt_table: the pattern-table (list of 2-tuples)
:param pref: the binary-data-header prefix.
:param paranoia_level: paranoia-level (that overrides the default one)
Note:
In order to avoid Settings-Conflict make sure you can find
a valid sampling-rate, `sclk`, such that the length in points
of each dwell-time, `dwell-time*sclk` is integral number, and
the total length in points is divisible by the segment-quantum
(either 16 or 32 depending on the instrument model).
Optionally set the point-time-resolution manually to `1/sclk`.
Example:
>>> inst = TEWXAwg('192.168.0.170')
>>>
>>> # Create fast-pulse pattern table:
>>> volt_levels = [0.0 , 0.1 , 0.5 , 0.1 , -0.1, -0.5, -0.1, -0.05]
>>> dwell_times = [1e-9, 1e-6, 1e-9, 1e-6, 1e-6, 1e-9, 1e-6, 5e-9 ]
>>> pattern_table = zip(volt_levels, dwell_times)
>>>
>>> # Set Function-Mode=Pattern, Pattern-Mode=Composer, Pattern-Type=Fast:
>>> inst.send_cmd(':FUNC:MODE PATT; :PATT:MODE COMP; :PATT:COMP:TRAN:TYPE FAST')
>>>
>>> # Optionally set User-Defined (rather than Auto) point sampling time:
>>> inst.send_cmd(':PATT:COMP:RES:TYPE USER; :PATT:COMP:RES 0.5e-9')
>>>
>>> # Download the pattern-table to instrument:
>>> inst.download_fast_pattern_table(pattern_table)
>>>
>>> inst.close()
'''
try:
tbl_len = len(patt_table)
except:
patt_table = list(patt_table)
tbl_len = len(patt_table)
s = struct.Struct('< f d')
s_size = s.size
m = np.empty(s_size * tbl_len, dtype='uint8')
for n in range(tbl_len):
volt_level, dwel_time = patt_table[n]
volt_level = float(volt_level)
dwel_time = float(dwel_time)
s.pack_into(m, n * s_size, volt_level, dwel_time)
self.send_binary_data(pref, m, paranoia_level=paranoia_level)
def download_linear_pattern_table(self, patt_table, start_level, pref=':PATT:COMP:LIN:DATA', paranoia_level=None):
'''Download Piecewise-Linear Pulse-Pattern to Instrument
The pattern-table, `patt_table`, is a list of 2-tuples
of the form: (<voltage-level (volt)>, <dwell-time (sec)>).
Here the `vlotage-level` is the section's end-level.
The section's start-lavel is the previous-section's end-level.
The argument `start_level` is the first-section's start-level.
:param patt_table: the pattern-table (list of 2-tuples)
:param start_level: the (first-section's) start voltage level.
:param pref: the binary-data-header prefix.
Note:
In order to avoid Settings-Conflict make sure you can find
a valid sampling-rate, `sclk`, such that the length in points
of each dwell-time, `dwell-time` * `sclk` is integral number, and
the total length in points is divisible by the segment-quantum
(either 16 or 32 depending on the instrument model).
Optionally set the point-time-resolution manually to `1/sclk`.
Example:
>>> inst = TEWXAwg('192.168.0.170')
>>>
>>> # Create fast-pulse pattern table:
>>> start_level = 0.0
>>> volt_levels = [0.1 , 0.1 , 0.5 , 0.1 , -0.1, -0.1, -0.5, -0.1, 0.0 ]
>>> dwel_times = [1e-9, 1e-6, 1e-9, 1e-6, 4e-9, 1e-6, 1e-9, 1e-6, 1e-9 ]
>>> pattern_table = zip(volt_levels, dwel_times)
>>>
>>> # Set Function-Mode=Pattern, Pattern-Mode=Composer, Pattern-Type=Linear:
>>>inst.send_cmd(':FUNC:MODE PATT; :PATT:MODE COMP; :PATT:COMP:TRAN:TYPE LIN')
>>>
>>> # Optionally set User-Defined (rather than Auto) point sampling time:
>>> inst.send_cmd(':PATT:COMP:RES:TYPE USER; :PATT:COMP:RES 0.5e-9')
>>>
>>> # Download the pattern-table to instrument:
>>> inst.download_linear_pattern_table(pattern_table, start_level)
>>>
>>> inst.close()
'''
try:
tbl_len = len(patt_table)
except:
patt_table = list(patt_table)
tbl_len = len(patt_table)
s = struct.Struct('< f d')
s_size = s.size
m = np.empty(s_size * tbl_len, dtype='uint8')
for n in range(tbl_len):
volt_level, dwel_time = patt_table[n]
volt_level = float(volt_level)
dwel_time = float(dwel_time)
s.pack_into(m, n * s_size, volt_level, dwel_time)
if start_level is not None:
start_level = float(start_level)
self.send_cmd(':PATT:COMP:LIN:STARt {0:f}'.format(start_level))
self.download_binary_data(pref, m, paranoia_level=paranoia_level)
def send_load_file_cmd(self, file_type, file_path, paranoia_level=None):
'''Send Load-File Command to Instrument
The `file_type` is either a file-type number or a corresponding SCPI string.
:param file_type: the file-type.
:param file_path: the file-path (relative to the disk-on-key)
'''
assert (self._intf_type != CommIntfType.NIL)
if paranoia_level is None:
paranoia_level = self._paranoia_level
paranoia_level = max(paranoia_level, 1)
try:
file_type = int(file_type)
except:
file_type = file_type.upper()
if file_type.startswith(':'):
file_type = file_type[1:]
if file_type.startswith('SOURCE:'):
file_type = file_type[7:]
elif file_type.startswith('SOUR:'):
file_type = file_type[5:]
if file_type in _file_types_dict:
file_type = _file_types_dict[file_type]
else:
file_type = 0
file_path = str(file_path)
file_path = posixpath.join(*file_path.split('\\'))
#if type(file_path) is unicode:
# file_path = unicodedata.normalize('NFKD', file_path).encode('ascii','ignore')
if paranoia_level == 1:
cmd_str = 'LOAD {0:d},\'{1:s}\';*OPC?\n'.format(file_type, file_path)
elif paranoia_level >= 2:
cmd_str = 'LOAD {0:d},\'{1:s}\';:SYST:ERR?\n'.format(file_type, file_path)
else:
cmd_str = 'LOAD {0:d},\'{1:s}\'\n'.format(file_type, file_path)
if isinstance(cmd_str, str):
cmd_str = np.fromstring(cmd_str, dtype=np.uint8)
if self._intf_type == CommIntfType.LAN:
self._tcp_sock.sendall(cmd_str)
elif self._intf_type == CommIntfType.USB:
self._usb_sock.write_raw(cmd_str)
if paranoia_level > 0:
rsep_str = ''
t0 = time.clock()
while True:
try:
rsep_str = self.read_resp()
break
except socket.timeout:
t1 = time.clock()
if len(rsep_str) > 0 or t1 - t0 > 100:
raise
if paranoia_level >= 2:
if not rsep_str.startswith('0'):
wrn_msg = 'CMD: \"{0}\", ERR: \"{1}\"'.format(cmd_str.rstrip(), rsep_str.rstrip())
warnings.warn(wrn_msg)
_ = self.send_query('*CLS; *OPC?')
def build_sine_wave(self, cycle_len, num_cycles=1, phase_degree=0, low_level=0, high_level=2**14-1):
'''Build Sine Wave
:param cycle_len: cycle length (in points).
:param num_cycles: number of cycles.
:param phase_degree: starting-phase (in degrees)
:param low_level: the sine low level.
:param high_level: the sine high level.
:returns: `numpy.array` with the wave data (DAC values)
'''
cycle_len = int(cycle_len)
num_cycles = int(num_cycles)
if cycle_len <= 0 or num_cycles <= 0:
return None
dac_min = self.get_dev_property('min_dac_val', 0)
dac_max = self.get_dev_property('max_dac_val', 2**14-1)
wav_len = cycle_len * num_cycles
phase = float(phase_degree) * np.pi / 180.0
x = np.linspace(start=phase, stop=phase+2*np.pi, num=cycle_len, endpoint=False)
zero_val = (low_level + high_level) / 2.0
amplitude = (high_level - low_level) / 2.0
y = np.sin(x) * amplitude + zero_val
y = np.round(y)
y = np.clip(y, dac_min, dac_max)
y = y.astype(np.uint16)