1lxi(1)                      General Commands Manual                     lxi(1)
2
3
4

NAME

6       lxi - a tool for controlling LXI compatible instruments.
7
8

SYNOPSIS

10       lxi [--help] [--version] <command> [<args>]
11
12

DESCRIPTION

14       lxi  is  a  commandline tool for controlling LXI compatible instruments
15       such as modern oscilloscopes, power supplies, spectrum analyzers, etc.
16
17

OPTIONS

19       -h, --help
20              Display help
21
22
23       -v, --version
24              Display program version
25
26

COMMANDS

28       discover [<options>]
29              Search available networks for LXI devices
30
31
32       scpi [<options>] <SCPI-command>
33              Send SCPI command
34
35
36       screenshot [<options>] [<filename>]
37              Capture screenshot
38
39
40       benchmark [<options>]
41              Benchmark
42
43
44       run [<options>] <filename>
45              Run Lua script
46
47

DISCOVER OPTIONS

49       -t, --timeout <seconds>
50              Timeout in seconds
51
52
53       -m, --mdns
54              Search via mDNS/DNS-SD
55
56

SCPI OPTIONS

58       -a, --address <ip>
59              IP address of LXI device
60
61
62       -p, --port
63              Use port
64
65
66       -t, --timeout <seconds>
67              Timeout in seconds
68
69
70       -x, --hex
71              Print response in hexadecimal
72
73
74       -i, --interactive
75              Enter interactive mode
76
77
78       -s, --script <filename>
79              Run script (plain text file with one SCPI command per line)
80
81
82       -r, --raw
83              Use raw/TCP protocol
84
85

SCREENSHOT OPTIONS

87       -a, --address <ip>
88              IP address of LXI device
89
90
91       -t, --timeout <seconds>
92              Timeout in seconds
93
94
95       -p, --plugin <name>
96              Use screenshot plugin by name
97
98              If this option is omitted the tool  will  automatically  try  to
99              select the most suitable plugin.
100
101       -l, --list
102              List available screenshot plugins
103
104
105       To  write screenshot image to stdout simply use '-' as the output file‐
106       name.
107
108

BENCHMARK OPTIONS

110       -a, --address <ip>
111              IP address of LXI device
112
113
114       -p, --port
115              Use port
116
117
118       -t, --timeout <seconds>
119              Timeout in seconds
120
121
122       -c, --count <count>
123              Number of request messages
124
125
126       -r, --raw
127              Use raw/TCP protocol
128
129

RUN OPTIONS

131       -t, --timeout <seconds>
132              Timeout in seconds
133
134

EXAMPLES

136       Search for LXI instruments:
137
138              lxi discover
139
140
141       Search for LXI instruments using mDNS/DNS-SD:
142
143              lxi discover --mdns
144
145
146       Send SCPI command:
147
148              lxi scpi --address 10.0.0.42 "*IDN?"
149
150
151       Send SCPI command and dump response to file:
152
153              lxi scpi --address 10.0.0.42 "*IDN?" > response.txt
154
155
156       Capture screenshot from a Rigol 1000Z series oscilloscope:
157
158              lxi screenshot --address 10.0.0.42 --plugin rigol-1000z
159
160              Or by using screenshot plugin autodetection simply:
161
162              lxi screenshot --address 10.0.0.42
163
164
165       Note: Some LXI devices are slow to process SCPI commands, in which case
166       you might need to take care to increase the timeout value.
167
168

WEBSITE

170       Visit https://lxi-tools.github.io
171
172

AUTHOR

174       Written by Martin Lund <martin.lund@keep-it-simple.com>
175
176
177
178                                  March 2018                            lxi(1)
Impressum