-
Notifications
You must be signed in to change notification settings - Fork 178
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.
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): liquid presence verification #15695
Changes from 19 commits
799ee29
827e28c
5116a9c
e3fd8fd
af41076
d429836
2fdc24e
2363e91
608a71e
a491e76
b96d9dd
3f797a7
48ae5d5
7b1fe38
51d21fb
5db9dd0
5677a16
ec25699
1bfff50
8cb74dd
f786e59
bb661f1
5920bad
a4f7577
12f34e5
c6a6fde
d8b5d7f
dbb62f9
6aeb47d
b6d3160
b38a289
e40a07b
2fcc41c
07fddd3
00aaf91
3292b61
8560aa2
29b0dc7
bb36fa3
883ed72
0710757
8031d97
458d46a
16b50c5
9e1b8b6
c4f0012
ab42190
a283b30
378c96b
fd5b72e
6a17891
36aea23
b4352ae
7f4ffbe
28fb7ae
5cd4ae0
0e7d19c
7f993b2
9ef431d
c4106bf
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -258,3 +258,28 @@ This example aspirates enough air to fill the remaining volume in a pipette:: | |
|
||
.. versionadded:: 2.0 | ||
|
||
.. _detect-liquid-presence: | ||
|
||
Detect Liquids | ||
============== | ||
|
||
The :py:meth:`.InstrumentContext.detect_liquid_presence` method tells the robot to check for a liquid and return the results. It returns ``True`` if liquid is detected and ``False`` if liquid is not detected. It will not raise an error or stop your protocol if a liquid is not present in a well or reservoir. See also :ref:`lpv`. | ||
|
||
.. code-block:: python | ||
|
||
pipette.detect_liquid_presence() | ||
|
||
.. versionadded:: 2.20 | ||
|
||
.. _require-liquid-presence: | ||
|
||
Require Liquids | ||
=============== | ||
|
||
The :py:meth:`.InstrumentContext.require_liquid_presence` method forces the robot to check for the presence of a liquid, even when :ref:`lpv` is specifically disabled. When using this method, the robot will raise an error that stops a protocol, writes a warning to the run logs, and also lets you recover from the error through your own error handling code. | ||
|
||
.. code-block:: python | ||
|
||
pipette.require_liquid_presence() | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Needs a well argument. |
||
|
||
.. versionadded:: 2.20 |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -937,8 +937,8 @@ def pick_up_tip( # noqa: C901 | |
# in which self.starting_tip consumes tips. It would currently vary | ||
# depending on the configuration layout of a pipette at a given | ||
# time, which means that some combination of starting tip and partial | ||
# configuraiton are incompatible under the current understanding of | ||
# starting tip behavior. Replacing starting_tip with an undeprecated | ||
# configuration are incompatible under the current understanding of | ||
# starting tip behavior. Replacing starting_tip with an un-deprecated | ||
# Labware.has_tip may solve this. | ||
raise CommandPreconditionViolated( | ||
"Automatic tip tracking is not available when using a partial pipette" | ||
|
@@ -2055,7 +2055,7 @@ def configure_nozzle_layout( | |
|
||
@requires_version(2, 20) | ||
def detect_liquid_presence(self, well: labware.Well) -> bool: | ||
"""Check if there is liquid in a well. | ||
"""Check if there is liquid in a well. See :ref:`detect-liquid-presence`. | ||
|
||
:returns: A boolean. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We could remove line 2125, or move the prose description of the values of true and false here. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Will move the longer, prose description to |
||
""" | ||
|
@@ -2072,7 +2072,7 @@ def detect_liquid_presence(self, well: labware.Well) -> bool: | |
|
||
@requires_version(2, 20) | ||
def require_liquid_presence(self, well: labware.Well) -> None: | ||
"""If there is no liquid in a well, raise an error. | ||
"""If there is no liquid in a well, raise an error. See :ref:`require-liquid-presence`. | ||
|
||
:returns: None. | ||
ecormany marked this conversation as resolved.
Show resolved
Hide resolved
|
||
""" | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Needs a well argument.