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

package/lib/js/helpers/positionMath.d.ts

@@ -0,0 +1,127 @@
+/** Compute positions of labware stacked upon other labware, modules, deck slots, etc. */
+import type { AddressableArea, DeckDefinition, LabwareDefinition, LabwareDefinition2, ModuleDefinition, Vector3D } from '../types';
+/** Return dimensions of the total labware bounding box in the style of labware schema 2. */
+export declare function getSchema2Dimensions(definition: LabwareDefinition): LabwareDefinition2['dimensions'];
+/**
+ * Return a bounding box, in coordinates relative to the labware's origin,
+ * that encloses the labware when viewed from the top down.
+ */
+export declare function getLabwareViewBox(definition: LabwareDefinition): {
+    /** The minimum x-coord, i.e. the left of the labware. */
+    minX: number;
+    /** The minimum y-coord, i.e. the front of the labware. */
+    minY: number;
+    /** The maximum x-coord, i.e. the right of the labware. */
+    maxX: number;
+    /** The maximum y-coord, i.e. the back of the labware. */
+    maxY: number;
+    /** The distance between left and right. */
+    xDimension: number;
+    /** The distance between front and back. */
+    yDimension: number;
+};
+/** Logically specifies where a labware is located. */
+export interface ComputeLabwareOriginInput {
+    /** The underlying deck. */
+    deckDefinition: DeckDefinition;
+    /**
+     * The underlying slot. If this is a Flex and the labware is on a module, this should
+     * be the slot that the module replaces.
+     */
+    slotId: string;
+    /**
+     * The definition of the module underneath the labware, if there is one.
+     * This should be specified even if it's only transitively underneath the labware,
+     * like slot -> module -> adapter -> labware in question.
+     */
+    moduleDefinition: ModuleDefinition | null;
+    /** The labware and all the labware underneath it. */
+    labwareDefinitionsBottomToTop: LabwareDefinition[];
+}
+/**
+ * Computes the absolute deck coordinates of a labware.
+ * Returns null if there was some internal error.
+ */
+export declare function computeLabwareOrigin(input: ComputeLabwareOriginInput): Vector3D | null;
+/**
+ * Return the offset from a deck slot's origin (the slot's front-left, -x, -y)
+ * to a labware's origin (varies depending on the labware),
+ * supposing the labware is placed in that slot.
+ */
+export declare function getDeckSlotOriginToLabwareOrigin(slotDefinition: AddressableArea, labwareDefinition: LabwareDefinition): Vector3D;
+/**
+ * Given a stackup like:
+ *
+ * deck slot --> module --> labware
+ *
+ * This computes the offset from the deck slot's origin (its front-left / -x,-y corner)
+ * to the labware's origin (varies depending on the labware).
+ *
+ * This is currently how it works even for Flex modules, even though they are not really
+ * "in a slot." The slot in this case is the slot that the module replaces.
+ *
+ * The API is like this for transitional reasons. Ideally, we would have one function
+ * to go slot->module and a second function to go module->labware.
+ */
+export declare function getModuleParentOriginToLabwareOrigin(deckId: string, slotId: string | null, moduleDefinition: ModuleDefinition, labwareDefinition: LabwareDefinition): Vector3D;
+/**
+ * Given a labware -> labware stackup, compute the offset from the parent (bottom)
+ * labware's origin to the child (top) labware's origin.
+ */
+export declare function getLabwareOriginToLabwareOrigin(parentDefinition: LabwareDefinition, childDefinition: LabwareDefinition): Vector3D;
+/**
+ * Given a module, computes the offset from the origin (front-left, -x,-y corner) of the
+ * deck slot that the module is in, to the origin (again, front-left, -x,-y corner) of
+ * the slot atop that module.
+ *
+ * On a Flex, modules are not really "in deck slots". There, "the deck slot that the
+ * module is in" means "the deck slot that the module replaces."
+ *
+ * @deprecated We are trying to move away from the idea that modules always have slots
+ *  atop them and that things should be positioned relative to those slots' -x,-y
+ *  corners. That idea is especially untrue for things like the Thermocycler and
+ *  Heater-Shaker. You probably want `getModuleParentOriginToLabwareOrigin()` instead,
+ *  which is higher-level and can model different ways that a labware can mate with a
+ *  module. This is exported to support things like UI controls that want to cover
+ *  a module's "labware area" and whose implementations assume the traditional
+ *  slot -x,-y corner idea.
+ */
+export declare function getModuleParentOriginToChildSlotOrigin(deckId: string, slotId: string | null, moduleDefinition: ModuleDefinition): Vector3D;
+/**
+ * Return the offset from a labware's back-left-bottom (-x, +y, -z) corner to its origin.
+ *
+ * This is a lower-level helper for the rare cases where we want to position a labware
+ * specifically by its back-left corner. Typically, you'll want something higher-level,
+ * like `getLabwareViewBox()` or `getDeckSlotOriginToLabwareOrigin()`, instead.
+ */
+export declare function getLabwareBackLeftBottomToOrigin(definition: LabwareDefinition): Vector3D;
+/**
+ * Return a definition's cornerOffsetFromSlot in the style of labware schema 2.
+ *
+ * @deprecated This is probably an inherently wrong interface to attempt, for a couple
+ * reasons.
+ *
+ * FIRST, depending on what the call site does with this, it might expect the return
+ * value to be either:
+ *
+ * - The vector from the (-x, -y) corner of the parent slot to the (-x, -y) corner of
+ *   the labware
+ * - The vector from the (-x, -y) corner of the parent slot to the origin of the
+ *   labware
+ *
+ * In labware schema 2, these were the same thing, but not in schema 3.
+ *
+ * SECOND, in labware schema 2, how a child labware sits on its parent is almost
+ * entirely a function of the child's definition. In labware schema 3, it is
+ * much more dependent on information only available in the parent. For example, to
+ * line up a child's well A1 with a parent's well A1, we need to know where the
+ * parent's well A1 is. (Schema 2 just did not attempt to support that).
+ *
+ * For schema-2 definitions, this will return cornerOffsetFromSlot as-is.
+ *
+ * For schema-3 definitions, this currently returns the placeholder (12, 34, 56), which
+ * is certainly wrong and will cause all manner of visual mayhem, but at least it's
+ * wrong in an obvious way and it unblocks importing schema-3 definitions. Solving this
+ * properly is call-site-dependent, as described above.
+ */
+export declare function getSchema2CornerOffsetFromSlot(definition: LabwareDefinition): LabwareDefinition2['cornerOffsetFromSlot'];

