diff --git a/api/docs/img/Flex-and-OT-2-decks.svg b/api/docs/img/Flex-and-OT-2-decks.svg index d8615b347520..9ac54206c71c 100644 --- a/api/docs/img/Flex-and-OT-2-decks.svg +++ b/api/docs/img/Flex-and-OT-2-decks.svg @@ -1,225 +1,565 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/api/docs/v2/deck_slots.rst b/api/docs/v2/deck_slots.rst index 83781227e3c5..2cf3dd6838f8 100644 --- a/api/docs/v2/deck_slots.rst +++ b/api/docs/v2/deck_slots.rst @@ -1,24 +1,19 @@ :og:description: How to specify deck slots in the Python Protocol API. -.. - Allow concise cross-referencing to ProtocolContext.load_labware() et. al., without barfing out the whole import path. -.. py:currentmodule:: opentrons.protocol_api - - .. _deck-slots: ********** Deck Slots ********** -When you load an item onto the robot's deck, like with :py:obj:`ProtocolContext.load_labware()` or :py:obj:`ProtocolContext.load_module()`, you need to specify which slot to put it in. The API accepts values that correspond to the physical deck slot labels on an OT-2 or Flex robot. +Deck slots are where you place hardware items on the deck surface of your Opentrons robot. In the API, you load the corresponding items into your protocol with methods like :py:obj:`.ProtocolContext.load_labware`, :py:obj:`.ProtocolContext.load_module`, or :py:obj:`.ProtocolContext.load_trash_bin`. When you call these methods, you need to specify which slot to load the item in. Physical Deck Labels ==================== -The Opentrons Flex uses a coordinate labeling system for slots A1 (back left) through D3 (front right). +Flex uses a coordinate labeling system for slots A1 (back left) through D4 (front right). Columns 1 through 3 are in the *working area* and are accessible by pipettes and the gripper. Column 4 is in the *staging area* and is only accessible by the gripper. For more information on staging area slots, see :ref:`deck-configuration` below. -The Opentrons OT-2 uses a numeric labeling system for slots 1 (front left) through 11 (back center). The back right slot is occupied by the fixed trash. +OT-2 uses a numeric labeling system for slots 1 (front left) through 11 (back center). The back right slot is occupied by the fixed trash. .. image:: ../img/Flex-and-OT-2-decks.svg :width: 100% @@ -27,7 +22,7 @@ The Opentrons OT-2 uses a numeric labeling system for slots 1 (front left) throu API Deck Labels =============== -Specify a slot in either the Flex or OT-2 format: +The API accepts values that correspond to the physical deck slot labels on a Flex or OT-2 robot. Specify a slot in either format: * A coordinate like ``"A1"``. This format must be a string. * A number like ``"10"`` or ``10``. This format can be a string or an integer. @@ -83,3 +78,19 @@ The correspondence between deck labels is based on the relative locations of the - 3 .. TODO staging slots and error handling of A4–D4 in OT-2 protocols + +Slots A4, B4, C4, and D4 on Flex have no equivalent on OT-2. + +.. _deck-configuration: + +Deck Configuration +================== + +Flex robots running robot system version 7.1.0 or higher let you specify their deck configuration on the touchscreen or in the Opentrons App. This tells the robot the positions of unpowered *deck fixtures*, like staging area slots, trash bins, and the waste chute. + +When the robot analyzes your Python protocol, it will check whether there are any conflicts with its current deck configuration. You can't start the protocol run until any conflicts are resolved. You can resolve them one of two ways: + + - Physically move hardware around the deck, and update the deck configuration. + - Alter your protocol to work with the current deck configuration, and resend the protocol to your Flex. + +The expected configuration is based on both explicit load commands and implicit effects of other commands in your protocol. [more TK] \ No newline at end of file