Skip to content

Commit 76bf6b8

Browse files
authored
docs(api): new section for push_out (#14183)
1 parent 0832c04 commit 76bf6b8

File tree

2 files changed

+24
-2
lines changed

2 files changed

+24
-2
lines changed

api/docs/v2/basic_commands/liquids.rst

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -111,10 +111,27 @@ Flex and OT-2 pipettes dispense at :ref:`default flow rates <new-plunger-flow-ra
111111

112112
pipette.dispense(200, plate['B1'], rate=2.0)
113113

114-
.. Removing the 2 notes here from the original. Covered by new revisions.
115-
116114
.. versionadded:: 2.0
117115

116+
.. _push-out-dispense:
117+
118+
Push Out After Dispense
119+
-----------------------
120+
121+
The optional ``push_out`` parameter of ``dispense()`` helps ensure all liquid leaves the tip. Use ``push_out`` for applications that require moving the pipette plunger lower than the default, without performing a full :ref:`blow out <blow-out>`.
122+
123+
For example, this dispense action moves the plunger the equivalent of an additional 5 µL beyond where it would stop if ``push_out`` was set to zero or omitted::
124+
125+
pipette.pick_up_tip()
126+
pipette.aspirate(100, plate['A1'])
127+
pipette.dispense(100, plate['B1'], push_out=5)
128+
pipette.drop_tip()
129+
130+
.. versionadded:: 2.15
131+
132+
.. note::
133+
In version 7.0.2 and earlier of the robot software, you could accomplish a similar result by dispensing a volume greater than what was aspirated into the pipette. In version 7.1.0 and later, the API will return an error. Calculate the difference between the two amounts and use that as the value of ``push_out``.
134+
118135
.. _new-blow-out:
119136

120137
.. _blow-out:

api/src/opentrons/protocol_api/instrument_context.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -330,6 +330,8 @@ def dispense(
330330
:type rate: float
331331
:param push_out: Continue past the plunger bottom to help ensure all liquid
332332
leaves the tip. Measured in µL. The default value is ``None``.
333+
334+
See :ref:`push-out-dispense` for details.
333335
:type push_out: float
334336
335337
:returns: This instance.
@@ -341,6 +343,9 @@ def dispense(
341343
``location``, specify it as a keyword argument:
342344
``pipette.dispense(location=plate['A1'])``.
343345
346+
.. versionchanged:: 2.15
347+
Added the ``push_out`` parameter.
348+
344349
"""
345350
if self.api_version < APIVersion(2, 15) and push_out:
346351
raise APIVersionError(

0 commit comments

Comments
 (0)