Skip to content

Commit 5da85c3

Browse files
authored
docs(app): add quick transfer doc to keep track of versioning (#17473)
1 parent 2ec42e1 commit 5da85c3

File tree

2 files changed

+59
-0
lines changed

2 files changed

+59
-0
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# Quick Transfer Versioning:
2+
3+
Quick Transfer is versioned under the `designerApplicationData` field on the resulting protocol file. Since this data is not yet read or migrated this doc details the versions, type of `quickTransferState` per version, and other changes made so that migration can occur in the future if needed.
4+
5+
## Version 1.0.0
6+
7+
```
8+
export interface QuickTransferSummaryState {
9+
pipette: PipetteV2Specs
10+
mount: Mount
11+
tipRack: LabwareDefinition2
12+
source: LabwareDefinition2
13+
sourceWells: string[]
14+
destination: LabwareDefinition2 | 'source'
15+
destinationWells: string[]
16+
transferType: TransferType
17+
volume: number
18+
aspirateFlowRate: number
19+
dispenseFlowRate: number
20+
path: PathOption
21+
tipPositionAspirate: number
22+
preWetTip: boolean
23+
mixOnAspirate?: {
24+
mixVolume: number
25+
repititions: number
26+
}
27+
delayAspirate?: {
28+
delayDuration: number
29+
positionFromBottom: number
30+
}
31+
touchTipAspirate?: number
32+
airGapAspirate?: number
33+
tipPositionDispense: number
34+
mixOnDispense?: {
35+
mixVolume: number
36+
repititions: number
37+
}
38+
delayDispense?: {
39+
delayDuration: number
40+
positionFromBottom: number
41+
}
42+
touchTipDispense?: number
43+
disposalVolume?: number
44+
blowOut?: BlowOutLocation
45+
airGapDispense?: number
46+
changeTip: ChangeTipOptions
47+
dropTipLocation: CutoutConfig
48+
}
49+
```
50+
51+
## Version 1.1.0
52+
53+
Type is the same as in `1.0.0`, but the number represented by `touchTipAspirate` and `touchTipDispense` is now the distance from the top of the well instead of distance from the bottom of the well. This can be migrated using the well height from the definition on both source and dest labware.
54+
55+
```
56+
touchTipAspirate = -(sourceWellHeight - prevTouchTipAspirate)
57+
touchTipDispense = -(destWellHeight - prevTouchTipDispense)
58+
```

app/src/organisms/ODD/QuickTransferFlow/utils/createQuickTransferFile.ts

+1
Original file line numberDiff line numberDiff line change
@@ -202,6 +202,7 @@ export function createQuickTransferFile(
202202
subcategory: null,
203203
tags: [],
204204
},
205+
// see QuickTransferFlow/README.md for versioning details
205206
designerApplication: {
206207
name: 'opentrons/quick-transfer',
207208
version: '1.1.0',

0 commit comments

Comments
 (0)