feat(shared-data, api): add uiMaxFlowRate key to pipette definitions #14859
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
koji
reviewed
Apr 10, 2024
shared-data/pipette/definitions/2/liquid/eight_channel/p1000/default/3_3.json
Outdated
Show resolved
Hide resolved
koji
reviewed
Apr 10, 2024
sfoster1
requested changes
Apr 16, 2024
There was a problem hiding this comment.
Looks great overall, but a couple things
- Definitely need to call out the actual
lowVolumeDefaultchanges in the description a bit more; as we discussed, they're fine because they won't result in actual changed physical behavior, but they should be highlighted - This is less significant of an opinion - it could also be a followup - but we need to switch the python over to importing
ul_per_mmfrom the new location at some point
| "24": 10.0, | ||
| "48": 10.0 | ||
| }, | ||
| "speed": 10.0, |
There was a problem hiding this comment.
this is going to cause issues when merged and is because this is based on an old edge - may want to merge recent edge into this
There was a problem hiding this comment.
oops i did not catch this when i merged edge in, thank you!
| "defaultAspirateFlowRate": { | ||
| "default": 35, | ||
| "valuesByApiLevel": { "2.14": 35 } | ||
| "default": 32.6, |
There was a problem hiding this comment.
Let's call this out in the PR description and thus the eventual commit message a little more please
| @@ -0,0 +1,33 @@ | |||
| from typing import List, Tuple | |||
There was a problem hiding this comment.
We prooobably should change the code that imports this to import it from here also
sanni-t
reviewed
Apr 16, 2024
| @@ -92,6 +92,11 @@ | |||
| "dispense": { | |||
| "type": "array", | |||
| "items": { "$ref": "#/definitions/liquidHandlingSpecs" } | |||
| }, | |||
| "uiMaxFlowRate": { | |||
| "type": "string", | |||
There was a problem hiding this comment.
Suggested change
| "type": "string", | |
| "type": "number", |
or probably better is to use a reference to the existing positiveNumber
Carlos-fernandez
pushed a commit
that referenced
this pull request
May 20, 2024
…14859) closes AUTH-328 This PR add max flow rate values to each GEN2 and GEN3 pipette model definition to be used for FE applications. Rather than having a max flow rate for every pipette's supported tip's volume for aspirate and dispense, we have only 1 max flow rate for every pipette's supported tip that is. That value is based off of the lowest volume minus 2% to account for safety. For example: `p1000_single_v3.6` has a `minVolume` of 5uL. The `t50` tips has a max flow rate at volume 5uL of `801.3`. So the `uiMaxFlowRate` value is 98% of that which is `785.2` 🔈 Additionally, the `lowVolumeDefault` default flow rates for `aspirate`, `dispense`, and `blowout` have been changed to match the `uiMaxFlowRate`. This DOES NOT result in a physical change behavior and the change is needed for ui purposes.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
closes AUTH-328
Overview
This PR add max flow rate values to each GEN2 and GEN3 pipette model definition to be used for FE applications, based off of the calculations here
Rather than having a max flow rate for every pipette's supported tip's volume for aspirate and dispense, we have only 1 max flow rate for every pipette's supported tip that is. That value is based off of the lowest volume minus 2% to account for safety.
For example:
p1000_single_v3.6has aminVolumeof 5uL. Thet50tips has a max flow rate at volume 5uL of801.3. So theuiMaxFlowRatevalue is 98% of that which is785.2The new key in the definition is called
uiMaxFlowRatebecause it is limited to the lowest volume's max flow rate, which will be used for FE applications only (Quick transfer and PD)🔈 Additionally, the
lowVolumeDefaultdefault flow rates foraspirate,dispense, andblowouthave been changed to match theuiMaxFlowRate. This DOES NOT result in a physical change behavior and the change is needed for ui purposes.Test Plan
Review the additions to the definitions
Review the pytest
Changelog
uiMaxFlowRatekey to each pipette liquid definitions's supported tipslowVolumeDefaultflowrates to match theuiMaxFlowRateul_per_mmpython file and copy over thepiecewise_volume_conversionfn from the api hardware directory, removing the old versionReview requests
see test plan
Risk assessment
low-ish, nothing is using these new values yet