Magnetic Module

MagneticModuleContext

An object representing a connected Magnetic Module.

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

New in version 2.0

disengage v2.0

disengage()

Lower the magnets back into the Magnetic Module.

engage v2.0

engage(height=None, offset=None, height_from_base=None)

Raise the Magnetic Module's magnets. You can specify how high the magnets should move:

• No parameter: Move to the default height for the loaded labware. If the loaded labware has no default, or if no labware is loaded, this will raise an error.

• height_from_base: Move this many millimeters above the bottom of the labware. Acceptable values are between 0 and 25.

  This is the recommended way to adjust the magnets' height.

  New in version 2.2

• offset: Move this many millimeters above (positive value) or below (negative value) the default height for the loaded labware. The sum of the default height and offset must be between 0 and 25.

• height: Intended to move this many millimeters above the magnets' home position. However, depending on the generation of module and the loaded labware, this may produce unpredictable results. You should normally use height_from_base instead.

  Removed in version 2.14

You shouldn't specify more than one of these parameters. However, if you do, their order of precedence is height, then height_from_base, then offset.

labware property v2.0

labware

The labware (if any) present on this module.

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.

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.

status property v2.0

status

The status of the module, either engaged or disengaged.

type property v2.14

type

Get the module's general type identifier.