SCPI Instrument Control

Drive your whole bench from Python. Oscilloscopes, function generators, power supplies, and DAQ units — one API, over LAN, USB, GPIB, or serial.

Point it at an IP address and it identifies the instrument, picks the right SCPI dialect, and gets out of your way. Or point it at nothing at all: the built-in mock synthesizes real waveforms so you can write and test the entire acquisition pipeline with an empty bench.

Try it with no instrument on your desk

pip install SCPI-Instrument-Control

from scpi_control.connection import MockConnection
from scpi_control.oscilloscope import Oscilloscope
from scpi_control.signal_synth import SignalSpec

# A virtual SDS1104X-E probing a 3.3 V, 1 kHz logic clock.
scope = Oscilloscope("mock", connection=MockConnection(
    "mock",
    channel_states={1: True},
    signals={1: SignalSpec(kind="square", frequency=1000.0, amplitude=1.65, offset=1.65)},
    sample_rate=20e6,
    timebase=500e-6,
))
scope.connect()

wf = scope.get_waveform(channel=1)
print(f"{len(wf.time)} samples")
print(f"Vpp  {wf.voltage.max() - wf.voltage.min():.3f} V")
print(f"Freq {scope.measurement.measure_frequency(1):.2f} Hz")

14000 samples
Vpp  3.280 V
Freq 1000.00 Hz

Those are the same 3.28 V rails as the real SDS824X HD calibration square wave further down this page — captured with nothing plugged in. The mock is not a stub replaying a canned buffer: every sample is computed from the scope's current timebase, volts/division, offset, and trigger state, so the capture window follows the timebase, the code grid quantizes the way an 8-bit digitizer does, and free-running acquisitions drift in phase like a real one. Your CI can exercise the full stack with nothing plugged in.

Captures become reports

Annotate a plot with callouts, reference lines and shaded windows, and both the PDF and Markdown generators render them — here the code, then the plots it produced:

# wf: a WaveformData just captured from the scope. Coordinates below are in
# DOMAIN units -- seconds here, hertz on an FFT plot -- never display units.
wf.annotations = [
    PlotAnnotation(kind=KIND_VLINE, text="trigger", x=1e-3),
    PlotAnnotation(kind=KIND_LABEL, text="overshoot", x=1.03e-3, y=3.75),
    PlotAnnotation(kind=KIND_HLINE, text="3.3 V nominal", y=3.3),
    PlotAnnotation(kind=KIND_SPAN, text="settling", x=1e-3, x_end=2.4e-3),
]
wf.caption = "Figure 1: C1 step response, 10x probe"

# A region zoom carries no annotations of its own -- it inherits the parent's,
# clipped to its own window.
wf.add_region(0.9e-3, 2.2e-3, label="Settling")

MarkdownReportGenerator().generate(report, out / "report.md")

# FFT plots, overlays, styling and sidecars: examples/report_annotations_advanced.py

wf and report come from the capture and report setup around it — examples/report_annotations_advanced.py is the whole thing, runnable with no instrument attached.

What you get

Honest about limits

This project would rather raise than invent a number. Setting a trigger type a scope's dialect cannot express raises FeatureNotSupportedError instead of silently leaving the instrument as it was; a PSU without a documented protection subsystem refuses ovp_level rather than sending a command the firmware discards. Tektronix and LeCroy command tables were verified line-by-line against the vendor programming manuals and exercised against a dialect-aware mock, but have not yet been run against physical Tektronix or LeCroy hardware — the Siglent path has.

Install

pip install SCPI-Instrument-Control          # core: capture + analysis
pip install "SCPI-Instrument-Control[all]"   # everything below

Requires Python 3.9+. The core install needs only NumPy, SciPy, and Matplotlib.

Then point it at real hardware

Not a mockup — a live screen grab pulled over LAN from a Siglent SDS824X HD with scope.screen_capture.get_screenshot_pil().

from scpi_control import Oscilloscope

scope = Oscilloscope("192.168.1.100")   # dialect auto-detected from *IDN?
scope.connect()

scope.channel1.enable()
scope.channel1.voltage_scale = 1.0      # V/div
scope.channel1.coupling = "DC"

scope.trigger.set_edge_trigger(source="C1", slope="POS")
scope.trigger.level = 1.0

wf = scope.get_waveform(channel=1)
scope.waveform.save_waveform(wf, "capture.npz")   # provenance travels with it

scope.disconnect()

Ask the instrument what it can actually do before you ask it to do something:

caps = scope.capabilities
print(caps.trigger_types, caps.channel_couplings)

Batch sweeps, continuous logging, and trigger-driven capture live in scpi_control.automation — see the automation guide.

The desktop GUI

pip install "SCPI-Instrument-Control[gui]"
siglent-gui

Two channels live. This one is the mock again — the desktop app runs hardware-free too.

FFT of that square wave — the odd-harmonic comb, peaks picked out at 1, 3, and 5 kHz.

A live view that holds 5–20 fps on four channels, measurement markers you drag directly onto the trace, cursors, FFT, math channels, reference-waveform overlays, and a raw SCPI terminal for when you need to talk to the instrument yourself. Dedicated tabs connect to a power supply or a DAQ / data logger alongside the scope.

Software protocol decoding covers I2C, SPI, and UART.

→ Full GUI guide

The browser lab gateway

pip install "SCPI-Instrument-Control[web]"
scpi-web                    # prints its URL on every start
scpi-web invite alice       # a 10-minute link + code for a colleague

Run one gateway on the bench machine and reach your instruments from any browser on the LAN — live traces, screenshots, measurements, server-side FFT and filters, and ~1 Hz measurement logging with CSV export. GET /api/discover sweeps the subnet for instruments when DHCP moves them.

Every request needs a token, each session has an owner (owner writes, everyone else watches), and outbound connection targets are validated. The admin panel binds loopback only. It does not terminate TLS — keep it on a trusted network or behind a reverse proxy.

→ Gateway guide · Security model

Automated test reports

pip install "SCPI-Instrument-Control[report-generator]"

Turn captures into PDF or Markdown reports with plots, signal classification, 25+ statistics, pass/fail criteria, and a SHA-256 manifest of the raw data. Comparison and batch modes handle before/after runs and multi-DUT yield tables. Analysis text can be generated by a local LLM through Ollama — on your machine, no cloud provider, no API key.

See example_reports/ for generated samples, including one with LLM analysis.

→ Report generator guide

Supported instruments

Other SCPI instruments generally work: model-specific behavior comes from the ModelCapability registry, and unrecognized models fall back to a conservative profile for their vendor with a logged warning.

→ SCPI dialects and per-vendor gaps

Command-line tools

Documentation

• Full documentation — guides, tutorials, API reference
• Quick start · Connecting an instrument
• Interactive tutorial — Jupyter notebook, step by step
• 31 runnable examples — 14 of them run with no instrument attached
• Changelog · Security policy

Upgrading? import siglent became import scpi_control in v1.0.0 and the compatibility shim was removed in v2.0.0; the API is otherwise identical. Pin SCPI-Instrument-Control<2.0 if you cannot migrate yet. The v4.x → 5.0 gateway now requires a token — see the security guide.

Contributing

Issues and pull requests are welcome — see the Contributing Guide.

git clone https://github.com/little-did-I-know/SCPI-Instrument-Control.git
cd SCPI-Instrument-Control
make dev-setup
make check

License

MIT — see LICENSE.