Skip to main content

Typed Python API for test-and-measurement instruments: power supplies, multimeters, electronic loads, DAQs, and more

Project description

⟢ instro

Python library for talking to test-and-measurement instruments (power supplies, multimeters, electronic loads, DAQs, oscilloscopes, PLCs) from a unified, typed API.

PyPI Downloads Docs SDK Community

Quickstart

Talk to a simulated PSU. No hardware required.

# Terminal 1: start the in-process SCPI sim server:
uv run python -m instro.psu.scpi_sim_server
# Terminal 2: run this:
from instro.psu import InstroPSU
from instro.psu.drivers import SimulatedPSU

with InstroPSU(
    name="my-psu",
    driver=SimulatedPSU("TCPIP0::127.0.0.1::5025::SOCKET"),
    num_channels=2,
) as psu:
    psu.set_voltage(3.3, channel=1)
    psu.output_enable(True, channel=1)
    print(psu.get_voltage(channel=1))

That's the whole loop: construct, open(), configure, measure, close(). When you want to capture the data, attach a publisher to stream it to a file, a custom destination, or Nominal. For the full walkthrough (including the background polling daemon and publishers), see the official documentation.

Installation

pip install instro

Requires Python 3.10 to 3.13.

To work on instro itself, clone and install with uv:

git clone https://github.com/nominal-io/instro.git
cd instro
uv sync --extra all

This creates a virtual environment with the core library, all optional vendor drivers, and dev dependencies. Run with uv run python your_script.py or activate via source .venv/bin/activate (Unix) / .venv\Scripts\activate (Windows).

For the full toolchain needed to run just check and just test (including the native Rust/CMake/LLVM dependencies that just test requires), see Prerequisites in the contributing guide.

Optional Extras

Instro drivers that require a separate vendor sdk installation ship as separate packages so the heavy dependencies stay optional, and community-contributed drivers ship in their own package. Install only what you need:

Extra Pulls in Package
instro[nidaq] NI-DAQmx (Linux + Windows) PyPI
instro[labjack] LabJack LJM PyPI
instro[mccdaq] MCC UL (Windows-only) PyPI
instro[aardvark] Total Phase Aardvark (I2C) PyPI
instro[ethernetip] EtherNet/IP support for Allen-Bradley PLCs PyPI
instro[contrib] Community-contributed hardware drivers PyPI
instro[unstable] In-development features whose API isn't settled PyPI
instro[all] Everything above

Pass the extra package name in brackets to pip install:

pip install "instro[labjack]"
pip install "instro[nidaq,contrib]"

Supported devices

Category Class Vendors
Power Supply InstroPSU B&K Precision (9115, 914X), Keysight (E36100-series), Rigol (DP800-series), Siglent (SPD3303), TDK Lambda (Genesys), simulated
Multimeter InstroDMM Agilent 34401A, Keithley 2400
Electronic Load InstroELoad B&K Precision (85xxB-series)
Oscilloscope InstroScope Keysight (1200X-series), Tektronix (2-series), Siglent (SDS1000X-E)
DAQ InstroDAQ Keysight 34980A, NI-DAQmx, LabJack T-series, MCC USB-series
I2C I2CInterface Total Phase Aardvark
Modbus ModbusDevice Any Modbus TCP / RTU device
EtherNet/IP EtherNetIPDevice Allen-Bradley / CompactLogix-class PLCs

Don't see your vendor? Drivers the maintainers can't test directly land in instro-contrib. Install them with instro[contrib]. See CONTRIBUTING.md for the verification expectations.

Contributing

  • Humans: see CONTRIBUTING.md for development setup, PR conventions, and where different kinds of contributions belong in the workspace.
  • AI coding tools (Claude Code, Cursor, Codex, Copilot Workspace, …): see AGENTS.md for codebase landmarks, conventions, and common workflows. The repo ships reusable skills and subagents for both Claude Code (.claude/) and Codex CLI (.agents/, .codex/). The existing skills are add-instrument-driver which scaffolds a new vendor driver from a programming manual/API, and validate-driver-hardware which smoke-tests an authored driver against the real instrument and self-corrects it. See Repo skills and subagents.

License

Apache License 2.0. Third-party dependency notices and proprietary vendor runtime requirements are documented in NOTICE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

instro-1.1.0.tar.gz (886.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

instro-1.1.0-py3-none-any.whl (134.0 kB view details)

Uploaded Python 3

File details

Details for the file instro-1.1.0.tar.gz.

File metadata

  • Download URL: instro-1.1.0.tar.gz
  • Upload date:
  • Size: 886.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for instro-1.1.0.tar.gz
Algorithm Hash digest
SHA256 f6b4f57becffd3523922e66bba73937d597b4dbaa4517e18a6baf1a89b1e2340
MD5 a90e67eddd70d1d7e43d8a679211fc3e
BLAKE2b-256 028008930027aef66c01297c30ca769ef24904e88b61cd0b13fd31cd82140001

See more details on using hashes here.

Provenance

The following attestation bundles were made for instro-1.1.0.tar.gz:

Publisher: release-please-publish.yml on nominal-io/instro

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file instro-1.1.0-py3-none-any.whl.

File metadata

  • Download URL: instro-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 134.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for instro-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 09f8e92dd0c22d29531551094e53be8c8410b75c086a09256dc486d7a433dff4
MD5 0d7e665c95e6fa488482a5d3bba1d87e
BLAKE2b-256 b72e4cca80122c9f8853c25065e4b9d9129bca09e7b199694739e2283f0e6a3d

See more details on using hashes here.

Provenance

The following attestation bundles were made for instro-1.1.0-py3-none-any.whl:

Publisher: release-please-publish.yml on nominal-io/instro

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page