Fixtures #

A fixture in Litmus is a YAML file at fixtures/<name>.yaml that maps UUT pins to station instruments. It's the bridge that lets a test say "measure the voltage at pin VOUT" without knowing which DMM channel VOUT happens to be wired to on this particular bench.

Naming collision. "Fixture" overloads. Throughout this page, "fixture" means hardware test fixture — the YAML pin-map. When the test signature has def test_x(pins, dmm, verify): ..., the names pins, dmm, verify are pytest fixtures — Python objects the pytest plugin synthesizes (in part from your hardware fixture YAML). When this page needs the pytest sense it says "pytest fixture".

What fixtures model #

Three things have to line up before a test can measure anything:

  1. The part declares pins (VIN, VOUT, GND) and their measurable characteristics (output voltage, current draw, etc.).
  2. The station declares instruments by role (dmm, psu, eload) and where each is physically connected (a VISA address, a serial port).
  3. The fixture declares which station instrument (and channel) is currently wired to which part pin.
%%{init: {'flowchart': {'curve': 'stepBefore'}}}%%
flowchart LR
    subgraph Part
        VIN[VIN]
        VOUT[VOUT]
    end
 
    subgraph Fixture
        F_VIN["VIN → psu.1"]
        F_VOUT["VOUT → dmm"]
    end
 
    subgraph Station
        PSU[psu]
        DMM[dmm]
    end
 
    VIN --- F_VIN
    VOUT --- F_VOUT
    F_VIN --- PSU
    F_VOUT --- DMM

The fixture is the only piece that changes when you move a board from one bench to another. The part stays the same (it's the device). The station stays the same (it's the bench). The fixture re-maps which pins are on which channels — and every test runs unchanged.

This is also what makes a measurement traceable: every value flows through a named fixture connection (VOUT, not dmm channel 1), and the recorded measurement row carries the UUT-side name. Six months later you can ask "which board's VOUT was reading 3.5 V?" — the connection name is the join key.

When you need a fixture #

SetupFixture?
One UUT, one bench, you remember which instrument is on which pinOptional — the dmm / psu per-role pytest fixtures from your station YAML are enough
Multiple parts on the same bench, or one part across multiple benchesRequired — the pin-map is what lets the test code stay portable
Multiple UUTs running in parallelRequired — see Multi-UUT scaling
Production traceability — every measurement records its UUT-side pinRequired — uut_pin is the connection field that flows into the parquet row

For development without any fixture, see Mock mode and the per-role auto-fixtures in Litmus fixtures.

Data model #

A fixture YAML loads into a FixtureConfig. Two top-level shapes:

  • Single-UUT — fields directly on the fixture
  • Multi-UUTslots: with one FixtureSlot per UUT position

Both share the same FixtureConnection shape underneath.

FixtureConfig fields #

FieldDescription
idUnique fixture identifier
nameOptional display name
part_idSpecific part this fixture is wired for (preferred)
part_familyOr part family — for fixtures that work for multiple parts in a line
part_revisionOptional — for fixtures that differ by board revision
station_typesOptional — abstract station-type layouts this fixture can wire against. Validated at session start against the active profile's station_type. Empty list = "any station".
uut_resourceOptional UUT-side connection string (a COM port, USB serial number, etc.) for tests that talk to the UUT directly
connectionsUUT-pin ↔ instrument-channel pairings. Single-UUT shape.
slotsPer-UUT-position connections for multi-UUT fixtures. Multi-UUT shape.
descriptionFree-form documentation

connections and slots are mutually exclusive — a fixture that sets both is rejected.

FixtureConnection fields #

A connection is the addressable unit — a name that identifies one UUT-side signal path:

FieldDescription
nameThe connection's identifier (test code uses this; parquet rows record this)
instrumentStation role (must match a key in station.instruments)
instrument_channelChannel on the instrument ("1", "CH2", "ai0")
instrument_terminalPhysical terminal on the channel (hi, lo, sense_hi, sense_lo, signal). Optional.
uut_pinPart pin this connection is wired to (must match a pins.<name> key in the part spec)
netSchematic net name. Alternative to uut_pin when matching by net rather than physical pin.
functionOptional MeasurementFunction the connection is for. When set, the resolver matches by (uut_pin, function) — see Function as a routing dimension.
routeOptional SwitchRoute for switched signal paths — see Switched routing.
descriptionFree-form documentation

Single-UUT shape #

The simplest fixture: each UUT pin gets one connection, one instrument, one channel.

# fixtures/power_board_fixture.yaml
id: power_board_fixture
name: "Power Board Test Fixture"
part_id: power_board
 
connections:
  VIN:
    name: VIN
    uut_pin: VIN
    net: VIN_5V
    instrument: psu
    instrument_channel: "1"
    instrument_terminal: hi
  VOUT:
    name: VOUT
    uut_pin: VOUT
    net: VOUT_3V3
    instrument: dmm
    instrument_channel: "CH1"
  GND:
    name: GND
    uut_pin: GND
    instrument: psu
    instrument_channel: "GND"

A test addresses each connection by its uut_pin through the pins pytest fixture:

def test_output_voltage(pins, verify):
    pins["VIN"].set_voltage(5.0)
    pins["VIN"].enable_output()
    verify("output_voltage", pins["VOUT"].measure_voltage())

pins["VIN"] resolves to the connected psu instrument (because the fixture says VIN → psu). The measurement row records uut_pin=VIN, the connection's instrument_channel, and the resolved instrument identity — the test body never sees those details.

How a measurement reaches the row #

