@opentrons/shared-data 0.1.6-alpha.9 → 0.1.7-alpha.1

package/lib/js/types.d.ts

@@ -1,6 +1,7 @@
-import type { MAGDECK, TEMPDECK, THERMOCYCLER, MAGNETIC_MODULE_V1, MAGNETIC_MODULE_V2, TEMPERATURE_MODULE_V1, TEMPERATURE_MODULE_V2, THERMOCYCLER_MODULE_V1, THERMOCYCLER_MODULE_V2, HEATERSHAKER_MODULE_V1, ABSORBANCE_READER_V1, MAGNETIC_MODULE_TYPE, TEMPERATURE_MODULE_TYPE, THERMOCYCLER_MODULE_TYPE, HEATERSHAKER_MODULE_TYPE, MAGNETIC_BLOCK_TYPE, ABSORBANCE_READER_TYPE, GEN1, GEN2, FLEX, LEFT, RIGHT, GRIPPER_V1, GRIPPER_V1_1, GRIPPER_V1_2, GRIPPER_V1_3, EXTENSION, MAGNETIC_BLOCK_V1 } from './constants';
-import type { RunTimeCommand, LabwareLocation } from '../command/types';
+import type { LoadedLabwareLocation, RunTimeCommand } from '../command/types';
+import type { CommandAnnotation } from '../commandAnnotation/types';
 import type { AddressableAreaName, CutoutFixtureId, CutoutId } from '../deck';
+import type { ABSORBANCE_READER_TYPE, ABSORBANCE_READER_V1, EXTENSION, FLEX, FLEX_STACKER_MODULE_TYPE, FLEX_STACKER_MODULE_V1, GEN1, GEN2, GRIPPER_V1, GRIPPER_V1_1, GRIPPER_V1_2, GRIPPER_V1_3, HEATERSHAKER_MODULE_TYPE, HEATERSHAKER_MODULE_V1, LEFT, MAGDECK, MAGNETIC_BLOCK_TYPE, MAGNETIC_BLOCK_V1, MAGNETIC_MODULE_TYPE, MAGNETIC_MODULE_V1, MAGNETIC_MODULE_V2, POSITION_REFERENCE_BOTTOM, POSITION_REFERENCE_CENTER, POSITION_REFERENCE_LIQUID_MENISCUS, POSITION_REFERENCE_TOP, RIGHT, TEMPDECK, TEMPERATURE_MODULE_TYPE, TEMPERATURE_MODULE_V1, TEMPERATURE_MODULE_V2, THERMOCYCLER, THERMOCYCLER_MODULE_TYPE, THERMOCYCLER_MODULE_V1, THERMOCYCLER_MODULE_V2 } from './constants';
 import type { PipetteName } from './pipettes';
 export type RobotType = 'OT-2 Standard' | 'OT-3 Standard';
 export interface RobotDefinition {
@@ -36,7 +37,7 @@ export interface LabwareDefinition1 {
         [well: string]: WellDefinition;
     };
 }
