Skill Tracer
Skills › Scientific Agent Skills › pylabrobot › material-handling.md

material-handling.md

226 lines · skills/pylabrobot/references/material-handling.md at 5f2bc03

Open on GitHub

Most marks come from matching words in the file, so treat them as pointers.

1# Material handling, pumps, and environmental devices
2
3Verified against **PyLabRobot 0.2.2** on **2026-10-01**. Every operation in
4this domain can create physical motion, pressure, heat, or stored energy. The
5snippets below identify APIs only; they do not connect to devices.
6

Material handling, pumps, and environmental devices

Verified against PyLabRobot 0.2.2 on 2026-10-01. Every operation in this domain can create physical motion, pressure, heat, or stored energy. The snippets below identify APIs only; they do not connect to devices.

Raw lines 1 to 6
7## Pumps
8
9Stable frontend and one stable backend export:
11```python
12from pylabrobot.pumps import MasterflexBackend, Pump
13```
15Verified `Pump` methods:
17```text
18run_revolutions(num_revolutions)
19run_continuously(speed)
20run_for_duration(speed, duration)
21pump_volume(speed, volume)
22halt()
23```
25`pump_volume()` requires a `PumpCalibration`, converting requested volume to
26time or revolutions. It is an open-loop estimate, not a measured delivery.
27`start` and `calibrate(duration=..., speed=..., volume=...)` are not these
28frontend methods. `stop()` closes the backend; `halt()` requests halted flow.
29`run_for_duration()` does not halt in a `finally` block if its sleep is
30cancelled. Review interruption handling with the exact backend before live use.
32`MasterflexBackend(com_port)` is transport-specific. Do not instantiate it
33during discovery. The current development machine table labels listed Masterflex L/S models
34and Agrowtek Pump Array **Full**; this is separate from release/firmware support.

Pumps

Stable frontend and one stable backend export:

from pylabrobot.pumps import MasterflexBackend, Pump

Verified Pump methods:

run_revolutions(num_revolutions)
run_continuously(speed)
run_for_duration(speed, duration)
pump_volume(speed, volume)
halt()

pump_volume() requires a PumpCalibration, converting requested volume to time or revolutions. It is an open-loop estimate, not a measured delivery. start and calibrate(duration=..., speed=..., volume=...) are not these frontend methods. stop() closes the backend; halt() requests halted flow. run_for_duration() does not halt in a finally block if its sleep is cancelled. Review interruption handling with the exact backend before live use.

MasterflexBackend(com_port) is transport-specific. Do not instantiate it during discovery. The current development machine table labels listed Masterflex L/S models and Agrowtek Pump Array Full; this is separate from release/firmware support.

Raw lines 7 to 35
36### Pump safety
38Before a separately authorized run, verify:
40- exact pump/head/tubing model, material, inner diameter, direction, occlusion,
41 fittings, valves, clamps, and destination;
42- calibrated relationship among command speed/revolutions/time and delivered
43 volume for the current fluid, tubing age, backpressure, and temperature;
44- prime/purge route, bubbles, siphoning, dead volume, residual volume, maximum
45 pressure/flow, leak containment, and waste capacity;
46- chemical/biological compatibility, cross-contamination controls, and tubing
47 change policy;
48- an accessible stop and safe behavior on disconnect, timeout, or partial
49 delivery.
51A time/speed command is not a measured volume. Record the calibration and
52uncertainty; use a validated scale/flow sensor if closed-loop confirmation is
53required.

Pump safety

Before a separately authorized run, verify:

  • exact pump/head/tubing model, material, inner diameter, direction, occlusion, fittings, valves, clamps, and destination;
  • calibrated relationship among command speed/revolutions/time and delivered volume for the current fluid, tubing age, backpressure, and temperature;
  • prime/purge route, bubbles, siphoning, dead volume, residual volume, maximum pressure/flow, leak containment, and waste capacity;
  • chemical/biological compatibility, cross-contamination controls, and tubing change policy;
  • an accessible stop and safe behavior on disconnect, timeout, or partial delivery.

A time/speed command is not a measured volume. Record the calibration and uncertainty; use a validated scale/flow sensor if closed-loop confirmation is required.