package/lib/js/helpers/validateCustomLabwareHelper.d.ts

@@ -1,4 +1,4 @@
-import type { LabwareDefinition2 } from '..';
+import type { LabwareDefinition } from '..';
 /**
  * This function is used to help validate that the wells and ordering matches in
  * a custom labware definition in terms of the wellName and the wells length
@@ -6,4 +6,4 @@ import type { LabwareDefinition2 } from '..';
  * @param definition - a labware definition
  * @returns A boolean for if they exist
  */
-export declare const validateCustomLabwareHelper: (definition: LabwareDefinition2 | null) => boolean;
+export declare const validateCustomLabwareHelper: (definition?: LabwareDefinition | null) => boolean;

package/lib/js/helpers/vectorMath.d.ts

@@ -0,0 +1,14 @@
+import type { CoordinateTuple, Vector3D } from '../types';
+export declare const IDENTITY_VECTOR: Vector3D;
+/**
+ * Add an arbitrary number of vectors.
+ * e.g. `getVectorSum(a, b, c)` is a + b + c.
+ */
+export declare function getVectorSum(first: Vector3D, ...rest: Vector3D[]): Vector3D;
+/**
+ * Subtract an arbitrary number of vectors.
+ * e.g. `getVectorDifference(a, b, c)` is a - b - c.
+ */
+export declare function getVectorDifference(first: Vector3D, ...rest: Vector3D[]): Vector3D;
+export declare function getVectorInverse(vector: Vector3D): Vector3D;
+export declare function coordinateTupleToVector3D(coordinateTuple: CoordinateTuple): Vector3D;

