1lxi(1)                           User Commands                          lxi(1)
2
3
4

NAME

6       lxi - a tool for managing 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 <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       -r, --raw
79              Use raw/TCP protocol
80
81

SCREENSHOT OPTIONS

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

BENCHMARK OPTIONS

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

EXAMPLES

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

WEBSITE

161       Visit https://lxi-tools.github.io
162
163

AUTHOR

165       Written by Martin Lund <martin.lund@keep-it-simple.com>
166
167
168
169lxi-tools 2.7                     2023-02-21                            lxi(1)