Skip to content

Commit

Permalink
warning for COLUMN start
Browse files Browse the repository at this point in the history
  • Loading branch information
ecormany committed Dec 8, 2023
1 parent 99cba98 commit df93a3d
Showing 1 changed file with 13 additions and 7 deletions.
20 changes: 13 additions & 7 deletions api/src/opentrons/protocol_api/instrument_context.py
Original file line number Diff line number Diff line change
Expand Up @@ -1802,22 +1802,28 @@ def configure_nozzle_layout(
.. note::
When picking up fewer than 96 tips at once, the tip rack *must not* be
placed in a tip rack adapter in the deck. If you try to perform partial tip
pickup on a tip rack that is in an adapter, the API will raise an error.
placed in a tip rack adapter in the deck. If you try to pick up fewer than 96
tips from a tip rack that is in an adapter, the API will raise an error.
:param style: The shape of the nozzle layout.
- ``COLUMN`` sets the pipette to use 8 nozzles, aligned from front to back
with respect to the deck. This corresponds to a column of wells on labware.
- ``ALL`` resets the pipette to use all of its nozzles. Calling ``configure_nozzle_layout`` with no arguments also resets the pipette.
- ``ALL`` resets the pipette to use all of its nozzles. Calling
``configure_nozzle_layout`` with no arguments also resets the pipette.
:type style: ``NozzleLayout`` or ``None``
:param start: The nozzle at the back left of the layout, which the robot uses
to determine how it will move to different locations on the deck. The string
should be of the same format used when identifying wells by name. Use
``"A1"`` to have the pipette use its leftmost nozzles to pick up tips
*right-to-left* from a tip rack. Use ``"A12"`` to have the pipette use its
rightmost nozzles to pick up tips *left-to-right* from a tip rack.
should be of the same format used when identifying wells by name.
Required unless setting ``style=ALL``.
.. warning::
Currently, when using the ``COLUMN`` layout, you *must* set
``start="A12"``. Using any other value will cause the pipette to move to
unexpected locations, pick up incorrect tips, or crash into items on the
deck.
:type start: str or ``None``
:param tip_racks: Behaves the same as setting the ``tip_racks`` parameter of
:py:meth:`.load_instrument`. If not specified, the new configuration resets
Expand Down

0 comments on commit df93a3d

Please sign in to comment.