@opentrons/shared-data 0.1.0-beta.7 → 0.1.1

package/command/schemas/8.json

@@ -1,6 +1,71 @@
 {
   "title": "CreateCommandUnion",
   "description": "Model that validates a union of all CommandCreate models.",
+  "discriminator": {
+    "propertyName": "commandType",
+    "mapping": {
+      "aspirate": "#/definitions/AspirateCreate",
+      "aspirateInPlace": "#/definitions/AspirateInPlaceCreate",
+      "comment": "#/definitions/CommentCreate",
+      "configureForVolume": "#/definitions/ConfigureForVolumeCreate",
+      "configureNozzleLayout": "#/definitions/ConfigureNozzleLayoutCreate",
+      "custom": "#/definitions/CustomCreate",
+      "dispense": "#/definitions/DispenseCreate",
+      "dispenseInPlace": "#/definitions/DispenseInPlaceCreate",
+      "blowout": "#/definitions/BlowOutCreate",
+      "blowOutInPlace": "#/definitions/BlowOutInPlaceCreate",
+      "dropTip": "#/definitions/DropTipCreate",
+      "dropTipInPlace": "#/definitions/DropTipInPlaceCreate",
+      "home": "#/definitions/HomeCreate",
+      "retractAxis": "#/definitions/RetractAxisCreate",
+      "loadLabware": "#/definitions/LoadLabwareCreate",
+      "loadLiquid": "#/definitions/LoadLiquidCreate",
+      "loadModule": "#/definitions/LoadModuleCreate",
+      "loadPipette": "#/definitions/LoadPipetteCreate",
+      "moveLabware": "#/definitions/MoveLabwareCreate",
+      "moveRelative": "#/definitions/MoveRelativeCreate",
+      "moveToCoordinates": "#/definitions/MoveToCoordinatesCreate",
+      "moveToWell": "#/definitions/MoveToWellCreate",
+      "moveToAddressableArea": "#/definitions/MoveToAddressableAreaCreate",
+      "moveToAddressableAreaForDropTip": "#/definitions/MoveToAddressableAreaForDropTipCreate",
+      "prepareToAspirate": "#/definitions/PrepareToAspirateCreate",
+      "waitForResume": "#/definitions/WaitForResumeCreate",
+      "pause": "#/definitions/WaitForResumeCreate",
+      "waitForDuration": "#/definitions/WaitForDurationCreate",
+      "pickUpTip": "#/definitions/PickUpTipCreate",
+      "savePosition": "#/definitions/SavePositionCreate",
+      "setRailLights": "#/definitions/SetRailLightsCreate",
+      "touchTip": "#/definitions/TouchTipCreate",
+      "setStatusBar": "#/definitions/SetStatusBarCreate",
+      "verifyTipPresence": "#/definitions/VerifyTipPresenceCreate",
+      "getTipPresence": "#/definitions/GetTipPresenceCreate",
+      "heaterShaker/waitForTemperature": "#/definitions/opentrons__protocol_engine__commands__heater_shaker__wait_for_temperature__WaitForTemperatureCreate",
+      "heaterShaker/setTargetTemperature": "#/definitions/opentrons__protocol_engine__commands__heater_shaker__set_target_temperature__SetTargetTemperatureCreate",
+      "heaterShaker/deactivateHeater": "#/definitions/DeactivateHeaterCreate",
+      "heaterShaker/setAndWaitForShakeSpeed": "#/definitions/SetAndWaitForShakeSpeedCreate",
+      "heaterShaker/deactivateShaker": "#/definitions/DeactivateShakerCreate",
+      "heaterShaker/openLabwareLatch": "#/definitions/OpenLabwareLatchCreate",
+      "heaterShaker/closeLabwareLatch": "#/definitions/CloseLabwareLatchCreate",
+      "magneticModule/disengage": "#/definitions/DisengageCreate",
+      "magneticModule/engage": "#/definitions/EngageCreate",
+      "temperatureModule/setTargetTemperature": "#/definitions/opentrons__protocol_engine__commands__temperature_module__set_target_temperature__SetTargetTemperatureCreate",
+      "temperatureModule/waitForTemperature": "#/definitions/opentrons__protocol_engine__commands__temperature_module__wait_for_temperature__WaitForTemperatureCreate",
+      "temperatureModule/deactivate": "#/definitions/DeactivateTemperatureCreate",
+      "thermocycler/setTargetBlockTemperature": "#/definitions/SetTargetBlockTemperatureCreate",
+      "thermocycler/waitForBlockTemperature": "#/definitions/WaitForBlockTemperatureCreate",
+      "thermocycler/setTargetLidTemperature": "#/definitions/SetTargetLidTemperatureCreate",
+      "thermocycler/waitForLidTemperature": "#/definitions/WaitForLidTemperatureCreate",
+      "thermocycler/deactivateBlock": "#/definitions/DeactivateBlockCreate",
+      "thermocycler/deactivateLid": "#/definitions/DeactivateLidCreate",
+      "thermocycler/openLid": "#/definitions/OpenLidCreate",
+      "thermocycler/closeLid": "#/definitions/CloseLidCreate",
+      "thermocycler/runProfile": "#/definitions/RunProfileCreate",
+      "calibration/calibrateGripper": "#/definitions/CalibrateGripperCreate",
+      "calibration/calibratePipette": "#/definitions/CalibratePipetteCreate",
+      "calibration/calibrateModule": "#/definitions/CalibrateModuleCreate",
+      "calibration/moveToMaintenancePosition": "#/definitions/MoveToMaintenancePositionCreate"
+    }
+  },
   "anyOf": [
     {
       "$ref": "#/definitions/AspirateCreate"
@@ -259,8 +324,8 @@
         },
         "volume": {
           "title": "Volume",
-          "description": "Amount of liquid in uL. Must be greater than 0 and less than a pipette-specific maximum volume.",
-          "exclusiveMinimum": 0,
+          "description": "The amount of liquid to aspirate, in \u00b5L. Must not be greater than the remaining available amount, which depends on the pipette (see `loadPipette`), its configuration (see `configureForVolume`), the tip (see `pickUpTip`), and the amount you've aspirated so far. There is some tolerance for floating point rounding errors.",
+          "minimum": 0,
           "type": "number"
         },
         "pipetteId": {
@@ -320,8 +385,8 @@
         },
         "volume": {
           "title": "Volume",
-          "description": "Amount of liquid in uL. Must be greater than 0 and less than a pipette-specific maximum volume.",
-          "exclusiveMinimum": 0,
+          "description": "The amount of liquid to aspirate, in \u00b5L. Must not be greater than the remaining available amount, which depends on the pipette (see `loadPipette`), its configuration (see `configureForVolume`), the tip (see `pickUpTip`), and the amount you've aspirated so far. There is some tolerance for floating point rounding errors.",
+          "minimum": 0,
           "type": "number"
         },
         "pipetteId": {
@@ -410,19 +475,19 @@
       "description": "Parameters required to configure volume for a specific pipette.",
       "type": "object",
       "properties": {
-        "volume": {
-          "title": "Volume",
-          "description": "Amount of liquid in uL. Must be greater than 0 and less than a pipette-specific maximum volume.",
-          "exclusiveMinimum": 0,
-          "type": "number"
-        },
         "pipetteId": {
           "title": "Pipetteid",
           "description": "Identifier of pipette to use for liquid handling.",
           "type": "string"
+        },
+        "volume": {
+          "title": "Volume",
+          "description": "Amount of liquid in uL. Must be at least 0 and no greater than a pipette-specific maximum volume.",
+          "minimum": 0,
+          "type": "number"
         }
       },
-      "required": ["volume", "pipetteId"]
+      "required": ["pipetteId", "volume"]
     },
     "ConfigureForVolumeCreate": {
       "title": "ConfigureForVolumeCreate",
@@ -684,8 +749,8 @@
         },
         "volume": {
           "title": "Volume",
-          "description": "Amount of liquid in uL. Must be greater than 0 and less than a pipette-specific maximum volume.",
-          "exclusiveMinimum": 0,
+          "description": "The amount of liquid to dispense, in \u00b5L. Must not be greater than the currently aspirated volume. There is some tolerance for floating point rounding errors.",
+          "minimum": 0,
           "type": "number"
         },
         "pipetteId": {
@@ -744,8 +809,8 @@
         },
         "volume": {
           "title": "Volume",
-          "description": "Amount of liquid in uL. Must be greater than 0 and less than a pipette-specific maximum volume.",
-          "exclusiveMinimum": 0,
+          "description": "The amount of liquid to dispense, in \u00b5L. Must not be greater than the currently aspirated volume. There is some tolerance for floating point rounding errors.",
+          "minimum": 0,
           "type": "number"
         },
         "pipetteId": {
@@ -1965,6 +2030,12 @@
               "$ref": "#/definitions/AddressableOffsetVector"
             }
           ]
+        },
+        "stayAtHighestPossibleZ": {
+          "title": "Stayathighestpossiblez",
+          "description": "If `true`, the pipette will retract to its highest possible height and stay there instead of descending to the destination. `minimumZHeight` will be ignored.",
+          "default": false,
+          "type": "boolean"
         }
       },
       "required": ["pipetteId", "addressableAreaName"]

