Skip to content

Commit

Permalink
temp mod additions
Browse files Browse the repository at this point in the history
  • Loading branch information
ecormany committed Oct 17, 2023
1 parent eee5555 commit 7e75431
Showing 1 changed file with 92 additions and 7 deletions.
99 changes: 92 additions & 7 deletions api/docs/v2/modules/temperature_module.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,17 +11,102 @@ The Temperature Module acts as both a cooling and heating device. It can control
The Temperature Module is represented in code by a :py:class:`.TemperatureModuleContext` object, which has methods for setting target temperatures and reading the module's status. This example demonstrates loading a Temperature Module GEN2 and loading a well plate on top of it.

.. code-block:: python
:substitutions:
def run(protocol: protocol_api.ProtocolContext):
temp_mod = protocol.load_module(
module_name='temperature module gen2',
location='D3')
plate = temp_mod.load_labware(
name='corning_96_wellplate_360ul_flat')
temp_mod = protocol.load_module(
module_name="temperature module gen2", location="D3"
)
.. versionadded:: 2.3

Loading Labware
===============

Use the Temperature Module’s :py:meth:`~.TemperatureModuleContext.load_adapter` and :py:meth:`~.TemperatureModuleContext.load_labware` methods to specify what you will place on the module. You may use one or both of the methods, depending on the labware you're using. See :ref:`labware-on-adapters` for examples of loading labware on modules.

The `Opentrons Labware Library <https://labware.opentrons.com/>`_ includes standalone adapter definitions and pre-configured adapter–labware combinations that help make the Temperature Module ready to use right out of the box.

Standalone Adapters
-------------------

You can use these standalone adapter definitions to load Opentrons verified or custom labware on top of the Temperature Module.

.. list-table::
:header-rows: 1

* - Adapter Type
- API Load Name
* - Opentrons Aluminum Flat Bottom Plate
- ``opentrons_aluminum_flat_bottom_plate``
* - Opentrons 96 Well Aluminum Block
- ``opentrons_96_well_aluminum_block``

For example, these commands load a PCR plate on top of the 96-well block::

temp_adapter = temp_mod.load_adapter('opentrons_96_well_aluminum_block')
temp_plate = temp_adapter.load_labware('nest_96_wellplate_100ul_pcr_full_skirt')

.. versionadded:: 2.15

.. note::
You can also load labware directly onto the Temperature Module. In API version 2.14 and earlier, this was the correct way to load labware on top of the flat bottom plate. In API version 2.15 and later, you should load both the adapter and the labware with separate commands.

Block-and-tube combinations
---------------------------

You can use these combination labware definitions to load various types of tubes into the 24-well thermal block on top of the Temperature Module. There is no standalone definition for the 24-well block.

.. list-table::
:header-rows: 1

* - Tube Type
- API Load Name
* - Generic 2 mL screw cap
- ``opentrons_24_aluminumblock_generic_2ml_screwcap``
* - NEST 0.5 mL screw cap
- ``opentrons_24_aluminumblock_nest_0.5ml_screwcap``
* - NEST 1.5 mL screw cap
- ``opentrons_24_aluminumblock_nest_1.5ml_screwcap``
* - NEST 1.5 mL snap cap
- ``opentrons_24_aluminumblock_nest_1.5ml_snapcap``
* - NEST 2 mL screw cap
- ``opentrons_24_aluminumblock_nest_2ml_screwcap``
* - NEST 2 mL snap cap
- ``opentrons_24_aluminumblock_nest_2ml_snapcap``

For example, this command loads the 24-well block with generic 2 mL tubes::

temp_tubes = temp_mod.load_labware(
'opentrons_24_aluminumblock_generic_2ml_screwcap'
)

.. versionadded:: 2.0

Block-and-plate combinations
----------------------------

The Temperature Module supports these 96-well block and labware combinations for backwards compatibility. If your protocol specifies an ``apiLevel`` of 2.15 or higher, you should use the standalone 96-well block definition instead.

.. list-table::
:header-rows: 1

* - 96-well block contents
- API Load Name
* - Bio-Rad well plate 200 μL
- ``opentrons_96_aluminumblock_biorad_wellplate_200uL``
* - Generic PCR strip 200 μL
- ``opentrons_96_aluminumblock_generic_pcr_strip_200uL``
* - NEST well plate 100 μL
- ``opentrons_96_aluminumblock_nest_wellplate_100uL``

This command loads the same physical adapter and labware as the example in the Standalone Adapters section above, but it is also compatible with earlier API versions::

temp_combo = temp_mod.load_labware(
"opentrons_96_aluminumblock_nest_wellplate_100uL"
)

.. versionadded:: 2.0


Temperature Control
===================

Expand Down

0 comments on commit 7e75431

Please sign in to comment.