@opentrons/shared-data 0.1.2-alpha.0 → 0.1.2-alpha.1

package/lib/js/types.d.ts

@@ -0,0 +1,398 @@
+import { MAGDECK, TEMPDECK, THERMOCYCLER, MAGNETIC_MODULE_V1, MAGNETIC_MODULE_V2, TEMPERATURE_MODULE_V1, TEMPERATURE_MODULE_V2, THERMOCYCLER_MODULE_V1, THERMOCYCLER_MODULE_V2, HEATERSHAKER_MODULE_V1, MAGNETIC_MODULE_TYPE, TEMPERATURE_MODULE_TYPE, THERMOCYCLER_MODULE_TYPE, HEATERSHAKER_MODULE_TYPE, MAGNETIC_BLOCK_TYPE, GEN1, GEN2, FLEX, LEFT, RIGHT, GRIPPER_V1, GRIPPER_V1_1, GRIPPER_V1_2, EXTENSION, MAGNETIC_BLOCK_V1 } from './constants';
+import type { RunTimeCommand, LabwareLocation } from '../command/types';
+import type { AddressableAreaName, CutoutFixtureId, CutoutId } from '../deck';
+import type { PipetteName } from './pipettes';
+export declare type RobotType = 'OT-2 Standard' | 'OT-3 Standard';
+export interface RobotDefinition {
+    displayName: string;
+    robotType: RobotType;
+    models: string[];
+}
+export interface WellDefinition {
+    diameter?: number;
+    depth?: number;
+    height: number;
+    length: number;
+    width: number;
+    x: number;
+    y: number;
+    z: number;
+    'total-liquid-volume': number;
+}
+export interface LabwareDefinition1 {
+    metadata: {
+        name: string;
+        format: string;
+        deprecated?: boolean;
+        displayName?: string;
+        displayCategory?: string;
+        isValidSource?: boolean;
+        isTiprack?: boolean;
+        tipVolume?: number;
+    };
+    ordering: string[][];
+    wells: {
+        [well: string]: WellDefinition;
+    };
+}
+export declare type LabwareDisplayCategory = 'wellPlate' | 'tipRack' | 'tubeRack' | 'reservoir' | 'aluminumBlock' | 'trash' | 'other' | 'adapter';
+export declare type LabwareVolumeUnits = 'µL' | 'mL' | 'L';
+export declare type WellBottomShape = 'flat' | 'u' | 'v';
+export interface LabwareMetadata {
+    displayName: string;
+    displayCategory: LabwareDisplayCategory;
+    displayVolumeUnits: LabwareVolumeUnits;
+    tags?: string[];
+}
+export interface LabwareDimensions {
+    xDimension: number;
+    yDimension: number;
+    zDimension: number;
+}
+export interface Coordinates {
+    x: number;
+    y: number;
+    z: number;
+}
+export declare type LabwareOffset = Coordinates;
+export interface LabwareParameters {
+    loadName: string;
+    format: string;
+    isTiprack: boolean;
+    tipLength?: number;
+    isMagneticModuleCompatible: boolean;
+    magneticModuleEngageHeight?: number;
+    quirks?: string[];
+}
+export interface LabwareBrand {
+    brand: string;
+    brandId?: string[];
+    links?: string[];
+}
+export interface CircularWellShapeProperties {
+    shape: 'circular';
+    diameter: number;
+}
+export interface RectangularWellShapeProperties {
+    shape: 'rectangular';
+    xDimension: number;
+    yDimension: number;
+}
+export declare type LabwareWellShapeProperties = CircularWellShapeProperties | RectangularWellShapeProperties;
+export declare type LabwareWellProperties = LabwareWellShapeProperties & {
+    depth: number;
+    totalLiquidVolume: number;
+};
+export declare type LabwareWell = LabwareWellProperties & {
+    x: number;
+    y: number;
+    z: number;
+};
+export declare type LabwareWellMap = Record<string, LabwareWell>;
+export interface LabwareWellGroupMetadata {
+    displayName?: string;
+    displayCategory?: LabwareDisplayCategory;
+    wellBottomShape?: WellBottomShape;
+}
+export interface LabwareWellGroup {
+    wells: string[];
+    metadata: LabwareWellGroupMetadata;
+    brand?: LabwareBrand;
+}
+export declare type LabwareRoles = 'labware' | 'adapter' | 'fixture' | 'maintenance';
+export interface LabwareDefinition2 {
+    version: number;
+    schemaVersion: 2;
+    namespace: string;
+    metadata: LabwareMetadata;
+    dimensions: LabwareDimensions;
+    cornerOffsetFromSlot: LabwareOffset;
+    parameters: LabwareParameters;
+    brand: LabwareBrand;
+    ordering: string[][];
+    wells: LabwareWellMap;
+    groups: LabwareWellGroup[];
+    allowedRoles?: LabwareRoles[];
+}
+export declare type ModuleType = typeof MAGNETIC_MODULE_TYPE | typeof TEMPERATURE_MODULE_TYPE | typeof THERMOCYCLER_MODULE_TYPE | typeof HEATERSHAKER_MODULE_TYPE | typeof MAGNETIC_BLOCK_TYPE;
+export declare type MagneticModuleModel = typeof MAGNETIC_MODULE_V1 | typeof MAGNETIC_MODULE_V2;
+export declare type TemperatureModuleModel = typeof TEMPERATURE_MODULE_V1 | typeof TEMPERATURE_MODULE_V2;
+export declare type ThermocyclerModuleModel = typeof THERMOCYCLER_MODULE_V1 | typeof THERMOCYCLER_MODULE_V2;
+export declare type HeaterShakerModuleModel = typeof HEATERSHAKER_MODULE_V1;
+export declare type MagneticBlockModel = typeof MAGNETIC_BLOCK_V1;
+export declare type ModuleModel = MagneticModuleModel | TemperatureModuleModel | ThermocyclerModuleModel | HeaterShakerModuleModel | MagneticBlockModel;
+export declare type GripperModel = typeof GRIPPER_V1 | typeof GRIPPER_V1_1 | typeof GRIPPER_V1_2;
+export declare type ModuleModelWithLegacy = ModuleModel | typeof THERMOCYCLER | typeof MAGDECK | typeof TEMPDECK;
+export interface Dimensions {
+    xDimension: number;
+    yDimension: number;
+    zDimension: number;
+}
+export interface DeckRobot {
+    model: RobotType;
+}
+export declare type CoordinateTuple = [number, number, number];
+export declare type UnitDirection = 1 | -1;
+export declare type UnitVectorTuple = [UnitDirection, UnitDirection, UnitDirection];
+export declare type DeckSlotId = string;
+export interface DeckSlot {
+    id: DeckSlotId;
+    position: CoordinateTuple;
+    matingSurfaceUnitVector?: UnitVectorTuple;
+    boundingBox: Dimensions;
+    displayName: string;
+    compatibleModules: ModuleType[];
+}
+export interface DeckCalibrationPoint {
+    id: string;
+    position: CoordinateTuple;
+    displayName: string;
+}
+export interface CutoutFixture {
+    id: CutoutFixtureId;
+    mayMountTo: CutoutId[];
+    displayName: string;
+    providesAddressableAreas: Record<CutoutId, AddressableAreaName[]>;
+    height: number;
+}
+declare type AreaType = 'slot' | 'movableTrash' | 'wasteChute' | 'fixedTrash' | 'stagingSlot';
+export interface AddressableArea {
+    id: AddressableAreaName;
+    areaType: AreaType;
+    offsetFromCutoutFixture: CoordinateTuple;
+    boundingBox: Dimensions;
+    displayName: string;
+    compatibleModuleTypes: ModuleType[];
+    ableToDropLabware?: boolean;
+    ableToDropTips?: boolean;
+    matingSurfaceUnitVector?: UnitVectorTuple;
+}
+export interface DeckMetadata {
+    displayName: string;
+    tags: string[];
+}
+export interface DeckCutout {
+    id: CutoutId;
+    position: CoordinateTuple;
+    displayName: string;
+}
+export interface LegacyFixture {
+    id: string;
+    slot: string;
+    labware: string;
+    displayName: string;
+}
+export interface DeckLocations {
+    addressableAreas: AddressableArea[];
+    calibrationPoints: DeckCalibrationPoint[];
+    cutouts: DeckCutout[];
+    legacyFixtures: LegacyFixture[];
+}
+export interface DeckDefinition {
+    otId: string;
+    cornerOffsetFromOrigin: CoordinateTuple;
+    dimensions: CoordinateTuple;
+    robot: DeckRobot;
+    locations: DeckLocations;
+    metadata: DeckMetadata;
+    cutoutFixtures: CutoutFixture[];
+}
+export interface ModuleDimensions {
+    bareOverallHeight: number;
+    overLabwareHeight: number;
+    xDimension: number;
+    yDimension: number;
+    footprintXDimension?: number;
+    footprintYDimension?: number;
+    labwareInterfaceXDimension?: number;
+    labwareInterfaceYDimension?: number;
+    lidHeight?: number;
+}
+export interface ModuleCalibrationPoint {
+    x: number;
+    y: number;
+    z?: number;
+}
+export interface ModuleLayer {
+    name: string;
+    pathDValues: string[];
+}
+export interface ModuleDefinition {
+    moduleType: ModuleType;
+    model: ModuleModel;
+    labwareOffset: Coordinates;
+    dimensions: ModuleDimensions;
+    cornerOffsetFromSlot: Coordinates;
+    calibrationPoint: ModuleCalibrationPoint;
+    displayName: string;
+    quirks: string[];
+    slotTransforms: SlotTransforms;
+    compatibleWith: ModuleModel[];
+    twoDimensionalRendering: any;
+}
+export declare type AffineTransformMatrix = number[][];
+export interface SlotTransforms {
+    [deckOtId: string]: {
+        [slotId: string]: {
+            [transformKey in keyof ModuleDefinition]?: AffineTransformMatrix;
+        };
+    };
+}
+export declare type ModuleOrientation = 'left' | 'right';
+export declare type PipetteChannels = 1 | 8 | 96;
+export declare type PipetteDisplayCategory = typeof GEN1 | typeof GEN2 | typeof FLEX;
+export declare type PipetteMount = typeof LEFT | typeof RIGHT;
+export declare type GantryMount = typeof LEFT | typeof RIGHT | typeof EXTENSION;
+export interface FlowRateSpec {
+    value: number;
+    min: number;
+    max: number;
+}
+export interface PipetteNameSpecs {
+    name: string;
+    displayName: string;
+    displayCategory: PipetteDisplayCategory;
+    minVolume: number;
+    maxVolume: number;
+    channels: PipetteChannels;
+    defaultAspirateFlowRate: FlowRateSpec;
+    defaultDispenseFlowRate: FlowRateSpec;
+    defaultBlowOutFlowRate: FlowRateSpec;
+    defaultTipracks: string[];
+    smoothieConfigs?: {
+        stepsPerMM: number;
+        homePosition: number;
+        travelDistance: number;
+    };
+}
+export interface PipetteModelSpecs extends PipetteNameSpecs {
+    model: string;
+    backCompatNames?: string[];
+    tipLength: {
+        value: number;
+    };
+}
+export interface ProtocolMetadata {
+    protocolName?: string;
+    author?: string;
+    description?: string | null;
+    created?: number;
+    lastModified?: number | null;
+    category?: string | null;
+    subcategory?: string | null;
+    tags?: string[];
+    [key: string]: unknown;
+}
+export interface PendingProtocolAnalysis {
+    id: string;
+    status?: 'pending';
+}
+export interface ProtocolAnalysisSummary {
+    id: string;
+    status: 'pending' | 'completed';
+}
+export interface LoadedPipette {
+    id: string;
+    pipetteName: PipetteName;
+    mount: 'left' | 'right';
+}
+export interface LoadedLabware {
+    id: string;
+    loadName: string;
+    definitionUri: string;
+    location: LabwareLocation;
+    offsetId?: string;
+    displayName?: string;
+}
+export interface LoadedModule {
+    id: string;
+    model: ModuleModel;
+    location: {
+        slotName: string;
+    };
+    serialNumber: string;
+}
+export interface Liquid {
+    id: string;
+    displayName: string;
+    description: string;
+    displayColor?: string;
+}
+export interface AnalysisError {
+    id: string;
+    detail: string;
+    errorType: string;
+    createdAt: string;
+}
+export interface CompletedProtocolAnalysis {
+    id: string;
+    status?: 'completed';
+    result: 'ok' | 'not-ok' | 'error';
+    pipettes: LoadedPipette[];
+    labware: LoadedLabware[];
+    modules: LoadedModule[];
+    liquids: Liquid[];
+    commands: RunTimeCommand[];
+    errors: AnalysisError[];
+    robotType?: RobotType | null;
+}
+export interface ResourceFile {
+    name: string;
+    role: string;
+}
+export interface ProtocolResource {
+    id: string;
+    createdAt: string;
+    protocolType: 'json' | 'python';
+    robotType: RobotType;
+    metadata: ProtocolMetadata;
+    analysisSummaries: ProtocolAnalysisSummary[];
+    files: ResourceFile[];
+    key?: string;
+}
+export interface ProtocolAnalysesResource {
+    analyses: Array<PendingProtocolAnalysis | CompletedProtocolAnalysis>;
+}
+export declare type MotorAxis = 'x' | 'y' | 'leftZ' | 'rightZ' | 'leftPlunger' | 'rightPlunger' | 'extensionZ' | 'extensionJaw';
+export declare type MotorAxes = MotorAxis[];
+export declare type ThermalAdapterName = 'PCR Adapter' | 'Deep Well Adapter' | '96 Flat Bottom Adapter' | 'Universal Flat Adapter';
+export interface GripperDefinition {
+    $otSharedSchema: string;
+    model: GripperModel;
+    schemaVersion: number;
+    displayName: string;
+    zMotorConfigurations: {
+        idle: number;
+        run: number;
+    };
+    jawMotorConfigurations: {
+        vref: number;
+    };
+    gripForceProfile: {
+        polynomial: [[number, number], [number, number]];
+        defaultGripForce: number;
+        defaultHomeForce: number;
+        defaultIdleForce: number;
+        min: number;
+        max: number;
+    };
+    geometry: {
+        baseOffsetFromMount: [number, number, number];
+        jawCenterOffsetFromBase: [number, number, number];
+        pinOneOffsetFromBase: [number, number, number];
+        pinTwoOffsetFromBase: [number, number, number];
+        jawWidth: {
+            min: number;
+            max: number;
+        };
+        maxAllowedGripError: number;
+    };
+}
+export declare type StatusBarAnimation = 'idle' | 'confirm' | 'updating' | 'disco' | 'off';
+export declare type StatusBarAnimations = StatusBarAnimation[];
+export interface CutoutConfig {
+    cutoutId: CutoutId;
+    cutoutFixtureId: CutoutFixtureId | null;
+}
+export declare type DeckConfiguration = CutoutConfig[];
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opentrons/shared-data",
-  "version": "0.1.2-alpha.0",
+  "version": "0.1.2-alpha.1",
   "description": "Shared system definitions and utilities for Opentrons robots and software",
   "repository": {
     "type": "git",