Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(shared-data, api): add uiMaxFlowRate key to pipette definitions #14859

Merged
merged 16 commits into from
Apr 17, 2024
Merged

feat(shared-data, api): add uiMaxFlowRate key to pipette definitions #14859

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
8555c2e
feat(shared-data): create getMaxFlowRateByVolume util
jerader Apr 10, 2024
5cf7c57
update the pipette definitions with max flow rate numbers
jerader Apr 10, 2024
d83baf8
maxFlowRate volumes to match pipette tip volumes
jerader Apr 11, 2024
717cd14
add missing maxFlowRates for a few volumes in p1000 3.5 single channe…
jerader Apr 11, 2024
0cd9f8b
add maxFlowRate to the liquid properties schema
jerader Apr 11, 2024
4a99416
update defs to only have 1 maxFlowRate per supported tip and start wr…
jerader Apr 12, 2024
8fe83e6
fix test_max_flow_rates_per_volume
jerader Apr 12, 2024
a526a63
fix js test, make maxFlowRate optional
jerader Apr 15, 2024
9693f27
reformat file
jerader Apr 15, 2024
0a69042
rename maxFlowRate to uiMaxFlowRate, adjust to only have 2% safety
jerader Apr 15, 2024
e2506bd
fix pipettes js test
jerader Apr 15, 2024
b3753e6
Merge branch 'edge' into shared-data_create-max-flowrate-util
jerader Apr 15, 2024
c360d34
add lowVolumeDefault comments to pipette definition and liquid schema
jerader Apr 16, 2024
d01741e
use only shared-data ul_per_mm util in hardware_control
jerader Apr 16, 2024
992bb59
revert wrong edge change to 3_6 def
jerader Apr 16, 2024
3e19949
fix js type typo
jerader Apr 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions api/src/opentrons/hardware_control/instruments/ot2/pipette.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,18 +26,19 @@
InvalidLiquidClassName,
CommandPreconditionViolated,
)
from opentrons_shared_data.pipette.ul_per_mm import (
piecewise_volume_conversion,
PIPETTING_FUNCTION_FALLBACK_VERSION,
PIPETTING_FUNCTION_LATEST_VERSION,
)


from opentrons.types import Point, Mount
from opentrons.config import robot_configs
from opentrons.config.types import RobotConfig
from opentrons.drivers.types import MoveSplit
from ..instrument_abc import AbstractInstrument
from ..instrument_helpers import (
piecewise_volume_conversion,
PIPETTING_FUNCTION_FALLBACK_VERSION,
PIPETTING_FUNCTION_LATEST_VERSION,
)

