lxi

Discover LXI devices on available networks

$ lxi discover

$ lxi screenshot [[-a|--address]] [ip_address]

$ lxi screenshot [[-a|--address]] [ip_address] [[-p|--plugin]] [rigol-1000z]

$ lxi scpi [[-a|--address]] [ip_address] "[*IDN?]"

$ lxi benchmark [[-a|--address]] [ip_address]

The lxi command typically functions as a dispatcher for various subcommands, each performing a specific task.
lxi [options] subcommand [subcommand_options]

-v, --verbose
    Enables verbose output, providing more detailed information about the command's execution and network interactions. This is useful for debugging and understanding the communication flow.

-d, --debug
    Enables debug output, which provides even more detailed information than verbose mode, often including low-level communication data. This option is primarily intended for developers and deep troubleshooting.

-h, --help
    Displays a brief help message and exits. When used as lxi --help, it shows global options. When used as lxi subcommand --help, it provides help specific to that subcommand.

-V, --version
    Shows the program's version number and exits.

lxi is the primary command-line interface for the lxi-tools suite, an open-source collection of software designed for controlling LXI (LAN eXtensions for Instrumentation) compatible devices. LXI is an Ethernet-based communication standard predominantly used in test and measurement instruments. The lxi command enables users to perform various operations directly from the command line, including discovering LXI instruments on a network, querying their status, sending SCPI (Standard Commands for Programmable Instruments) commands, and interacting with their low-level protocols. It provides a flexible and scriptable method for automating complex measurement setups in laboratory and industrial environments, leveraging the speed and reliability of Ethernet for instrument communication.

lxi is not a standard, pre-installed Linux command; it requires the installation of the lxi-tools package. Its functionality is dependent on the presence of LXI-compatible test and measurement instruments on the network. The command itself is primarily a dispatcher; most practical operations are performed through its various subcommands, each with its own set of options and usage patterns.

The lxi command functions as a dispatcher for various specific operations, each handled by a distinct subcommand. Key subcommands include:
discover: Scans the local network for available LXI instruments and displays their details.
instrument: Provides detailed information, status, and control options for a specified LXI instrument.
scpi: Allows sending Standard Commands for Programmable Instruments (SCPI) directly to an instrument and receiving responses.
vxi11: Offers low-level access to the VXI-11 protocol, useful for advanced diagnostics or custom communication.
Each subcommand has its own specific set of options and arguments, which can be explored by running lxi subcommand --help.

The lxi-tools project emerged as an open-source initiative to address the need for a free and accessible way to control LXI-compatible test and measurement instruments. Historically, controlling such devices often relied on proprietary software or expensive commercial solutions. The project aims to democratize instrument control by providing a robust command-line interface and library that integrates seamlessly into standard Linux environments. Its development is community-driven, focusing on interoperability, stability, and ease of use for engineers and researchers working with modern laboratory equipment, filling a significant gap in open-source instrument automation.

ping(8), nmap(1), ip(8)