fix(api): Raise cases for unsupported nozzle layouts #15009
Merged
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
ecormany
reviewed
Apr 25, 2024
| @@ -25,6 +25,10 @@ For greater convenience, also import the individual layout constants that you pl | |||
|
|
|||
| Then when you call ``configure_nozzle_layout`` later in your protocol, you can set ``style=COLUMN``. | |||
|
|
|||
| It is important to note that for versions <= 7.3, when configuring for COLUMN layout, there may be a noticeable tip overlap offset that will need to be accounted for through Labware Position Check. | |||
There was a problem hiding this comment.
If there isn't an API change here, I think this is best addressed in the 7.3 release notes, probably under the "Improved features" header.
There was a problem hiding this comment.
Another possible location is as a note in the API Reference entry. Regardless, I think I'd want to keep it out of the main description of the feature in this article — especially if we've improved the behavior to the point that we don't have to be issuing warnings about how the latest version works.
| @@ -25,6 +25,10 @@ For greater convenience, also import the individual layout constants that you pl | |||
|
|
|||
| Then when you call ``configure_nozzle_layout`` later in your protocol, you can set ``style=COLUMN``. | |||
|
|
|||
| It is important to note that for versions <= 7.3, when configuring for COLUMN layout, there may be a noticeable tip overlap offset that will need to be accounted for through Labware Position Check. | |||
|
|
|||
| Along that same line of logic, it would be advisable to determine a configuration to be used for a specific labware, and only interact with that labware when in said configuration. | |||
There was a problem hiding this comment.
I'm not sure what this means.
| ): | ||
| if len(rows) * len(columns) > MAXIMUM_NOZZLE_COUNT: | ||
| raise IncompatibleNozzleConfiguration( | ||
| f"Partial Nozzle Layouts may not be configured to contain more than {MAXIMUM_NOZZLE_COUNT} channels." |
There was a problem hiding this comment.
copy suggestion
Suggested change
| f"Partial Nozzle Layouts may not be configured to contain more than {MAXIMUM_NOZZLE_COUNT} channels." | |
| f"Partial nozzle layouts can contain at most {MAXIMUM_NOZZLE_COUNT} channels." |
| ] | ||
| if style in disabled_layouts: | ||
| raise ValueError( | ||
| f"Nozzle layout configuration of style {style.value} is currently unsupported." |
There was a problem hiding this comment.
copy suggestion
Suggested change
| f"Nozzle layout configuration of style {style.value} is currently unsupported." | |
| f"{style.value} nozzle layouts are currently not supported." |
CaseyBatten
changed the title
vegano1
approved these changes
Apr 26, 2024
ecormany
added a commit
that referenced
this pull request
Apr 29, 2024
…#15003) # Overview Update partial tip pickup docs to reflect the latest behavior, as added in #15009 and to be released in robot software 7.3. Addresses RTC-440. # Test Plan [Sandbox](http:https://sandbox.docs.opentrons.com/docs-partial-pickup-channel-1/v2/) # Changelog - Removed "Column 12" and "Column 1" headers from Partial Tip Pickup page. Removed tip-tracking code for Column 1 as no longer needed.. - Reworded note in `configure_nozzle_layout` API reference entry. # Review requests Already spoke with @CaseyBatten to get an idea of what needed to be included here and what will go in separate documentation. - <s>Should we actually put this straight into `edge` and deploy ASAP, or can it wait a month and roll out with 2.18 docs (current plan)?</s> PAPI 2.18 deploy will be timed with robot stack 7.3 release, which this aligns with. # Risk assessment none
ecormany
added a commit
that referenced
this pull request
May 2, 2024
…#15003) Update partial tip pickup docs to reflect the latest behavior, as added in #15009 and to be released in robot software 7.3. Addresses RTC-440. [Sandbox](http:https://sandbox.docs.opentrons.com/docs-partial-pickup-channel-1/v2/) - Removed "Column 12" and "Column 1" headers from Partial Tip Pickup page. Removed tip-tracking code for Column 1 as no longer needed.. - Reworded note in `configure_nozzle_layout` API reference entry. Already spoke with @CaseyBatten to get an idea of what needed to be included here and what will go in separate documentation. - <s>Should we actually put this straight into `edge` and deploy ASAP, or can it wait a month and roll out with 2.18 docs (current plan)?</s> PAPI 2.18 deploy will be timed with robot stack 7.3 release, which this aligns with. none
Carlos-fernandez
pushed a commit
that referenced
this pull request
May 20, 2024
limit user access to unapproved configurations through the PAPI and raise errors when configuring potentially unsafe layouts
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.
Overview
See RTC-440
This PR seeks to limit user access to unapproved configurations through the PAPI and raise errors when configuring potentially unsafe layouts for the nozzle map.
UPDATE:
After discussion, doc side changes and API docstrings have been moved to alternative PR.
Test Plan
Ensure that protocols with that attempt to utilize unsupported single/row/quadrants API commands are rejected. Ensure that if engine commands are used, no more than 24 tips can be added to partial configuration.
Changelog
FULLto 24 nozzles, a size limit found by hardware testing.Review requests
Risk assessment
Relatively low as we were not exposing these configurations publicly yet anyways, however some use cases involving non-public facing API may be effected.