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

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 {};

package/lib/deck/definitions/5/ot2_short_trash.json

@@ -23,6 +23,9 @@
                     "zDimension": 0
                 },
                 "displayName": "Slot 1",
+                "features": {
+                    "springDirectionalForceAsParent": "backLeftBottom"
+                },
                 "compatibleModuleTypes": [
                     "magneticModuleType",
                     "temperatureModuleType",
@@ -40,6 +43,9 @@
                     "zDimension": 0
                 },
                 "displayName": "Slot 2",
+                "features": {
+                    "springDirectionalForceAsParent": "backLeftBottom"
+                },
                 "compatibleModuleTypes": [
                     "magneticModuleType",
                     "temperatureModuleType",
@@ -57,6 +63,9 @@
                     "zDimension": 0
                 },
                 "displayName": "Slot 3",
+                "features": {
+                    "springDirectionalForceAsParent": "backLeftBottom"
+                },
                 "compatibleModuleTypes": [
                     "magneticModuleType",
                     "temperatureModuleType",
@@ -74,6 +83,9 @@
                     "zDimension": 0
                 },
                 "displayName": "Slot 4",
+                "features": {
+                    "springDirectionalForceAsParent": "backLeftBottom"
+                },
                 "compatibleModuleTypes": [
                     "magneticModuleType",
                     "temperatureModuleType",
@@ -91,6 +103,9 @@
                     "zDimension": 0
                 },
                 "displayName": "Slot 5",
+                "features": {
+                    "springDirectionalForceAsParent": "backLeftBottom"
+                },
                 "compatibleModuleTypes": [
                     "magneticModuleType",
                     "temperatureModuleType",
@@ -108,6 +123,9 @@
                     "zDimension": 0
                 },
                 "displayName": "Slot 6",
+                "features": {
+                    "springDirectionalForceAsParent": "backLeftBottom"
+                },
                 "compatibleModuleTypes": [
                     "magneticModuleType",
                     "temperatureModuleType",
@@ -125,6 +143,9 @@
                     "zDimension": 0
                 },
                 "displayName": "Slot 7",
+                "features": {
+                    "springDirectionalForceAsParent": "backLeftBottom"
+                },
                 "compatibleModuleTypes": [
                     "magneticModuleType",
                     "temperatureModuleType",
@@ -143,6 +164,9 @@
                     "zDimension": 0
                 },
                 "displayName": "Slot 8",
+                "features": {
+                    "springDirectionalForceAsParent": "backLeftBottom"
+                },
                 "compatibleModuleTypes": [
                     "magneticModuleType",
                     "temperatureModuleType",
@@ -160,6 +184,9 @@
                     "zDimension": 0
                 },
                 "displayName": "Slot 9",
+                "features": {
+                    "springDirectionalForceAsParent": "backLeftBottom"
+                },
                 "compatibleModuleTypes": [
                     "magneticModuleType",
                     "temperatureModuleType",
@@ -177,6 +204,9 @@
                     "zDimension": 0
                 },
                 "displayName": "Slot 10",
+                "features": {
+                    "springDirectionalForceAsParent": "backLeftBottom"
+                },
                 "compatibleModuleTypes": [
                     "magneticModuleType",
                     "temperatureModuleType",
@@ -194,6 +224,9 @@
                     "zDimension": 0
                 },
                 "displayName": "Slot 11",
+                "features": {
+                    "springDirectionalForceAsParent": "backLeftBottom"
+                },
                 "compatibleModuleTypes": [
                     "magneticModuleType",
                     "temperatureModuleType",
@@ -210,6 +243,9 @@
                     "zDimension": 0
                 },
                 "displayName": "Slot 12",
+                "features": {
+                    "springDirectionalForceAsParent": "backLeftBottom"
+                },
                 "compatibleModuleTypes": []
             },
             {
@@ -222,6 +258,7 @@
                     "zDimension": 58
                 },
                 "displayName": "Slot 12/Short Fixed Trash",
+                "features": {},
                 "ableToDropTips": true
             }
         ],

