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

docs(api): describe new drop_tip() behavior introduced in PAPI 2.18 #15078

Merged
merged 2 commits into from
May 6, 2024
Merged

docs(api): describe new drop_tip() behavior introduced in PAPI 2.18 #15078

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3f37a9e
update drop tip behavior for 2.18
ecormany May 2, 2024
2fa7f95
clarify API version and bin only
ecormany May 6, 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
14 changes: 9 additions & 5 deletions api/src/opentrons/protocol_api/instrument_context.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1021,11 +1021,6 @@ def drop_tip(
If no location is passed (e.g. ``pipette.drop_tip()``), the pipette will drop
the attached tip into its :py:attr:`trash_container`.

Starting with API version 2.15, if the trash container is the default fixed
trash, the API will instruct the pipette to drop tips in different locations
within the trash container. Varying the tip drop location helps prevent tips
from piling up in a single location.

The location in which to drop the tip can be manually specified with the
``location`` argument. The ``location`` argument can be specified in several
ways:
Expand All @@ -1044,6 +1039,15 @@ def drop_tip(
the ``WasteChute`` object. For example,
``pipette.drop_tip(location=waste_chute)``.

In API versions 2.15 to 2.17, if ``location`` is a ``TrashBin`` or not
specified, the API will instruct the pipette to drop tips in different locations
ecormany marked this conversation as resolved.
Show resolved Hide resolved
within the bin. Varying the tip drop location helps prevent tips
from piling up in a single location.

Starting with API version 2.18, the API will only vary the tip drop location if
``location`` is not specified. Specifying a ``TrashBin`` as the ``location``
behaves the same as specifying :py:meth:`.TrashBin.top`, which is a fixed position.

:param location:
Where to drop the tip.

Expand Down
Loading