Raw lines 36 to 54
55## Heater shakers and shakers
57Stable frontend imports:
59```python
60from pylabrobot.heating_shaking import (
61 HamiltonHeaterShakerBackend,
62 HeaterShaker,
63 InhecoThermoshakeBackend,
65from pylabrobot.shaking import Shaker
66```
68The stable class is `InhecoThermoshakeBackend` (lowercase `s` in
69`Thermoshake`), not the stale `InhecoThermoShakeBackend`.
71Verified `HeaterShaker` methods:
73```text
74set_temperature(temperature, passive=False)
75get_temperature()
76shake(speed, duration=None, **backend_kwargs)
77stop_shaking(**backend_kwargs)
78lock_plate(**backend_kwargs)
79unlock_plate(**backend_kwargs)
80```
82The old names `set_shake_rate` and `set_temperature(None)` are not the verified
830.2.2 frontend signatures. Use the exact device page for deactivation/cooling
84and do not substitute zero/`None` unless documented for that backend.
86`HeaterShaker` construction requires `name`, dimensions, backend, and a
87`child_location`. Backend construction is also device topology-specific:
88`HamiltonHeaterShakerBackend(index, interface)` and
89`InhecoThermoshakeBackend(index, control_box)` require approved shared
90interfaces/controllers.
92The current hosted development inventory labels Inheco Thermoshake variants
93**WIP**, Hamilton Heater Shaker and QInstruments BioShake **Full**, and the
94Opentrons Heater-Shaker Module **Full**. The old blanket **Full** claim for
95Inheco was stale. A 0.2.2 import does not establish current device support.

Heater shakers and shakers

Stable frontend imports:

from pylabrobot.heating_shaking import (
    HamiltonHeaterShakerBackend,
    HeaterShaker,
    InhecoThermoshakeBackend,
)
from pylabrobot.shaking import Shaker

The stable class is InhecoThermoshakeBackend (lowercase s in Thermoshake), not the stale InhecoThermoShakeBackend.

Verified HeaterShaker methods:

set_temperature(temperature, passive=False)
get_temperature()
shake(speed, duration=None, **backend_kwargs)
stop_shaking(**backend_kwargs)
lock_plate(**backend_kwargs)
unlock_plate(**backend_kwargs)

The old names set_shake_rate and set_temperature(None) are not the verified 0.2.2 frontend signatures. Use the exact device page for deactivation/cooling and do not substitute zero/None unless documented for that backend.

HeaterShaker construction requires name, dimensions, backend, and a child_location. Backend construction is also device topology-specific: HamiltonHeaterShakerBackend(index, interface) and InhecoThermoshakeBackend(index, control_box) require approved shared interfaces/controllers.

The current hosted development inventory labels Inheco Thermoshake variants WIP, Hamilton Heater Shaker and QInstruments BioShake Full, and the Opentrons Heater-Shaker Module Full. The old blanket Full claim for Inheco was stale. A 0.2.2 import does not establish current device support.

Raw lines 55 to 96
97### Heater/shaker safety
99Confirm plate compatibility, mass, balance, lid/seal, locking, condensation,
100spillage containment, orbit/speed limits, thermal limits, ramp/equilibration,
101sensor calibration, and safe unlock temperature. Never unlock or move a plate
102while shaking. Treat a requested setpoint as a command, not proof that the
103sample has reached that temperature.

Heater/shaker safety

Confirm plate compatibility, mass, balance, lid/seal, locking, condensation, spillage containment, orbit/speed limits, thermal limits, ramp/equilibration, sensor calibration, and safe unlock temperature. Never unlock or move a plate while shaking. Treat a requested setpoint as a command, not proof that the sample has reached that temperature.

Raw lines 97 to 104
105## Temperature controllers
107Stable frontend:
109```python
110from pylabrobot.temperature_controlling import TemperatureController
111```
113Verified methods:
115```text
116set_temperature(temperature, passive=False)
117get_temperature()
118deactivate()
119```
121The current development inventory includes Inheco CPAC and the Opentrons
122Temperature Module; these support labels do not establish 0.2.2 compatibility. Validate active cooling, condensation,
123plate/adapter contact, setpoint range, ramp, sensor placement, overshoot, and
124sample-versus-block temperature. `set_temperature()` does not await thermal
125equilibration; use `wait_for_temperature(timeout=..., tolerance=...)` for the
126block sensor. In 0.2.2 `passive=True` below the current temperature only skips a
127new setpoint command: it does not deactivate prior heating. Do not equate it
128with a verified safe cooling action.