package/command/types/gantry.ts

@@ -1,4 +1,5 @@
 import type { CommonCommandRunTimeInfo, CommonCommandCreateInfo } from '.'
+import type { AddressableAreaName } from '../../deck'
 import type {
   Coordinates,
   MotorAxes,
@@ -175,9 +176,10 @@ interface AddressableOffsetVector {
 }
 export interface MoveToAddressableAreaParams {
   pipetteId: string
-  addressableAreaName: string
+  addressableAreaName: AddressableAreaName
   offset: AddressableOffsetVector
   speed?: number
   minimumZHeight?: number
   forceDirect?: boolean
+  stayAtHighestPossibleZ?: boolean
 }

package/command/types/pipetting.ts

@@ -1,3 +1,4 @@
+import type { AddressableAreaName } from '../../deck'
 import type { CommonCommandRunTimeInfo, CommonCommandCreateInfo } from '.'
 export type PipettingRunTimeCommand =
   | AspirateInPlaceRunTimeCommand
@@ -224,7 +225,7 @@ export interface DropTipInPlaceParams {
 
 export interface MoveToAddressableAreaForDropTipParams {
   pipetteId: string
-  addressableAreaName: string
+  addressableAreaName: AddressableAreaName
   offset?: AddressableOffsetVector
   alternateDropLocation?: boolean
   speed?: number

package/command/types/setup.ts

@@ -1,11 +1,11 @@
 import type {
+  AddressableAreaName,
   CommonCommandRunTimeInfo,
   CommonCommandCreateInfo,
   LabwareDefinition2,
   LabwareOffset,
   PipetteName,
   ModuleModel,
-  Cutout,
 } from '../../js'
 
 export interface LoadPipetteCreateCommand extends CommonCommandCreateInfo {
@@ -59,16 +59,6 @@ export interface LoadLiquidRunTimeCommand
     LoadLiquidCreateCommand {
   result?: LoadLiquidResult
 }
-//  TODO(jr, 10/31/23): update `loadFixture` to `loadAddressableArea`
-export interface LoadFixtureCreateCommand extends CommonCommandCreateInfo {
-  commandType: 'loadFixture'
-  params: LoadFixtureParams
-}
-export interface LoadFixtureRunTimeCommand
-  extends CommonCommandRunTimeInfo,
-    LoadFixtureCreateCommand {
-  result?: LoadLabwareResult
-}
 
 export interface ConfigureNozzleLayoutCreateCommand
   extends CommonCommandCreateInfo {
@@ -86,7 +76,6 @@ export type SetupRunTimeCommand =
   | ConfigureNozzleLayoutRunTimeCommand
   | LoadPipetteRunTimeCommand
   | LoadLabwareRunTimeCommand
-  | LoadFixtureRunTimeCommand
   | LoadModuleRunTimeCommand
   | LoadLiquidRunTimeCommand
   | MoveLabwareRunTimeCommand
@@ -95,7 +84,6 @@ export type SetupCreateCommand =
   | ConfigureNozzleLayoutCreateCommand
   | LoadPipetteCreateCommand
   | LoadLabwareCreateCommand
-  | LoadFixtureCreateCommand
   | LoadModuleCreateCommand
   | LoadLiquidCreateCommand
   | MoveLabwareCreateCommand
@@ -105,13 +93,13 @@ export type LabwareLocation =
   | { slotName: string }
   | { moduleId: string }
   | { labwareId: string }
-  | { addressableAreaName: string }
+  | { addressableAreaName: AddressableAreaName }
 
 export type NonStackedLocation =
   | 'offDeck'
   | { slotName: string }
   | { moduleId: string }
-  | { addressableAreaName: string }
+  | { addressableAreaName: AddressableAreaName }
 
 export interface ModuleLocation {
   slotName: string
@@ -169,12 +157,6 @@ interface LoadLiquidResult {
   liquidId: string
 }
 
-interface LoadFixtureParams {
-  location: { cutout: Cutout }
-  loadName: string
-  fixtureId?: string
-}
-
 export const COLUMN = 'COLUMN'
 const SINGLE = 'SINGLE'
 const ROW = 'ROW'

package/deck/types/schemaV4.ts

@@ -61,6 +61,20 @@ export type CutoutId =
   | 'cutoutA2'
   | 'cutoutA3'
 
+export type OT2CutoutId =
+  | 'cutout1'
+  | 'cutout2'
+  | 'cutout3'
+  | 'cutout4'
+  | 'cutout5'
+  | 'cutout6'
+  | 'cutout7'
+  | 'cutout8'
+  | 'cutout9'
+  | 'cutout10'
+  | 'cutout11'
+  | 'cutout12'
+
 export type SingleSlotCutoutFixtureId =
   | 'singleLeftSlot'
   | 'singleCenterSlot'
@@ -76,11 +90,14 @@ export type WasteChuteCutoutFixtureId =
   | 'stagingAreaSlotWithWasteChuteRightAdapterCovered'
   | 'stagingAreaSlotWithWasteChuteRightAdapterNoCover'
 
+export type OT2SingleStandardSlot = 'singleStandardSlot'
+
+export type OT2FixedTrashSlot = 'fixedTrashSlot'
+
 export type CutoutFixtureId =
   | SingleSlotCutoutFixtureId
   | StagingAreaRightSlotFixtureId
   | TrashBinAdapterCutoutFixtureId
   | WasteChuteCutoutFixtureId
-  | 'stagingAreaRightSlot'
-  | 'trashBinAdapter'
-  | 'fixedTrashSlot'
+  | OT2SingleStandardSlot
+  | OT2FixedTrashSlot

package/labware/definitions/2/armadillo_96_wellplate_200ul_pcr_full_skirt/2.json

@@ -55,7 +55,7 @@
       "z": 10.7
     }
   },
-  "gripForce": 9,
+  "gripForce": 15,
   "gripHeightFromLabwareBottom": 10,
   "ordering": [
     ["A1", "B1", "C1", "D1", "E1", "F1", "G1", "H1"],

package/labware/definitions/2/opentrons_96_wellplate_200ul_pcr_full_skirt/2.json

@@ -55,7 +55,7 @@
       "z": 10.7
     }
   },
-  "gripForce": 9,
+  "gripForce": 15,
   "gripHeightFromLabwareBottom": 10,
   "ordering": [
     ["A1", "B1", "C1", "D1", "E1", "F1", "G1", "H1"],