package/lib/js/helpers/wellSets.d.ts

@@ -1,17 +1,17 @@
-import type { LabwareDefinition2, NozzleLayoutConfig, PipetteV2Specs } from '../types';
+import type { LabwareDefinition, NozzleLayoutConfig, PipetteV2Specs } from '../types';
 type WellSetByPrimaryWell = string[][];
 export interface NozzleLayoutDetails {
     nozzleConfig: NozzleLayoutConfig;
     activeNozzleCount: number;
 }
 export interface WellSetForMultiChannelParams {
-    labwareDef: LabwareDefinition2;
+    labwareDef: LabwareDefinition;
     wellName: string;
     channels: 8 | 96;
     pipetteNozzleDetails?: NozzleLayoutDetails;
 }
 export interface WellSetHelpers {
-    getAllWellSetsForLabware: (labwareDef: LabwareDefinition2) => WellSetByPrimaryWell;
+    getAllWellSetsForLabware: (labwareDef: LabwareDefinition) => WellSetByPrimaryWell;
     /** Given a well for a labware, returns the well set it belongs to (or null)
      * for 8-channel and 96-channel access.
      * Ex: C2 for 96-flat => ['A2', 'B2', 'C2', ... 'H2']
@@ -21,7 +21,7 @@ export interface WellSetHelpers {
      * nozzle configuration.
      **/
     getWellSetForMultichannel: (params: WellSetForMultiChannelParams) => string[] | null | undefined;
-    canPipetteUseLabware: (pipetteSpec: PipetteV2Specs, labwareDef?: LabwareDefinition2, trashName?: string) => boolean;
+    canPipetteUseLabware: (pipetteSpec: PipetteV2Specs, labwareDef?: LabwareDefinition, trashName?: string) => boolean;
 }
 export declare const makeWellSetHelpers: () => WellSetHelpers;
 export {};

package/lib/js/labware.d.ts

@@ -1,19 +1,20 @@
-import labwareSchemaV2 from '../labware/schemas/2.json';
-import fixture96Plate from '../labware/fixtures/2/fixture_96_plate.json';
 import fixture12Trough from '../labware/fixtures/2/fixture_12_trough.json';
 import fixture24Tuberack from '../labware/fixtures/2/fixture_24_tuberack.json';
-import fixtureTiprack10ul from '../labware/fixtures/2/fixture_tiprack_10_ul.json';
-import fixtureTiprack300ul from '../labware/fixtures/2/fixture_tiprack_300_ul.json';
+import fixture96Plate from '../labware/fixtures/2/fixture_96_plate.json';
+import fixture384Plate from '../labware/fixtures/2/fixture_384_plate.json';
+import fixtureCalibrationBlock from '../labware/fixtures/2/fixture_calibration_block.json';
 import fixtureTiprack1000ul from '../labware/fixtures/2/fixture_flex_96_tiprack_1000ul.json';
 import fixtureTiprackAdapter from '../labware/fixtures/2/fixture_flex_96_tiprack_adapter.json';
-import fixtureCalibrationBlock from '../labware/fixtures/2/fixture_calibration_block.json';
-import fixture384Plate from '../labware/fixtures/2/fixture_384_plate.json';
+import fixtureTiprack10ul from '../labware/fixtures/2/fixture_tiprack_10_ul.json';
+import fixtureTiprack300ul from '../labware/fixtures/2/fixture_tiprack_300_ul.json';
 import fixtureTrash from '../labware/fixtures/2/fixture_trash.json';
-import type { LabwareDefByDefURI, LabwareDefinition2, LegacyLabwareDefByName } from './types';
+import labwareSchemaV2 from '../labware/schemas/2.json';
+import labwareSchemaV3 from '../labware/schemas/3.json';
+import type { LabwareDef2ByDefURI, LabwareDefinition2, LegacyLabwareDefByName } from './types';
 export declare const getAllLabwareDefs: () => Record<string, LabwareDefinition2>;
