wisent-wire-sdk 0.4.0

Python client library for the Wisent Wire hardware testing platform API

Wisent Wire Python SDK

Python client library for the WisentWire hardware testing platform.

Installation

pip install wisent-wire-sdk

Quick start

from wisentwire import WisentWireClient

# API key (recommended — scripts, CI, MCP)
client = WisentWireClient(
    base_url="https://int.wisent-wire.com",
    api_key="wwk_...",   # or set WISENTWIRE_API_KEY env var
)

# Cognito (email + password)
client = WisentWireClient(
    base_url="https://int.wisent-wire.com",
    email="[e-mail]",
    password="secret",
)

# Pre-existing bearer token
client = WisentWireClient(
    base_url="https://int.wisent-wire.com",
    token="eyJhbGciOi...",
)

Create an API key from the web app under Settings → API keys. Keys are shown once — store securely. Default expiry is 1 year; max 10 active keys per user.

Usage

WisentWires

wws = client.list_wisentwires()
ww = client.get_wisentwire(ww_id=1)

Power supply

client.set_power_supply(ww_id=1, state="ON", voltage=5.0, current=2.0)
shadow = client.wait_shadow_state(ww_id=1, expected_state="ON")
print(shadow.reported.voltage_setpoint)

Firmware & flash

fw = client.upload_firmware("app.bin", firmware_bytes, "STM32F4")
job_id = client.flash(ww_id=1, firmware_id=fw.id)
client.wait_flash_complete(ww_id=1, job_id=job_id)

UART

client.send_uart_ascii(ww_id=1, text="HELLO")
msg = client.wait_for_uart_rx(ww_id=1, match_hex="48454C4C4F")
print(msg.bytes_hex)

Telemetry

readings = client.get_power_telemetry(ww_id=1)

Reservations

reservations = client.list_reservations()

Organization

org = client.get_organization()
members = client.list_members()

Error handling

All API errors raise typed exceptions inheriting from WisentWireError:

from wisentwire import NotFoundError, ConflictError

try:
    client.get_wisentwire(ww_id=999)
except NotFoundError as e:
    print(f"WisentWire not found: {e}")

HTTP status	Exception
400	BadRequestError
401	AuthenticationError
403	ForbiddenError
404	NotFoundError
409	ConflictError
429	RateLimitError
503	ServiceUnavailableError

Development

pip install -e ".[dev]"
pytest tests/ -v

Requirements

• Python >= 3.10
• requests >= 2.28
• tenacity >= 8.0