1PYTHONVXI11(1) Python VXI11 PYTHONVXI11(1)
2
6 pythonvxi11 - Python VXI11 Documentation
7 This Python package supports the VXI-11 Ethernet instrument control
9 protocol for controlling VXI11 and LXI compatible instruments.
10 See also:
12 · Python VXI11 home page
14 · GitHub repository
16 Contents:
18
20 Overview
21 This Python package supports the VXI-11 Ethernet instrument control
22 protocol for controlling VXI11 and LXI compatible instruments. The
23 implementation is pure Python and highly portable.
24 It is released under the MIT license, see LICENSE for more details.
26 Copyright (c) 2012-2017 Alex Forencich and Michael Walle
28 See also:
30 · Python VXI11 home page
32 · GitHub repository
34 Features
36 · Supports Python 2 and Python 3
37 · Pure Python
39 · Highly portable
41 · Communicates with instruments over the VXI11 TCP/IP instrument con‐
43 trol protocol
44 Requirements
46 · Python 2 or Python 3
47 Installation
49 To install the module for all users on the system, administrator rights
50 (root) are required.
51 From source
53 Download the archive, extract, and run:
54 python setup.py install
56 Packages
58 There are also packaged versions for some Linux distributions:
59 Arch Linux
61 Python VXI11 is available under the name “python-vxi11-git” in
62 the AUR.
63
65 Opening a connection
66 Connect to an Agilent MSO7104A oscilloscope on IP address
67 192.168.1.104:
68 >>> import vxi11
70 >>> instr = vxi11.Instrument("192.168.1.104")
71 >>> print(instr.ask("*IDN?"))
72 'AGILENT TECHNOLOGIES,MSO7104A,MY********,06.16.0001'
73 Connect to an Agilent E3649A via an HP 2050A GPIB bridge:
75 >>> import vxi11
77 >>> instr = vxi11.Instrument("192.168.1.105", "gpib,5")
78 >>> print(instr.ask("*IDN?"))
79 'Agilent Technologies,E3649A,0,1.4-5.0-1.0'
80 Configuring connections
82 Open a connection and set the timeout:
83 >>> import vxi11
85 >>> instr = vxi11.Instrument("192.168.1.104")
86 >>> instr.timeout = 60*1000
87 >>> print(instr.ask("*TST?"))
88 '0'
89
91 This module provides a VXI11 TCP/IP instrument driver.
92 Functions and Exceptions
94 exception vxi11.Vxi11Error
95 Exception raised on various occasions; argument is a string
96 describing what is wrong.
97 Instrument class
99 class vxi11.Instrument(host, name=None, client_id=None, term_char=None)
100 VXI-11 instrument interface client
101 local()
103 Send local command
104 read_stb()
106 Read status byte
107 remote()
109 Send remote command
110
112 License
113 Copyright (c) 2012-2017 Alex Forencich and Michael Walle
114 Permission is hereby granted, free of charge, to any person obtaining a
116 copy of this software and associated documentation files (the “Soft‐
117 ware”), to deal in the Software without restriction, including without
118 limitation the rights to use, copy, modify, merge, publish, distribute,
119 sublicense, and/or sell copies of the Software, and to permit persons
120 to whom the Software is furnished to do so, subject to the following
121 conditions:
122 The above copyright notice and this permission notice shall be included
124 in all copies or substantial portions of the Software.
125 THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS
127 OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MER‐
128 CHANTABILITY FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
129 NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
130 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
131 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFT‐
132 WARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
133 · genindex
135 · modindex
137 · search
139
141 Alex Forencich
142
144 2013, Alex Forencich
1450.1 Jul 15, 2018 PYTHONVXI11(1)