-export declare function getAllDefinitions(blockList?: string[]): LabwareDefByDefURI;
+export declare function getAllDefinitions(blockList?: string[]): LabwareDef2ByDefURI;
 export declare function getAllLegacyDefinitions(): LegacyLabwareDefByName;
-export { labwareSchemaV2, fixture96Plate, fixture12Trough, fixture24Tuberack, fixtureTiprack10ul, fixtureTiprack300ul, fixtureTiprack1000ul, fixtureTiprackAdapter, fixtureTrash, fixture384Plate, fixtureCalibrationBlock, };
+export { labwareSchemaV2, labwareSchemaV3, fixture96Plate, fixture12Trough, fixture24Tuberack, fixtureTiprack10ul, fixtureTiprack300ul, fixtureTiprack1000ul, fixtureTiprackAdapter, fixtureTrash, fixture384Plate, fixtureCalibrationBlock, };
 export declare const opentrons96PcrAdapterV1: LabwareDefinition2;
 export declare const opentrons1Trash3200MlFixedV1: LabwareDefinition2;
 export declare const opentrons96Tiprack10UlV1Uncasted: LabwareDefinition2;

package/lib/js/labwareTools/index.d.ts

@@ -1,4 +1,4 @@
-import type { LabwareDefinition2 as Definition, LabwareMetadata as Metadata, LabwareDimensions as Dimensions, LabwareBrand as Brand, LabwareParameters as Params, LabwareWell as Well, LabwareWellProperties as InputWell, LabwareWellGroup as WellGroup, LabwareOffset as Offset, LabwareVolumeUnits as VolumeUnits, ModuleModel, LabwareOffset } from '../types';
+import type { LabwareBrand as Brand, LabwareDefinition2 as Definition, LabwareDimensions as Dimensions, LabwareWellProperties as InputWell, LabwareOffset, LabwareMetadata as Metadata, ModuleModel, LabwareOffset as Offset, LabwareParameters as Params, LabwareVolumeUnits as VolumeUnits, LabwareWell as Well, LabwareWellGroup as WellGroup } from '../types';
 export declare const DEFAULT_CUSTOM_NAMESPACE = "custom_beta";
 interface Cell {
     row: number;

package/lib/js/liquidClasses.d.ts

@@ -1,2 +1,6 @@
 import type { LiquidClass } from '.';
+export declare const WATER_LIQUID_CLASS_NAME = "waterV1";
+export declare const NONE_LIQUID_CLASS_NAME = "none";
+export declare const GLYCEROL_LIQUID_CLASS_NAME = "glycerol50V1";
+export declare const ETHANOL_LIQUID_CLASS_NAME = "ethanol80V1";
 export declare const getAllLiquidClassDefs: () => Record<string, LiquidClass>;

package/lib/js/modules.d.ts

@@ -1,5 +1,5 @@
-import type { ModuleModel, ModuleModelWithLegacy, ModuleType, ModuleDefinition } from './types';
-export declare const getModuleDef2: (moduleModel: ModuleModel) => ModuleDefinition;
+import type { ModuleDefinition, ModuleModel, ModuleModelWithLegacy, ModuleType } from './types';
+export declare const getModuleDef: (moduleModel: ModuleModel) => ModuleDefinition;
 export declare function normalizeModuleModel(legacyModule: ModuleModelWithLegacy): ModuleModel;
 export declare function getModuleType(moduleModel: ModuleModel): ModuleType;
 export declare function getModuleDisplayName(moduleModel: ModuleModel): string;

package/lib/js/pipettes.d.ts

@@ -1,6 +1,6 @@
-import pipetteNameSpecs from '../pipette/definitions/1/pipetteNameSpecs.json';
 import pipetteModelSpecs from '../pipette/definitions/1/pipetteModelSpecs.json';
-import type { PipetteV2Specs, PipetteNameSpecs, PipetteModelSpecs } from './types';
+import pipetteNameSpecs from '../pipette/definitions/1/pipetteNameSpecs.json';
+import type { PipetteModelSpecs, PipetteNameSpecs, PipetteV2Specs } from './types';
 type SortableProps = 'maxVolume' | 'channels';
 export type PipetteName = keyof typeof pipetteNameSpecs;
 export type PipetteModel = keyof typeof pipetteModelSpecs.config;
@@ -13,3 +13,4 @@ export declare const getIncompatiblePipetteNames: (currentPipette: PipetteName)
 export * from '../pipette/fixtures/name';
 export * from '../pipette/fixtures/index';
 export declare const getPipetteSpecsV2: (name?: PipetteName | PipetteModel) => PipetteV2Specs | null;
+export declare const getFlexNameConversion: (pipetteSpec: PipetteV2Specs) => string;

package/lib/js/types.d.ts

@@ -1,8 +1,8 @@
-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, FLEX_STACKER_MODULE_V1, FLEX_STACKER_MODULE_TYPE, WELL_BOTTOM, WELL_CENTER, WELL_TOP, LIQUID_MENISCUS } from './constants';
-import type { RunTimeCommand, LoadedLabwareLocation } 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, AddressableAreaNamesWithFakes, AddressableAreaWithFakes, AreaTypeWithFakes, CutoutFixtureIdsWithFakes, 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';
-import type { CommandAnnotation } from '../commandAnnotation/types';
 export type RobotType = 'OT-2 Standard' | 'OT-3 Standard';
 export interface RobotDefinition {
     displayName: string;
@@ -51,12 +51,16 @@ 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;
@@ -133,9 +137,16 @@ export interface RoundedCuboidSegment {
     bottomHeight: number;
 }
 export type WellSegment = CuboidalFrustum | ConicalFrustum | SquaredConeSegment | SphericalSegment | RoundedCuboidSegment;
+export interface HeightVolumePair {
+    height: number;
+    volume: number;
+}
 export interface InnerWellGeometry {
     sections: WellSegment[];
 }
+export interface UserDefinedVolumes {
+    heightToVolumeMap: HeightVolumePair[];
+}
 export type LabwareWellMap = Record<string, LabwareWell>;
 export interface LabwareWellGroupMetadata {
     displayName?: string;
@@ -147,6 +158,31 @@ export interface LabwareWellGroup {
     metadata: LabwareWellGroupMetadata;
     brand?: LabwareBrand;
 }
+export interface AxisAlignedBoundingBox2D {
+    backLeft: Vector2D;
+    frontRight: Vector2D;
+}
+export interface AxisAlignedBoundingBox3D {
+    backLeftBottom: Vector3D;
+    frontRightTop: Vector3D;
+}
+export interface Extents {
+    total: AxisAlignedBoundingBox3D;
+}
+export interface SlotFootprintAsChildFeature {
+    z: number;
+    backLeft: Vector2D;
+    frontRight: Vector2D;
+}
+export interface SlotFootprintAsParentFeature {
+    z: number;
+    backLeft: Vector2D;
+    frontRight: Vector2D;
+}
+export interface LocatingFeatures {
+    slotFootprintAsChild?: SlotFootprintAsChildFeature;
+    slotFootprintAsParent?: SlotFootprintAsParentFeature;
+}
 export type LabwareRoles = 'labware' | 'adapter' | 'fixture' | 'maintenance' | 'lid' | 'system';
 export interface LabwareDefinition2 {
     version: number;
@@ -165,7 +201,7 @@ export interface LabwareDefinition2 {
     stackingOffsetWithModule?: Record<string, LabwareOffset>;
     stackLimit?: number;
     compatibleParentLabware?: string[];
-    innerLabwareGeometry?: Record<string, InnerWellGeometry> | null;
+    innerLabwareGeometry?: Record<string, InnerWellGeometry | UserDefinedVolumes> | null;
 }
 export interface LabwareDefinition3 {
     version: number;
@@ -173,8 +209,8 @@ export interface LabwareDefinition3 {
     schemaVersion: 3;
     namespace: string;
     metadata: LabwareMetadata;
-    dimensions: LabwareDimensions;
-    cornerOffsetFromSlot: LabwareOffset;
+    extents: Extents;
+    features: LocatingFeatures;
     parameters: LabwareParameters;
     brand: LabwareBrand;
     ordering: string[][];
@@ -187,7 +223,8 @@ export interface LabwareDefinition3 {
     compatibleParentLabware?: string[];
     innerLabwareGeometry?: Record<string, InnerWellGeometry> | null;
 }
-export interface LabwareDefByDefURI {
+export type LabwareDefinition = LabwareDefinition2 | LabwareDefinition3;
+export interface LabwareDef2ByDefURI {
     [defUri: string]: LabwareDefinition2;
 }
 export interface LegacyLabwareDefByName {
@@ -229,10 +266,11 @@ export interface DeckCalibrationPoint {
     position: CoordinateTuple;
     displayName: string;
 }
+export type CutoutIdToCutoutFixtureId = {
+    [cutoutId in CutoutId]?: CutoutFixtureId;
+};
 export type CutoutFixtureGroup = {
-    [cutoutId in CutoutId]?: Array<{
-        [cutoutId in CutoutId]?: CutoutFixtureId;
-    }>;
+    [cutoutId in CutoutId]?: CutoutIdToCutoutFixtureId[];
 };
 export interface CutoutFixture {
     id: CutoutFixtureId;
@@ -243,7 +281,12 @@ export interface CutoutFixture {
     fixtureGroup: CutoutFixtureGroup;
     height: number;
 }
-type AreaType = 'slot' | 'movableTrash' | 'wasteChute' | 'fixedTrash' | 'stagingSlot' | 'lidDock';
+export interface FakeCutoutFixture extends Omit<CutoutFixture, 'id' | 'providesAddressableAreas'> {
+    id: CutoutFixtureIdsWithFakes;
+    providesAddressableAreas: Record<CutoutId, AddressableAreaNamesWithFakes[] | AddressableAreaName[]>;
+}
+export type CutoutFixtureWithFakes = FakeCutoutFixture | CutoutFixture;
+export type AreaType = 'slot' | 'movableTrash' | 'wasteChute' | 'fixedTrash' | 'stagingSlot' | 'lidDock' | 'thermocycler' | 'heaterShaker' | 'temperatureModule' | 'magneticBlock' | 'absorbanceReader' | 'flexStacker';
 export interface AddressableArea {
     id: AddressableAreaName;
     areaType: AreaType;
@@ -255,6 +298,10 @@ export interface AddressableArea {
     ableToDropTips?: boolean;
     matingSurfaceUnitVector?: UnitVectorTuple;
 }
+export interface FakeAddressableArea extends Omit<AddressableArea, 'id' | 'areaType'> {
+    id: AddressableAreaNamesWithFakes;
+    areaType: AreaTypeWithFakes;
+}
 export interface DeckMetadata {
     displayName: string;
     tags: string[];
@@ -276,6 +323,9 @@ export interface DeckLocations {
     cutouts: DeckCutout[];
     legacyFixtures: LegacyFixture[];
 }
+export interface DeckLocationsWithFakes extends Omit<DeckLocations, 'addressableAreas' | 'calibrationPoints' | 'legacyFixtures'> {
+    addressableAreas: AddressableAreaWithFakes[];
+}
 export interface DeckDefinition {
     otId: string;
     cornerOffsetFromOrigin: CoordinateTuple;
@@ -285,6 +335,10 @@ export interface DeckDefinition {
     metadata: DeckMetadata;
     cutoutFixtures: CutoutFixture[];
 }
+export interface DeckDefinitionWithFakes extends Omit<DeckDefinition, 'locations' | 'cutoutFixtures' | 'otId' | 'cornerOffsetFromOrigin' | 'dimensions' | 'metadata' | 'robot'> {
+    locations: DeckLocationsWithFakes;
+    cutoutFixtures: CutoutFixtureWithFakes[];
+}
 export interface ModuleDimensions {
     bareOverallHeight: number;
     overLabwareHeight: number;
@@ -308,20 +362,25 @@ 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[];
     slotTransforms: SlotTransforms;
     compatibleWith: ModuleModel[];
-    twoDimensionalRendering: any;
 }
-export type AffineTransformMatrix = number[][];
+type AffineTransformRow = [number, number, number, number];
+export type AffineTransformMatrix = [
+    AffineTransformRow,
+    AffineTransformRow,
+    AffineTransformRow,
+    AffineTransformRow
+];
 export interface SlotTransforms {
-    [deckOtId: string]: {
-        [slotId: string]: {
+    [deckOtId: string]: undefined | {
+        [slotId: string]: undefined | {
             [transformKey in keyof ModuleDefinition]?: AffineTransformMatrix;
         };
     };
@@ -538,22 +597,26 @@ export interface Liquid {
     description: string;
     displayColor?: string;
 }
-type LiquidHandlingPropertyByVolume = number[][];
-export type PositionReference = typeof WELL_BOTTOM | typeof WELL_CENTER | typeof WELL_TOP | typeof LIQUID_MENISCUS;
+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;
 }
-interface DelayProperties {
+export interface TipPosition {
+    positionReference: PositionReference;
+    offset: Vector3D;
+}
+export interface DelayProperties {
     enable: boolean;
     params?: DelayParams;
 }
 interface TouchTipParams {
     zOffset: number;
-    mmToEdge: number;
+    mmFromEdge: number;
     speed: number;
 }
-interface TouchTipProperties {
+export interface TouchTipProperties {
     enable: boolean;
     params?: TouchTipParams;
 }
@@ -561,7 +624,7 @@ interface MixParams {
     repetitions: number;
     volume: number;
 }
-interface MixProperties {
+export interface MixProperties {
     enable: boolean;
     params?: MixParams;
 }
@@ -569,56 +632,55 @@ interface BlowoutParams {
     location: BlowoutLocation;
     flowRate: number;
 }
-interface BlowoutProperties {
+export interface BlowoutProperties {
     enable: boolean;
     params?: BlowoutParams;
 }
-interface Submerge {
-    positionReference: PositionReference;
-    offset: Coordinates;
+export interface Submerge {
+    startPosition: TipPosition;
     speed: number;
     delay: DelayProperties;
 }
 interface BaseRetract {
-    positionReference: PositionReference;
-    offset: Coordinates;
+    endPosition: TipPosition;
     speed: number;
     airGapByVolume: LiquidHandlingPropertyByVolume;
     touchTip: TouchTipProperties;
     delay: DelayProperties;
 }
-type RetractAspirate = BaseRetract;
-interface RetractDispense extends BaseRetract {
+export type RetractAspirate = BaseRetract;
+export interface RetractDispense extends BaseRetract {
     blowout: BlowoutProperties;
 }
 interface BaseLiquidHandlingProperties<RetractType> {
     submerge: Submerge;
     retract: RetractType;
-    positionReference: PositionReference;
-    offset: Coordinates;
     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 {
+export interface MultiDispenseProperties extends BaseLiquidHandlingProperties<RetractDispense> {
+    dispensePosition: TipPosition;
     conditioningByVolume: LiquidHandlingPropertyByVolume;
     disposalByVolume: LiquidHandlingPropertyByVolume;
 }
-interface ByTipTypeSetting {
+export interface ByTipTypeSetting {
     tiprack: string;
     aspirate: AspirateProperties;
     singleDispense: SingleDispenseProperties;
     multiDispense?: MultiDispenseProperties;
 }
-interface ByPipetteSetting {
+export interface ByPipetteSetting {
     pipetteModel: string;
     byTipType: ByTipTypeSetting[];
 }
@@ -778,5 +840,10 @@ export interface CutoutConfig {
     opentronsModuleSerialNumber?: string;
 }
 export type DeckConfiguration = CutoutConfig[];
+type CutoutConfigWithoutCutoutFixtureId = Omit<CutoutConfig, 'cutoutFixtureId'>;
+export interface CutoutConfigMap extends CutoutConfigWithoutCutoutFixtureId {
+    addressableAreaId: AddressableAreaNamesWithFakes;
+    cutoutFixtureId: CutoutFixtureIdsWithFakes;
+}
 export type NozzleLayoutConfig = 'single' | 'column' | 'row' | 'full' | 'subrect';
 export {};

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
+                }
+            ]
+        }
+    }
+}