Heater-Shaker

HeaterShakerContext

An object representing a connected Heater-Shaker Module.

It should not be instantiated directly; instead, it should be created through ProtocolContext.load_module().

New in version 2.13

close_labware_latch v2.13

close_labware_latch()

Closes the labware latch.

The labware latch needs to be closed using this method before sending a shake command, even if the latch was manually closed before starting the protocol.

current_speed property v2.13

current_speed

The current speed of the Heater-Shaker's plate in rpm.

current_temperature property v2.13

current_temperature

The current temperature of the Heater-Shaker's plate in °C.

Returns 23 in simulation if no target temperature has been set.

deactivate_heater v2.13

deactivate_heater()

Stops heating.

The module will passively cool to room temperature. The Heater-Shaker does not have active cooling.

deactivate_shaker v2.13

deactivate_shaker()

Stops shaking.

Decelerating to 0 rpm typically only takes a few seconds.

labware property v2.0

labware

The labware (if any) present on this module.

labware_latch_status property v2.13

labware_latch_status

One of six possible latch statuses:

• opening: The latch is currently opening (in motion).
• idle_open: The latch is open and not moving.
• closing: The latch is currently closing (in motion).
• idle_closed: The latch is closed and not moving.
• idle_unknown: The default status upon reset, regardless of physical latch position. Use close_labware_latch before other commands requiring confirmation that the latch is closed.
• unknown: The latch status can't be determined.

load_adapter v2.15

load_adapter(name, namespace=None, version=None)

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_adapter_from_definition(definition)

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

load_labware_by_name(name, label=None, namespace=None, version=None)

Deprecated in version 2.0: Use load_labware instead.

load_labware_from_definition v2.0

load_labware_from_definition(definition, label=None)

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.

model property v2.14

model

Get the module's model identifier.

open_labware_latch v2.13

open_labware_latch()

Open the Heater-Shaker's labware latch.

The labware latch needs to be closed before:

• Shaking
• Pipetting to or from the labware on the Heater-Shaker
• Pipetting to or from labware to the left or right of the Heater-Shaker

Attempting to open the latch while the Heater-Shaker is shaking will raise an error.

Note

Before opening the latch, this command will retract the pipettes upward if they are parked adjacent to the left or right of the Heater-Shaker.

parent property v2.14

parent

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.

serial_number property v2.14

serial_number

Get the module's unique hardware serial number.

set_and_wait_for_shake_speed v2.13

set_and_wait_for_shake_speed(rpm)

Set a shake speed in rpm and block execution of further commands until the module reaches the target.

Reaching a target shake speed typically only takes a few seconds.

Note

Before shaking, this command will retract the pipettes upward if they are parked adjacent to the Heater-Shaker.

Parameters:

• rpm (int) –

  A value between 200 and 3000, representing the target shake speed in revolutions per minute.

set_and_wait_for_temperature v2.13

set_and_wait_for_temperature(celsius)

Set a target temperature and wait until the module reaches the target.

No other protocol commands will execute while waiting for the temperature.

Changed in version 2.25: Removed the minimum temperature limit of 37 °C. Note that temperatures under ambient are not achievable.

Parameters:

• celsius (float) –

  A value under 95, representing the target temperature in °C. Values are automatically truncated to two decimal places, and the Heater-Shaker module has a temperature accuracy of ±0.5 °C.

set_shake_speed v2.27

set_shake_speed(rpm)

Set a shake speed in rpm to run in the background.

Note

Before shaking, this command will retract the pipettes upward if they are parked adjacent to the Heater-Shaker.

Parameters:

• rpm (int) –

  A value between 200 and 3000, representing the target shake speed in revolutions per minute.

set_target_temperature v2.13

set_target_temperature(celsius)

Set target temperature and return immediately.

Sets the Heater-Shaker's target temperature and returns immediately without waiting for the target to be reached. Does not delay the protocol until target temperature has reached. Use wait_for_temperature() to delay protocol execution for API levels below 2.27.

Changed in version 2.25: Removed the minimum temperature limit of 37 °C. Note that temperatures under ambient are not achievable.

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.

Parameters:

• celsius (float) –

  A value under 95, representing the target temperature in °C. Values are automatically truncated to two decimal places, and the Heater-Shaker module has a temperature accuracy of ±0.5 °C.

speed_status property v2.13

speed_status

One of five possible shaking statuses:

• holding at target: The module has reached its target shake speed and is actively maintaining that speed.
• speeding up: The module is increasing its shake speed towards a target.
• slowing down: The module was previously shaking at a faster speed and is currently reducing its speed to a lower target or to deactivate.
• idle: The module is not shaking.
• error: The shaking status can't be determined.

target_speed property v2.13

target_speed

Target speed of the Heater-Shaker's plate in rpm.

target_temperature property v2.13

target_temperature

The target temperature of the Heater-Shaker's plate in °C.

Returns None if no target has been set.

temperature_status property v2.13

temperature_status

One of five possible temperature statuses:

• holding at target: The module has reached its target temperature and is actively maintaining that temperature.
• cooling: The module has previously heated and is now passively cooling. The Heater-Shaker does not have active cooling.
• heating: The module is heating to a target temperature.
• idle: The module has not heated since the beginning of the protocol.
• error: The temperature status can't be determined.

type property v2.14

type

Get the module's general type identifier.

wait_for_temperature v2.13

wait_for_temperature()

Delays protocol execution until the Heater-Shaker has reached its target temperature.

Raises an error if no target temperature was previously set.