devices¶
The devices block catalogs every instrument or tool invoked during the protocol. It drives automation compatibility and ensures calibration data is captured alongside procedure steps.
Field Reference¶
| Field | Type | Required | Units | Allowed Types | Constraints / Enum | Example |
|---|---|---|---|---|---|---|
id |
string | ✅ | - | string | Unique | "d_centrifuge" |
name |
string | ✅ | - | string | - | "Mini centrifuge" |
kind |
string | ✅ | - | enum | centrifuge, pipette, thermal_cycler, spectrophotometer, incubator, balance, shaker, robotic_arm, freezer, microscope, biosafety_cabinet, autoclave, liquid_handler, plate_reader, flow_cytometer, custom |
"centrifuge" |
description |
string | conditional | - | string | Required if kind = "custom" |
"Ultrasonic cleaner 40 kHz" |
capabilities |
map | conditional | - | object | Required if kind: custom & validation_mode: strict |
{ frequency: { unit: "kHz", min: 30, max: 45 } } |
manufacturer |
string | optional | - | string | - | "Eppendorf" |
model |
string | optional | - | string | - | "5418R" |
calibrated_at |
date | optional | - | ISO 8601 | - | "2025-01-10" |
Optional additions such as serial_number, location, maintenance_schedule, attachments, or vendor-specific extension namespaces (automation_ext, microscopy_ext, etc.) can be used for richer integration.
kind Vocabulary¶
| Kind | Description | Typical Equipment Example |
|---|---|---|
centrifuge |
Spinning device for separating components by density. | Eppendorf 5420 |
pipette |
Liquid handling tool for transferring defined volumes. | Gilson PIPETMAN |
thermal_cycler |
PCR cycler controlling temperature cycles. | Bio-Rad C1000 |
spectrophotometer |
Measures absorbance/transmittance across wavelengths. | Thermo Scientific NanoDrop |
incubator |
Maintains temperature (and often humidity/CO₂) for cultures. | Binder CB 160 |
balance |
Analytical or precision scale. | METTLER TOLEDO XPR |
shaker |
Orbital/linear shaker or rocker platform. | Eppendorf Innova 2100 |
robotic_arm |
Multi-axis arm for automation or sample handling. | Universal Robots UR5e |
freezer |
Cold storage (−20 °C, −80 °C, cryogenic). | Thermo TSX Series |
microscope |
Optical or fluorescence microscope. | ZEISS LSM 900 |
biosafety_cabinet |
Containment enclosure for sterile/BSL operations. | Labconco Purifier Logic+ |
autoclave |
Steam sterilizer for decontaminating equipment and media. | Tuttnauer EZ9 |
liquid_handler |
Automated pipetting / deck platform. | Tecan Fluent |
plate_reader |
Multi-well plate detection (absorbance, fluorescence, luminescence). | Molecular Devices SpectraMax |
flow_cytometer |
Measures cell populations using lasers and detectors. | BD FACSCelesta |
custom |
Any instrument not covered above; requires descriptive capabilities for validation. | Custom-built imaging rig |
Defining Capabilities for Custom Devices¶
- Provide quantitative ranges with units (
frequency,volume_capacity,temperature_range, etc.). - Use arrays of strings for discrete functions (
functions: ["wash", "sterilize"]). - Include maintenance metadata when performance drifts over time (e.g.,
last_service,calibration_certificateviaattachments).
Best Practices¶
- Ensure
idmatches what appears insteps[].useand avoid spaces or uppercase letters (d_incubator_a). - Record
calibrated_atin ISO 8601 (2025-01-10); pair withattachmentsreferencing calibration certificates. - Document device placement (
location: "Room B, Bench 3") so technicians know which hardware matches the identifier. - When multiple devices share a
kind, use descriptivenamepatterns and includeserial_numberorasset_tag. - Offload complex vendor schemas into
extensionsto keep the core section manageable.
Validation Notes¶
- Validators enforce the controlled
kindvocabulary; unknown terms raise schema errors. - In
strictmode, custom devices must declarecapabilitiesto describe measurable performance envelopes. - Cross-references ensure every
usevalue instepsmaps to a declareddevices.id, preventing orphan references.