Skip to main content

AI-powered lab instrument connection assistant

Project description

hardware-connector

AI-powered CLI tool that helps engineers connect to lab instruments. It uses an LLM agent to diagnose connection issues, install dependencies, fix permissions, and generate working Python code — all from your terminal.

How it works

  1. Detects your OS, Python environment, USB devices, and VISA backends
  2. Loads device-specific knowledge (pinouts, quirks, known errors)
  3. Runs an AI agent loop that iteratively diagnoses and fixes connection issues
  4. Outputs working Python code that communicates with your instrument

Supported devices

Device Manufacturer Type
DS1054Z Rigol Oscilloscope

More devices coming soon.

Requirements

Installation

pip install hardware-connector

Setup

Set your Anthropic API key:

export ANTHROPIC_API_KEY='sk-ant-...'

Usage

Connect to a device

# Auto-detect connected device
hardware-connector connect

# Specify a device
hardware-connector connect --device rigol_ds1054z

# Auto-confirm all actions (no prompts)
hardware-connector connect --device rigol_ds1054z --yes

Other commands

hardware-connector list-devices     # Show supported devices
hardware-connector detect           # Show environment info + detected devices
hardware-connector config get       # View configuration
hardware-connector config set model claude-sonnet-4-20250514  # Change LLM model
hardware-connector version          # Print version

Options

Flag Description
--device, -d Device identifier (e.g. rigol_ds1054z)
--yes, -y Auto-confirm all actions
--model, -m LLM model to use
--max-iterations Max agent iterations (default: 20)

Configuration

# Disable telemetry
hardware-connector config set telemetry off

# Change default model
hardware-connector config set model claude-sonnet-4-20250514

Model resolution order: --model flag → HARDWARE_AGENT_MODEL env var → config DB → default.

License

Copyright (c) 2026 Yash Prakash. All rights reserved. See LICENSE for details.

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

hardware_connector-0.2.0.tar.gz (86.4 kB view details)

Uploaded Source

Built Distribution

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

hardware_connector-0.2.0-py3-none-any.whl (58.3 kB view details)

Uploaded Python 3

File details

Details for the file hardware_connector-0.2.0.tar.gz.

File metadata

  • Download URL: hardware_connector-0.2.0.tar.gz
  • Upload date:
  • Size: 86.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for hardware_connector-0.2.0.tar.gz
Algorithm Hash digest
SHA256 ed152f1986d193557eac8de30b4f4ef383acd345ed4fd7eedaf493f141f789a8
MD5 4e350c87e1e4675aecefe5c4e5798fe2
BLAKE2b-256 c10209758b4013a5e5886716579595f05ad9704a955c1972f709b014114fae9d

See more details on using hashes here.

File details

Details for the file hardware_connector-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for hardware_connector-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 566b919d0d8a321164af39dcfba788abffc0b14c23063dda4347b9f4034ce54b
MD5 2e53adc6559d7a8cd82b3878194b7ea5
BLAKE2b-256 3a98710e8ec22d1be2f9cfdf69212c0ed64a5822ca60512bc434b61fdff2acbd

See more details on using hashes here.

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