package/lib/deck/definitions/5/ot2_standard.json

@@ -23,6 +23,9 @@
                     "zDimension": 0
                 },
                 "displayName": "Slot 1",
+                "features": {
+                    "springDirectionalForceAsParent": "backLeftBottom"
+                },
                 "compatibleModuleTypes": [
                     "magneticModuleType",
                     "temperatureModuleType",
@@ -40,6 +43,9 @@
                     "zDimension": 0
                 },
                 "displayName": "Slot 2",
+                "features": {
+                    "springDirectionalForceAsParent": "backLeftBottom"
+                },
                 "compatibleModuleTypes": [
                     "magneticModuleType",
                     "temperatureModuleType",
@@ -57,6 +63,9 @@
                     "zDimension": 0
                 },
                 "displayName": "Slot 3",
+                "features": {
+                    "springDirectionalForceAsParent": "backLeftBottom"
+                },
                 "compatibleModuleTypes": [
                     "magneticModuleType",
                     "temperatureModuleType",
@@ -74,6 +83,9 @@
                     "zDimension": 0
                 },
                 "displayName": "Slot 4",
+                "features": {
+                    "springDirectionalForceAsParent": "backLeftBottom"
+                },
                 "compatibleModuleTypes": [
                     "magneticModuleType",
                     "temperatureModuleType",
@@ -91,6 +103,9 @@
                     "zDimension": 0
                 },
                 "displayName": "Slot 5",
+                "features": {
+                    "springDirectionalForceAsParent": "backLeftBottom"
+                },
                 "compatibleModuleTypes": [
                     "magneticModuleType",
                     "temperatureModuleType",
@@ -108,6 +123,9 @@
                     "zDimension": 0
                 },
                 "displayName": "Slot 6",
+                "features": {
+                    "springDirectionalForceAsParent": "backLeftBottom"
+                },
                 "compatibleModuleTypes": [
                     "magneticModuleType",
                     "temperatureModuleType",
@@ -125,6 +143,9 @@
                     "zDimension": 0
                 },
                 "displayName": "Slot 7",
+                "features": {
+                    "springDirectionalForceAsParent": "backLeftBottom"
+                },
                 "compatibleModuleTypes": [
                     "magneticModuleType",
                     "temperatureModuleType",
@@ -143,6 +164,9 @@
                     "zDimension": 0
                 },
                 "displayName": "Slot 8",
+                "features": {
+                    "springDirectionalForceAsParent": "backLeftBottom"
+                },
                 "compatibleModuleTypes": [
                     "magneticModuleType",
                     "temperatureModuleType",
@@ -160,6 +184,9 @@
                     "zDimension": 0
                 },
                 "displayName": "Slot 9",
+                "features": {
+                    "springDirectionalForceAsParent": "backLeftBottom"
+                },
                 "compatibleModuleTypes": [
                     "magneticModuleType",
                     "temperatureModuleType",
@@ -177,6 +204,9 @@
                     "zDimension": 0
                 },
                 "displayName": "Slot 10",
+                "features": {
+                    "springDirectionalForceAsParent": "backLeftBottom"
+                },
                 "compatibleModuleTypes": [
                     "magneticModuleType",
                     "temperatureModuleType",
@@ -194,6 +224,9 @@
                     "zDimension": 0
                 },
                 "displayName": "Slot 11",
+                "features": {
+                    "springDirectionalForceAsParent": "backLeftBottom"
+                },
                 "compatibleModuleTypes": [
                     "magneticModuleType",
                     "temperatureModuleType",
@@ -210,6 +243,9 @@
                     "zDimension": 0
                 },
                 "displayName": "Slot 12",
+                "features": {
+                    "springDirectionalForceAsParent": "backLeftBottom"
+                },
                 "compatibleModuleTypes": []
             },
             {
@@ -222,6 +258,7 @@
                     "zDimension": 82
                 },
                 "displayName": "Slot 12/Fixed Trash",
+                "features": {},
                 "ableToDropTips": true
             }
         ],