@opentrons/shared-data 0.1.7-alpha.1 → 0.2.1-alpha.0

package/labware/fixtures/3/fixture_corning_24_plate.json

@@ -16,7 +16,7 @@
   },
   "schemaVersion": 3,
   "version": 3,
-  "namespace": "opentrons",
+  "namespace": "fixture",
   "metadata": {
     "displayName": "Corning 24 Well Plate 3.4 mL Flat",
     "displayVolumeUnits": "mL",
@@ -35,8 +35,11 @@
         "y": -85.47,
         "z": 20.27
       }
-    },
-    "footprint": {
+    }
+  },
+  "features": {
+    "slotFootprintAsChild": {
+      "z": 0,
       "backLeft": {
         "x": 0,
         "y": 0

package/labware/fixtures/3/index.ts

@@ -0,0 +1,4 @@
+import fixture_2_plate from './fixture_2_plate.json'
+import fixture_corning_24_plate from './fixture_corning_24_plate.json'
+
+export { fixture_2_plate, fixture_corning_24_plate }

package/labware/schemas/3.json

@@ -496,6 +496,7 @@
     "parameters",
     "ordering",
     "extents",
+    "features",
     "wells",
     "groups"
   ],
@@ -614,18 +615,69 @@
       }
     },
     "extents": {
-      "description": "The outer dimensions of the labware.",
+      "description": "The outer dimensions of the labware. Includes offsets from `cornerOffsetFromSlot`.",
       "type": "object",
-      "required": ["total", "footprint"],
+      "required": ["total"],
       "additionalProperties": false,
       "properties": {
         "total": {
           "description": "The all-encompassing outer dimensions of the labware.",
           "$ref": "#/definitions/axisAlignedBoundingBox3D"
+        }
+      }
+    },
+    "features": {
+      "type": "object",
+      "description": "Locating features when this labware is a part of a stackup.",
+      "required": [],
+      "properties": {
+        "slotFootprintAsChild": {
+          "description": "The 3D plane of the labware that makes physical contact with a parent entity. Constrained by the dimensions of a slot.",
+          "type": "object",
+          "required": ["backLeft", "frontRight", "z"],
+          "properties": {
+            "backLeft": {
+              "description": "(-x, +y) relative to the labware origin.",
+              "$ref": "#/definitions/vector2D"
+            },
+            "frontRight": {
+              "description": "(+x, -y) relative to the labware origin.",
+              "$ref": "#/definitions/vector2D"
+            },
+            "z": {
+              "description": "Always zero by convention. Z-coordinate of the footprint plane.",
+              "type": "number"
+            },
+            "springDirectionalForce": {
+              "description": "Applicable when the labware contains a spring that influences its position when placed on a parent deck item.",
+              "type": "string",
+              "enum": ["backLeftBottom"]
+            }
+          }
         },
-        "footprint": {
-          "description": "The outer dimensions of the labware where it meets the deck.",
-          "$ref": "#/definitions/axisAlignedBoundingBox2D"
+        "slotFootprintAsParent": {
+          "description": "The 2D plane on which a child deck item resides.",
+          "type": "object",
+          "required": ["backLeft", "frontRight", "z"],
+          "properties": {
+            "backLeft": {
+              "description": "(-x, +y), the back left corner of a labware's mating plane.",
+              "$ref": "#/definitions/vector2D"
+            },
+            "frontRight": {
+              "description": "(+x, -y), the back left corner of a labware's module plane.",
+              "$ref": "#/definitions/vector2D"
+            },
+            "z": {
+              "description": "The z-offset from this labware's origin to the plane on which a child deck item resides.",
+              "type": "number"
+            },
+            "springDirectionalForce": {
+              "description": "Applicable when the labware contains a spring that influences the positioning of a child deck item.",
+              "type": "string",
+              "enum": ["backLeftBottom"]
+            }
+          }
         }
       }
     },

package/lib/command/index.d.ts

@@ -5,6 +5,7 @@ import commandSchemaV10 from './schemas/10.json';
 import commandSchemaV11 from './schemas/11.json';
 import commandSchemaV12 from './schemas/12.json';
 import commandSchemaV13 from './schemas/13.json';
+import commandSchemaV14 from './schemas/14.json';
 export * from './types/index';
 export declare const commandSchemaLatest: {
     $defs: {
@@ -253,6 +254,7 @@ export declare const commandSchemaLatest: {
             type: string;
         };
         AspirateProperties: {
+            additionalProperties: boolean;
             description: string;
             properties: {
                 aspiratePosition: {
@@ -511,6 +513,7 @@ export declare const commandSchemaLatest: {
             type: string;
         };
         BlowoutParams: {
+            additionalProperties: boolean;
             description: string;
             properties: {
                 flowRate: {
@@ -531,6 +534,7 @@ export declare const commandSchemaLatest: {
             type: string;
         };
         BlowoutProperties: {
+            additionalProperties: boolean;
             description: string;
             properties: {
                 enable: {
@@ -1241,6 +1245,7 @@ export declare const commandSchemaLatest: {
             type: string;
         };
         DelayParams: {
+            additionalProperties: boolean;
             description: string;
             properties: {
                 duration: {
@@ -1257,6 +1262,7 @@ export declare const commandSchemaLatest: {
             type: string;
         };
         DelayProperties: {
+            additionalProperties: boolean;
             description: string;
             properties: {
                 enable: {
@@ -2037,6 +2043,14 @@ export declare const commandSchemaLatest: {
         IdentifyModuleParams: {
             description: string;
             properties: {
+                color: {
+                    anyOf: {
+                        type: string;
+                    }[];
+                    default: null;
+                    description: string;
+                    title: string;
+                };
                 model: {
                     $ref: string;
                     description: string;
@@ -2046,6 +2060,11 @@ export declare const commandSchemaLatest: {
                     title: string;
                     type: string;
                 };
+                start: {
+                    description: string;
+                    title: string;
+                    type: string;
+                };
             };
             required: string[];
             title: string;
@@ -2144,6 +2163,7 @@ export declare const commandSchemaLatest: {
             type: string;
         };
         LiquidClassRecord: {
+            additionalProperties: boolean;
             description: string;
             properties: {
                 aspirate: {
@@ -2180,6 +2200,7 @@ export declare const commandSchemaLatest: {
             type: string;
         };
         LiquidClassTouchTipParams: {
+            additionalProperties: boolean;
             description: string;
             properties: {
                 mmFromEdge: {
@@ -2740,6 +2761,7 @@ export declare const commandSchemaLatest: {
             type: string;
         };
         MixParams: {
+            additionalProperties: boolean;
             description: string;
             properties: {
                 repetitions: {
@@ -2762,6 +2784,7 @@ export declare const commandSchemaLatest: {
             type: string;
         };
         MixProperties: {
+            additionalProperties: boolean;
             description: string;
             properties: {
                 enable: {
@@ -3426,6 +3449,7 @@ export declare const commandSchemaLatest: {
             type: string;
         };
         MultiDispenseProperties: {
+            additionalProperties: boolean;
             description: string;
             properties: {
                 conditioningByVolume: {
@@ -3968,6 +3992,7 @@ export declare const commandSchemaLatest: {
             type: string;
         };
         RetractAspirate: {
+            additionalProperties: boolean;
             description: string;
             properties: {
                 airGapByVolume: {
@@ -4052,6 +4077,7 @@ export declare const commandSchemaLatest: {
             type: string;
         };
         RetractDispense: {
+            additionalProperties: boolean;
             description: string;
             properties: {
                 airGapByVolume: {
@@ -4627,6 +4653,14 @@ export declare const commandSchemaLatest: {
                     title: string;
                     type: string;
                 };
+                poolOverlapOverride: {
+                    anyOf: {
+                        type: string;
+                    }[];
+                    default: null;
+                    description: string;
+                    title: string;
+                };
                 primaryLabware: {
                     $ref: string;
                     description: string;
@@ -4739,6 +4773,7 @@ export declare const commandSchemaLatest: {
             type: string;
         };
         SingleDispenseProperties: {
+            additionalProperties: boolean;
             description: string;
             properties: {
                 correctionByVolume: {
@@ -4938,6 +4973,7 @@ export declare const commandSchemaLatest: {
             type: string;
         };
         Submerge: {
+            additionalProperties: boolean;
             description: string;
             properties: {
                 delay: {
@@ -4987,6 +5023,7 @@ export declare const commandSchemaLatest: {
             type: string;
         };
         TipPosition: {
+            additionalProperties: boolean;
             description: string;
             properties: {
                 offset: {
@@ -5080,6 +5117,7 @@ export declare const commandSchemaLatest: {
             type: string;
         };
         TouchTipProperties: {
+            additionalProperties: boolean;
             description: string;
             properties: {
                 enable: {
@@ -6404,4 +6442,4 @@ export declare const commandSchemaLatest: {
         $ref: string;
     }[];
 };
-export { commandSchemaV7, commandSchemaV8, commandSchemaV9, commandSchemaV10, commandSchemaV11, commandSchemaV12, commandSchemaV13, };
+export { commandSchemaV7, commandSchemaV8, commandSchemaV9, commandSchemaV10, commandSchemaV11, commandSchemaV12, commandSchemaV13, commandSchemaV14, };

package/lib/command/types/index.d.ts

@@ -89,7 +89,7 @@ export interface RunCommandErrorFlexStackerStall extends RunCommandErrorBase {
         labwareId?: string;
     };
 }
-export interface RunCommandErrorFlexStackerShuttle extends RunCommandErrorBase {
+export interface RunCommandErrorFlexStackerShuttleMissing extends RunCommandErrorBase {
     errorCode: '3020';
     errorType: 'flexStackerShuttleMissing';
     isDefined: true;
@@ -97,7 +97,15 @@ export interface RunCommandErrorFlexStackerShuttle extends RunCommandErrorBase {
         labwareId?: string;
     };
 }
-export interface RunCommandErrorFlexStackerHopper extends RunCommandErrorBase {
+export interface RunCommandErrorFlexStackerShuttleLabware extends RunCommandErrorBase {
+    errorCode: '3021';
+    errorType: 'flexStackerLabwareRetrieveFailed';
+    isDefined: true;
+    errorInfo: {
+        labwareId?: string;
+    };
+}
+export interface RunCommandErrorFlexStackerHopperLabware extends RunCommandErrorBase {
     errorCode: '3022';
     errorType: 'flexStackerHopperLabwareFailed';
     isDefined: true;
@@ -105,4 +113,4 @@ export interface RunCommandErrorFlexStackerHopper extends RunCommandErrorBase {
         labwareId?: string;
     };
 }
-export type RunCommandFlexStackerError = RunCommandErrorFlexStackerStall | RunCommandErrorFlexStackerShuttle | RunCommandErrorFlexStackerHopper;
+export type RunCommandFlexStackerError = RunCommandErrorFlexStackerStall | RunCommandErrorFlexStackerShuttleMissing | RunCommandErrorFlexStackerHopperLabware | RunCommandErrorFlexStackerShuttleLabware;

package/lib/command/types/module.d.ts

@@ -1,8 +1,8 @@
 import type { CommonCommandCreateInfo, CommonCommandRunTimeInfo, RunCommandFlexStackerError } from '.';
-import type { LabwareDefinition2 } from '../../js';
+import type { LabwareDefinition } from '../../js';
 import type { LabwareLocationSequence } from './setup';
-export type ModuleRunTimeCommand = MagneticModuleEngageMagnetRunTimeCommand | MagneticModuleDisengageRunTimeCommand | TemperatureModuleSetTargetTemperatureRunTimeCommand | TemperatureModuleDeactivateRunTimeCommand | TemperatureModuleAwaitTemperatureRunTimeCommand | TCSetTargetBlockTemperatureRunTimeCommand | TCSetTargetLidTemperatureRunTimeCommand | TCWaitForBlockTemperatureRunTimeCommand | TCWaitForLidTemperatureRunTimeCommand | TCOpenLidRunTimeCommand | TCCloseLidRunTimeCommand | TCDeactivateBlockRunTimeCommand | TCDeactivateLidRunTimeCommand | TCRunProfileRunTimeCommand | TCRunExtendedProfileRunTimeCommand | TCAwaitProfileCompleteRunTimeCommand | HeaterShakerSetTargetTemperatureRunTimeCommand | HeaterShakerWaitForTemperatureRunTimeCommand | HeaterShakerSetAndWaitForShakeSpeedRunTimeCommand | HeaterShakerOpenLatchRunTimeCommand | HeaterShakerCloseLatchRunTimeCommand | HeaterShakerDeactivateHeaterRunTimeCommand | HeaterShakerDeactivateShakerRunTimeCommand | AbsorbanceReaderOpenLidRunTimeCommand | AbsorbanceReaderCloseLidRunTimeCommand | AbsorbanceReaderInitializeRunTimeCommand | AbsorbanceReaderReadRunTimeCommand | FlexStackerSetStoredLabwareRunTimeCommand | FlexStackerRetrieveRunTimeCommand | FlexStackerStoreRunTimeCommand | FlexStackerFillRunTimeCommand | FlexStackerEmptyRunTimeCommand;
-export type ModuleCreateCommand = MagneticModuleEngageMagnetCreateCommand | MagneticModuleDisengageCreateCommand | TemperatureModuleSetTargetTemperatureCreateCommand | TemperatureModuleDeactivateCreateCommand | TemperatureModuleAwaitTemperatureCreateCommand | TCSetTargetBlockTemperatureCreateCommand | TCSetTargetLidTemperatureCreateCommand | TCWaitForBlockTemperatureCreateCommand | TCWaitForLidTemperatureCreateCommand | TCOpenLidCreateCommand | TCCloseLidCreateCommand | TCDeactivateBlockCreateCommand | TCDeactivateLidCreateCommand | TCRunProfileCreateCommand | TCRunExtendedProfileCreateCommand | TCAwaitProfileCompleteCreateCommand | HeaterShakerWaitForTemperatureCreateCommand | HeaterShakerSetAndWaitForShakeSpeedCreateCommand | HeaterShakerOpenLatchCreateCommand | HeaterShakerCloseLatchCreateCommand | HeaterShakerDeactivateHeaterCreateCommand | HeaterShakerDeactivateShakerCreateCommand | HeaterShakerSetTargetTemperatureCreateCommand | AbsorbanceReaderOpenLidCreateCommand | AbsorbanceReaderCloseLidCreateCommand | AbsorbanceReaderInitializeCreateCommand | AbsorbanceReaderReadCreateCommand | FlexStackerSetStoredLabwareCreateCommand | FlexStackerRetrieveCreateCommand | FlexStackerStoreCreateCommand | FlexStackerFillCreateCommand | FlexStackerEmptyCreateCommand | FlexStackerPrepareShuttleCreateCommand | FlexStackerOpenLatch | FlexStackerCloseLatch;
+export type ModuleRunTimeCommand = MagneticModuleEngageMagnetRunTimeCommand | MagneticModuleDisengageRunTimeCommand | TemperatureModuleSetTargetTemperatureRunTimeCommand | TemperatureModuleDeactivateRunTimeCommand | TemperatureModuleAwaitTemperatureRunTimeCommand | TCSetTargetBlockTemperatureRunTimeCommand | TCSetTargetLidTemperatureRunTimeCommand | TCWaitForBlockTemperatureRunTimeCommand | TCWaitForLidTemperatureRunTimeCommand | TCOpenLidRunTimeCommand | TCCloseLidRunTimeCommand | TCDeactivateBlockRunTimeCommand | TCDeactivateLidRunTimeCommand | TCRunProfileRunTimeCommand | TCRunExtendedProfileRunTimeCommand | TCAwaitProfileCompleteRunTimeCommand | HeaterShakerSetTargetTemperatureRunTimeCommand | HeaterShakerWaitForTemperatureRunTimeCommand | HeaterShakerSetAndWaitForShakeSpeedRunTimeCommand | HeaterShakerOpenLatchRunTimeCommand | HeaterShakerCloseLatchRunTimeCommand | HeaterShakerDeactivateHeaterRunTimeCommand | HeaterShakerDeactivateShakerRunTimeCommand | AbsorbanceReaderOpenLidRunTimeCommand | AbsorbanceReaderCloseLidRunTimeCommand | AbsorbanceReaderInitializeRunTimeCommand | AbsorbanceReaderReadRunTimeCommand | FlexStackerSetStoredLabwareRunTimeCommand | FlexStackerRetrieveRunTimeCommand | FlexStackerStoreRunTimeCommand | FlexStackerFillRunTimeCommand | FlexStackerEmptyRunTimeCommand | IdentifyModuleRunTimeCommand;
+export type ModuleCreateCommand = MagneticModuleEngageMagnetCreateCommand | MagneticModuleDisengageCreateCommand | TemperatureModuleSetTargetTemperatureCreateCommand | TemperatureModuleDeactivateCreateCommand | TemperatureModuleAwaitTemperatureCreateCommand | TCSetTargetBlockTemperatureCreateCommand | TCSetTargetLidTemperatureCreateCommand | TCWaitForBlockTemperatureCreateCommand | TCWaitForLidTemperatureCreateCommand | TCOpenLidCreateCommand | TCCloseLidCreateCommand | TCDeactivateBlockCreateCommand | TCDeactivateLidCreateCommand | TCRunProfileCreateCommand | TCRunExtendedProfileCreateCommand | TCAwaitProfileCompleteCreateCommand | HeaterShakerWaitForTemperatureCreateCommand | HeaterShakerSetAndWaitForShakeSpeedCreateCommand | HeaterShakerOpenLatchCreateCommand | HeaterShakerCloseLatchCreateCommand | HeaterShakerDeactivateHeaterCreateCommand | HeaterShakerDeactivateShakerCreateCommand | HeaterShakerSetTargetTemperatureCreateCommand | AbsorbanceReaderOpenLidCreateCommand | AbsorbanceReaderCloseLidCreateCommand | AbsorbanceReaderInitializeCreateCommand | AbsorbanceReaderReadCreateCommand | FlexStackerSetStoredLabwareCreateCommand | FlexStackerRetrieveCreateCommand | FlexStackerStoreCreateCommand | FlexStackerFillCreateCommand | FlexStackerEmptyCreateCommand | FlexStackerPrepareShuttleCreateCommand | FlexStackerOpenLatch | FlexStackerCloseLatch | IdentifyModuleCreateCommand;
 export interface MagneticModuleEngageMagnetCreateCommand extends CommonCommandCreateInfo {
     commandType: 'magneticModule/engage';
     params: EngageMagnetParams;
@@ -280,9 +280,9 @@ export interface FlexStackerSetStoredLabwareCreateCommand extends CommonCommandC
 }
 export interface FlexStackerSetStoredLabwareRunTimeCommand extends FlexStackerSetStoredLabwareCreateCommand, CommonCommandRunTimeInfo {
     result?: {
-        primaryLabwareDefinition: LabwareDefinition2;
-        lidLabwareDefinition?: LabwareDefinition2 | null;
-        adapterLabwareDefinition?: LabwareDefinition2 | null;
+        primaryLabwareDefinition: LabwareDefinition;
+        lidLabwareDefinition?: LabwareDefinition | null;
+        adapterLabwareDefinition?: LabwareDefinition | null;
         count: number;
         storedLabware: FlexStackerStoredLabwareGroup[];
     } & StackerStoredLabwareLocationSequences;
@@ -395,4 +395,17 @@ export interface FlexStackerEmptyRunTimeCommand extends FlexStackerEmptyCreateCo
         removedLabware?: FlexStackerStoredLabwareGroup[] | null;
     } & StackerStoredLabwareLocationSequences & StackerStoredLabwareDefinitionURIs;
 }
+export type IdentifyColor = 'white' | 'red' | 'green' | 'blue' | 'yellow' | null;
+export interface IdentifyModuleCreateCommand extends CommonCommandCreateInfo {
+    commandType: 'identifyModule';
+    params: {
+        model: string;
+        moduleId: string;
+        start: boolean;
+        color?: IdentifyColor;
+    };
+}
+export interface IdentifyModuleRunTimeCommand extends CommonCommandRunTimeInfo, IdentifyModuleCreateCommand {
+    result?: any;
+}
 export {};

package/lib/command/types/setup.d.ts

@@ -1,4 +1,4 @@
-import type { AddressableAreaName, AspirateProperties, CommonCommandCreateInfo, CommonCommandRunTimeInfo, LabwareDefinition2, LabwareOffset, ModuleModel, MultiDispenseProperties, PipetteName, SingleDispenseProperties } from '../../js';
+import type { AddressableAreaName, AspirateProperties, CommonCommandCreateInfo, CommonCommandRunTimeInfo, LabwareDefinition, LabwareOffset, ModuleModel, MultiDispenseProperties, PipetteName, SingleDispenseProperties } from '../../js';
 export interface LoadPipetteCreateCommand extends CommonCommandCreateInfo {
     commandType: 'loadPipette';
     params: LoadPipetteParams;
@@ -154,7 +154,7 @@ interface LoadLabwareParams {
 }
 interface LoadLabwareResult {
     labwareId: string;
-    definition: LabwareDefinition2;
+    definition: LabwareDefinition;
     offset: LabwareOffset;
     locationSequence?: LabwareLocationSequence;
 }
@@ -232,8 +232,8 @@ interface LoadLidStackParams {
 interface LoadLidStackResult {
     stackLabwareId: string;
     labwareIds: string[];
-    definition?: LabwareDefinition2;
-    lidStackDefinition: LabwareDefinition2;
+    definition?: LabwareDefinition;
+    lidStackDefinition: LabwareDefinition;
     location: LabwareLocation;
     stackLocationSequence?: LabwareLocationSequence;
     locationSequences?: LabwareLocationSequence[];
@@ -246,7 +246,7 @@ export interface LoadLidParams {
 }
 interface LoadLidResult {
     labwareId: string;
-    definition: LabwareDefinition2;
+    definition: LabwareDefinition;
     locationSequence?: LabwareLocationSequence;
 }
 export {};