From 9ef431deb6192d38b673c3168ddbbb4a6a76ee2d Mon Sep 17 00:00:00 2001 From: Joe Wojak Date: Thu, 15 Aug 2024 13:56:37 -0400 Subject: [PATCH] More reviewer changes -- removed code sample -- added text about pressure sensor locations -- ready for review again --- api/docs/v2/basic_commands/liquids.rst | 4 +--- api/docs/v2/pipettes/loading.rst | 9 ++++++++- api/src/opentrons/protocol_api/instrument_context.py | 6 +++--- 3 files changed, 12 insertions(+), 7 deletions(-) diff --git a/api/docs/v2/basic_commands/liquids.rst b/api/docs/v2/basic_commands/liquids.rst index 5c32246bb2c..408183b8f59 100644 --- a/api/docs/v2/basic_commands/liquids.rst +++ b/api/docs/v2/basic_commands/liquids.rst @@ -269,9 +269,7 @@ The :py:meth:`.InstrumentContext.detect_liquid_presence` method tells a Flex pip pipette.detect_liquid_presence(well) -.. removed code sample. maybe some text advice could help? - -In cases where you need more information than ``true`` or ``false``, you could write your own code to handle the output of this method. For example, by adding some indexing along with ``for`` and ``while`` loops, your protocol could count how many aspirations a robot performed before a source well ran out of liquid. +.. removed code sample. .. versionadded:: 2.20 diff --git a/api/docs/v2/pipettes/loading.rst b/api/docs/v2/pipettes/loading.rst index 0d3a699a4e4..4753a72f4a7 100644 --- a/api/docs/v2/pipettes/loading.rst +++ b/api/docs/v2/pipettes/loading.rst @@ -221,7 +221,14 @@ Another example is a Flex protocol that uses a waste chute. Say you want to only Liquid Presence Detection ========================= -Liquid presence detection is a pressure-based feature that allows Opentrons Flex pipettes to detect the presence or absence of liquids in a well, reservoir, or other container. It gives you the ability to identify, avoid, and recover from liquid-related protocol errors. You can enable this feature for an entire protocol run or toggle it on and off as required. Liquid presence detection works with Flex pipettes only and is disabled by default. +Liquid presence detection is a pressure-based feature that allows Opentrons Flex pipettes to detect the presence or absence of liquids in a well, reservoir, tube, or other container. It gives you the ability to identify, avoid, and recover from liquid-related protocol errors. You can enable this feature for an entire protocol run or toggle it on and off as required. Liquid presence detection is disabled by default. + +Pipette Compatibility +--------------------- + +Liquid presence detection works with Flex 1-, 8-, and 96-channel pipettes only. 1-channel pipettes have one pressure sensor. The 8-channel pipette pressure sensors are on channels 1 and 8 (positions A1 and H1). The 96-channel pipette pressure sensors are on channels 1 and 96 (positions A1 and H12). Other channels on multi-channel pipettes do not have sensors and cannot detect liquid. + +.. add text with link to revised pipette sensor section in manual? Enabling Globally ----------------- diff --git a/api/src/opentrons/protocol_api/instrument_context.py b/api/src/opentrons/protocol_api/instrument_context.py index 7571eaa3614..5319b8f7ce4 100644 --- a/api/src/opentrons/protocol_api/instrument_context.py +++ b/api/src/opentrons/protocol_api/instrument_context.py @@ -2122,7 +2122,7 @@ def configure_nozzle_layout( # noqa: C901 def detect_liquid_presence(self, well: labware.Well) -> bool: """Checks for liquid in a well and returns ``True`` if liquid is present and ``False`` if liquid is not present. Will not raise an error if it does not detect liquid. When simulating a protocol, the check always succeeds (returns ``True``). Works with Flex 1-, 8-, and 96-channel pipettes. See :ref:`lpd` and :ref:`detect-liquid-presence` - If your protocol uses :ref:`partial tip pickup `, the pressure sensors for the Flex 8-channel pipette are on channels A1 and H1. For the Flex 96-channel pipette, the pressure sensors are on channels A1 and H12. All other channels for these pipettes cannot detect the presence/absence of a liquid. + If your protocol uses :ref:`partial tip pickup `, the pressure sensors for the Flex 8-channel pipette are on channels 1 and 8 (positions A1 and H1). For the Flex 96-channel pipette, the pressure sensors are on channels 1 and 96 (positions A1 and H12). Other channels on multi-channel pipettes do not have sensors and cannot detect liquid. """ loc = well.top() @@ -2131,9 +2131,9 @@ def detect_liquid_presence(self, well: labware.Well) -> bool: @requires_version(2, 20) def require_liquid_presence(self, well: labware.Well) -> None: - """Check for liquid in a well and raise an error if none is detected. When this method raises an error, Flex will offer the opportunity to enter recovery mode. In recovery mode, you can manually add liquid to resolve the error. When simulating a protocol, the check always succeeds (does not raise an error). Works with Flex 1-, 8-, and 96-channel pipettes. See :ref:`lpd` and :ref:`require-liquid-presence`. + """Check for liquid in a well and raises an error if none is detected. When this method raises an error, Flex will offer the opportunity to enter recovery mode. In recovery mode, you can manually add liquid to resolve the error. When simulating a protocol, the check always succeeds (does not raise an error). Works with Flex 1-, 8-, and 96-channel pipettes. See :ref:`lpd` and :ref:`require-liquid-presence`. - If your protocol uses :ref:`partial tip pickup `, the pressure sensors for the Flex 8-channel pipette are on channels A1 and H1. For the Flex 96-channel pipette, the pressure sensors are on channels A1 and H12. All other channels for these pipettes cannot detect the presence/absence of a liquid. + If your protocol uses :ref:`partial tip pickup `, the pressure sensors for the Flex 8-channel pipette are on channels 1 and 8 (positions A1 and H1). For the Flex 96-channel pipette, the pressure sensors are on channels 1 and 96 (positions A1 and H12). Other channels on multi-channel pipettes do not have sensors and cannot detect liquid. """ loc = well.top()