Temperature controllers

Stable frontend:

from pylabrobot.temperature_controlling import TemperatureController

Verified methods:

set_temperature(temperature, passive=False)
get_temperature()
deactivate()

The current development inventory includes Inheco CPAC and the Opentrons Temperature Module; these support labels do not establish 0.2.2 compatibility. Validate active cooling, condensation, plate/adapter contact, setpoint range, ramp, sensor placement, overshoot, and sample-versus-block temperature. set_temperature() does not await thermal equilibration; use wait_for_temperature(timeout=..., tolerance=...) for the block sensor. In 0.2.2 passive=True below the current temperature only skips a new setpoint command: it does not deactivate prior heating. Do not equate it with a verified safe cooling action.

Raw lines 105 to 129
130## Centrifuges
132Stable imports:
134```python
135from pylabrobot.centrifuge import Access2Backend, Centrifuge, VSpinBackend
136```
138Verified frontend:
140```text
141open_door()
142close_door()
143lock_door()
144unlock_door()
145spin(g, duration, **backend_kwargs)
146```
148The stable method takes relative centrifugal force `g`, not the stale
149`speed=...` RPM argument. Converting RPM to RCF requires the correct rotor
150radius; never guess it.
152The current development table labels both Agilent VSpin and its Access2 loader
153**Full**; older tables called VSpin **Mostly**. Released constructors are:
155`VSpinBackend(device_id=None)` and `Access2Backend(device_id, timeout=60)` are
156device-specific. Do not use placeholder IDs in a live script.
158The released 0.2.2 wheel includes `MicroSpin(name, host, port=1000, timeout=30.0,
159backend=None)` and `pylabrobot.centrifuge.highres.MicroSpinBackend`. The changelog
160still lists them under `Unreleased`, so it cannot decide release availability.
161The driver speaks ASCII over TCP; `setup()` opens a connection and `stop()`
162closes it without stopping a spinning rotor. `status` can block until spin-down.
163These contracts were source-inspected only; the [review ledger](review.md)
164records framing and limits. No factory or hardware backend was instantiated.

Centrifuges

Stable imports:

from pylabrobot.centrifuge import Access2Backend, Centrifuge, VSpinBackend

Verified frontend:

open_door()
close_door()
lock_door()
unlock_door()
spin(g, duration, **backend_kwargs)

The stable method takes relative centrifugal force g, not the stale speed=... RPM argument. Converting RPM to RCF requires the correct rotor radius; never guess it.

The current development table labels both Agilent VSpin and its Access2 loader Full; older tables called VSpin Mostly. Released constructors are:

VSpinBackend(device_id=None) and Access2Backend(device_id, timeout=60) are device-specific. Do not use placeholder IDs in a live script.

The released 0.2.2 wheel includes MicroSpin(name, host, port=1000, timeout=30.0, backend=None) and pylabrobot.centrifuge.highres.MicroSpinBackend. The changelog still lists them under Unreleased, so it cannot decide release availability. The driver speaks ASCII over TCP; setup() opens a connection and stop() closes it without stopping a spinning rotor. status can block until spin-down. These contracts were source-inspected only; the review ledger records framing and limits. No factory or hardware backend was instantiated.

Raw lines 130 to 165
166### Centrifuge safety
168Require human verification of rotor/bucket/adapter model, plate rating,
169orientation, balance, maximum RCF, duration, acceleration/deceleration, lid/door
170interlocks, loading position, clearance, maintenance, and emergency procedure.
171Never open/unlock while rotating or issue movement merely to test a connection.
172On timeout or disconnect, assume the rotor may still be moving until physically
173verified safe.

Centrifuge safety

Require human verification of rotor/bucket/adapter model, plate rating, orientation, balance, maximum RCF, duration, acceleration/deceleration, lid/door interlocks, loading position, clearance, maintenance, and emergency procedure. Never open/unlock while rotating or issue movement merely to test a connection. On timeout or disconnect, assume the rotor may still be moving until physically verified safe.

