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

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).

Optional extras

Native-SDK drivers ship as separate workspace packages so the heavy dependencies stay optional, and community-contributed drivers ship in their own package. Install only what you need:

Extra Pulls in
instro[nidaq] NI-DAQmx (Linux + Windows)
instro[labjack] LabJack LJM
instro[mccdaq] MCC UL (Windows-only)
instro[daq] All three DAQ vendor SDKs
instro[aardvark] Total Phase Aardvark (I2C); alias: instro[i2c]
instro[contrib] Community-contributed drivers for devices the maintainers can't verify directly
instro[all] Everything above

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.output_enable(True, channel=1)
    psu.set_voltage(3.3, channel=1)
    print(psu.get_voltage(channel=1))  # Measurement(channel_data={'my-psu.ch1.voltage': [3.31...]}, ...)

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.

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)
DAQ InstroDAQ Keysight 34980A, NI-DAQmx, LabJack T-series, MCC USB-series
I2C I2CInterface Total Phase Aardvark
Modbus ModbusDevice Any Modbus TCP / RTU device

Don't see your vendor? Drivers the maintainers can't verify directly against the device land in instro-contrib on contributor verification — install them with instro[contrib]. See CONTRIBUTING.md for the bar.

Experimental modules

In-development categories whose APIs may break between releases live in the separate instro-unstable workspace package:

  • InstroScope: oscilloscope category, with drivers for Keysight 1200x, Tektronix 2-series, and Siglent SDS1000X-E. Import via instro.unstable.scope.
  • EtherNetIPDevice: EtherNet/IP / CIP support for CompactLogix-class PLCs. Import via instro.unstable.ethernetip.

Opt in by depending on instro-unstable explicitly. EtherNet/IP uses an optional native backend; install it with instro-unstable[ethernetip].

Documentation

Full guides, API reference, and per-category walkthroughs live at instro.nominal.io.

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-0.13.0.tar.gz (652.3 kB view details)

Uploaded Source

Built Distribution

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

instro-0.13.0-py3-none-any.whl (110.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for instro-0.13.0.tar.gz
Algorithm Hash digest
SHA256 af57e4d38da844cb16c13b9f4ea97f106aada932ef78cc2a12d7961e6c022c5c
MD5 52f6a553adce336011b435fd3c7c5cb9
BLAKE2b-256 3881ad2b54ab8bcb81a2e4ff70e048f60ead8466f6a86031781b3124ebee71d4

See more details on using hashes here.

Provenance

The following attestation bundles were made for instro-0.13.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-0.13.0-py3-none-any.whl.

File metadata

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

File hashes

Hashes for instro-0.13.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2a41f5301a07f0d2f38d35780ad3a4dacdfaff11862dfb1444e120c440bcb7dc
MD5 2f2335199c9a0e0a8ab9dbe4ed6ee4c2
BLAKE2b-256 b9711937325127367b21d79348cacd3553a37ceb0f7a826c795b44c5f4c6d16d

See more details on using hashes here.

Provenance

The following attestation bundles were made for instro-0.13.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