-
-
Notifications
You must be signed in to change notification settings - Fork 121
/
tcpip.py
1454 lines (1169 loc) · 49.7 KB
/
tcpip.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
# -*- coding: utf-8 -*-
"""TCPIP Session implementation using Python Standard library.
:copyright: 2014-2024 by PyVISA-py Authors, see AUTHORS for more details.
:license: MIT, see LICENSE for more details.
"""
import ipaddress
import random
import select
import socket
import time
import warnings
from typing import Any, Dict, List, Optional, Tuple, Type, cast
from pyvisa import attributes, constants, errors, rname
from pyvisa.constants import BufferOperation, ResourceAttribute, StatusCode
from . import common
from .protocols import hislip, rpc, vxi11
from .sessions import Session, UnknownAttribute, VISARMSession
# Let psutil be optional dependency
try:
import psutil # type: ignore
except ImportError:
psutil = None
# Let zeroconf be optional dependency
try:
import zeroconf # type: ignore
except ImportError:
zeroconf = None # type: ignore
# Let pyvicp be an optional dependency
try:
import pyvicp # type: ignore
except ImportError:
pyvicp = None # type: ignore
# Conversion between VXI11 error codes and VISA status
# TODO this is so far a best guess, in particular 6 and 29 are likely wrong
VXI11_ERRORS_TO_VISA = {
0: StatusCode.success, # no_error
1: StatusCode.error_invalid_format, # syntax_error
3: StatusCode.error_connection_lost, # device_no_accessible
4: StatusCode.error_invalid_access_key, # invalid_link_identifier
5: StatusCode.error_invalid_parameter, # parameter_error
6: StatusCode.error_handler_not_installed, # channel_not_established
8: StatusCode.error_nonsupported_operation, # operation_not_supported
9: StatusCode.error_allocation, # out_of_resources
11: StatusCode.error_resource_locked, # device_locked_by_another_link
12: StatusCode.error_session_not_locked, # no_lock_held_by_this_link
15: StatusCode.error_timeout, # io_timeout
17: StatusCode.error_io, # io_error
23: StatusCode.error_abort, # abort
29: StatusCode.error_window_already_mapped, # channel_already_established
}
@Session.register(constants.InterfaceType.tcpip, "INSTR")
class TCPIPInstrSession(Session):
"""A class to dispatch to VXI11 or HiSLIP, based on the protocol."""
def __new__(
cls,
resource_manager_session: VISARMSession,
resource_name: str,
parsed=None,
open_timeout: Optional[int] = None,
):
newcls: Type
if parsed is None:
parsed = rname.parse_resource_name(resource_name)
if parsed.lan_device_name.lower().startswith("hislip"):
newcls = TCPIPInstrHiSLIP
else:
newcls = TCPIPInstrVxi11
return newcls(resource_manager_session, resource_name, parsed, open_timeout)
@staticmethod
def list_resources(wait_time=1.0) -> List[str]:
return TCPIPInstrVxi11.list_resources() + TCPIPInstrHiSLIP.list_resources()
@classmethod
def get_low_level_info(cls) -> str:
vxi11 = "ok" if psutil is not None else "partial (psutil not installed)"
hislip = "ok" if zeroconf is not None else "disabled (zeroconf not installed)"
return (
"\n Resource discovery:"
f"\n - VXI-11: {vxi11}"
f"\n - hislip: {hislip}"
)
class TCPIPInstrHiSLIP(Session):
"""A TCPIP Session built on socket standard library using HiSLIP protocol."""
# we don't decorate this class with Session.register() because we don't
# want it to be registered in the _session_classes array, but we still
# need to define session_type to make the set_attribute machinery work.
session_type = (constants.InterfaceType.tcpip, "INSTR")
# Override parsed to take into account the fact that this class is only used
# for a specific kind of resource
parsed: rname.TCPIPInstr
@staticmethod
def list_resources(wait_time=1.0) -> List[str]:
resources = []
try:
for host in get_services("_hislip._tcp.local.", wait_time=wait_time):
resources.append(f"TCPIP::{host}::hislip0,4880::INSTR")
except NotImplementedError:
warnings.warn(
"TCPIP::hislip resource discovery requires the zeroconf package "
"to be installed... try 'pip install zeroconf'",
UserWarning,
)
return sorted(resources)
def after_parsing(self) -> None:
# TODO: board_number not handled
if "," in self.parsed.lan_device_name:
sub_address, port_str = self.parsed.lan_device_name.split(",")
port = int(port_str)
else:
sub_address = self.parsed.lan_device_name
port = 4880
self.interface = hislip.Instrument(
self.parsed.host_address,
timeout=self.timeout,
port=port,
sub_address=sub_address,
)
# initialize the constant attributes
self.attrs[ResourceAttribute.dma_allow_enabled] = constants.VI_FALSE
self.attrs[ResourceAttribute.file_append_enabled] = constants.VI_FALSE
self.attrs[ResourceAttribute.interface_instrument_name] = "TCPIP0 (HiSLIP)"
self.attrs[ResourceAttribute.interface_number] = 0
self.attrs[ResourceAttribute.io_prot] = constants.VI_PROT_NORMAL
self.attrs[ResourceAttribute.read_buffer_operation_mode] = (
constants.VI_FLUSH_DISABLE
)
self.attrs[ResourceAttribute.resource_lock_state] = constants.VI_NO_LOCK
self.attrs[ResourceAttribute.send_end_enabled] = constants.VI_TRUE
self.attrs[ResourceAttribute.suppress_end_enabled] = constants.VI_FALSE
self.attrs[ResourceAttribute.tcpip_address] = self.parsed.host_address
self.attrs[ResourceAttribute.tcpip_device_name] = self.parsed.lan_device_name
self.attrs[ResourceAttribute.tcpip_hislip_overlap_enable] = constants.VI_FALSE
self.attrs[ResourceAttribute.tcpip_hislip_version] = 0x0010_0000
self.attrs[ResourceAttribute.tcpip_hostname] = self.parsed.host_address
self.attrs[ResourceAttribute.tcpip_is_hislip] = constants.VI_TRUE
self.attrs[ResourceAttribute.tcpip_nodelay] = constants.VI_TRUE
self.attrs[ResourceAttribute.tcpip_port] = port
self.attrs[ResourceAttribute.termchar] = ord("\n")
self.attrs[ResourceAttribute.termchar_enabled] = constants.VI_FALSE
self.attrs[ResourceAttribute.write_buffer_operation_mode] = (
constants.VI_FLUSH_WHEN_FULL
)
# configure the variable attributes
self.attrs[ResourceAttribute.tcpip_hislip_max_message_kb] = (
self.get_max_message_kb,
self.set_max_message_kb,
)
self.attrs[ResourceAttribute.tcpip_keepalive] = (
self.get_keepalive,
self.set_keepalive,
)
# TODO: additional attributes (someday)
# self.attrs[ResourceAttribute.manufacturer_id] = 16711
# self.attrs[ResourceAttribute.max_queue_length] = 50
# self.attrs[ResourceAttribute.read_buffer_size] = 4096
# self.attrs[ResourceAttribute.resource_impl_version] = 0x0050_0c01
# self.attrs[ResourceAttribute.resource_manufacturer_id] = 4015
# self.attrs[ResourceAttribute.resource_manufacturer_name] = 'Rohde & Schwarz GmbH'
# self.attrs[ResourceAttribute.resource_spec_version] = 0x0050_0800
# self.attrs[ResourceAttribute.user_data] = 0
# self.attrs[ResourceAttribute.write_buffer_size] = 4096
def get_max_message_kb(
self, attribute: ResourceAttribute
) -> Tuple[int, StatusCode]:
"""Get the maximum HiSLIP message size in kilobytes."""
max_msg_size_kb = int(round(self.interface.max_msg_size / 1024))
return max_msg_size_kb, StatusCode.success
def set_max_message_kb(
self, attribute: ResourceAttribute, size_kb: int
) -> StatusCode:
"""Set the maximum HiSLIP message size in kilobytes."""
if size_kb < 1:
raise ValueError("size must be >= 1 kilobyte")
if size_kb > 0xFFFF_FFFF:
raise ValueError("size exceeds the range in the VISA spec")
self.interface.max_msg_size = int(round(size_kb * 1024))
return StatusCode.success
def get_keepalive(self, attribute: ResourceAttribute) -> Tuple[bool, StatusCode]:
"""Is TCP keepalive enabled for the resource."""
return self.interface.keepalive, StatusCode.success
def set_keepalive(
self, attribute: ResourceAttribute, keepalive: bool
) -> StatusCode:
"""Turns TCP keepalive on/off for this connection."""
self.interface.keepalive = keepalive
return StatusCode.success
def close(self) -> StatusCode:
self.interface.close()
self.interface = None
return StatusCode.success
def _set_timeout(self, attribute: ResourceAttribute, value: int) -> StatusCode:
status = super()._set_timeout(attribute, value)
if hasattr(self.interface, "timeout"):
self.interface.timeout = 1e-3 * value
return status
def read(self, count: int) -> Tuple[bytes, StatusCode]:
"""Reads data from device or interface synchronously.
Corresponds to viRead function of the VISA library.
Parameters
-----------
count : int
Number of bytes to be read.
Returns
-------
bytes
Data read from the device
StatusCode
Return value of the library call.
"""
try:
data = self.interface.receive(count)
status = (
StatusCode.success_termination_character_read
if self.interface._rmt
else StatusCode.success_max_count_read
if len(data) >= count
else StatusCode.success
)
except socket.timeout:
data, status = b"", StatusCode.error_timeout
return data, status
def write(self, data: bytes) -> Tuple[int, StatusCode]:
"""Writes data to device or interface synchronously.
Corresponds to viWrite function of the VISA library.
Parameters
----------
data : bytes
Data to be written.
Returns
-------
int
Number of bytes actually transferred
StatusCode
Return value of the library call.
"""
self.interface.send(data)
return len(data), StatusCode.success
def clear(self) -> StatusCode:
"""Clears a device.
Corresponds to viClear function of the VISA library.
"""
self.interface.device_clear()
return StatusCode.success
def read_stb(self) -> Tuple[int, StatusCode]:
"""Reads a status byte of the service request.
Corresponds to viReadSTB function of the VISA library.
Returns
-------
int
Service request status byte
StatusCode
Return value of the library call.
"""
interface = cast(hislip.Instrument, self.interface)
# According to IVI-6.1 Rev.2 status query corresponds to viReadSTB.
stb = interface.async_status_query()
errorcode = StatusCode.success
return stb, errorcode
def _get_attribute(self, attribute: ResourceAttribute) -> Tuple[Any, StatusCode]:
"""Get the value for a given VISA attribute for this session.
Use to implement custom logic for attributes.
Parameters
----------
attribute : ResourceAttribute
Attribute for which the state query is made
Returns
-------
Any
State of the queried attribute for a specified resource
StatusCode
Return value of the library call.
"""
raise UnknownAttribute(attribute)
def _set_attribute(
self, attribute: ResourceAttribute, attribute_state: Any
) -> StatusCode:
"""Sets the state of an attribute.
Corresponds to viSetAttribute function of the VISA library.
Parameters
----------
attribute : constants.ResourceAttribute
Attribute for which the state is to be modified. (Attributes.*)
attribute_state : Any
The state of the attribute to be set for the specified object.
Returns
-------
StatusCode
Return value of the library call.
"""
raise UnknownAttribute(attribute)
class Vxi11CoreClient(vxi11.CoreClient):
"""
make a connection using vxi11 protocol, optionally allowing the port number
to be specified. although in general the port number must be obtained by
querying the portmapper, in practice any given instrument typically always
uses the same port number. this allows you to open that port on a firewall
or set up an ssh tunnel to that port.
"""
def __init__(
self, host: str, port: Optional[int], open_timeout: Optional[int] = 5000
) -> None:
self.packer = vxi11.Vxi11Packer()
self.unpacker = vxi11.Vxi11Unpacker(b"")
prog, vers = vxi11.DEVICE_CORE_PROG, vxi11.DEVICE_CORE_VERS
if port is None:
rpc.TCPClient.__init__(self, host, prog, vers, open_timeout)
else:
# bypass the portmapper lookup and use the specified port instead
rpc.RawTCPClient.__init__(self, host, prog, vers, port, open_timeout)
class TCPIPInstrVxi11(Session):
"""A TCPIP Session built on socket standard library using VXI-11 protocol."""
# we don't decorate this class with Session.register() because we don't
# want it to be registered in the _session_classes array, but we still
# need to define session_type to make the set_attribute machinery work.
session_type = (constants.InterfaceType.tcpip, "INSTR")
#: Maximum size of a chunk of data in bytes.
max_recv_size: int
#: Time to wait before erroring with a timeout when trying to acquire a lock
lock_timeout: int
#: Unique ID of the client used to authenticate messages.
client_id: int
#: ID of the link used for VXI-11 communication
link: int
# Override parsed to take into account the fact that this class is only used
# for a specific kind of resource
parsed: rname.TCPIPInstr
# Setting if keepalive has been activated
keepalive: bool
@staticmethod
def list_resources() -> List[str]:
broadcast_addr = []
if psutil is not None:
# Get broadcast address for each interface
for interface, snics in psutil.net_if_addrs().items():
for snic in snics:
if snic.family is socket.AF_INET:
addr = snic.address
mask = snic.netmask
network = ipaddress.IPv4Network(addr + "/" + mask, strict=False)
broadcast_addr.append(str(network.broadcast_address))
else:
# If psutil unavailable fallback to default interface
broadcast_addr.append("255.255.255.255")
warnings.warn(
"TCPIP:instr resource discovery is limited to the default interface."
"Install psutil: pip install psutil if you want to scan all interfaces.",
UserWarning,
)
pmap_list = [rpc.BroadcastUDPPortMapperClient(ip) for ip in broadcast_addr]
for pmap in list(pmap_list):
pmap.set_timeout(0)
try:
pmap.send_port(
(vxi11.DEVICE_CORE_PROG, vxi11.DEVICE_CORE_VERS, rpc.IPPROTO_TCP, 0)
)
except rpc.RPCError:
pmap_list.remove(pmap)
# Timeout for responses
time.sleep(1)
all_res = []
for pmap in pmap_list:
try:
resp = pmap.recv_port(
(vxi11.DEVICE_CORE_PROG, vxi11.DEVICE_CORE_VERS, rpc.IPPROTO_TCP, 0)
)
except rpc.RPCError:
pass
else:
res = [r[1][0] for r in resp if r[0] > 0]
res = sorted(
res, key=lambda ip: tuple(int(part) for part in ip.split("."))
)
# TODO: Detect GPIB over TCPIP
res = ["TCPIP::{}::INSTR".format(host) for host in res]
all_res.extend(res)
return all_res
def after_parsing(self) -> None:
# TODO: board_number not handled
host_address = self.parsed.host_address
if "," in host_address:
host_address, port_str = host_address.split(",")
port = int(port_str)
else:
port = None
try:
self.interface = Vxi11CoreClient(host_address, port, self.open_timeout)
except rpc.RPCError:
raise errors.VisaIOError(constants.VI_ERROR_RSRC_NFOUND)
# vxi11 expect all timeouts to be expressed in ms and should be integers
self.lock_timeout = 10000
self.client_id = random.getrandbits(31)
self.keepalive = False
error, link, abort_port, max_recv_size = self.interface.create_link(
self.client_id, 0, self.lock_timeout, self.parsed.lan_device_name
)
if error:
raise Exception("error creating link: %d" % error)
self.link = link
self.max_recv_size = min(max_recv_size, 2**30) # 1GB
self.attrs[ResourceAttribute.tcpip_is_hislip] = False
self.attrs[ResourceAttribute.tcpip_address] = self.parsed.host_address
self.attrs[ResourceAttribute.tcpip_hostname] = ""
self.attrs[ResourceAttribute.tcpip_device_name] = self.parsed.lan_device_name
for name in ("SEND_END_EN", "TERMCHAR", "TERMCHAR_EN"):
attribute = getattr(constants, "VI_ATTR_" + name)
self.attrs[attribute] = attributes.AttributesByID[attribute].default
def close(self) -> StatusCode:
try:
self.interface.destroy_link(self.link)
except (errors.VisaIOError, socket.error, rpc.RPCError) as e:
print("Error closing VISA link: {}".format(e))
self.interface.close()
self.link = 0
self.interface = None
return StatusCode.success
def read(self, count: int) -> Tuple[bytes, StatusCode]:
"""Reads data from device or interface synchronously.
Corresponds to viRead function of the VISA library.
Parameters
----------
count : int
Number of bytes to be read.
Returns
-------
bytes
Data read
StatusCode
Return value of the library call.
"""
if count < self.max_recv_size:
chunk_length = count
else:
chunk_length = self.max_recv_size
if self.get_attribute(ResourceAttribute.termchar_enabled)[0]:
term_char, _ = self.get_attribute(ResourceAttribute.termchar)
flags = vxi11.OP_FLAG_TERMCHAR_SET
else:
term_char = flags = 0
read_data = bytearray()
reason = 0
# Stop on end of message or when a termination character has been
# encountered.
end_reason = vxi11.RX_END | vxi11.RX_CHR
read_fun = self.interface.device_read
status = StatusCode.success
timeout = self._io_timeout
start_time = time.time()
while reason & end_reason == 0:
# Decrease timeout so that the total timeout does not get larger
# than the specified timeout.
timeout = max(0, timeout - int((time.time() - start_time) * 1000))
error, reason, data = read_fun(
self.link, chunk_length, timeout, self.lock_timeout, flags, term_char
)
if error == vxi11.ErrorCodes.io_timeout:
return bytes(read_data), StatusCode.error_timeout
elif error:
return bytes(read_data), StatusCode.error_io
read_data.extend(data)
count -= len(data)
if count <= 0:
status = StatusCode.success_max_count_read
break
chunk_length = min(count, chunk_length)
return bytes(read_data), status
def write(self, data: bytes) -> Tuple[int, StatusCode]:
"""Writes data to device or interface synchronously.
Corresponds to viWrite function of the VISA library.
Parameters
----------
data : bytes
Data to be written.
Returns
-------
int
Number of bytes actually transferred
StatusCode
Return value of the library call.
"""
try:
flags = 0
num = len(data)
offset = 0
while num > 0:
if num <= self.max_recv_size:
flags |= vxi11.OP_FLAG_END
block = data[offset : offset + self.max_recv_size]
error, size = self.interface.device_write(
self.link, self._io_timeout, self.lock_timeout, flags, block
)
if error == vxi11.ErrorCodes.io_timeout:
return offset, StatusCode.error_timeout
elif error or size < len(block):
return offset, StatusCode.error_io
offset += size
num -= size
return offset, StatusCode.success
except vxi11.Vxi11Error:
return 0, StatusCode.error_timeout
def _get_attribute(self, attribute: ResourceAttribute) -> Tuple[Any, StatusCode]:
"""Get the value for a given VISA attribute for this session.
Use to implement custom logic for attributes.
Parameters
----------
attribute :
Resource attribute for which the state query is made
Returns
-------
Any
The state of the queried attribute for a specified resource
StatusCode
Return value of the library call.
"""
# This is an abuse of the VISA standard
if attribute == constants.VI_ATTR_TCPIP_KEEPALIVE:
return self.keepalive, StatusCode.success
elif attribute == constants.VI_ATTR_SUPPRESS_END_EN:
raise NotImplementedError
raise UnknownAttribute(attribute)
def _set_attribute(
self, attribute: ResourceAttribute, attribute_state: Any
) -> StatusCode:
"""Sets the state of an attribute.
Corresponds to viSetAttribute function of the VISA library.
Parameters
----------
attribute : ResourceAttribute
Attribute for which the state is to be modified.
attribute_state : Any
The state of the attribute to be set for the specified object.
Returns
-------
StatusCode
Return value of the library call.
"""
# In case of an environment with idle socket garbage collection (like docker)
# sockets need to be kept alive. Set pyvisa.constants.ResourceAttribute.tcpip_keepalive to enable
# keepalive packets even for VXI11 protocol. To read more on this issue
# https://tech.xing.com/a-reason-for-unexplained-connection-timeouts-on-kubernetes-docker-abd041cf7e02
if attribute == constants.VI_ATTR_TCPIP_KEEPALIVE:
if attribute_state is True:
self.interface.sock.setsockopt(
socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1
)
self.interface.sock.setsockopt(
socket.IPPROTO_TCP, socket.TCP_KEEPIDLE, 60
)
self.interface.sock.setsockopt(
socket.IPPROTO_TCP, socket.TCP_KEEPINTVL, 60
)
self.interface.sock.setsockopt(
socket.IPPROTO_TCP, socket.TCP_KEEPCNT, 5
)
self.keepalive = True
elif attribute_state is False:
self.interface.sock.setsockopt(
socket.SOL_SOCKET, socket.SO_KEEPALIVE, 0
)
self.keepalive = False
else:
return StatusCode.error_nonsupported_format
return StatusCode.success
raise UnknownAttribute(attribute)
def assert_trigger(self, protocol: constants.TriggerProtocol):
"""Asserts software or hardware trigger.
Corresponds to viAssertTrigger function of the VISA library.
Parameters
----------
protocol : constants.TriggerProtocol
Trigger protocol to use during assertion. Only default is supported.
Returns
-------
StatusCode
Return value of the library call.
"""
# XXX make this nicer (either validate protocol or pass it)
error = self.interface.device_trigger(
self.link, 0, self.lock_timeout, self._io_timeout
)
return VXI11_ERRORS_TO_VISA[error]
def clear(self) -> StatusCode:
"""Clears a device.
Corresponds to viClear function of the VISA library.
"""
error = self.interface.device_clear(
self.link, 0, self.lock_timeout, self._io_timeout
)
return VXI11_ERRORS_TO_VISA[error]
def read_stb(self) -> Tuple[int, StatusCode]:
"""Reads a status byte of the service request.
Corresponds to viReadSTB function of the VISA library.
Returns
-------
int
Service request status byte
StatusCode
Return value of the library call.
"""
error, stb = self.interface.device_read_stb(
self.link, 0, self.lock_timeout, self._io_timeout
)
return stb, VXI11_ERRORS_TO_VISA[error]
def lock(
self,
lock_type: constants.Lock,
timeout: int,
requested_key: Optional[str] = None,
) -> Tuple[str, constants.StatusCode]:
"""Establishes an access mode to the specified resources.
Corresponds to viLock function of the VISA library.
Parameters
----------
session : VISASession
Unique logical identifier to a session.
lock_type : constants.Lock
Specifies the type of lock requested.
timeout : int
Absolute time period (in milliseconds) that a resource waits to get
unlocked by the locking session before returning an error.
requested_key : Optional[str], optional
Requested locking key in the case of a shared lock. For an exclusive
lock it should be None.
Returns
-------
Optional[str]
Key that can then be passed to other sessions to share the lock, or
None for an exclusive lock.
StatusCode
Return value of the library call.
"""
# TODO: lock type not implemented
flags = 0
error = self.interface.device_lock(self.link, flags, self.lock_timeout)
return "", VXI11_ERRORS_TO_VISA[error]
def unlock(self) -> constants.StatusCode:
"""Relinquish a lock for the specified resource.
Corresponds to viUnlock function of the VISA library.
Returns
-------
StatusCode
Return value of the library call.
"""
error = self.interface.device_unlock(self.link)
return VXI11_ERRORS_TO_VISA[error]
def _set_timeout(self, attribute: ResourceAttribute, value: int) -> StatusCode:
"""Sets timeout calculated value from python way to VI_ way"""
if value == constants.VI_TMO_INFINITE:
self.timeout = None
self._io_timeout = 2**32 - 1
elif value == constants.VI_TMO_IMMEDIATE:
self.timeout = 0
self._io_timeout = 0
else:
self.timeout = value / 1000.0
self._io_timeout = int(self.timeout * 1000)
return StatusCode.success
class TCPIPInstrVicp(Session):
"""VICP Session that uses pyvicp to do the low level communication."""
# Override parsed to take into account the fact that this class is only used
# for a specific kind of resource
parsed: rname.VICPInstr
@staticmethod
def list_resources(wait_time=1.0) -> List[str]:
resources = []
try:
services = get_services("_lxi._tcp.local.", wait_time=wait_time)
except NotImplementedError:
warnings.warn(
"VICP resources discovery requires the zeroconf package to be "
"installed... try 'pip install zeroconf'",
UserWarning,
)
return []
for host, properties in services.items():
if properties["Manufacturer"].lower().startswith("lecroy"):
resources.append(f"VICP::{host}::INSTR")
return sorted(resources)
def after_parsing(self) -> None:
# TODO: board_number not handled
if pyvicp is None:
raise NotImplementedError(
"VICP requires the pyvicp package to be installed... "
"try 'pip install pyvicp'"
)
host_address = self.parsed.host_address
if "," in host_address:
host_address, port_str = host_address.split(",")
port = int(port_str)
else:
port = 1861
self.interface = pyvicp.Client(
self.parsed.host_address, port, timeout=self.timeout
)
# initialize the constant attributes
for name in ("SEND_END_EN", "TERMCHAR", "TERMCHAR_EN"):
attribute = getattr(constants, "VI_ATTR_" + name)
self.attrs[attribute] = attributes.AttributesByID[attribute].default
self.attrs[ResourceAttribute.dma_allow_enabled] = constants.VI_FALSE
self.attrs[ResourceAttribute.file_append_enabled] = constants.VI_FALSE
self.attrs[ResourceAttribute.interface_instrument_name] = "TCPIP0 (VICP)"
self.attrs[ResourceAttribute.interface_number] = 0
self.attrs[ResourceAttribute.io_prot] = constants.VI_PROT_NORMAL
self.attrs[ResourceAttribute.read_buffer_operation_mode] = (
constants.VI_FLUSH_DISABLE
)
self.attrs[ResourceAttribute.resource_lock_state] = constants.VI_NO_LOCK
self.attrs[ResourceAttribute.suppress_end_enabled] = constants.VI_FALSE
self.attrs[ResourceAttribute.tcpip_address] = self.parsed.host_address
self.attrs[ResourceAttribute.tcpip_hostname] = self.parsed.host_address
self.attrs[ResourceAttribute.tcpip_is_hislip] = constants.VI_FALSE
self.attrs[ResourceAttribute.tcpip_nodelay] = constants.VI_TRUE
self.attrs[ResourceAttribute.tcpip_port] = port
self.attrs[ResourceAttribute.write_buffer_operation_mode] = (
constants.VI_FLUSH_WHEN_FULL
)
# configure the variable attributes
self.attrs[ResourceAttribute.tcpip_keepalive] = (
self.get_keepalive,
self.set_keepalive,
)
# TODO: additional attributes (someday)
# self.attrs[ResourceAttribute.manufacturer_id] = 16711
# self.attrs[ResourceAttribute.max_queue_length] = 50
# self.attrs[ResourceAttribute.read_buffer_size] = 4096
# self.attrs[ResourceAttribute.resource_impl_version] = 0x0050_0c01
# self.attrs[ResourceAttribute.resource_manufacturer_id] = 4015
# self.attrs[ResourceAttribute.resource_manufacturer_name] = 'Rohde & Schwarz GmbH'
# self.attrs[ResourceAttribute.resource_spec_version] = 0x0050_0800
# self.attrs[ResourceAttribute.user_data] = 0
# self.attrs[ResourceAttribute.write_buffer_size] = 4096
def get_keepalive(self, attribute: ResourceAttribute) -> Tuple[bool, StatusCode]:
"""Is TCP keepalive enabled for the resource."""
return self.interface.keepalive, StatusCode.success
def set_keepalive(
self, attribute: ResourceAttribute, keepalive: bool
) -> StatusCode:
"""Turns TCP keepalive on/off for this connection."""
self.interface.keepalive = keepalive
return StatusCode.success
def close(self) -> StatusCode:
self.interface.close()
self.interface = None
return StatusCode.success
def read(self, count: int) -> Tuple[bytes, StatusCode]:
"""Reads data from device or interface synchronously.
Corresponds to viRead function of the VISA library.
Parameters
-----------
count : int
Number of bytes to be read.
Returns
-------
bytes
Data read from the device
StatusCode
Return value of the library call.
"""
try:
data = self.interface.receive(count)
except socket.timeout:
return b"", StatusCode.error_timeout
if len(data) >= count:
return data, StatusCode.success_max_count_read
else:
return data, StatusCode.success_termination_character_read
def write(self, data: bytes) -> Tuple[int, StatusCode]:
"""Writes data to device or interface synchronously.
Corresponds to viWrite function of the VISA library.
Parameters
----------
data : bytes
Data to be written.
Returns
-------
int
Number of bytes actually transferred
StatusCode
Return value of the library call.
"""
self.interface.send(data)
return len(data), StatusCode.success
def clear(self) -> StatusCode:
"""Clears a device.
Corresponds to viClear function of the VISA library.
"""
self.interface.device_clear()
return StatusCode.success
def _set_timeout(self, attribute: ResourceAttribute, value: int) -> StatusCode:
status = super()._set_timeout(attribute, value)
if hasattr(self.interface, "timeout"):
self.interface.timeout = 1e-3 * value
return status
def _get_attribute(self, attribute: ResourceAttribute) -> Tuple[Any, StatusCode]:
"""Get the value for a given VISA attribute for this session.
Use to implement custom logic for attributes.