from .instrument_calibration import (
PipetteOffsetByPipetteMount,
load_pipette_offset,
Expand Down
4 changes: 2 additions & 2 deletions api/src/opentrons/hardware_control/instruments/ot3/pipette.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,12 @@
CommandPreconditionViolated,
PythonException,
)
from ..instrument_abc import AbstractInstrument
from ..instrument_helpers import (
from opentrons_shared_data.pipette.ul_per_mm import (
piecewise_volume_conversion,
PIPETTING_FUNCTION_FALLBACK_VERSION,
PIPETTING_FUNCTION_LATEST_VERSION,
)
from ..instrument_abc import AbstractInstrument
from .instrument_calibration import (
save_pipette_offset_calibration,
load_pipette_offset,
Expand Down
14 changes: 8 additions & 6 deletions shared-data/js/__tests__/pipettes.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,7 @@ describe('pipette data accessors', () => {
minVolume: 5,
supportedTips: {
t50: {
uiMaxFlowRate: 47,
aspirate: {
default: {
1: expect.anything(),
Expand Down Expand Up @@ -205,27 +206,28 @@ describe('pipette data accessors', () => {
minVolume: 1,
supportedTips: {
t50: {
uiMaxFlowRate: 26.7,
aspirate: {
default: {
1: expect.anything(),
},
},
defaultAspirateFlowRate: {
default: 35,
default: 26.7,
valuesByApiLevel: {
2.14: 35,
2.14: 26.7,
},
},
defaultBlowOutFlowRate: {
default: 57,
default: 26.7,
valuesByApiLevel: {
2.14: 57,
2.14: 26.7,
},
},
defaultDispenseFlowRate: {
default: 57,
default: 26.7,
valuesByApiLevel: {
2.14: 57,
2.14: 26.7,
},
},
defaultFlowAcceleration: 1200,
Expand Down
1 change: 1 addition & 0 deletions shared-data/js/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -486,6 +486,7 @@ export interface SupportedTip {
}
defaultReturnTipHeight?: number
defaultFlowAcceleration?: number
uiMaxFlowRate?: number
}

export interface SupportedTips {
Expand Down
3 changes: 3 additions & 0 deletions shared-data/pipette/definitions/2/liquid/eight_channel/p1000/default/3_3.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
"$otSharedSchema": "#/pipette/schemas/2/pipetteLiquidPropertiesSchema.json",
"supportedTips": {
"t50": {
"uiMaxFlowRate": 808.3,
"defaultAspirateFlowRate": {
"default": 6,
"valuesByApiLevel": { "2.14": 6 }
Expand Down Expand Up @@ -116,6 +117,7 @@
"defaultPushOutVolume": 7
},
"t200": {
"uiMaxFlowRate": 905.7,
"defaultAspirateFlowRate": {
"default": 80,
"valuesByApiLevel": { "2.14": 80 }
Expand Down Expand Up @@ -228,6 +230,7 @@
"defaultPushOutVolume": 5
},
"t1000": {
"uiMaxFlowRate": 787.7,
"defaultAspirateFlowRate": {
"default": 160,
"valuesByApiLevel": { "2.14": 160 }
Expand Down
3 changes: 3 additions & 0 deletions shared-data/pipette/definitions/2/liquid/eight_channel/p1000/default/3_4.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
"$otSharedSchema": "#/pipette/schemas/2/pipetteLiquidPropertiesSchema.json",
"supportedTips": {
"t50": {
"uiMaxFlowRate": 808.3,
"defaultAspirateFlowRate": {
"default": 478,
"valuesByApiLevel": { "2.14": 478 }
Expand Down Expand Up @@ -116,6 +117,7 @@
"defaultPushOutVolume": 7
},
"t200": {
"uiMaxFlowRate": 905.7,
"defaultAspirateFlowRate": {
"default": 716,
"valuesByApiLevel": { "2.14": 716 }
Expand Down Expand Up @@ -228,6 +230,7 @@
"defaultPushOutVolume": 5
},
"t1000": {
"uiMaxFlowRate": 787.7,
"defaultAspirateFlowRate": {
"default": 716,
"valuesByApiLevel": { "2.14": 716 }
Expand Down
3 changes: 3 additions & 0 deletions shared-data/pipette/definitions/2/liquid/eight_channel/p1000/default/3_5.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
"$otSharedSchema": "#/pipette/schemas/2/pipetteLiquidPropertiesSchema.json",
"supportedTips": {
"t50": {
"uiMaxFlowRate": 802.9,
"defaultAspirateFlowRate": {
"default": 478,
"valuesByApiLevel": { "2.14": 478 }
Expand Down Expand Up @@ -82,6 +83,7 @@
"defaultPushOutVolume": 7
},
"t200": {
"uiMaxFlowRate": 847.9,
"defaultAspirateFlowRate": {
"default": 716,
"valuesByApiLevel": { "2.14": 716 }
Expand Down Expand Up @@ -160,6 +162,7 @@
"defaultPushOutVolume": 5
},
"t1000": {
"uiMaxFlowRate": 744.6,
"defaultAspirateFlowRate": {
"default": 716,
"valuesByApiLevel": { "2.14": 716 }
Expand Down
2 changes: 2 additions & 0 deletions shared-data/pipette/definitions/2/liquid/eight_channel/p20/default/2_1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
"$otSharedSchema": "#/pipette/schemas/2/pipetteLiquidPropertiesSchema.json",
"supportedTips": {
"t20": {
"uiMaxFlowRate": 25,
"defaultAspirateFlowRate": {
"default": 7.6,
"valuesByApiLevel": { "2.0": 7.6 }
Expand Down Expand Up @@ -86,6 +87,7 @@
"defaultPushOutVolume": 0
},
"t10": {
"uiMaxFlowRate": 23,
"defaultAspirateFlowRate": {
"default": 7.6,
"valuesByApiLevel": { "2.0": 7.6 }
Expand Down
2 changes: 2 additions & 0 deletions shared-data/pipette/definitions/2/liquid/eight_channel/p300/default/2_1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
"$otSharedSchema": "#/pipette/schemas/2/pipetteLiquidPropertiesSchema.json",
"supportedTips": {
"t200": {
"uiMaxFlowRate": 335.3,
"defaultAspirateFlowRate": {
"default": 94,
"valuesByApiLevel": { "2.0": 94 }
Expand Down Expand Up @@ -89,6 +90,7 @@
"defaultPushOutVolume": 0
},
"t300": {
"uiMaxFlowRate": 335.3,
"defaultAspirateFlowRate": {
"default": 94,
"valuesByApiLevel": { "2.0": 94 }
Expand Down
1 change: 1 addition & 0 deletions shared-data/pipette/definitions/2/liquid/eight_channel/p50/default/3_3.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
"$otSharedSchema": "#/pipette/schemas/2/pipetteLiquidPropertiesSchema.json",
"supportedTips": {
"t50": {
"uiMaxFlowRate": 46.8,
"defaultAspirateFlowRate": {
"default": 8,
"valuesByApiLevel": { "2.14": 8 }
Expand Down
1 change: 1 addition & 0 deletions shared-data/pipette/definitions/2/liquid/eight_channel/p50/default/3_4.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
"$otSharedSchema": "#/pipette/schemas/2/pipetteLiquidPropertiesSchema.json",
"supportedTips": {
"t50": {
"uiMaxFlowRate": 46.8,
"defaultAspirateFlowRate": {
"default": 35,
"valuesByApiLevel": { "2.14": 35 }
Expand Down
1 change: 1 addition & 0 deletions shared-data/pipette/definitions/2/liquid/eight_channel/p50/default/3_5.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
"$otSharedSchema": "#/pipette/schemas/2/pipetteLiquidPropertiesSchema.json",
"supportedTips": {
"t50": {
"uiMaxFlowRate": 46.7,
"defaultAspirateFlowRate": {
"default": 35,
"valuesByApiLevel": { "2.14": 35 }
Expand Down
1 change: 1 addition & 0 deletions shared-data/pipette/definitions/2/liquid/eight_channel/p50/lowVolumeDefault/3_3.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
"$otSharedSchema": "#/pipette/schemas/2/pipetteLiquidPropertiesSchema.json",
"supportedTips": {
"t50": {
"uiMaxFlowRate": 32.6,
"defaultAspirateFlowRate": {
"default": 8,
"valuesByApiLevel": { "2.14": 8 }
Expand Down
13 changes: 7 additions & 6 deletions shared-data/pipette/definitions/2/liquid/eight_channel/p50/lowVolumeDefault/3_4.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,18 @@
"$otSharedSchema": "#/pipette/schemas/2/pipetteLiquidPropertiesSchema.json",
"supportedTips": {
"t50": {
"uiMaxFlowRate": 32.6,
"defaultAspirateFlowRate": {
"default": 35,
"valuesByApiLevel": { "2.14": 35 }
"default": 32.6,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's call this out in the PR description and thus the eventual commit message a little more please

"valuesByApiLevel": { "2.14": 32.6 }
},
"defaultDispenseFlowRate": {
"default": 57,
"valuesByApiLevel": { "2.14": 57 }
"default": 32.6,
"valuesByApiLevel": { "2.14": 32.6 }
},
"defaultBlowOutFlowRate": {
"default": 57,
"valuesByApiLevel": { "2.14": 57 }
"default": 32.6,
"valuesByApiLevel": { "2.14": 32.6 }
},
"defaultFlowAcceleration": 1200.0,
"defaultTipLength": 57.9,
Expand Down
13 changes: 7 additions & 6 deletions shared-data/pipette/definitions/2/liquid/eight_channel/p50/lowVolumeDefault/3_5.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,18 @@
"$otSharedSchema": "#/pipette/schemas/2/pipetteLiquidPropertiesSchema.json",
"supportedTips": {
"t50": {
"uiMaxFlowRate": 32.6,
"defaultAspirateFlowRate": {
"default": 35,
"valuesByApiLevel": { "2.14": 35 }
"default": 32.6,
"valuesByApiLevel": { "2.14": 32.6 }
},
"defaultDispenseFlowRate": {
"default": 57,
"valuesByApiLevel": { "2.14": 57 }
"default": 32.6,
"valuesByApiLevel": { "2.14": 32.6 }
},
"defaultBlowOutFlowRate": {
"default": 57,
"valuesByApiLevel": { "2.14": 57 }
"default": 32.6,
"valuesByApiLevel": { "2.14": 32.6 }
},
"defaultFlowAcceleration": 1200.0,
"defaultTipLength": 57.9,
Expand Down
3 changes: 3 additions & 0 deletions shared-data/pipette/definitions/2/liquid/ninety_six_channel/p1000/default/3_3.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
"$otSharedSchema": "#/pipette/schemas/2/pipetteLiquidPropertiesSchema.json",
"supportedTips": {
"t50": {
"uiMaxFlowRate": 189.1,
"defaultAspirateFlowRate": {
"default": 6,
"valuesByApiLevel": { "2.14": 6 }
Expand Down Expand Up @@ -56,6 +57,7 @@
"defaultPushOutVolume": 7
},
"t200": {
"uiMaxFlowRate": 185.1,
"defaultAspirateFlowRate": {
"default": 80,
"valuesByApiLevel": { "2.14": 80 }
Expand Down Expand Up @@ -108,6 +110,7 @@
"defaultPushOutVolume": 5
},
"t1000": {
"uiMaxFlowRate": 184.8,
"defaultAspirateFlowRate": {
"default": 160,
"valuesByApiLevel": { "2.14": 160 }
Expand Down
3 changes: 3 additions & 0 deletions shared-data/pipette/definitions/2/liquid/ninety_six_channel/p1000/default/3_4.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
"$otSharedSchema": "#/pipette/schemas/2/pipetteLiquidPropertiesSchema.json",
"supportedTips": {
"t50": {
"uiMaxFlowRate": 189.1,
"defaultAspirateFlowRate": {
"default": 6,
"valuesByApiLevel": { "2.14": 6 }
Expand Down Expand Up @@ -56,6 +57,7 @@
"defaultPushOutVolume": 7
},
"t200": {
"uiMaxFlowRate": 185.1,
"defaultAspirateFlowRate": {
"default": 80,
"valuesByApiLevel": { "2.14": 80 }
Expand Down Expand Up @@ -108,6 +110,7 @@
"defaultPushOutVolume": 5
},
"t1000": {
"uiMaxFlowRate": 184.8,
"defaultAspirateFlowRate": {
"default": 160,
"valuesByApiLevel": { "2.14": 160 }
Expand Down
3 changes: 3 additions & 0 deletions shared-data/pipette/definitions/2/liquid/ninety_six_channel/p1000/default/3_5.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
"$otSharedSchema": "#/pipette/schemas/2/pipetteLiquidPropertiesSchema.json",
"supportedTips": {
"t50": {
"uiMaxFlowRate": 189.1,
"defaultAspirateFlowRate": {
"default": 6,
"valuesByApiLevel": { "2.14": 6 }
Expand Down Expand Up @@ -56,6 +57,7 @@
"defaultPushOutVolume": 7
},
"t200": {
"uiMaxFlowRate": 185.1,
"defaultAspirateFlowRate": {
"default": 80,
"valuesByApiLevel": { "2.14": 80 }
Expand Down Expand Up @@ -108,6 +110,7 @@
"defaultPushOutVolume": 5
},
"t1000": {
"uiMaxFlowRate": 185.1,
"defaultAspirateFlowRate": {
"default": 160,
"valuesByApiLevel": { "2.14": 160 }
Expand Down
3 changes: 3 additions & 0 deletions shared-data/pipette/definitions/2/liquid/ninety_six_channel/p1000/default/3_6.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
"$otSharedSchema": "#/pipette/schemas/2/pipetteLiquidPropertiesSchema.json",
"supportedTips": {
"t50": {
"uiMaxFlowRate": 194,
"defaultAspirateFlowRate": {
"default": 6,
"valuesByApiLevel": { "2.14": 6 }
Expand Down Expand Up @@ -56,6 +57,7 @@
"defaultPushOutVolume": 7
},
"t200": {
"uiMaxFlowRate": 194,
"defaultAspirateFlowRate": {
"default": 80,
"valuesByApiLevel": { "2.14": 80 }
Expand Down Expand Up @@ -108,6 +110,7 @@
"defaultPushOutVolume": 5
},
"t1000": {
"uiMaxFlowRate": 187.2,
"defaultAspirateFlowRate": {
"default": 160,
"valuesByApiLevel": { "2.14": 160 }
Expand Down
1 change: 1 addition & 0 deletions shared-data/pipette/definitions/2/liquid/single_channel/p1000/default/2_1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
"$otSharedSchema": "#/pipette/schemas/2/pipetteLiquidPropertiesSchema.json",
"supportedTips": {
"t1000": {
"uiMaxFlowRate": 1018.6,
"defaultAspirateFlowRate": {
"default": 274.7,
"valuesByApiLevel": { "2.0": 137.35, "2.6": 274.7 }
Expand Down
1 change: 1 addition & 0 deletions shared-data/pipette/definitions/2/liquid/single_channel/p1000/default/2_2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
"$otSharedSchema": "#/pipette/schemas/2/pipetteLiquidPropertiesSchema.json",
"supportedTips": {
"t1000": {
"uiMaxFlowRate": 1020.7,
"defaultAspirateFlowRate": {
"default": 274.7,
"valuesByApiLevel": { "2.0": 137.35, "2.6": 274.7 }
Expand Down
Loading
Loading