Merge back 'chore_release-8.5.1' into 'chore_release-pd-8.5.0' (#19037)

ddcc4 · ddcc4 · commit d46293b3cf65 · 2025-07-25T23:33:30.000-04:00
diff --git a/api/release-notes.md b/api/release-notes.md
@@ -10,10 +10,12 @@ By installing and using Opentrons software, you agree to the Opentrons End-User
 
 ## Opentrons Robot Software Changes in 8.5.1
 
-The 8.5.1 hotfix release fixes two bugs:
+The 8.5.1 hotfix release fixes these bugs:
 
 - Corrected behavior when performing multi-dispense actions using a custom or modified liquid class.
 - Fixed a problem where certain quick transfers (specifically ones that attempt to blow out over the waste chute) could not be run.
+- Air-gapping after a dispense when using a liquid class now uses the correct volume.
+- Fixed a problem where distributing with a liquid class would sometimes fail to blow out the disposal volume.
 
 ---
 
diff --git a/api/src/opentrons/protocol_api/core/engine/instrument.py b/api/src/opentrons/protocol_api/core/engine/instrument.py
@@ -1573,7 +1573,7 @@ def distribute_with_liquid_class(  # noqa: C901
             # multi-dispense in those destinations.
             # If the tip has a volume corresponding to a single destination, then
             # do a single-dispense into that destination.
-            for dispense_vol, dispense_dest in vol_dest_combo:
+            for idx, (dispense_vol, dispense_dest) in enumerate(vol_dest_combo):
                 if use_single_dispense:
                     tip_contents = self.dispense_liquid_class(
                         volume=dispense_vol,
@@ -1601,6 +1601,7 @@ def distribute_with_liquid_class(  # noqa: C901
                         trash_location=trash_location,
                         conditioning_volume=conditioning_vol,
                         disposal_volume=disposal_vol,
+                        is_last_dispense_in_tip=(idx == len(vol_dest_combo) - 1),
                     )
                 is_first_step = False
 
@@ -2180,6 +2181,7 @@ def dispense_liquid_class_during_multi_dispense(
         trash_location: Union[Location, TrashBin, WasteChute],
         conditioning_volume: float,
         disposal_volume: float,
+        is_last_dispense_in_tip: bool,
     ) -> List[tx_comps_executor.LiquidAndAirGapPair]:
         """Execute a dispense step that's part of a multi-dispense.
 
@@ -2226,9 +2228,8 @@ def dispense_liquid_class_during_multi_dispense(
         components_executor.submerge(
             submerge_properties=dispense_props.submerge, post_submerge_action="dispense"
         )
-        tip_starting_volume = self.get_current_volume()
         is_last_dispense_without_disposal_vol = (
-            disposal_volume == 0 and tip_starting_volume == volume
+            disposal_volume == 0 and is_last_dispense_in_tip
         )
         push_out_vol = (
             # TODO (spp): verify if it's okay to use push_out_by_volume of single dispense
@@ -2248,7 +2249,7 @@ def dispense_liquid_class_during_multi_dispense(
             source_well=source[1] if source else None,
             conditioning_volume=conditioning_volume,
             add_final_air_gap=add_final_air_gap,
-            is_last_retract=tip_starting_volume - volume == disposal_volume,
+            is_last_retract=is_last_dispense_in_tip,
         )
         last_contents = components_executor.tip_state.last_liquid_and_air_gap_in_tip
         new_tip_contents = tip_contents[0:-1] + [last_contents]
diff --git a/api/src/opentrons/protocol_api/core/engine/transfer_components_executor.py b/api/src/opentrons/protocol_api/core/engine/transfer_components_executor.py
@@ -543,6 +543,11 @@ def retract_after_dispensing(
             blowout_props.enabled
             and blowout_props.location == BlowoutLocation.DESTINATION
         ) or not blowout_props.enabled
+
+        if is_final_air_gap and not add_final_air_gap:
+            air_gap_volume = 0.0
+        else:
+            air_gap_volume = retract_props.air_gap_by_volume.get_for_volume(0)
         # Regardless of the blowout location, do touch tip and air gap
         # when leaving the dispense well. If this will be the final air gap, i.e,
         # we won't be moving to a Trash or a Source for Blowout after this air gap,
@@ -551,7 +556,7 @@ def retract_after_dispensing(
             touch_tip_properties=retract_props.touch_tip,
             location=retract_location,
             well=self._target_well,
-            add_air_gap=False if is_final_air_gap and not add_final_air_gap else True,
+            air_gap_volume=air_gap_volume,
         )
 
         if (
@@ -599,15 +604,21 @@ def retract_after_dispensing(
             last_air_gap = self._tip_state.last_liquid_and_air_gap_in_tip.air_gap
             self._tip_state.delete_air_gap(last_air_gap)
             self._tip_state.ready_to_aspirate = False
+
+            air_gap_volume = (
+                retract_props.air_gap_by_volume.get_for_volume(0)
+                if add_final_air_gap
+                else 0.0
+            )
             # Do touch tip and air gap again after blowing out into source well or trash
             self._do_touch_tip_and_air_gap_after_dispense(
                 touch_tip_properties=retract_props.touch_tip,
                 location=touch_tip_and_air_gap_location,
                 well=touch_tip_and_air_gap_well,
-                add_air_gap=add_final_air_gap,
+                air_gap_volume=air_gap_volume,
             )
 
-    def retract_during_multi_dispensing(
+    def retract_during_multi_dispensing(  # noqa: C901
         self,
         trash_location: Union[Location, TrashBin, WasteChute],
         source_location: Optional[Location],
@@ -720,6 +731,14 @@ def retract_during_multi_dispensing(
             else:
                 add_air_gap = True
 
+        air_gap_volume = (
+            retract_props.air_gap_by_volume.get_for_volume(
+                self.tip_state.last_liquid_and_air_gap_in_tip.liquid
+            )
+            if add_air_gap
+            else 0.0
+        )
+
         # Regardless of the blowout location, do touch tip
         # when leaving the dispense well.
         # Add an air gap depending on conditioning volume + whether this is
@@ -729,7 +748,7 @@ def retract_during_multi_dispensing(
             touch_tip_properties=retract_props.touch_tip,
             location=retract_location,
             well=self._target_well,
-            add_air_gap=add_air_gap,
+            air_gap_volume=air_gap_volume,
         )
 
         if (
@@ -776,25 +795,30 @@ def retract_during_multi_dispensing(
             self._tip_state.delete_last_air_gap_and_liquid()
             self._tip_state.ready_to_aspirate = False
 
+            if (
+                # Same check as before for when it's the final air gap of current retract
+                conditioning_volume > 0
+                and is_last_retract
+                and add_final_air_gap
+            ):
+                # The volume in tip at this point should be 0uL
+                air_gap_volume = retract_props.air_gap_by_volume.get_for_volume(0)
+            else:
+                air_gap_volume = 0
             # Do touch tip and air gap again after blowing out into source well or trash
             self._do_touch_tip_and_air_gap_after_dispense(
                 touch_tip_properties=retract_props.touch_tip,
                 location=touch_tip_and_air_gap_location,
                 well=touch_tip_and_air_gap_well,
-                add_air_gap=(
-                    # Same check as before for when it's the final air gap of current retract
-                    conditioning_volume > 0
-                    and is_last_retract
-                    and add_final_air_gap
-                ),
+                air_gap_volume=air_gap_volume,
             )
 
     def _do_touch_tip_and_air_gap_after_dispense(  # noqa: C901
         self,
         touch_tip_properties: TouchTipProperties,
         location: Union[Location, TrashBin, WasteChute],
         well: Optional[WellCore],
-        add_air_gap: bool,
+        air_gap_volume: float,
     ) -> None:
         """Perform touch tip and air gap as part of post-dispense retract.
 
@@ -840,7 +864,7 @@ def _do_touch_tip_and_air_gap_after_dispense(  # noqa: C901
                     # Full speed because the tip will already be out of the liquid
                     speed=None,
                 )
-        if add_air_gap or not self._tip_state.ready_to_aspirate:
+        if air_gap_volume > 0 or not self._tip_state.ready_to_aspirate:
             # If we need to move the plunger up either to prepare for aspirate or to add air gap,
             # move to a safe location above the well if the retract location is not already
             # at or above this safe location
@@ -886,12 +910,8 @@ def _do_touch_tip_and_air_gap_after_dispense(  # noqa: C901
             if not self._tip_state.ready_to_aspirate:
                 self._instrument.prepare_to_aspirate()
                 self._tip_state.ready_to_aspirate = True
-            if add_air_gap:
-                self._add_air_gap(
-                    air_gap_volume=self._transfer_properties.aspirate.retract.air_gap_by_volume.get_for_volume(
-                        0
-                    )
-                )
+            if air_gap_volume > 0:
+                self._add_air_gap(air_gap_volume=air_gap_volume)
 
     def _add_air_gap(
         self,
diff --git a/api/src/opentrons/protocol_api/instrument_context.py b/api/src/opentrons/protocol_api/instrument_context.py
@@ -1801,9 +1801,6 @@ def transfer_with_liquid_class(
     ) -> InstrumentContext:
         """Move a particular type of liquid from one well or group of wells to another.
 
-        ..
-            This is intended for Opentrons internal use only and is not a guaranteed API.
-
         :param liquid_class: The type of liquid to move. You must specify the liquid class,
             even if you have used :py:meth:`.Labware.load_liquid` to indicate what liquid the
             source contains.
@@ -1944,16 +1941,12 @@ def distribute_with_liquid_class(
         """
         Distribute a particular type of liquid from one well to a group of wells.
 
-        ..
-            This is intended for Opentrons internal use only and is not a guaranteed API.
-
         :param liquid_class: The type of liquid to move. You must specify the liquid class,
             even if you have used :py:meth:`.Labware.load_liquid` to indicate what liquid the
             source contains.
         :type liquid_class: :py:class:`.LiquidClass`
 
-        :param volume: The amount, in µL, to aspirate from the source and dispense to
-                       each destination.
+        :param volume: The amount, in µL, to dispense to each destination.
         :param source: A single well for the pipette to target, or a group of wells to
                        target in a single aspirate for a multi-channel pipette.
         :param dest: A list of wells to dispense liquid into.
@@ -2092,16 +2085,12 @@ def consolidate_with_liquid_class(
         """
         Consolidate a particular type of liquid from a group of wells to one well.
 
-        ..
-            This is intended for Opentrons internal use only and is not a guaranteed API.
-
         :param liquid_class: The type of liquid to move. You must specify the liquid class,
             even if you have used :py:meth:`.Labware.load_liquid` to indicate what liquid the
             source contains.
         :type liquid_class: :py:class:`.LiquidClass`
 
-        :param volume: The amount, in µL, to aspirate from the source and dispense to
-                       each destination.
+        :param volume: The amount, in µL, to aspirate from each source well.
         :param source: A list of wells to aspirate liquid from.
         :param dest: A single well, list of wells, trash bin, or waste chute to dispense liquid into.
                      Multiple wells can only be given for multi-channel pipette configurations, and
diff --git a/api/src/opentrons/protocol_api/protocol_context.py b/api/src/opentrons/protocol_api/protocol_context.py
@@ -1386,6 +1386,8 @@ def get_liquid_class(
             - ``"ethanol_80"``: an Opentrons-verified liquid class for volatile liquid. Based on 80% ethanol.
 
         :raises: ``LiquidClassDefinitionDoesNotExist``: if the specified liquid class does not exist.
+
+        :returns: A new LiquidClass object.
         """
         return self._core.get_liquid_class(name=name, version=DEFAULT_LC_VERSION)
 
@@ -1397,15 +1399,16 @@ def define_liquid_class(
         base_liquid_class: Optional[LiquidClass] = None,
         display_name: Optional[str] = None,
     ) -> LiquidClass:
-        """Define a custom liquid class, either based on an existing, Opentrons-verified liquid class, or to create a completely new one.
+        """Define a custom liquid class, either based on an existing liquid class, or create a completely new one.
 
         :param name: The name to give to the new liquid class. Cannot use the name of an Opentrons-verified liquid class.
-        :param properties: A dict of transfer properties for the Flex pipette and tips to use for liquid class transfers. The nested dictionary must have top-level keys corresponding to pipette load names and second-level keys corresponding to compatible tip rack load names. Further nested key–value pairs should be in the format returned by :py:meth:`.LiquidClass.get_for`. See also the `liquid class JSON schema <https://github.com/Opentrons/opentrons/tree/edge/shared-data/liquid-class/schemas>`_.
+        :param properties: A dict of transfer properties for pipette and tip combinations to use for liquid class transfers. The nested dictionary must have top-level keys corresponding to pipette load names and second-level keys corresponding to compatible tip rack load names. Further nested key–value pairs should be as specified in ``TransferPropertiesDict``. See the  `liquid class type definitions <https://github.com/Opentrons/opentrons/blob/edge/shared-data/python/opentrons_shared_data/liquid_classes/types.py>`_.
 
-        :param base_liquid_class: An Opentrons-verified liquid class to base the newly defined liquid class on. The specified ``transfer_properties`` will override any existing properties for the Flex pipette and tips. All other properties will remain the same as those in the base class.
+        :param base_liquid_class: An existing liquid class object to base the newly defined liquid class on. The specified ``transfer_properties`` will override any existing properties for the specified pipette and tip combinations. All other properties will remain the same as those in the base class.
 
         :param display_name: An optional name for the liquid class. Defaults to the title-case ``name`` if a display name isn't provided.
 
+        :returns: A new LiquidClass object.
         """
         if definition_exists(name, DEFAULT_LC_VERSION):
             raise ValueError(
diff --git a/api/tests/opentrons/protocol_api/core/engine/test_instrument_core.py b/api/tests/opentrons/protocol_api/core/engine/test_instrument_core.py
@@ -2666,9 +2666,6 @@ def test_dispense_liquid_class_during_multi_dispense(
     decoy.when(
         mock_transfer_components_executor.tip_state.last_liquid_and_air_gap_in_tip
     ).then_return(LiquidAndAirGapPair(liquid=333, air_gap=444))
-    decoy.when(
-        mock_engine_client.state.pipettes.get_aspirated_volume("abc123")
-    ).then_return(12345)
     result = subject.dispense_liquid_class_during_multi_dispense(
         volume=123,
         dest=(dest_location, dest_well),
@@ -2680,6 +2677,7 @@ def test_dispense_liquid_class_during_multi_dispense(
         trash_location=Location(Point(1, 2, 3), labware=None),
         conditioning_volume=conditioning_volume,
         disposal_volume=disposal_volume,
+        is_last_dispense_in_tip=False,  # testing the case when this is not last dispense
     )
     decoy.verify(
         mock_transfer_components_executor.submerge(
@@ -2750,9 +2748,6 @@ def test_last_dispense_liquid_class_during_multi_dispense(
     decoy.when(
         mock_transfer_components_executor.tip_state.last_liquid_and_air_gap_in_tip
     ).then_return(LiquidAndAirGapPair(liquid=333, air_gap=444))
-    decoy.when(
-        mock_engine_client.state.pipettes.get_aspirated_volume("abc123")
-    ).then_return(123)
     result = subject.dispense_liquid_class_during_multi_dispense(
         volume=123,
         dest=(dest_location, dest_well),
@@ -2764,6 +2759,7 @@ def test_last_dispense_liquid_class_during_multi_dispense(
         trash_location=Location(Point(1, 2, 3), labware=None),
         conditioning_volume=conditioning_volume,
         disposal_volume=disposal_volume,
+        is_last_dispense_in_tip=True,
     )
     decoy.verify(
         mock_transfer_components_executor.submerge(
diff --git a/api/tests/opentrons/protocol_api/core/engine/test_transfer_components_executor.py b/api/tests/opentrons/protocol_api/core/engine/test_transfer_components_executor.py
diff --git a/api/tests/opentrons/protocol_api_integration/test_transfer_with_liquid_classes.py b/api/tests/opentrons/protocol_api_integration/test_transfer_with_liquid_classes.py
diff --git a/shared-data/liquid-class/schemas/1.json b/shared-data/liquid-class/schemas/1.json
