lxi(1)

📦
version 2.8 · 5 versions
, in debian trixie, nixos 26.05, nixpkgs unstable, ubuntu questing, ubuntu resolute, ubuntu stonking

💖 lxi(1) — bestie's guide to the lxi command 💖

okay so real talk: this is the manual page for lxi, a User Commands situation, and it's literally your group chat with every LXI instrument you own. pull up a chair 🫶

✨ NAME ✨

lxi — a tool for managing LXI compatible instruments.

🌸 SYNOPSIS 🌸

lxi [--help] [--version] <command> [<args>]

🦋 DESCRIPTION 🦋

lxi is a commandline tool for controlling LXI compatible instruments such as modern oscilloscopes, power supplies, spectrum analyzers, etc. no cap, it's giving lab-bench main character energy ✨

💅 OPTIONS 💅

  • -h, --help — Display help. when you're lost, she's got you 🥺
  • -v, --version — Display program version. the "who even am i" button 🎀

👑 COMMANDS 👑

  • discover [<options>] — Search available networks for LXI devices. it's giving detective 🕵️‍♀️
  • scpi [<options>] <scpi-command> — Send SCPI command. say it with your chest 💬
  • screenshot [<options>] [<filename>] — Capture screenshot. 📸
  • benchmark [<options>] — Benchmark. let's see what you're working with 💀
  • run <filename> — Run Lua script. 🧚

🎀 DISCOVER OPTIONS 🎀

  • -t, --timeout <seconds> — Timeout in seconds. patience is a virtue bestie ⏳
  • -m, --mdns — Search via mDNS/DNS-SD. the fancy discovery route ✨

🔥 SCPI OPTIONS 🔥

  • -a, --address <ip> — IP address of LXI device. who are we talking to 👀
  • -p, --port — Use port.
  • -t, --timeout <seconds> — Timeout in seconds. ⏳
  • -x, --hex — Print response in hexadecimal. nerd mode activated 🧮
  • -i, --interactive — Enter interactive mode. she wants a conversation 💬
  • -r, --raw — Use raw/TCP protocol. no filter, just vibes 🌈

🌈 SCREENSHOT OPTIONS 🌈

  • -a, --address <ip> — IP address of LXI device.
  • -t, --timeout <seconds> — Timeout in seconds. ⏳
  • -p, --plugin <name> — Use screenshot plugin by name. pick your fighter 💅
    • If this option is omitted the tool will automatically try to select the most suitable plugin. she'll choose for you, trust 🤝
  • -l, --list — List available screenshot plugins. the menu 🍓
To write screenshot image to stdout simply use '-' as the output filename. yes literally a dash, iconic behavior

⭐ BENCHMARK OPTIONS ⭐

  • -a, --address <ip> — IP address of LXI device.
  • -p, --port — Use port.
  • -t, --timeout <seconds> — Timeout in seconds. ⏳
  • -c, --count <count> — Number of request messages. how many times we goin' 🔁
  • -r, --raw — Use raw/TCP protocol. 🌈

🧚 EXAMPLES 🧚

Search for LXI instruments:

lxi discover

Search for LXI instruments using mDNS/DNS-SD:

lxi discover --mdns

Send SCPI command:

lxi scpi --address 10.0.0.42 "*IDN?"

Send SCPI command and dump response to file:

lxi scpi --address 10.0.0.42 "*IDN?" > response.txt

Capture screenshot from a Rigol 1000Z series oscilloscope:

lxi screenshot --address 10.0.0.42 --plugin rigol-1000z

Or by using screenshot plugin autodetection simply:

lxi screenshot --address 10.0.0.42
Note: Some LXI devices are slow to process SCPI commands, in which case you might need to take care to increase the timeout value. fr fr, don't blame the tool, blame the instrument 😭

🫶 WEBSITE 🫶

Visit https://lxi-tools.github.io — go say hi, she's lovely 💖

💜 AUTHOR 💜

Written by Martin Lund <martin.lund@keep-it-simple.com>

and that's the whole page bestie 🎀 this one shipped as part of lxi-tools, dated 2024-11-30, and it lives in section lxi(1) of the manual. mwah 💋 slay, go talk to your oscilloscope 🦋✨

📦 where this page comes from