nominal-io/instro

Nominal's open-source library for hardware test instrumentation

680

stars

246

commits

Python

primary language

Sep 10, 2026

updated

instro.nominal.io/
arbitrary-waveform-generator
data-acquisition
digital-multimeter
electronic-load
flow-controller
instrument-control
oscilloscope
power-supply
scpi
test-and-measurement

README

Nominal Instro SDK Logo

Python library for talking to test instrumentation (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:
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 flow. 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.14.

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 their Rust recipes require), 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:

ExtraPulls in Package
instro[nidaq]NI-DAQmx (Linux + Windows)PyPI
instro[labjack]LabJack LJMPyPI
instro[mccdaq]MCC UL (Windows-only)PyPI
instro[aardvark]Total Phase Aardvark (I2C)PyPI
instro[ethernetip]EtherNet/IP support for Allen-Bradley PLCsPyPI
instro[contrib]Community-contributed hardware driversPyPI
instro[unstable]In-development features whose API isn't settledPyPI
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

CategoryClassVendors
Power SupplyInstroPSUB&K Precision (9115, 914X), Keysight (E36100-series), Rigol (DP800-series), Siglent (SPD3303), TDK Lambda (Genesys), simulated
MultimeterInstroDMMAgilent 34401A, Keysight 34461A, Keithley 2400, Keithley 2750 (unstable), simulated
Arbitrary Waveform GeneratorInstroAWGKeysight (33521B, unstable), Rigol (DG1022Z, unstable)
Electronic LoadInstroELoadB&K Precision (85xxB-series)
OscilloscopeInstroScopeKeysight (1200X-series), Tektronix (2-series), Siglent (SDS1000X-E)
Flow ControllerInstroFlowControllerAlicat MC-series
DAQInstroDAQKeysight 34980A, NI-DAQmx, LabJack T-series, MCC USB-series
I2CI2CInterfaceTotal Phase Aardvark
ModbusModbusDeviceAny Modbus TCP / RTU device
EtherNet/IPEtherNetIPDeviceAllen-Bradley / CompactLogix-class PLCs

Don't see your vendor? Drivers we 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.

Contributors

hoehner

66 commits

nominal-bot

43 commits

nhschwab

29 commits

LizzyC-115

20 commits

nominal-io/instro

Nominal's open-source library for hardware test instrumentation

680

stars

246

commits

Python

primary language

Sep 10, 2026

updated

instro.nominal.io/
arbitrary-waveform-generator
data-acquisition
digital-multimeter
electronic-load
flow-controller
instrument-control
oscilloscope
power-supply
scpi
test-and-measurement

README

Nominal Instro SDK Logo

Python library for talking to test instrumentation (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:
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 flow. 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.14.

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 their Rust recipes require), 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:

ExtraPulls in Package
instro[nidaq]NI-DAQmx (Linux + Windows)PyPI
instro[labjack]LabJack LJMPyPI
instro[mccdaq]MCC UL (Windows-only)PyPI
instro[aardvark]Total Phase Aardvark (I2C)PyPI
instro[ethernetip]EtherNet/IP support for Allen-Bradley PLCsPyPI
instro[contrib]Community-contributed hardware driversPyPI
instro[unstable]In-development features whose API isn't settledPyPI
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

CategoryClassVendors
Power SupplyInstroPSUB&K Precision (9115, 914X), Keysight (E36100-series), Rigol (DP800-series), Siglent (SPD3303), TDK Lambda (Genesys), simulated
MultimeterInstroDMMAgilent 34401A, Keysight 34461A, Keithley 2400, Keithley 2750 (unstable), simulated
Arbitrary Waveform GeneratorInstroAWGKeysight (33521B, unstable), Rigol (DG1022Z, unstable)
Electronic LoadInstroELoadB&K Precision (85xxB-series)
OscilloscopeInstroScopeKeysight (1200X-series), Tektronix (2-series), Siglent (SDS1000X-E)
Flow ControllerInstroFlowControllerAlicat MC-series
DAQInstroDAQKeysight 34980A, NI-DAQmx, LabJack T-series, MCC USB-series
I2CI2CInterfaceTotal Phase Aardvark
ModbusModbusDeviceAny Modbus TCP / RTU device
EtherNet/IPEtherNetIPDeviceAllen-Bradley / CompactLogix-class PLCs

Don't see your vendor? Drivers we 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.

Contributors

hoehner

66 commits

nominal-bot

43 commits

nhschwab

29 commits

LizzyC-115

20 commits

Languages

Python

85.6%

Rust

14.2%