Raw lines 166 to 174
175## Storage/incubation
177The current development inventory includes Thermo Fisher/Heraeus Cytomat
178models with differing support levels and Inheco Incubator Shaker/SCILA. Their APIs
179are model-specific; do not use stale generic examples such as
180`from pylabrobot.incubation import Incubator` without verifying that exact
181symbol in the pinned wheel.
183Storage moves require explicit plate identity, slot mapping, occupancy state,
184door/hatch/interlock state, orientation, environmental setpoints, and recovery
185from an interrupted handoff. Software occupancy is not physical detection.

Storage/incubation

The current development inventory includes Thermo Fisher/Heraeus Cytomat models with differing support levels and Inheco Incubator Shaker/SCILA. Their APIs are model-specific; do not use stale generic examples such as from pylabrobot.incubation import Incubator without verifying that exact symbol in the pinned wheel.

Storage moves require explicit plate identity, slot mapping, occupancy state, door/hatch/interlock state, orientation, environmental setpoints, and recovery from an interrupted handoff. Software occupancy is not physical detection.

Raw lines 175 to 186
187## Multi-device orchestration
189Do not independently `gather()` hardware operations just because frontends are
190async. Safe concurrency requires approved workcell interlocks and a scheduler
191that owns:
193- device and plate state;
194- collision zones and transfer ownership;
195- door/tray/bucket/lock preconditions;
196- timeouts, retries, idempotency, and partial-completion handling;
197- emergency stop and restart/reconciliation behavior.
199Default sequence:
2011. Validate manifests and transfers offline.
2022. Generate a non-executable simulation plan.
2033. Exercise software-only frontends where available.
2044. Review every handoff with the operator.
2055. Obtain explicit confirmation for the exact live protocol.
2066. Commission one device/move at a time under site procedures.

Multi-device orchestration

Do not independently gather() hardware operations just because frontends are async. Safe concurrency requires approved workcell interlocks and a scheduler that owns:

  • device and plate state;
  • collision zones and transfer ownership;
  • door/tray/bucket/lock preconditions;
  • timeouts, retries, idempotency, and partial-completion handling;
  • emergency stop and restart/reconciliation behavior.

Default sequence:

  1. Validate manifests and transfers offline.
  2. Generate a non-executable simulation plan.
  3. Exercise software-only frontends where available.
  4. Review every handoff with the operator.
  5. Obtain explicit confirmation for the exact live protocol.
  6. Commission one device/move at a time under site procedures.
Raw lines 187 to 207
208## No-connection inspection
210```bash
211python3 skills/pylabrobot/scripts/inspect_backends.py \
212 --expected-version 0.2.2 --strict
213```
215This checks a fixed set of frontend symbols and methods without constructing
216devices or calling `setup()`.

No-connection inspection

python3 skills/pylabrobot/scripts/inspect_backends.py \
  --expected-version 0.2.2 --strict

This checks a fixed set of frontend symbols and methods without constructing devices or calling setup().

Raw lines 208 to 217
Runs code python3 skills/pylabrobot/scripts/inspect_backends.py :211
218## Sources
220Reviewed **2026-10-01**: constructors, methods and transports in the
221[official 0.2.2 source distribution](https://pypi.org/project/PyLabRobot/0.2.2/#files),
222[current machine inventory](https://docs.pylabrobot.org/stable/user_guide/machines.html),
223and [release review](review.md). Source files inspected include `pumps/pump.py`,
224`heating_shaking/heater_shaker.py`, `temperature_controlling/temperature_controller.py`,
225`centrifuge/centrifuge.py`, and `centrifuge/highres/microspin_backend.py`.
226Physical control and transport behavior remain untested.

Sources

Reviewed 2026-10-01: constructors, methods and transports in the official 0.2.2 source distribution, current machine inventory, and release review. Source files inspected include pumps/pump.py, heating_shaking/heater_shaker.py, temperature_controlling/temperature_controller.py, centrifuge/centrifuge.py, and centrifuge/highres/microspin_backend.py. Physical control and transport behavior remain untested.

Raw lines 218 to 226