Temperature Module
TemperatureModuleContext ¶
An object representing a connected Temperature Module.
It should not be instantiated directly; instead, it should be
created through load_module().
New in version 2.0
await_temperature
v2.3
¶
Wait until module reaches temperature.
Parameters:
-
celsius(float) –A value between 4 and 95, representing the target temperature in °C.
load_adapter
v2.15
¶
Load an adapter onto the module using its load parameters.
The parameters of this function behave like those of
load_adapter()
(which loads adapters directly onto the deck). Note that the parameter
name here corresponds to load_name on the ProtocolContext
function.
Returns:
-
Labware–The initialized and loaded adapter object.
load_adapter_from_definition
v2.15
¶
Load an adapter onto the module using an inline definition.
Parameters:
-
definition(LabwareDefinition) –The labware definition.
Returns:
-
Labware–The initialized and loaded labware object.
load_labware ¶
load_labware(name, label=None, namespace=None, version=None, adapter=None, lid=None, *, adapter_namespace=None, adapter_version=None, lid_namespace=None, lid_version=None)
Load a labware onto the module using its load parameters.
The parameters of this function behave like those of
load_labware()
(which loads labware directly onto the deck). Note that the parameter
name here corresponds to load_name on the ProtocolContext
function.
Returns:
-
Labware–The initialized and loaded labware object.
New in version 2.1: The label, namespace, and version parameters.
New in version 2.26: The adapter_namespace, adapter_version,
lid_namespace, and lid_version parameters.
load_labware_by_name
v2.1
¶
Deprecated in version 2.0:
Use load_labware instead.
load_labware_from_definition
v2.0
¶
Load a labware onto the module using an inline definition.
Parameters:
-
definition(LabwareDefinition) –The labware definition.
-
label(str, default:None) –An optional special name to give the labware. If specified, this is the name the labware will appear as in the run log and the calibration view in the Opentrons app.
Returns:
-
Labware–The initialized and loaded labware object.
parent
property
v2.14
¶
The name of the slot the module is on.
On a Flex, this will be like "D1". On an OT-2, this will be like "1".
See Deck Slots.
set_temperature
v2.0
¶
Set a target temperature and wait until the module reaches the target.
No other protocol commands will execute while waiting for the temperature.
Parameters:
-
celsius(float) –A value between 4 and 95, representing the target temperature in °C.
start_set_temperature
v2.3
¶
Set the target temperature without waiting for the target to be hit.
Changed in version 2.27: Returns a task object that represents
concurrent preheating. Pass the task object to
wait_for_tasks()
to wait for the preheat to complete.
On version 2.26 or below, this function returns None.
Parameters:
-
celsius(float) –A value between 4 and 95, representing the target temperature in °C.
status
property
v2.3
¶
One of four possible temperature statuses:
holding at target: The module has reached its target temperature and is actively maintaining that temperature.cooling: The module is cooling to a target temperature.heating: The module is heating to a target temperature.idle: The module has been deactivated.
target
property
v2.0
¶
The target temperature of the Temperature Module's deck in °C.
Returns None if no target has been set.
temperature
property
v2.0
¶
The current temperature of the Temperature Module's deck in °C.
Returns 0 in simulation if no target temperature has been set.