-export type LabwareDisplayCategory = 'wellPlate' | 'tipRack' | 'tubeRack' | 'reservoir' | 'aluminumBlock' | 'trash' | 'other' | 'adapter' | 'lid';
+export type LabwareDisplayCategory = 'wellPlate' | 'tipRack' | 'tubeRack' | 'reservoir' | 'aluminumBlock' | 'trash' | 'other' | 'adapter' | 'lid' | 'system';
 export type LabwareVolumeUnits = 'µL' | 'mL' | 'L';
 export type WellBottomShape = 'flat' | 'u' | 'v';
 export interface LabwareMetadata {
@@ -50,18 +51,23 @@ export interface LabwareDimensions {
     yDimension: number;
     zDimension: number;
 }
-export interface Coordinates {
+export interface Vector2D {
+    x: number;
+    y: number;
+}
+export interface Vector3D {
     x: number;
     y: number;
     z: number;
 }
-export type LabwareOffset = Coordinates;
+export type LabwareOffset = Vector3D;
 export interface LabwareParameters {
     loadName: string;
     format: string;
     isTiprack: boolean;
     tipLength?: number;
     isMagneticModuleCompatible: boolean;
+    isDeckSlotCompatible?: boolean;
     magneticModuleEngageHeight?: number;
     quirks?: string[];
 }
@@ -145,7 +151,19 @@ export interface LabwareWellGroup {
     metadata: LabwareWellGroupMetadata;
     brand?: LabwareBrand;
 }
-export type LabwareRoles = 'labware' | 'adapter' | 'fixture' | 'maintenance' | 'lid';
+export interface AxisAlignedBoundingBox2D {
+    backLeft: Vector2D;
+    frontRight: Vector2D;
+}
+export interface AxisAlignedBoundingBox3D {
+    backLeftBottom: Vector3D;
+    frontRightTop: Vector3D;
+}
+export interface Extents {
+    total: AxisAlignedBoundingBox3D;
+    footprint: AxisAlignedBoundingBox2D;
+}
+export type LabwareRoles = 'labware' | 'adapter' | 'fixture' | 'maintenance' | 'lid' | 'system';
 export interface LabwareDefinition2 {
     version: number;
     schemaVersion: 2;
@@ -161,14 +179,17 @@ export interface LabwareDefinition2 {
     allowedRoles?: LabwareRoles[];
     stackingOffsetWithLabware?: Record<string, LabwareOffset>;
     stackingOffsetWithModule?: Record<string, LabwareOffset>;
+    stackLimit?: number;
+    compatibleParentLabware?: string[];
+    innerLabwareGeometry?: Record<string, InnerWellGeometry> | null;
 }
 export interface LabwareDefinition3 {
     version: number;
+    $otSharedSchema: '#/labware/schemas/3';
     schemaVersion: 3;
     namespace: string;
     metadata: LabwareMetadata;
-    dimensions: LabwareDimensions;
-    cornerOffsetFromSlot: LabwareOffset;
+    extents: Extents;
     parameters: LabwareParameters;
     brand: LabwareBrand;
     ordering: string[][];
@@ -177,6 +198,8 @@ export interface LabwareDefinition3 {
     allowedRoles?: LabwareRoles[];
     stackingOffsetWithLabware?: Record<string, LabwareOffset>;
     stackingOffsetWithModule?: Record<string, LabwareOffset>;
+    stackLimit?: number;
+    compatibleParentLabware?: string[];
     innerLabwareGeometry?: Record<string, InnerWellGeometry> | null;
 }
 export interface LabwareDefByDefURI {
@@ -185,14 +208,15 @@ export interface LabwareDefByDefURI {
 export interface LegacyLabwareDefByName {
     [name: string]: LabwareDefinition1;
 }
-export type ModuleType = typeof MAGNETIC_MODULE_TYPE | typeof TEMPERATURE_MODULE_TYPE | typeof THERMOCYCLER_MODULE_TYPE | typeof HEATERSHAKER_MODULE_TYPE | typeof MAGNETIC_BLOCK_TYPE | typeof ABSORBANCE_READER_TYPE;
+export type ModuleType = typeof MAGNETIC_MODULE_TYPE | typeof TEMPERATURE_MODULE_TYPE | typeof THERMOCYCLER_MODULE_TYPE | typeof HEATERSHAKER_MODULE_TYPE | typeof MAGNETIC_BLOCK_TYPE | typeof ABSORBANCE_READER_TYPE | typeof FLEX_STACKER_MODULE_TYPE;
 export type MagneticModuleModel = typeof MAGNETIC_MODULE_V1 | typeof MAGNETIC_MODULE_V2;
 export type TemperatureModuleModel = typeof TEMPERATURE_MODULE_V1 | typeof TEMPERATURE_MODULE_V2;
 export type ThermocyclerModuleModel = typeof THERMOCYCLER_MODULE_V1 | typeof THERMOCYCLER_MODULE_V2;
 export type HeaterShakerModuleModel = typeof HEATERSHAKER_MODULE_V1;
 export type MagneticBlockModel = typeof MAGNETIC_BLOCK_V1;
 export type AbsorbanceReaderModel = typeof ABSORBANCE_READER_V1;
-export type ModuleModel = MagneticModuleModel | TemperatureModuleModel | ThermocyclerModuleModel | HeaterShakerModuleModel | MagneticBlockModel | AbsorbanceReaderModel;
+export type FlexStackerModuleModel = typeof FLEX_STACKER_MODULE_V1;
+export type ModuleModel = MagneticModuleModel | TemperatureModuleModel | ThermocyclerModuleModel | HeaterShakerModuleModel | MagneticBlockModel | AbsorbanceReaderModel | FlexStackerModuleModel;
 export type GripperModel = typeof GRIPPER_V1 | typeof GRIPPER_V1_1 | typeof GRIPPER_V1_2 | typeof GRIPPER_V1_3;
 export type ModuleModelWithLegacy = ModuleModel | typeof THERMOCYCLER | typeof MAGDECK | typeof TEMPDECK;
 export interface Dimensions {
@@ -299,9 +323,9 @@ export interface ModuleLayer {
 export interface ModuleDefinition {
     moduleType: ModuleType;
     model: ModuleModel;
-    labwareOffset: Coordinates;
+    labwareOffset: Vector3D;
     dimensions: ModuleDimensions;
-    cornerOffsetFromSlot: Coordinates;
+    cornerOffsetFromSlot: Vector3D;
     calibrationPoint: ModuleCalibrationPoint;
     displayName: string;
     quirks: string[];
@@ -327,6 +351,12 @@ export interface FlowRateSpec {
     min: number;
     max: number;
 }
+interface PlungerPositionsConfiguration {
+    top: number;
+    bottom: number;
+    blowout: number;
+    drop: number;
+}
 interface pressAndCamConfigurationValues {
     speed: number;
     distance: number;
@@ -368,12 +398,8 @@ export interface PipetteV2GeneralSpecs {
         run: number;
     };
     plungerPositionsConfigurations: {
-        default: {
-            top: number;
-            bottom: number;
-            blowout: number;
-            drop: number;
-        };
+        default: PlungerPositionsConfiguration;
+        lowVolumeDefault?: PlungerPositionsConfiguration;
     };
     availableSensors: {
         sensors: string[];
@@ -509,7 +535,7 @@ export interface LoadedLabware {
     id: string;
     loadName: string;
     definitionUri: string;
-    location: LabwareLocation;
+    location: LoadedLabwareLocation;
     offsetId?: string;
     displayName?: string;
 }
@@ -527,6 +553,101 @@ export interface Liquid {
     description: string;
     displayColor?: string;
 }
+export type LiquidHandlingPropertyByVolume = number[][];
+export type PositionReference = typeof POSITION_REFERENCE_BOTTOM | typeof POSITION_REFERENCE_CENTER | typeof POSITION_REFERENCE_TOP | typeof POSITION_REFERENCE_LIQUID_MENISCUS;
+type BlowoutLocation = 'source' | 'destination' | 'trash';
+interface DelayParams {
+    duration: number;
+}
+export interface TipPosition {
+    positionReference: PositionReference;
+    offset: Vector3D;
+}
+export interface DelayProperties {
+    enable: boolean;
+    params?: DelayParams;
+}
+interface TouchTipParams {
+    zOffset: number;
+    mmFromEdge: number;
+    speed: number;
+}
+export interface TouchTipProperties {
+    enable: boolean;
+    params?: TouchTipParams;
+}
+interface MixParams {
+    repetitions: number;
+    volume: number;
+}
+export interface MixProperties {
+    enable: boolean;
+    params?: MixParams;
+}
+interface BlowoutParams {
+    location: BlowoutLocation;
+    flowRate: number;
+}
+export interface BlowoutProperties {
+    enable: boolean;
+    params?: BlowoutParams;
+}
+export interface Submerge {
+    startPosition: TipPosition;
+    speed: number;
+    delay: DelayProperties;
+}
+interface BaseRetract {
+    endPosition: TipPosition;
+    speed: number;
+    airGapByVolume: LiquidHandlingPropertyByVolume;
+    touchTip: TouchTipProperties;
+    delay: DelayProperties;
+}
+export type RetractAspirate = BaseRetract;
+export interface RetractDispense extends BaseRetract {
+    blowout: BlowoutProperties;
+}
+interface BaseLiquidHandlingProperties<RetractType> {
+    submerge: Submerge;
+    retract: RetractType;
+    flowRateByVolume: LiquidHandlingPropertyByVolume;
+    correctionByVolume: LiquidHandlingPropertyByVolume;
+    delay: DelayProperties;
+}
+export interface AspirateProperties extends BaseLiquidHandlingProperties<RetractAspirate> {
+    aspiratePosition: TipPosition;
+    preWet: boolean;
+    mix: MixProperties;
+}
+export interface SingleDispenseProperties extends BaseLiquidHandlingProperties<RetractDispense> {
+    dispensePosition: TipPosition;
+    mix: MixProperties;
+    pushOutByVolume: LiquidHandlingPropertyByVolume;
+}
+export interface MultiDispenseProperties extends BaseLiquidHandlingProperties<RetractDispense> {
+    dispensePosition: TipPosition;
+    conditioningByVolume: LiquidHandlingPropertyByVolume;
+    disposalByVolume: LiquidHandlingPropertyByVolume;
+}
+export interface ByTipTypeSetting {
+    tiprack: string;
+    aspirate: AspirateProperties;
+    singleDispense: SingleDispenseProperties;
+    multiDispense?: MultiDispenseProperties;
+}
+interface ByPipetteSetting {
+    pipetteModel: string;
+    byTipType: ByTipTypeSetting[];
+}
+export interface LiquidClass {
+    liquidClassName: string;
+    displayName: string;
+    description: string;
+    schemaVersion: number;
+    namespace: string;
+    byPipette: ByPipetteSetting[];
+}
 export interface AnalysisError {
     id: string;
     detail: string;
@@ -612,6 +733,7 @@ export interface CompletedProtocolAnalysis {
     errors: AnalysisError[];
     robotType?: RobotType | null;
     runTimeParameters?: RunTimeParameter[];
+    commandAnnotations?: CommandAnnotation[];
 }
 export interface ResourceFile {
     name: string;

package/lib/labware/definitions/{3 → 2}/agilent_1_reservoir_290ml/2.json

@@ -46,7 +46,7 @@
     },
     "namespace": "opentrons",
     "version": 2,
-    "schemaVersion": 3,
+    "schemaVersion": 2,
     "cornerOffsetFromSlot": {
         "x": 0,
         "y": 0,
@@ -57,22 +57,22 @@
             "sections": [
                 {
                     "shape": "cuboidal",
-                    "topXDimension": 107.25,
+                    "topXDimension": 107.5,
+                    "topYDimension": 71.25,
+                    "bottomXDimension": 106.79,
+                    "bottomYDimension": 71.0,
+                    "topHeight": 39.23,
+                    "bottomHeight": 2.0
+                },
+                {
+                    "shape": "cuboidal",
+                    "topXDimension": 106.79,
                     "topYDimension": 8,
                     "bottomXDimension": 101.25,
                     "bottomYDimension": 1.66,
                     "topHeight": 2,
-                    "bottomHeight": 8,
+                    "bottomHeight": 0,
                     "yCount": 8
-                },
-                {
-                    "shape": "cuboidal",
-                    "topXDimension": 107.5,
-                    "topYDimension": 71.25,
-                    "bottomXDimension": 107.25,
-                    "bottomYDimension": 71.0,
-                    "topHeight": 39.22,
-                    "bottomHeight": 2
                 }
             ]
         }

package/lib/labware/definitions/2/agilent_1_reservoir_290ml/3.json

@@ -0,0 +1,80 @@
+{
+    "ordering": [["A1"]],
+    "brand": {
+        "brand": "Agilent",
+        "brandId": ["201252-100"],
+        "links": ["https://www.agilent.com/store/en_US/Prod-201252-100/201252-100"]
+    },
+    "metadata": {
+        "displayName": "Agilent 1 Well Reservoir 290 mL",
+        "displayCategory": "reservoir",
+        "displayVolumeUnits": "mL",
+        "tags": []
+    },
+    "dimensions": {
+        "xDimension": 127.76,
+        "yDimension": 85.57,
+        "zDimension": 44.04
+    },
+    "wells": {
+        "A1": {
+            "depth": 39.23,
+            "shape": "rectangular",
+            "xDimension": 108,
+            "yDimension": 72,
+            "totalLiquidVolume": 290000,
+            "x": 63.88,
+            "y": 42.785,
+            "z": 4.81,
+            "geometryDefinitionId": "cuboidalWell"
+        }
+    },
+    "groups": [
+        {
+            "wells": ["A1"],
+            "metadata": {
+                "wellBottomShape": "v"
+            }
+        }
+    ],
+    "parameters": {
+        "format": "trough",
+        "isTiprack": false,
+        "isMagneticModuleCompatible": false,
+        "loadName": "agilent_1_reservoir_290ml",
+        "quirks": ["centerMultichannelOnWells", "touchTipDisabled"]
+    },
+    "namespace": "opentrons",
+    "version": 3,
+    "schemaVersion": 2,
+    "cornerOffsetFromSlot": {
+        "x": 0,
+        "y": 0,
+        "z": 0
+    },
+    "innerLabwareGeometry": {
+        "cuboidalWell": {
+            "sections": [
+                {
+                    "shape": "cuboidal",
+                    "topXDimension": 107.5,
+                    "topYDimension": 71.25,
+                    "bottomXDimension": 106.785,
+                    "bottomYDimension": 71.0,
+                    "topHeight": 39.23,
+                    "bottomHeight": 2.0
+                },
+                {
+                    "shape": "cuboidal",
+                    "topXDimension": 106.785,
+                    "topYDimension": 8,
+                    "bottomXDimension": 100.75,
+                    "bottomYDimension": 1.66,
+                    "topHeight": 2,
+                    "bottomHeight": 0,
+                    "yCount": 8
+                }
+            ]
+        }
+    }
+}

package/lib/labware/definitions/{3 → 2}/appliedbiosystemsmicroamp_384_wellplate_40ul/2.json

@@ -441,9 +441,9 @@
         ]
     },
     "metadata": {
-        "displayName": "Applied Biosystems MicroAmp 384 Well Plate 40 \u00b5L",
+        "displayName": "Applied Biosystems MicroAmp 384 Well Plate 40 µL",
         "displayCategory": "wellPlate",
-        "displayVolumeUnits": "\u00b5L",
+        "displayVolumeUnits": "µL",
         "tags": []
     },
     "dimensions": {
@@ -4695,7 +4695,7 @@
     },
     "namespace": "opentrons",
     "version": 2,
-    "schemaVersion": 3,
+    "schemaVersion": 2,
     "cornerOffsetFromSlot": {
         "x": 0,
         "y": 0,
@@ -4705,24 +4705,24 @@
         "conicalWell": {
             "sections": [
                 {
-                    "shape": "spherical",
-                    "radiusOfCurvature": 0.89,
-                    "topHeight": 0.34,
-                    "bottomHeight": 0.0
+                    "shape": "conical",
+                    "bottomDiameter": 3.17,
+                    "topDiameter": 3.17,
+                    "topHeight": 9.09,
+                    "bottomHeight": 5.77
                 },
                 {
                     "shape": "conical",
-                    "bottomDiameter": 1.4,
                     "topDiameter": 3.17,
+                    "bottomDiameter": 1.4,
                     "topHeight": 5.77,
                     "bottomHeight": 0.34
                 },
                 {
-                    "shape": "conical",
-                    "bottomDiameter": 3.17,
-                    "topDiameter": 3.17,
-                    "topHeight": 9.09,
-                    "bottomHeight": 5.77
+                    "shape": "spherical",
+                    "radiusOfCurvature": 0.89,
+                    "topHeight": 0.34,
+                    "bottomHeight": 0.0
                 }
             ]
         }

package/lib/labware/definitions/{3 → 2}/armadillo_96_wellplate_200ul_pcr_full_skirt/3.json

@@ -1,7 +1,7 @@
 {
     "namespace": "opentrons",
     "version": 3,
-    "schemaVersion": 3,
+    "schemaVersion": 2,
     "parameters": {
         "loadName": "armadillo_96_wellplate_200ul_pcr_full_skirt",
         "format": "96Standard",
@@ -9,9 +9,9 @@
         "isMagneticModuleCompatible": true
     },
     "metadata": {
-        "displayName": "Armadillo 96 Well Plate 200 \u00b5L PCR Full Skirt",
+        "displayName": "Armadillo 96 Well Plate 200 µL PCR Full Skirt",
         "displayCategory": "wellPlate",
-        "displayVolumeUnits": "\u00b5L",
+        "displayVolumeUnits": "µL",
         "tags": []
     },
     "brand": {
@@ -1142,10 +1142,11 @@
         "conicalWell": {
             "sections": [
                 {
-                    "shape": "spherical",
-                    "radiusOfCurvature": 1.25,
-                    "topHeight": 0.8,
-                    "bottomHeight": 0.0
+                    "shape": "conical",
+                    "bottomDiameter": 5.5,
+                    "topDiameter": 5.5,
+                    "topHeight": 14.95,
+                    "bottomHeight": 11.35
                 },
                 {
                     "shape": "conical",
@@ -1155,11 +1156,10 @@
                     "bottomHeight": 0.8
                 },
                 {
-                    "shape": "conical",
-                    "bottomDiameter": 5.5,
-                    "topDiameter": 5.5,
-                    "topHeight": 14.95,
-                    "bottomHeight": 11.35
+                    "shape": "spherical",
+                    "radiusOfCurvature": 1.25,
+                    "topHeight": 0.8,
+                    "bottomHeight": 0.0
                 }
             ]
         }

package/lib/labware/definitions/{3 → 2}/axygen_1_reservoir_90ml/2.json

@@ -48,7 +48,7 @@
     },
     "namespace": "opentrons",
     "version": 2,
-    "schemaVersion": 3,
+    "schemaVersion": 2,
     "cornerOffsetFromSlot": {
         "x": 0,
         "y": 0,

package/lib/labware/definitions/{3 → 2}/biorad_384_wellplate_50ul/3.json

@@ -450,9 +450,9 @@
         ]
     },
     "metadata": {
-        "displayName": "Bio-Rad 384 Well Plate 50 \u00b5L",
+        "displayName": "Bio-Rad 384 Well Plate 50 µL",
         "displayCategory": "wellPlate",
-        "displayVolumeUnits": "\u00b5L",
+        "displayVolumeUnits": "µL",
         "tags": []
     },
     "dimensions": {
@@ -4706,7 +4706,7 @@
     },
     "namespace": "opentrons",
     "version": 3,
-    "schemaVersion": 3,
+    "schemaVersion": 2,
     "cornerOffsetFromSlot": {
         "x": 0,
         "y": 0,
@@ -4716,10 +4716,11 @@
         "conicalWell": {
             "sections": [
                 {
-                    "shape": "spherical",
-                    "radiusOfCurvature": 0.94,
-                    "topHeight": 0.35,
-                    "bottomHeight": 0.0
+                    "shape": "conical",
+                    "bottomDiameter": 3,
+                    "topDiameter": 3.1,
+                    "topHeight": 9.35,
+                    "bottomHeight": 5.35
                 },
                 {
                     "shape": "conical",
@@ -4729,11 +4730,10 @@
                     "bottomHeight": 0.35
                 },
                 {
-                    "shape": "conical",
-                    "bottomDiameter": 3,
-                    "topDiameter": 3.1,
-                    "topHeight": 9.35,
-                    "bottomHeight": 5.35
+                    "shape": "spherical",
+                    "radiusOfCurvature": 0.94,
+                    "topHeight": 0.35,
+                    "bottomHeight": 0.0
                 }
             ]
         }