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

package/command/types/index.ts

@@ -138,14 +138,24 @@ export interface RunCommandErrorFlexStackerStall extends RunCommandErrorBase {
   errorInfo: { labwareId?: string }
 }
 
-export interface RunCommandErrorFlexStackerShuttle extends RunCommandErrorBase {
+export interface RunCommandErrorFlexStackerShuttleMissing
+  extends RunCommandErrorBase {
   errorCode: '3020'
   errorType: 'flexStackerShuttleMissing'
   isDefined: true
   errorInfo: { 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
@@ -154,5 +164,6 @@ export interface RunCommandErrorFlexStackerHopper extends RunCommandErrorBase {
 
 export type RunCommandFlexStackerError =
   | RunCommandErrorFlexStackerStall
-  | RunCommandErrorFlexStackerShuttle
-  | RunCommandErrorFlexStackerHopper
+  | RunCommandErrorFlexStackerShuttleMissing
+  | RunCommandErrorFlexStackerHopperLabware
+  | RunCommandErrorFlexStackerShuttleLabware

package/command/types/module.ts

@@ -3,7 +3,7 @@ import type {
   CommonCommandRunTimeInfo,
   RunCommandFlexStackerError,
 } from '.'
-import type { LabwareDefinition2 } from '../../js'
+import type { LabwareDefinition } from '../../js'
 import type { LabwareLocationSequence } from './setup'
 
 export type ModuleRunTimeCommand =
@@ -39,6 +39,7 @@ export type ModuleRunTimeCommand =
   | FlexStackerStoreRunTimeCommand
   | FlexStackerFillRunTimeCommand
   | FlexStackerEmptyRunTimeCommand
+  | IdentifyModuleRunTimeCommand
 
 export type ModuleCreateCommand =
   | MagneticModuleEngageMagnetCreateCommand
@@ -76,6 +77,7 @@ export type ModuleCreateCommand =
   | FlexStackerPrepareShuttleCreateCommand
   | FlexStackerOpenLatch
   | FlexStackerCloseLatch
+  | IdentifyModuleCreateCommand
 
 export interface MagneticModuleEngageMagnetCreateCommand
   extends CommonCommandCreateInfo {
@@ -444,9 +446,9 @@ 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
@@ -590,3 +592,21 @@ export interface FlexStackerEmptyRunTimeCommand
   } & 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
+}

package/command/types/setup.ts

@@ -3,7 +3,7 @@ import type {
   AspirateProperties,
   CommonCommandCreateInfo,
   CommonCommandRunTimeInfo,
-  LabwareDefinition2,
+  LabwareDefinition,
   LabwareOffset,
   ModuleModel,
   MultiDispenseProperties,
@@ -222,7 +222,7 @@ interface LoadLabwareParams {
 }
 interface LoadLabwareResult {
   labwareId: string
-  definition: LabwareDefinition2
+  definition: LabwareDefinition
   // todo(mm, 2024-08-19): This does not match the server-returned offsetId field.
   // Confirm nothing client-side is trying to use this, then replace it with offsetId.
   offset: LabwareOffset
@@ -318,8 +318,8 @@ interface LoadLidStackParams {
 interface LoadLidStackResult {
   stackLabwareId: string
   labwareIds: string[]
-  definition?: LabwareDefinition2
-  lidStackDefinition: LabwareDefinition2
+  definition?: LabwareDefinition
+  lidStackDefinition: LabwareDefinition
   location: LabwareLocation
   stackLocationSequence?: LabwareLocationSequence
   locationSequences?: LabwareLocationSequence[]
@@ -334,6 +334,6 @@ export interface LoadLidParams {
 
 interface LoadLidResult {
   labwareId: string
-  definition: LabwareDefinition2
+  definition: LabwareDefinition
   locationSequence?: LabwareLocationSequence
 }

package/command/types/support.ts

@@ -16,6 +16,7 @@ export interface WellOffset {
   y?: number
   z?: number
 }
+// TODO(jh, 06-27-25): Origin and offset should be required. Mark them as so and fix all the type errors.
 export interface WellLocation {
   origin?: WellOrigin
   offset?: WellOffset

package/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/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
       }
     ],