From d0c16c787519739194a7a6fe6fe7bebe1d91efc5 Mon Sep 17 00:00:00 2001 From: jbleon95 Date: Fri, 8 Dec 2023 09:54:13 -0500 Subject: [PATCH] in depth comments --- .../protocol_engine/state/addressable_areas.py | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/api/src/opentrons/protocol_engine/state/addressable_areas.py b/api/src/opentrons/protocol_engine/state/addressable_areas.py index 7fb327a916a..7d03e556d92 100644 --- a/api/src/opentrons/protocol_engine/state/addressable_areas.py +++ b/api/src/opentrons/protocol_engine/state/addressable_areas.py @@ -416,7 +416,16 @@ def get_addressable_area_base_slot( return addressable_area.base_slot def get_addressable_area_position(self, addressable_area_name: str) -> Point: - """Get the position of an addressable area.""" + """Get the position of an addressable area. + + This does not require the addressable area to be in the deck configuration. + This is primarily used to support legacy fixed trash labware without + modifying the deck layout to remove the similar, but functionally different, + trashBinAdapter cutout fixture. + + Besides that instance, for movement purposes, this should only be called for + areas that have been pre-validated, otherwise there could be the risk of collision. + """ addressable_area = self._get_addressable_area_from_deck_data( addressable_area_name ) @@ -455,7 +464,10 @@ def get_fixture_height(self, cutout_fixture_name: str) -> float: return cutout_fixture["height"] def get_slot_definition(self, slot_id: str) -> SlotDefV3: - """Get the definition of a slot in the deck.""" + """Get the definition of a slot in the deck. + + This does not require that the slot exist in deck configuration. + """ try: addressable_area = self._get_addressable_area_from_deck_data(slot_id) except AddressableAreaDoesNotExistError: