@opentrons/shared-data 0.1.4 → 0.1.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/Makefile +1 -1
- package/command/schemas/8.json +7 -1
- package/deck/definitions/4/ot3_standard.json +0 -1
- package/lib/command/schemas/8.json +7 -1
- package/lib/command/types/annotation.d.ts +2 -2
- package/lib/command/types/calibration.d.ts +2 -2
- package/lib/command/types/gantry.d.ts +2 -2
- package/lib/command/types/incidental.d.ts +2 -2
- package/lib/command/types/index.d.ts +3 -3
- package/lib/command/types/module.d.ts +2 -2
- package/lib/command/types/pipetting.d.ts +8 -8
- package/lib/command/types/setup.d.ts +6 -6
- package/lib/command/types/timing.d.ts +3 -3
- package/lib/commandAnnotation/types/index.d.ts +2 -2
- package/lib/deck/definitions/4/ot3_standard.json +0 -1
- package/lib/deck/types/schemaV4.d.ts +12 -12
- package/lib/js/constants.d.ts +6 -6
- package/lib/js/errors.d.ts +2 -2
- package/lib/js/fixtures.d.ts +3 -0
- package/lib/js/helpers/getModuleVizDims.d.ts +1 -1
- package/lib/js/helpers/index.d.ts +3 -3
- package/lib/js/helpers/orderWells.d.ts +1 -1
- package/lib/js/helpers/parseProtocolData.d.ts +4 -4
- package/lib/js/helpers/wellSets.d.ts +1 -1
- package/lib/js/labwareTools/index.d.ts +2 -2
- package/lib/js/pipettes.d.ts +3 -3
- package/lib/js/types.d.ts +36 -36
- package/lib/opentrons-shared-data.js +1 -1
- package/lib/opentrons-shared-data.js.map +1 -1
- package/lib/pipette/definitions/2/geometry/eight_channel/p10/1_0.json +4 -0
- package/lib/pipette/definitions/2/geometry/eight_channel/p10/1_3.json +4 -0
- package/lib/pipette/definitions/2/geometry/eight_channel/p10/1_4.json +4 -0
- package/lib/pipette/definitions/2/geometry/eight_channel/p10/1_5.json +4 -0
- package/lib/pipette/definitions/2/geometry/eight_channel/p10/1_6.json +4 -0
- package/lib/pipette/definitions/2/geometry/eight_channel/p1000/1_0.json +4 -0
- package/lib/pipette/definitions/2/geometry/eight_channel/p1000/3_0.json +4 -0
- package/lib/pipette/definitions/2/geometry/eight_channel/p1000/3_3.json +4 -0
- package/lib/pipette/definitions/2/geometry/eight_channel/p1000/3_4.json +4 -0
- package/lib/pipette/definitions/2/geometry/eight_channel/p1000/3_5.json +4 -0
- package/lib/pipette/definitions/2/geometry/eight_channel/p20/2_0.json +4 -0
- package/lib/pipette/definitions/2/geometry/eight_channel/p20/2_1.json +4 -0
- package/lib/pipette/definitions/2/geometry/eight_channel/p300/1_0.json +4 -0
- package/lib/pipette/definitions/2/geometry/eight_channel/p300/1_3.json +4 -0
- package/lib/pipette/definitions/2/geometry/eight_channel/p300/1_4.json +4 -0
- package/lib/pipette/definitions/2/geometry/eight_channel/p300/1_5.json +4 -0
- package/lib/pipette/definitions/2/geometry/eight_channel/p300/2_0.json +4 -0
- package/lib/pipette/definitions/2/geometry/eight_channel/p300/2_1.json +4 -0
- package/lib/pipette/definitions/2/geometry/eight_channel/p50/1_0.json +4 -0
- package/lib/pipette/definitions/2/geometry/eight_channel/p50/1_3.json +4 -0
- package/lib/pipette/definitions/2/geometry/eight_channel/p50/1_4.json +4 -0
- package/lib/pipette/definitions/2/geometry/eight_channel/p50/1_5.json +4 -0
- package/lib/pipette/definitions/2/geometry/eight_channel/p50/3_0.json +4 -0
- package/lib/pipette/definitions/2/geometry/eight_channel/p50/3_3.json +4 -0
- package/lib/pipette/definitions/2/geometry/eight_channel/p50/3_4.json +4 -0
- package/lib/pipette/definitions/2/geometry/eight_channel/p50/3_5.json +4 -0
- package/lib/pipette/definitions/2/geometry/ninety_six_channel/p1000/1_0.json +4 -0
- package/lib/pipette/definitions/2/geometry/ninety_six_channel/p1000/3_0.json +4 -0
- package/lib/pipette/definitions/2/geometry/ninety_six_channel/p1000/3_3.json +4 -0
- package/lib/pipette/definitions/2/geometry/ninety_six_channel/p1000/3_4.json +4 -0
- package/lib/pipette/definitions/2/geometry/ninety_six_channel/p1000/3_5.json +4 -0
- package/lib/pipette/definitions/2/geometry/single_channel/p10/1_0.json +4 -0
- package/lib/pipette/definitions/2/geometry/single_channel/p10/1_3.json +4 -0
- package/lib/pipette/definitions/2/geometry/single_channel/p10/1_4.json +4 -0
- package/lib/pipette/definitions/2/geometry/single_channel/p10/1_5.json +4 -0
- package/lib/pipette/definitions/2/geometry/single_channel/p1000/1_0.json +4 -0
- package/lib/pipette/definitions/2/geometry/single_channel/p1000/1_3.json +4 -0
- package/lib/pipette/definitions/2/geometry/single_channel/p1000/1_4.json +4 -0
- package/lib/pipette/definitions/2/geometry/single_channel/p1000/1_5.json +4 -0
- package/lib/pipette/definitions/2/geometry/single_channel/p1000/2_0.json +4 -0
- package/lib/pipette/definitions/2/geometry/single_channel/p1000/2_1.json +4 -0
- package/lib/pipette/definitions/2/geometry/single_channel/p1000/2_2.json +4 -0
- package/lib/pipette/definitions/2/geometry/single_channel/p1000/3_0.json +4 -0
- package/lib/pipette/definitions/2/geometry/single_channel/p1000/3_3.json +4 -0
- package/lib/pipette/definitions/2/geometry/single_channel/p1000/3_4.json +4 -0
- package/lib/pipette/definitions/2/geometry/single_channel/p1000/3_5.json +4 -0
- package/lib/pipette/definitions/2/geometry/single_channel/p1000/3_6.json +4 -0
- package/lib/pipette/definitions/2/geometry/single_channel/p20/2_0.json +4 -0
- package/lib/pipette/definitions/2/geometry/single_channel/p20/2_1.json +4 -0
- package/lib/pipette/definitions/2/geometry/single_channel/p20/2_2.json +4 -0
- package/lib/pipette/definitions/2/geometry/single_channel/p300/1_0.json +4 -0
- package/lib/pipette/definitions/2/geometry/single_channel/p300/1_3.json +4 -0
- package/lib/pipette/definitions/2/geometry/single_channel/p300/1_4.json +4 -0
- package/lib/pipette/definitions/2/geometry/single_channel/p300/1_5.json +4 -0
- package/lib/pipette/definitions/2/geometry/single_channel/p300/2_0.json +4 -0
- package/lib/pipette/definitions/2/geometry/single_channel/p300/2_1.json +4 -0
- package/lib/pipette/definitions/2/geometry/single_channel/p50/1_0.json +4 -0
- package/lib/pipette/definitions/2/geometry/single_channel/p50/1_3.json +4 -0
- package/lib/pipette/definitions/2/geometry/single_channel/p50/1_4.json +4 -0
- package/lib/pipette/definitions/2/geometry/single_channel/p50/1_5.json +4 -0
- package/lib/pipette/definitions/2/geometry/single_channel/p50/3_0.json +4 -0
- package/lib/pipette/definitions/2/geometry/single_channel/p50/3_3.json +4 -0
- package/lib/pipette/definitions/2/geometry/single_channel/p50/3_4.json +4 -0
- package/lib/pipette/definitions/2/geometry/single_channel/p50/3_5.json +4 -0
- package/lib/pipette/schemas/2/pipetteGeometrySchema.json +8 -0
- package/lib/protocol/fixtures/6/multipleTipracks.json +26 -104
- package/lib/protocol/index.d.ts +1 -1
- package/lib/protocol/types/schemaV1.d.ts +5 -5
- package/lib/protocol/types/schemaV3.d.ts +9 -9
- package/lib/protocol/types/schemaV4.d.ts +1 -1
- package/lib/protocol/types/schemaV5.d.ts +1 -1
- package/lib/protocol/types/schemaV5Addendum.d.ts +2 -2
- package/lib/protocol/types/schemaV6/command/gantry.d.ts +2 -2
- package/lib/protocol/types/schemaV6/command/index.d.ts +3 -3
- package/lib/protocol/types/schemaV6/command/module.d.ts +2 -2
- package/lib/protocol/types/schemaV6/command/pipetting.d.ts +7 -7
- package/lib/protocol/types/schemaV6/command/setup.d.ts +4 -4
- package/lib/protocol/types/schemaV6/command/timing.d.ts +3 -3
- package/lib/protocol/types/schemaV7/command/annotation.d.ts +2 -2
- package/lib/protocol/types/schemaV7/command/calibration.d.ts +2 -2
- package/lib/protocol/types/schemaV7/command/gantry.d.ts +2 -2
- package/lib/protocol/types/schemaV7/command/incidental.d.ts +2 -2
- package/lib/protocol/types/schemaV7/command/index.d.ts +3 -3
- package/lib/protocol/types/schemaV7/command/module.d.ts +2 -2
- package/lib/protocol/types/schemaV7/command/pipetting.d.ts +8 -8
- package/lib/protocol/types/schemaV7/command/setup.d.ts +5 -5
- package/lib/protocol/types/schemaV7/command/timing.d.ts +3 -3
- package/lib/protocol/types/schemaV8/index.d.ts +2 -2
- package/package.json +1 -1
- package/pipette/definitions/2/geometry/eight_channel/p10/1_0.json +4 -0
- package/pipette/definitions/2/geometry/eight_channel/p10/1_3.json +4 -0
- package/pipette/definitions/2/geometry/eight_channel/p10/1_4.json +4 -0
- package/pipette/definitions/2/geometry/eight_channel/p10/1_5.json +4 -0
- package/pipette/definitions/2/geometry/eight_channel/p10/1_6.json +4 -0
- package/pipette/definitions/2/geometry/eight_channel/p1000/1_0.json +4 -0
- package/pipette/definitions/2/geometry/eight_channel/p1000/3_0.json +4 -0
- package/pipette/definitions/2/geometry/eight_channel/p1000/3_3.json +4 -0
- package/pipette/definitions/2/geometry/eight_channel/p1000/3_4.json +4 -0
- package/pipette/definitions/2/geometry/eight_channel/p1000/3_5.json +4 -0
- package/pipette/definitions/2/geometry/eight_channel/p20/2_0.json +4 -0
- package/pipette/definitions/2/geometry/eight_channel/p20/2_1.json +4 -0
- package/pipette/definitions/2/geometry/eight_channel/p300/1_0.json +4 -0
- package/pipette/definitions/2/geometry/eight_channel/p300/1_3.json +4 -0
- package/pipette/definitions/2/geometry/eight_channel/p300/1_4.json +4 -0
- package/pipette/definitions/2/geometry/eight_channel/p300/1_5.json +4 -0
- package/pipette/definitions/2/geometry/eight_channel/p300/2_0.json +4 -0
- package/pipette/definitions/2/geometry/eight_channel/p300/2_1.json +4 -0
- package/pipette/definitions/2/geometry/eight_channel/p50/1_0.json +4 -0
- package/pipette/definitions/2/geometry/eight_channel/p50/1_3.json +4 -0
- package/pipette/definitions/2/geometry/eight_channel/p50/1_4.json +4 -0
- package/pipette/definitions/2/geometry/eight_channel/p50/1_5.json +4 -0
- package/pipette/definitions/2/geometry/eight_channel/p50/3_0.json +4 -0
- package/pipette/definitions/2/geometry/eight_channel/p50/3_3.json +4 -0
- package/pipette/definitions/2/geometry/eight_channel/p50/3_4.json +4 -0
- package/pipette/definitions/2/geometry/eight_channel/p50/3_5.json +4 -0
- package/pipette/definitions/2/geometry/ninety_six_channel/p1000/1_0.json +4 -0
- package/pipette/definitions/2/geometry/ninety_six_channel/p1000/3_0.json +4 -0
- package/pipette/definitions/2/geometry/ninety_six_channel/p1000/3_3.json +4 -0
- package/pipette/definitions/2/geometry/ninety_six_channel/p1000/3_4.json +4 -0
- package/pipette/definitions/2/geometry/ninety_six_channel/p1000/3_5.json +4 -0
- package/pipette/definitions/2/geometry/single_channel/p10/1_0.json +4 -0
- package/pipette/definitions/2/geometry/single_channel/p10/1_3.json +4 -0
- package/pipette/definitions/2/geometry/single_channel/p10/1_4.json +4 -0
- package/pipette/definitions/2/geometry/single_channel/p10/1_5.json +4 -0
- package/pipette/definitions/2/geometry/single_channel/p1000/1_0.json +4 -0
- package/pipette/definitions/2/geometry/single_channel/p1000/1_3.json +4 -0
- package/pipette/definitions/2/geometry/single_channel/p1000/1_4.json +4 -0
- package/pipette/definitions/2/geometry/single_channel/p1000/1_5.json +4 -0
- package/pipette/definitions/2/geometry/single_channel/p1000/2_0.json +4 -0
- package/pipette/definitions/2/geometry/single_channel/p1000/2_1.json +4 -0
- package/pipette/definitions/2/geometry/single_channel/p1000/2_2.json +4 -0
- package/pipette/definitions/2/geometry/single_channel/p1000/3_0.json +4 -0
- package/pipette/definitions/2/geometry/single_channel/p1000/3_3.json +4 -0
- package/pipette/definitions/2/geometry/single_channel/p1000/3_4.json +4 -0
- package/pipette/definitions/2/geometry/single_channel/p1000/3_5.json +4 -0
- package/pipette/definitions/2/geometry/single_channel/p1000/3_6.json +4 -0
- package/pipette/definitions/2/geometry/single_channel/p20/2_0.json +4 -0
- package/pipette/definitions/2/geometry/single_channel/p20/2_1.json +4 -0
- package/pipette/definitions/2/geometry/single_channel/p20/2_2.json +4 -0
- package/pipette/definitions/2/geometry/single_channel/p300/1_0.json +4 -0
- package/pipette/definitions/2/geometry/single_channel/p300/1_3.json +4 -0
- package/pipette/definitions/2/geometry/single_channel/p300/1_4.json +4 -0
- package/pipette/definitions/2/geometry/single_channel/p300/1_5.json +4 -0
- package/pipette/definitions/2/geometry/single_channel/p300/2_0.json +4 -0
- package/pipette/definitions/2/geometry/single_channel/p300/2_1.json +4 -0
- package/pipette/definitions/2/geometry/single_channel/p50/1_0.json +4 -0
- package/pipette/definitions/2/geometry/single_channel/p50/1_3.json +4 -0
- package/pipette/definitions/2/geometry/single_channel/p50/1_4.json +4 -0
- package/pipette/definitions/2/geometry/single_channel/p50/1_5.json +4 -0
- package/pipette/definitions/2/geometry/single_channel/p50/3_0.json +4 -0
- package/pipette/definitions/2/geometry/single_channel/p50/3_3.json +4 -0
- package/pipette/definitions/2/geometry/single_channel/p50/3_4.json +4 -0
- package/pipette/definitions/2/geometry/single_channel/p50/3_5.json +4 -0
- package/pipette/schemas/2/pipetteGeometrySchema.json +8 -0
- package/protocol/fixtures/6/multipleTipracks.json +26 -104
package/Makefile
CHANGED
package/command/schemas/8.json
CHANGED
|
@@ -66,7 +66,7 @@
|
|
|
66
66
|
"calibration/moveToMaintenancePosition": "#/definitions/MoveToMaintenancePositionCreate"
|
|
67
67
|
}
|
|
68
68
|
},
|
|
69
|
-
"
|
|
69
|
+
"oneOf": [
|
|
70
70
|
{
|
|
71
71
|
"$ref": "#/definitions/AspirateCreate"
|
|
72
72
|
},
|
|
@@ -2120,6 +2120,12 @@
|
|
|
2120
2120
|
"description": "Whether to alternate location where tip is dropped within the addressable area. If True, this command will ignore the offset provided and alternate between dropping tips at two predetermined locations inside the specified labware well. If False, the tip will be dropped at the top center of the area.",
|
|
2121
2121
|
"default": false,
|
|
2122
2122
|
"type": "boolean"
|
|
2123
|
+
},
|
|
2124
|
+
"ignoreTipConfiguration": {
|
|
2125
|
+
"title": "Ignoretipconfiguration",
|
|
2126
|
+
"description": "Whether to utilize the critical point of the tip configuraiton when moving to an addressable area. If True, this command will ignore the tip configuration and use the center of the entire instrument as the critical point for movement. If False, this command will use the critical point provided by the current tip configuration.",
|
|
2127
|
+
"default": true,
|
|
2128
|
+
"type": "boolean"
|
|
2123
2129
|
}
|
|
2124
2130
|
},
|
|
2125
2131
|
"required": ["pipetteId", "addressableAreaName"]
|
|
@@ -66,7 +66,7 @@
|
|
|
66
66
|
"calibration/moveToMaintenancePosition": "#/definitions/MoveToMaintenancePositionCreate"
|
|
67
67
|
}
|
|
68
68
|
},
|
|
69
|
-
"
|
|
69
|
+
"oneOf": [
|
|
70
70
|
{
|
|
71
71
|
"$ref": "#/definitions/AspirateCreate"
|
|
72
72
|
},
|
|
@@ -2120,6 +2120,12 @@
|
|
|
2120
2120
|
"description": "Whether to alternate location where tip is dropped within the addressable area. If True, this command will ignore the offset provided and alternate between dropping tips at two predetermined locations inside the specified labware well. If False, the tip will be dropped at the top center of the area.",
|
|
2121
2121
|
"default": false,
|
|
2122
2122
|
"type": "boolean"
|
|
2123
|
+
},
|
|
2124
|
+
"ignoreTipConfiguration": {
|
|
2125
|
+
"title": "Ignoretipconfiguration",
|
|
2126
|
+
"description": "Whether to utilize the critical point of the tip configuraiton when moving to an addressable area. If True, this command will ignore the tip configuration and use the center of the entire instrument as the critical point for movement. If False, this command will use the critical point provided by the current tip configuration.",
|
|
2127
|
+
"default": true,
|
|
2128
|
+
"type": "boolean"
|
|
2123
2129
|
}
|
|
2124
2130
|
},
|
|
2125
2131
|
"required": ["pipetteId", "addressableAreaName"]
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type { CommonCommandRunTimeInfo, CommonCommandCreateInfo } from '.';
|
|
2
|
-
export
|
|
3
|
-
export
|
|
2
|
+
export type AnnotationCreateCommand = CommentCreateCommand | CustomCreateCommand;
|
|
3
|
+
export type AnnotationRunTimeCommand = CommentRunTimeCommand | CustomRunTimeCommand;
|
|
4
4
|
export interface CommentCreateCommand extends CommonCommandCreateInfo {
|
|
5
5
|
commandType: 'comment';
|
|
6
6
|
params: CommentParams;
|
|
@@ -28,8 +28,8 @@ export interface CalibrateModuleRunTimeCommand extends CommonCommandRunTimeInfo,
|
|
|
28
28
|
export interface MoveToMaintenancePositionRunTimeCommand extends CommonCommandRunTimeInfo, MoveToMaintenancePositionCreateCommand {
|
|
29
29
|
result?: {};
|
|
30
30
|
}
|
|
31
|
-
export
|
|
32
|
-
export
|
|
31
|
+
export type CalibrationRunTimeCommand = CalibratePipetteRunTimeCommand | CalibrateGripperRunTimeCommand | CalibrateModuleRunTimeCommand | MoveToMaintenancePositionRunTimeCommand;
|
|
32
|
+
export type CalibrationCreateCommand = CalibratePipetteCreateCommand | CalibrateGripperCreateCommand | CalibrateModuleCreateCommand | MoveToMaintenancePositionCreateCommand;
|
|
33
33
|
interface CalibratePipetteParams {
|
|
34
34
|
mount: PipetteMount;
|
|
35
35
|
}
|
|
@@ -62,8 +62,8 @@ export interface MoveToAddressableAreaCreateCommand extends CommonCommandCreateI
|
|
|
62
62
|
export interface MoveToAddressableAreaRunTimeCommand extends CommonCommandRunTimeInfo, MoveToAddressableAreaCreateCommand {
|
|
63
63
|
result?: {};
|
|
64
64
|
}
|
|
65
|
-
export
|
|
66
|
-
export
|
|
65
|
+
export type GantryRunTimeCommand = HomeRunTimeCommand | MoveRelativeRunTimeCommand | MoveToAddressableAreaRunTimeCommand | MoveToCoordinatesRunTimeCommand | MoveToSlotRunTimeCommand | MoveToWellRunTimeCommand | RetractAxisRunTimeCommand | SavePositionRunTimeCommand;
|
|
66
|
+
export type GantryCreateCommand = HomeCreateCommand | MoveRelativeCreateCommand | MoveToAddressableAreaCreateCommand | MoveToCoordinatesCreateCommand | MoveToSlotCreateCommand | MoveToWellCreateCommand | RetractAxisCreateCommand | SavePositionCreateCommand;
|
|
67
67
|
interface MoveToSlotParams {
|
|
68
68
|
pipetteId: string;
|
|
69
69
|
slotName: string;
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import type { CommonCommandRunTimeInfo, CommonCommandCreateInfo } from '.';
|
|
2
2
|
import type { StatusBarAnimation } from '../../js/types';
|
|
3
|
-
export
|
|
4
|
-
export
|
|
3
|
+
export type IncidentalCreateCommand = SetStatusBarCreateCommand;
|
|
4
|
+
export type IncidentalRunTimeCommand = SetStatusBarRunTimeCommand;
|
|
5
5
|
export interface SetStatusBarCreateCommand extends CommonCommandCreateInfo {
|
|
6
6
|
commandType: 'setStatusBar';
|
|
7
7
|
params: SetStatusBarParams;
|
|
@@ -14,7 +14,7 @@ export * from './module';
|
|
|
14
14
|
export * from './pipetting';
|
|
15
15
|
export * from './setup';
|
|
16
16
|
export * from './timing';
|
|
17
|
-
export
|
|
17
|
+
export type CommandStatus = 'queued' | 'running' | 'succeeded' | 'failed';
|
|
18
18
|
export interface CommonCommandRunTimeInfo {
|
|
19
19
|
key?: string;
|
|
20
20
|
id: string;
|
|
@@ -31,8 +31,8 @@ export interface CommonCommandCreateInfo {
|
|
|
31
31
|
[key: string]: any;
|
|
32
32
|
};
|
|
33
33
|
}
|
|
34
|
-
export
|
|
35
|
-
export
|
|
34
|
+
export type CreateCommand = PipettingCreateCommand | GantryCreateCommand | ModuleCreateCommand | SetupCreateCommand | TimingCreateCommand | CalibrationCreateCommand | AnnotationCreateCommand | IncidentalCreateCommand;
|
|
35
|
+
export type RunTimeCommand = PipettingRunTimeCommand | GantryRunTimeCommand | ModuleRunTimeCommand | SetupRunTimeCommand | TimingRunTimeCommand | CalibrationRunTimeCommand | AnnotationRunTimeCommand | IncidentalRunTimeCommand;
|
|
36
36
|
interface RunCommandError {
|
|
37
37
|
id: string;
|
|
38
38
|
errorType: string;
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type { CommonCommandRunTimeInfo, CommonCommandCreateInfo } from '.';
|
|
2
|
-
export
|
|
3
|
-
export
|
|
2
|
+
export type ModuleRunTimeCommand = MagneticModuleEngageMagnetRunTimeCommand | MagneticModuleDisengageRunTimeCommand | TemperatureModuleSetTargetTemperatureRunTimeCommand | TemperatureModuleDeactivateRunTimeCommand | TemperatureModuleAwaitTemperatureRunTimeCommand | TCSetTargetBlockTemperatureRunTimeCommand | TCSetTargetLidTemperatureRunTimeCommand | TCWaitForBlockTemperatureRunTimeCommand | TCWaitForLidTemperatureRunTimeCommand | TCOpenLidRunTimeCommand | TCCloseLidRunTimeCommand | TCDeactivateBlockRunTimeCommand | TCDeactivateLidRunTimeCommand | TCRunProfileRunTimeCommand | TCAwaitProfileCompleteRunTimeCommand | HeaterShakerSetTargetTemperatureRunTimeCommand | HeaterShakerWaitForTemperatureRunTimeCommand | HeaterShakerSetAndWaitForShakeSpeedRunTimeCommand | HeaterShakerOpenLatchRunTimeCommand | HeaterShakerCloseLatchRunTimeCommand | HeaterShakerDeactivateHeaterRunTimeCommand | HeaterShakerDeactivateShakerRunTimeCommand;
|
|
3
|
+
export type ModuleCreateCommand = MagneticModuleEngageMagnetCreateCommand | MagneticModuleDisengageCreateCommand | TemperatureModuleSetTargetTemperatureCreateCommand | TemperatureModuleDeactivateCreateCommand | TemperatureModuleAwaitTemperatureCreateCommand | TCSetTargetBlockTemperatureCreateCommand | TCSetTargetLidTemperatureCreateCommand | TCWaitForBlockTemperatureCreateCommand | TCWaitForLidTemperatureCreateCommand | TCOpenLidCreateCommand | TCCloseLidCreateCommand | TCDeactivateBlockCreateCommand | TCDeactivateLidCreateCommand | TCRunProfileCreateCommand | TCAwaitProfileCompleteCreateCommand | HeaterShakerWaitForTemperatureCreateCommand | HeaterShakerSetAndWaitForShakeSpeedCreateCommand | HeaterShakerOpenLatchCreateCommand | HeaterShakerCloseLatchCreateCommand | HeaterShakerDeactivateHeaterCreateCommand | HeaterShakerDeactivateShakerCreateCommand | HeaterShakerSetTargetTemperatureCreateCommand;
|
|
4
4
|
export interface MagneticModuleEngageMagnetCreateCommand extends CommonCommandCreateInfo {
|
|
5
5
|
commandType: 'magneticModule/engage';
|
|
6
6
|
params: EngageMagnetParams;
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import type { AddressableAreaName } from '../../deck';
|
|
2
2
|
import type { CommonCommandRunTimeInfo, CommonCommandCreateInfo } from '.';
|
|
3
|
-
export
|
|
4
|
-
export
|
|
3
|
+
export type PipettingRunTimeCommand = AspirateInPlaceRunTimeCommand | AspirateInPlaceRunTimeCommand | AspirateRunTimeCommand | BlowoutInPlaceRunTimeCommand | BlowoutRunTimeCommand | ConfigureForVolumeRunTimeCommand | DispenseInPlaceRunTimeCommand | DispenseRunTimeCommand | DropTipInPlaceRunTimeCommand | DropTipRunTimeCommand | GetTipPresenceRunTimeCommand | MoveToAddressableAreaForDropTipRunTimeCommand | PickUpTipRunTimeCommand | PrepareToAspirateRunTimeCommand | TouchTipRunTimeCommand | VerifyTipPresenceRunTimeCommand;
|
|
4
|
+
export type PipettingCreateCommand = AspirateCreateCommand | AspirateInPlaceCreateCommand | BlowoutCreateCommand | BlowoutInPlaceCreateCommand | ConfigureForVolumeCreateCommand | DispenseCreateCommand | DispenseInPlaceCreateCommand | DropTipCreateCommand | DropTipInPlaceCreateCommand | GetTipPresenceCreateCommand | MoveToAddressableAreaForDropTipCreateCommand | PickUpTipCreateCommand | PrepareToAspirateCreateCommand | TouchTipCreateCommand | VerifyTipPresenceCreateCommand;
|
|
5
5
|
export interface ConfigureForVolumeCreateCommand extends CommonCommandCreateInfo {
|
|
6
6
|
commandType: 'configureForVolume';
|
|
7
7
|
params: ConfigureForVolumeParams;
|
|
@@ -27,7 +27,7 @@ export interface AspirateInPlaceCreateCommand extends CommonCommandCreateInfo {
|
|
|
27
27
|
export interface AspirateInPlaceRunTimeCommand extends CommonCommandRunTimeInfo, AspirateInPlaceCreateCommand {
|
|
28
28
|
result?: BasicLiquidHandlingResult;
|
|
29
29
|
}
|
|
30
|
-
export
|
|
30
|
+
export type DispenseParams = AspDispAirgapParams & {
|
|
31
31
|
pushOut?: number;
|
|
32
32
|
};
|
|
33
33
|
export interface DispenseCreateCommand extends CommonCommandCreateInfo {
|
|
@@ -114,10 +114,10 @@ export interface VerifyTipPresenceCreateCommand extends CommonCommandCreateInfo
|
|
|
114
114
|
export interface VerifyTipPresenceRunTimeCommand extends CommonCommandRunTimeInfo, VerifyTipPresenceCreateCommand {
|
|
115
115
|
result?: any;
|
|
116
116
|
}
|
|
117
|
-
export
|
|
118
|
-
export
|
|
119
|
-
export
|
|
120
|
-
export
|
|
117
|
+
export type AspDispAirgapParams = FlowRateParams & PipetteAccessParams & VolumeParams & WellLocationParam;
|
|
118
|
+
export type BlowoutParams = FlowRateParams & PipetteAccessParams & WellLocationParam;
|
|
119
|
+
export type TouchTipParams = PipetteAccessParams & WellLocationParam;
|
|
120
|
+
export type DropTipParams = PipetteAccessParams & {
|
|
121
121
|
wellLocation?: {
|
|
122
122
|
origin?: 'default' | 'top' | 'center' | 'bottom';
|
|
123
123
|
offset?: {
|
|
@@ -127,7 +127,7 @@ export declare type DropTipParams = PipetteAccessParams & {
|
|
|
127
127
|
};
|
|
128
128
|
};
|
|
129
129
|
};
|
|
130
|
-
export
|
|
130
|
+
export type PickUpTipParams = TouchTipParams;
|
|
131
131
|
interface AddressableOffsetVector {
|
|
132
132
|
x: number;
|
|
133
133
|
y: number;
|
|
@@ -47,9 +47,9 @@ export interface ConfigureNozzleLayoutCreateCommand extends CommonCommandCreateI
|
|
|
47
47
|
export interface ConfigureNozzleLayoutRunTimeCommand extends CommonCommandRunTimeInfo, ConfigureNozzleLayoutCreateCommand {
|
|
48
48
|
result?: {};
|
|
49
49
|
}
|
|
50
|
-
export
|
|
51
|
-
export
|
|
52
|
-
export
|
|
50
|
+
export type SetupRunTimeCommand = ConfigureNozzleLayoutRunTimeCommand | LoadPipetteRunTimeCommand | LoadLabwareRunTimeCommand | LoadModuleRunTimeCommand | LoadLiquidRunTimeCommand | MoveLabwareRunTimeCommand;
|
|
51
|
+
export type SetupCreateCommand = ConfigureNozzleLayoutCreateCommand | LoadPipetteCreateCommand | LoadLabwareCreateCommand | LoadModuleCreateCommand | LoadLiquidCreateCommand | MoveLabwareCreateCommand;
|
|
52
|
+
export type LabwareLocation = 'offDeck' | {
|
|
53
53
|
slotName: string;
|
|
54
54
|
} | {
|
|
55
55
|
moduleId: string;
|
|
@@ -58,7 +58,7 @@ export declare type LabwareLocation = 'offDeck' | {
|
|
|
58
58
|
} | {
|
|
59
59
|
addressableAreaName: AddressableAreaName;
|
|
60
60
|
};
|
|
61
|
-
export
|
|
61
|
+
export type NonStackedLocation = 'offDeck' | {
|
|
62
62
|
slotName: string;
|
|
63
63
|
} | {
|
|
64
64
|
moduleId: string;
|
|
@@ -89,7 +89,7 @@ interface LoadLabwareResult {
|
|
|
89
89
|
definition: LabwareDefinition2;
|
|
90
90
|
offset: LabwareOffset;
|
|
91
91
|
}
|
|
92
|
-
export
|
|
92
|
+
export type LabwareMovementStrategy = 'usingGripper' | 'manualMoveWithPause' | 'manualMoveWithoutPause';
|
|
93
93
|
export interface MoveLabwareParams {
|
|
94
94
|
labwareId: string;
|
|
95
95
|
newLocation: LabwareLocation;
|
|
@@ -121,7 +121,7 @@ declare const SINGLE = "SINGLE";
|
|
|
121
121
|
declare const ROW = "ROW";
|
|
122
122
|
declare const QUADRANT = "QUADRANT";
|
|
123
123
|
export declare const ALL = "ALL";
|
|
124
|
-
export
|
|
124
|
+
export type NozzleConfigurationStyle = typeof COLUMN | typeof SINGLE | typeof ROW | typeof QUADRANT | typeof ALL;
|
|
125
125
|
interface NozzleConfigurationParams {
|
|
126
126
|
primaryNozzle?: string;
|
|
127
127
|
style: NozzleConfigurationStyle;
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type { CommonCommandRunTimeInfo, CommonCommandCreateInfo } from '.';
|
|
2
|
-
export
|
|
3
|
-
export
|
|
2
|
+
export type TimingCreateCommand = WaitForResumeCreateCommand | WaitForDurationCreateCommand | DeprecatedDelayCreateCommand;
|
|
3
|
+
export type TimingRunTimeCommand = WaitForResumeRunTimeCommand | WaitForDurationRunTimeCommand | DeprecatedDelayRunTimeCommand;
|
|
4
4
|
export interface WaitForResumeCreateCommand extends CommonCommandCreateInfo {
|
|
5
5
|
commandType: 'waitForResume' | 'pause';
|
|
6
6
|
params: WaitForResumeParams;
|
|
@@ -29,7 +29,7 @@ export interface DeprecatedDelayCreateCommand extends CommonCommandCreateInfo {
|
|
|
29
29
|
export interface DeprecatedDelayRunTimeCommand extends CommonCommandRunTimeInfo, DeprecatedDelayCreateCommand {
|
|
30
30
|
result?: {};
|
|
31
31
|
}
|
|
32
|
-
|
|
32
|
+
type DeprecatedDelayParams = {
|
|
33
33
|
waitForResume: true;
|
|
34
34
|
message?: string;
|
|
35
35
|
} | {
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
interface SharedCommandAnnotationProperties {
|
|
2
2
|
commandKeys: string[];
|
|
3
3
|
}
|
|
4
|
-
export
|
|
4
|
+
export type CustomCommandAnnotation = SharedCommandAnnotationProperties & {
|
|
5
5
|
[key: string]: any;
|
|
6
6
|
} & {
|
|
7
7
|
annotationType: 'custom';
|
|
@@ -15,5 +15,5 @@ export interface SecondOrderCommandAnnotation extends SharedCommandAnnotationPro
|
|
|
15
15
|
userSpecifiedName?: string;
|
|
16
16
|
userSpecifiedDescription?: string;
|
|
17
17
|
}
|
|
18
|
-
export
|
|
18
|
+
export type CommandAnnotation = SecondOrderCommandAnnotation | CustomCommandAnnotation;
|
|
19
19
|
export {};
|
|
@@ -1,12 +1,12 @@
|
|
|
1
|
-
export
|
|
2
|
-
export
|
|
3
|
-
export
|
|
4
|
-
export
|
|
5
|
-
export
|
|
6
|
-
export
|
|
7
|
-
export
|
|
8
|
-
export
|
|
9
|
-
export
|
|
10
|
-
export
|
|
11
|
-
export
|
|
12
|
-
export
|
|
1
|
+
export type FlexAddressableAreaName = 'D1' | 'D2' | 'D3' | 'C1' | 'C2' | 'C3' | 'B1' | 'B2' | 'B3' | 'A1' | 'A2' | 'A3' | 'A4' | 'B4' | 'C4' | 'D4' | 'movableTrashA1' | 'movableTrashA3' | 'movableTrashB1' | 'movableTrashB3' | 'movableTrashC1' | 'movableTrashC3' | 'movableTrashD1' | 'movableTrashD3' | '1ChannelWasteChute' | '8ChannelWasteChute' | '96ChannelWasteChute' | 'gripperWasteChute';
|
|
2
|
+
export type OT2AddressableAreaName = '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | '10' | '11' | '12' | 'fixedTrash';
|
|
3
|
+
export type AddressableAreaName = FlexAddressableAreaName | OT2AddressableAreaName;
|
|
4
|
+
export type CutoutId = 'cutoutD1' | 'cutoutD2' | 'cutoutD3' | 'cutoutC1' | 'cutoutC2' | 'cutoutC3' | 'cutoutB1' | 'cutoutB2' | 'cutoutB3' | 'cutoutA1' | 'cutoutA2' | 'cutoutA3';
|
|
5
|
+
export type OT2CutoutId = 'cutout1' | 'cutout2' | 'cutout3' | 'cutout4' | 'cutout5' | 'cutout6' | 'cutout7' | 'cutout8' | 'cutout9' | 'cutout10' | 'cutout11' | 'cutout12';
|
|
6
|
+
export type SingleSlotCutoutFixtureId = 'singleLeftSlot' | 'singleCenterSlot' | 'singleRightSlot';
|
|
7
|
+
export type StagingAreaRightSlotFixtureId = 'stagingAreaRightSlot';
|
|
8
|
+
export type TrashBinAdapterCutoutFixtureId = 'trashBinAdapter';
|
|
9
|
+
export type WasteChuteCutoutFixtureId = 'wasteChuteRightAdapterCovered' | 'wasteChuteRightAdapterNoCover' | 'stagingAreaSlotWithWasteChuteRightAdapterCovered' | 'stagingAreaSlotWithWasteChuteRightAdapterNoCover';
|
|
10
|
+
export type OT2SingleStandardSlot = 'singleStandardSlot';
|
|
11
|
+
export type OT2FixedTrashSlot = 'fixedTrashSlot';
|
|
12
|
+
export type CutoutFixtureId = SingleSlotCutoutFixtureId | StagingAreaRightSlotFixtureId | TrashBinAdapterCutoutFixtureId | WasteChuteCutoutFixtureId | OT2SingleStandardSlot | OT2FixedTrashSlot;
|
package/lib/js/constants.d.ts
CHANGED
|
@@ -24,7 +24,7 @@ export declare const MAGNETIC_BLOCK_V1: 'magneticBlockV1';
|
|
|
24
24
|
export declare const GRIPPER_V1: 'gripperV1';
|
|
25
25
|
export declare const GRIPPER_V1_1: 'gripperV1.1';
|
|
26
26
|
export declare const GRIPPER_V1_2: 'gripperV1.2';
|
|
27
|
-
export declare const GRIPPER_MODELS:
|
|
27
|
+
export declare const GRIPPER_MODELS: ("gripperV1" | "gripperV1.1" | "gripperV1.2")[];
|
|
28
28
|
export declare const FLEX_DISPLAY_NAME: 'Opentrons Flex';
|
|
29
29
|
export declare const FLEX: 'FLEX';
|
|
30
30
|
export declare const GEN2: 'GEN2';
|
|
@@ -38,15 +38,15 @@ export declare const MAGNETIC_MODULE_TYPE: 'magneticModuleType';
|
|
|
38
38
|
export declare const THERMOCYCLER_MODULE_TYPE: 'thermocyclerModuleType';
|
|
39
39
|
export declare const HEATERSHAKER_MODULE_TYPE: 'heaterShakerModuleType';
|
|
40
40
|
export declare const MAGNETIC_BLOCK_TYPE: 'magneticBlockType';
|
|
41
|
-
export declare const MAGNETIC_MODULE_MODELS:
|
|
41
|
+
export declare const MAGNETIC_MODULE_MODELS: ("magneticModuleV1" | "magneticModuleV2")[];
|
|
42
42
|
export declare const NON_CONNECTING_MODULE_TYPES: ModuleType[];
|
|
43
|
-
export declare const TEMPERATURE_MODULE_MODELS:
|
|
44
|
-
export declare const THERMOCYCLER_MODULE_MODELS:
|
|
43
|
+
export declare const TEMPERATURE_MODULE_MODELS: ("temperatureModuleV1" | "temperatureModuleV2")[];
|
|
44
|
+
export declare const THERMOCYCLER_MODULE_MODELS: ("thermocyclerModuleV1" | "thermocyclerModuleV2")[];
|
|
45
45
|
export declare const HEATERSHAKER_MODULE_MODELS: "heaterShakerModuleV1"[];
|
|
46
46
|
export declare const MAGNETIC_BLOCK_MODELS: "magneticBlockV1"[];
|
|
47
|
-
export declare const MODULE_MODELS:
|
|
47
|
+
export declare const MODULE_MODELS: ("magneticModuleV1" | "magneticModuleV2" | "temperatureModuleV1" | "temperatureModuleV2" | "thermocyclerModuleV1" | "thermocyclerModuleV2" | "heaterShakerModuleV1" | "magneticBlockV1")[];
|
|
48
48
|
export declare const MODULE_MODELS_OT2_ONLY: ("magneticModuleV1" | "magneticModuleV2" | "temperatureModuleV1" | "thermocyclerModuleV1")[];
|
|
49
|
-
export declare const MODULE_TYPES:
|
|
49
|
+
export declare const MODULE_TYPES: ("magneticModuleType" | "temperatureModuleType" | "thermocyclerModuleType" | "heaterShakerModuleType" | "magneticBlockType")[];
|
|
50
50
|
export declare const GEN_ONE_MULTI_PIPETTES: string[];
|
|
51
51
|
export declare const IDENTITY_VECTOR: {
|
|
52
52
|
x: number;
|
package/lib/js/errors.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import errorDefinitions from '../errors/definitions/1/errors.json';
|
|
2
|
-
export
|
|
3
|
-
export
|
|
2
|
+
export type ErrorCodes = keyof typeof errorDefinitions.codes;
|
|
3
|
+
export type ErrorCategories = keyof typeof errorDefinitions.categories;
|
|
4
4
|
export interface ErrorCategory {
|
|
5
5
|
detail: string;
|
|
6
6
|
codePrefix: string;
|
package/lib/js/fixtures.d.ts
CHANGED
|
@@ -7,6 +7,9 @@ export declare const OT2_CUTOUT_BY_SLOT_ID: {
|
|
|
7
7
|
export declare const FLEX_CUTOUT_BY_SLOT_ID: {
|
|
8
8
|
[slotId: string]: CutoutId;
|
|
9
9
|
};
|
|
10
|
+
export declare const FLEX_SINGLE_SLOT_BY_CUTOUT_ID: {
|
|
11
|
+
[CutoutId: string]: string;
|
|
12
|
+
};
|
|
10
13
|
export declare function getPositionFromSlotId(slotId: string, deckDef: DeckDefinition): CoordinateTuple | null;
|
|
11
14
|
export declare function getAddressableAreaFromSlotId(slotId: string, deckDef: DeckDefinition): AddressableArea | null;
|
|
12
15
|
export declare function getFixtureDisplayName(cutoutFixtureId: CutoutFixtureId | null): string;
|
|
@@ -10,7 +10,7 @@ export interface ModuleVizDims {
|
|
|
10
10
|
childYDimension: number;
|
|
11
11
|
}
|
|
12
12
|
export declare const getModuleVizDims: (orientation: ModuleOrientation, moduleType: ModuleType) => ModuleVizDims;
|
|
13
|
-
|
|
13
|
+
type DeckSlot = string;
|
|
14
14
|
export declare const inferModuleOrientationFromSlot: (slot: DeckSlot) => ModuleOrientation;
|
|
15
15
|
export declare const inferModuleOrientationFromXCoordinate: (xCoordinate: number) => ModuleOrientation;
|
|
16
16
|
export {};
|
|
@@ -35,9 +35,9 @@ export declare function splitWellsOnColumn(sortedArray: string[]): string[][];
|
|
|
35
35
|
export declare const getWellDepth: (labwareDef: LabwareDefinition2, well: string) => number;
|
|
36
36
|
export declare const getWellsDepth: (labwareDef: LabwareDefinition2, wells: string[]) => number;
|
|
37
37
|
export declare const getSlotHasMatingSurfaceUnitVector: (deckDef: DeckDefinition, addressableAreaName: string) => boolean;
|
|
38
|
-
export declare const getAreSlotsHorizontallyAdjacent: (slotNameA?: string | null
|
|
39
|
-
export declare const getAreSlotsVerticallyAdjacent: (slotNameA?: string | null
|
|
40
|
-
export declare const getAreSlotsAdjacent: (slotNameA?: string | null
|
|
38
|
+
export declare const getAreSlotsHorizontallyAdjacent: (slotNameA?: string | null, slotNameB?: string | null) => boolean;
|
|
39
|
+
export declare const getAreSlotsVerticallyAdjacent: (slotNameA?: string | null, slotNameB?: string | null) => boolean;
|
|
40
|
+
export declare const getAreSlotsAdjacent: (slotNameA?: string | null, slotNameB?: string | null) => boolean;
|
|
41
41
|
export declare const getIsLabwareAboveHeight: (labwareDef: LabwareDefinition2, height: number) => boolean;
|
|
42
42
|
export declare const getAdapterName: (labwareLoadname: string) => ThermalAdapterName;
|
|
43
43
|
export declare const getCalibrationAdapterLoadName: (moduleModel: ModuleModel) => string | null;
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export
|
|
1
|
+
export type WellOrderOption = 'l2r' | 'r2l' | 't2b' | 'b2t';
|
|
2
2
|
export declare const orderWells: (defaultOrdering: string[][], first: WellOrderOption, second: WellOrderOption) => string[];
|
|
@@ -1,16 +1,16 @@
|
|
|
1
1
|
import type { ErrorObject } from 'ajv';
|
|
2
2
|
import type { JsonProtocolFile } from '../../protocol';
|
|
3
|
-
export
|
|
3
|
+
export type ProtocolParseErrorKey = 'INVALID_FILE_TYPE' | 'INVALID_JSON_FILE';
|
|
4
4
|
interface ProtocolParseErrorDetails {
|
|
5
|
-
rawError?:
|
|
5
|
+
rawError?: unknown;
|
|
6
6
|
schemaErrors?: ErrorObject[] | null;
|
|
7
7
|
}
|
|
8
|
-
export
|
|
8
|
+
export type ProtocolParseErrorHandler = (errorKey: ProtocolParseErrorKey, errorDetails?: ProtocolParseErrorDetails) => unknown;
|
|
9
9
|
export interface PythonProtocolMetadata {
|
|
10
10
|
source?: string;
|
|
11
11
|
[key: string]: unknown;
|
|
12
12
|
}
|
|
13
|
-
export
|
|
13
|
+
export type ProtocolData = JsonProtocolFile | {
|
|
14
14
|
metadata: PythonProtocolMetadata;
|
|
15
15
|
};
|
|
16
16
|
export declare function parseProtocolData(file: File, contents: string, handleError?: ProtocolParseErrorHandler, metadata?: PythonProtocolMetadata | null): ProtocolData | null;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { LabwareDefinition2, PipetteNameSpecs } from '../types';
|
|
2
|
-
|
|
2
|
+
type WellSetByPrimaryWell = string[][];
|
|
3
3
|
export interface WellSetHelpers {
|
|
4
4
|
getAllWellSetsForLabware: (labwareDef: LabwareDefinition2) => WellSetByPrimaryWell;
|
|
5
5
|
getWellSetForMultichannel: (labwareDef: LabwareDefinition2, well: string, channels: 8 | 96) => string[] | null | undefined;
|
|
@@ -10,8 +10,8 @@ interface GridStart {
|
|
|
10
10
|
rowStride: number;
|
|
11
11
|
colStride: number;
|
|
12
12
|
}
|
|
13
|
-
|
|
14
|
-
|
|
13
|
+
type InputParams = Omit<Params, 'loadName'>;
|
|
14
|
+
type InputWellGroup = Omit<WellGroup, 'wells'>;
|
|
15
15
|
export interface BaseLabwareProps {
|
|
16
16
|
metadata: Metadata;
|
|
17
17
|
parameters: InputParams;
|
package/lib/js/pipettes.d.ts
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
import pipetteNameSpecs from '../pipette/definitions/1/pipetteNameSpecs.json';
|
|
2
2
|
import pipetteModelSpecs from '../pipette/definitions/1/pipetteModelSpecs.json';
|
|
3
3
|
import type { PipetteNameSpecs, PipetteModelSpecs } from './types';
|
|
4
|
-
|
|
5
|
-
export
|
|
6
|
-
export
|
|
4
|
+
type SortableProps = 'maxVolume' | 'channels';
|
|
5
|
+
export type PipetteName = keyof typeof pipetteNameSpecs;
|
|
6
|
+
export type PipetteModel = keyof typeof pipetteModelSpecs.config;
|
|
7
7
|
export declare function getPipetteNameSpecs(name: PipetteName): PipetteNameSpecs | null;
|
|
8
8
|
export declare function getPipetteModelSpecs(model: PipetteModel): PipetteModelSpecs | null | undefined;
|
|
9
9
|
export declare function getAllPipetteNames(...sortBy: SortableProps[]): PipetteName[];
|
package/lib/js/types.d.ts
CHANGED
|
@@ -2,7 +2,7 @@ import { MAGDECK, TEMPDECK, THERMOCYCLER, MAGNETIC_MODULE_V1, MAGNETIC_MODULE_V2
|
|
|
2
2
|
import type { RunTimeCommand, LabwareLocation } from '../command/types';
|
|
3
3
|
import type { AddressableAreaName, CutoutFixtureId, CutoutId } from '../deck';
|
|
4
4
|
import type { PipetteName } from './pipettes';
|
|
5
|
-
export
|
|
5
|
+
export type RobotType = 'OT-2 Standard' | 'OT-3 Standard';
|
|
6
6
|
export interface RobotDefinition {
|
|
7
7
|
displayName: string;
|
|
8
8
|
robotType: RobotType;
|
|
@@ -35,9 +35,9 @@ export interface LabwareDefinition1 {
|
|
|
35
35
|
[well: string]: WellDefinition;
|
|
36
36
|
};
|
|
37
37
|
}
|
|
38
|
-
export
|
|
39
|
-
export
|
|
40
|
-
export
|
|
38
|
+
export type LabwareDisplayCategory = 'wellPlate' | 'tipRack' | 'tubeRack' | 'reservoir' | 'aluminumBlock' | 'trash' | 'other' | 'adapter';
|
|
39
|
+
export type LabwareVolumeUnits = 'µL' | 'mL' | 'L';
|
|
40
|
+
export type WellBottomShape = 'flat' | 'u' | 'v';
|
|
41
41
|
export interface LabwareMetadata {
|
|
42
42
|
displayName: string;
|
|
43
43
|
displayCategory: LabwareDisplayCategory;
|
|
@@ -54,7 +54,7 @@ export interface Coordinates {
|
|
|
54
54
|
y: number;
|
|
55
55
|
z: number;
|
|
56
56
|
}
|
|
57
|
-
export
|
|
57
|
+
export type LabwareOffset = Coordinates;
|
|
58
58
|
export interface LabwareParameters {
|
|
59
59
|
loadName: string;
|
|
60
60
|
format: string;
|
|
@@ -78,17 +78,17 @@ export interface RectangularWellShapeProperties {
|
|
|
78
78
|
xDimension: number;
|
|
79
79
|
yDimension: number;
|
|
80
80
|
}
|
|
81
|
-
export
|
|
82
|
-
export
|
|
81
|
+
export type LabwareWellShapeProperties = CircularWellShapeProperties | RectangularWellShapeProperties;
|
|
82
|
+
export type LabwareWellProperties = LabwareWellShapeProperties & {
|
|
83
83
|
depth: number;
|
|
84
84
|
totalLiquidVolume: number;
|
|
85
85
|
};
|
|
86
|
-
export
|
|
86
|
+
export type LabwareWell = LabwareWellProperties & {
|
|
87
87
|
x: number;
|
|
88
88
|
y: number;
|
|
89
89
|
z: number;
|
|
90
90
|
};
|
|
91
|
-
export
|
|
91
|
+
export type LabwareWellMap = Record<string, LabwareWell>;
|
|
92
92
|
export interface LabwareWellGroupMetadata {
|
|
93
93
|
displayName?: string;
|
|
94
94
|
displayCategory?: LabwareDisplayCategory;
|
|
@@ -99,7 +99,7 @@ export interface LabwareWellGroup {
|
|
|
99
99
|
metadata: LabwareWellGroupMetadata;
|
|
100
100
|
brand?: LabwareBrand;
|
|
101
101
|
}
|
|
102
|
-
export
|
|
102
|
+
export type LabwareRoles = 'labware' | 'adapter' | 'fixture' | 'maintenance';
|
|
103
103
|
export interface LabwareDefinition2 {
|
|
104
104
|
version: number;
|
|
105
105
|
schemaVersion: 2;
|
|
@@ -114,15 +114,15 @@ export interface LabwareDefinition2 {
|
|
|
114
114
|
groups: LabwareWellGroup[];
|
|
115
115
|
allowedRoles?: LabwareRoles[];
|
|
116
116
|
}
|
|
117
|
-
export
|
|
118
|
-
export
|
|
119
|
-
export
|
|
120
|
-
export
|
|
121
|
-
export
|
|
122
|
-
export
|
|
123
|
-
export
|
|
124
|
-
export
|
|
125
|
-
export
|
|
117
|
+
export type ModuleType = typeof MAGNETIC_MODULE_TYPE | typeof TEMPERATURE_MODULE_TYPE | typeof THERMOCYCLER_MODULE_TYPE | typeof HEATERSHAKER_MODULE_TYPE | typeof MAGNETIC_BLOCK_TYPE;
|
|
118
|
+
export type MagneticModuleModel = typeof MAGNETIC_MODULE_V1 | typeof MAGNETIC_MODULE_V2;
|
|
119
|
+
export type TemperatureModuleModel = typeof TEMPERATURE_MODULE_V1 | typeof TEMPERATURE_MODULE_V2;
|
|
120
|
+
export type ThermocyclerModuleModel = typeof THERMOCYCLER_MODULE_V1 | typeof THERMOCYCLER_MODULE_V2;
|
|
121
|
+
export type HeaterShakerModuleModel = typeof HEATERSHAKER_MODULE_V1;
|
|
122
|
+
export type MagneticBlockModel = typeof MAGNETIC_BLOCK_V1;
|
|
123
|
+
export type ModuleModel = MagneticModuleModel | TemperatureModuleModel | ThermocyclerModuleModel | HeaterShakerModuleModel | MagneticBlockModel;
|
|
124
|
+
export type GripperModel = typeof GRIPPER_V1 | typeof GRIPPER_V1_1 | typeof GRIPPER_V1_2;
|
|
125
|
+
export type ModuleModelWithLegacy = ModuleModel | typeof THERMOCYCLER | typeof MAGDECK | typeof TEMPDECK;
|
|
126
126
|
export interface Dimensions {
|
|
127
127
|
xDimension: number;
|
|
128
128
|
yDimension: number;
|
|
@@ -131,10 +131,10 @@ export interface Dimensions {
|
|
|
131
131
|
export interface DeckRobot {
|
|
132
132
|
model: RobotType;
|
|
133
133
|
}
|
|
134
|
-
export
|
|
135
|
-
export
|
|
136
|
-
export
|
|
137
|
-
export
|
|
134
|
+
export type CoordinateTuple = [number, number, number];
|
|
135
|
+
export type UnitDirection = 1 | -1;
|
|
136
|
+
export type UnitVectorTuple = [UnitDirection, UnitDirection, UnitDirection];
|
|
137
|
+
export type DeckSlotId = string;
|
|
138
138
|
export interface DeckSlot {
|
|
139
139
|
id: DeckSlotId;
|
|
140
140
|
position: CoordinateTuple;
|
|
@@ -155,7 +155,7 @@ export interface CutoutFixture {
|
|
|
155
155
|
providesAddressableAreas: Record<CutoutId, AddressableAreaName[]>;
|
|
156
156
|
height: number;
|
|
157
157
|
}
|
|
158
|
-
|
|
158
|
+
type AreaType = 'slot' | 'movableTrash' | 'wasteChute' | 'fixedTrash' | 'stagingSlot';
|
|
159
159
|
export interface AddressableArea {
|
|
160
160
|
id: AddressableAreaName;
|
|
161
161
|
areaType: AreaType;
|
|
@@ -230,7 +230,7 @@ export interface ModuleDefinition {
|
|
|
230
230
|
compatibleWith: ModuleModel[];
|
|
231
231
|
twoDimensionalRendering: any;
|
|
232
232
|
}
|
|
233
|
-
export
|
|
233
|
+
export type AffineTransformMatrix = number[][];
|
|
234
234
|
export interface SlotTransforms {
|
|
235
235
|
[deckOtId: string]: {
|
|
236
236
|
[slotId: string]: {
|
|
@@ -238,11 +238,11 @@ export interface SlotTransforms {
|
|
|
238
238
|
};
|
|
239
239
|
};
|
|
240
240
|
}
|
|
241
|
-
export
|
|
242
|
-
export
|
|
243
|
-
export
|
|
244
|
-
export
|
|
245
|
-
export
|
|
241
|
+
export type ModuleOrientation = 'left' | 'right';
|
|
242
|
+
export type PipetteChannels = 1 | 8 | 96;
|
|
243
|
+
export type PipetteDisplayCategory = typeof GEN1 | typeof GEN2 | typeof FLEX;
|
|
244
|
+
export type PipetteMount = typeof LEFT | typeof RIGHT;
|
|
245
|
+
export type GantryMount = typeof LEFT | typeof RIGHT | typeof EXTENSION;
|
|
246
246
|
export interface FlowRateSpec {
|
|
247
247
|
value: number;
|
|
248
248
|
min: number;
|
|
@@ -353,9 +353,9 @@ export interface ProtocolResource {
|
|
|
353
353
|
export interface ProtocolAnalysesResource {
|
|
354
354
|
analyses: Array<PendingProtocolAnalysis | CompletedProtocolAnalysis>;
|
|
355
355
|
}
|
|
356
|
-
export
|
|
357
|
-
export
|
|
358
|
-
export
|
|
356
|
+
export type MotorAxis = 'x' | 'y' | 'leftZ' | 'rightZ' | 'leftPlunger' | 'rightPlunger' | 'extensionZ' | 'extensionJaw';
|
|
357
|
+
export type MotorAxes = MotorAxis[];
|
|
358
|
+
export type ThermalAdapterName = 'PCR Adapter' | 'Deep Well Adapter' | '96 Flat Bottom Adapter' | 'Universal Flat Adapter';
|
|
359
359
|
export interface GripperDefinition {
|
|
360
360
|
$otSharedSchema: string;
|
|
361
361
|
model: GripperModel;
|
|
@@ -388,11 +388,11 @@ export interface GripperDefinition {
|
|
|
388
388
|
maxAllowedGripError: number;
|
|
389
389
|
};
|
|
390
390
|
}
|
|
391
|
-
export
|
|
392
|
-
export
|
|
391
|
+
export type StatusBarAnimation = 'idle' | 'confirm' | 'updating' | 'disco' | 'off';
|
|
392
|
+
export type StatusBarAnimations = StatusBarAnimation[];
|
|
393
393
|
export interface CutoutConfig {
|
|
394
394
|
cutoutId: CutoutId;
|
|
395
395
|
cutoutFixtureId: CutoutFixtureId | null;
|
|
396
396
|
}
|
|
397
|
-
export
|
|
397
|
+
export type DeckConfiguration = CutoutConfig[];
|
|
398
398
|
export {};
|