When verify("output_voltage", pins["VOUT"].measure_voltage()) runs:

  1. pins["VOUT"] looks up the fixture connection named VOUT → finds {instrument: dmm, instrument_channel: "CH1"}.
  2. It finds the dmm on the bench and runs measure_voltage() on channel CH1.
  3. verify() records the measurement row. Because the active connection is VOUT, the row carries uut_pin=VOUT, instrument_channel=CH1, and the resolved instrument_name / instrument_resource automatically.

That auto-population is the traceability payoff: tests stay clean, parquet rows know exactly which signal path each measurement came through.

Routing one pin to different instruments by measurement #

One UUT pin can route to different instruments depending on what you're measuring. Set function: on each connection and Litmus picks the connection whose (pin, function) matches, instead of pin alone:

connections:
  vout_dc:
    name: vout_dc
    uut_pin: VOUT
    function: dc_voltage      # DMM measures the DC level
    instrument: dmm
  vout_ac:
    name: vout_ac
    uut_pin: VOUT
    function: ac_voltage      # Scope captures the ripple
    instrument: scope
    instrument_channel: "1"

A test asking for VOUT with no function context falls back to first-match by pin. A test bound to a specific characteristic (via litmus_characteristics) picks the connection whose function matches.

When function is unset, the first connection for that pin is used.

Multi-UUT scaling: slots, shared instruments, switching #

Three independent features scale the single-UUT shape to multiple boards:

Slots — parallel UUT positions #

When the bench has multiple identical positions and you test them in parallel, use slots instead of connections. Each slot has its own FixtureConnection map:

# fixtures/dual_board_fixture.yaml
id: dual_board_fixture
part_family: power_board
 
slots:
  slot_1:
    description: Left-side board
    uut_resource: /dev/ttyUSB0
    connections:
      vout_measure:
        name: vout_measure
        uut_pin: VOUT
        instrument: dmm
        instrument_channel: "1"
  slot_2:
    description: Right-side board
    uut_resource: /dev/ttyUSB1
    connections:
      vout_measure:
        name: vout_measure
        uut_pin: VOUT
        instrument: dmm
        instrument_channel: "2"

Litmus runs each slot in parallel; each slot's test sees only its own connections. Per-slot uut_resource overrides the fixture-level value. See Multi-UUT testing for the operational guide.

Shared instruments #

When multiple slots reference the same instrument role (e.g. both slots' dmm connections point at the bench's single DMM), Litmus treats it as a shared instrument. It connects once and shares it across the parallel slot workers — each one calls it as if it owned it.

Locking is per resource (the VISA address, COM port, or other connection identifier), so roles sharing one physical connection take turns, while roles on separate connections run at the same time.

Switched routing #

For a single instrument fanned out to multiple UUT positions through a relay matrix, add a SwitchRoute to the connection. The platform closes the listed switch channels before activating the instrument, waits the settling time, then runs the measurement:

slot_1:
  connections:
    vout_measure:
      name: vout_measure
      uut_pin: VOUT
      instrument: dmm
      route:
        switch: matrix          # role of the switch instrument
        channels: ["r0c0"]      # crosspoints to close
        settling_ms: 10

Switch routes activate on demand — the first time a test touches that instrument, Litmus closes the listed switch channels, waits the settling time, then takes the measurement. Multiple slots can share one instrument through different routes. Switches (instruments with type: switch) are exempt from the take-turns locking — closing channels in parallel is the point of the matrix.

Selecting a fixture at run time #

Stations do not pin a fixture themselves. The active fixture is chosen per session via the --fixture CLI flag (or a profile that sets it):

pytest tests/ \
  --station=bench_1 \
  --fixture=fixtures/power_board_fixture.yaml \
  --uut-serial=SN001

The fixture's part_id / part_family are scoping fields — the resolver uses them to pick the right fixture when multiple are present, but the plugin does not currently cross-check them against the active part spec.

Worked example #

A complete single-UUT setup, four files:

# parts/power_board.yaml
id: power_board
pins:
  VIN:  {name: "J1.1", role: power}
  VOUT: {name: "J1.3", role: signal}
  GND:  {name: "J1.2", role: ground}
characteristics:
  output_voltage:
    function: dc_voltage
    direction: output
    unit: V
    pin: VOUT
    bands:
      - value: 3.3
        accuracy: {pct_reading: 5}
# stations/bench_1.yaml
id: bench_1
instruments:
  psu:
    type: psu
    driver: pymeasure.instruments.keysight.KeysightE36312A
    resource: "GPIB0::5::INSTR"
  dmm:
    type: dmm
    driver: pymeasure.instruments.keysight.Keysight34461A
    resource: "TCPIP::192.168.1.100::INSTR"
# fixtures/power_board_fixture.yaml
id: power_board_fixture
part_id: power_board
connections:
  VIN:
    name: VIN
    uut_pin: VIN
    instrument: psu
    instrument_channel: "1"
  VOUT:
    name: VOUT
    uut_pin: VOUT
    instrument: dmm
  GND:
    name: GND
    uut_pin: GND
    instrument: psu
    instrument_channel: "GND"
# tests/test_power_board.py
def test_output_voltage(pins, verify):
    pins["VIN"].set_voltage(5.0)
    pins["VIN"].enable_output()
    verify("output_voltage", pins["VOUT"].measure_voltage())

Run it:

pytest tests/ \
  --part=parts/power_board.yaml \
  --station=stations/bench_1.yaml \
  --fixture=fixtures/power_board_fixture.yaml \
  --uut-serial=SN001

The recorded measurement row carries uut_pin=VOUT, instrument_name=dmm, characteristic_id=output_voltage — all pulled through the fixture connection automatically.

See also #