Sartorius

This module contains the Sartorius class.

CLASS	DESCRIPTION
Sartorius	Sartorius pipette tool class

Documentation last updated: 2025-02-22

Sartorius

Sartorius(
    port: str,
    *,
    channel: int = 1,
    verbose: bool = False,
    simulation: bool = False,
    tip_inset_mm: int = 12,
    tip_capacitance: int = 276,
    **kwargs,
)

Bases: LiquidHandler

Sartorius pipette tool class

ATTRIBUTE	DESCRIPTION
tip_length	The length of the tip attached to the pipette tool. TYPE: int | float
pullback_steps	The number of steps to pull back the pipette tool. TYPE: int
speed_interpolation	The interpolation of speed values. TYPE: dict
capacity	The capacity of the pipette tool. TYPE: float
channel	The channel of the pipette tool. TYPE: int
volume_resolution	The volume resolution of the pipette tool. TYPE: float
tip_inset_mm	The inset of the tip in mm. TYPE: float
device	Device object TYPE: SartoriusDevice
flags	Flags for the class TYPE: SimpleNamespace
speed_in	Speed for aspiration TYPE: int | float
speed_out	Speed for dispense TYPE: int | float
reagent	Name of reagent
offset	Offset for liquid handling
connection_details	Connection details for the device TYPE: dict
is_busy	Whether the device is busy TYPE: bool
is_connected	Whether the device is connected TYPE: bool
verbose	Verbosity of class TYPE: bool
volume	Current volume of liquid in the channel TYPE: float

METHOD	DESCRIPTION
aspirate	Aspirate desired volume of reagent
blowout	Blowout liquid from tip
dispense	Dispense desired volume of reagent
pullback	Pullback liquid from tip
addAirGap	Add an air gap to the pipette tool
attach	Attach the tip to the pipette tool
eject	Eject the tip from the pipette tool
home	Home the pipette tool
setSpeed	Set the speed of the pipette tool
isTipOn	Check if the tip is on the pipette tool
connect	Connect to the device
disconnect	Disconnect from the device
resetFlags	Reset all flags to to default
shutdown	Shutdown procedure for tool
cycle	Cycle between aspirate and dispense
empty	Empty the channel
fill	Fill the channel
rinse	Rinse the channel with aspirate and dispense cycles

Initialize the Sartorius pipette tool.

PARAMETER	DESCRIPTION
port	The port to connect to the pipette tool. TYPE: str
channel	The channel to connect to. Defaults to 1. TYPE: int DEFAULT: 1
verbose	Whether to print verbose output. Defaults to False. TYPE: bool DEFAULT: False
simulation	Whether to simulate the pipette tool. Defaults to False. TYPE: bool DEFAULT: False
tip_inset_mm	The inset of the tip in mm. Defaults to 12. TYPE: int DEFAULT: 12
tip_capacitance	The capacitance of the tip. Defaults to 276. TYPE: int DEFAULT: 276

tip_inset_mm property

tip_inset_mm: float

The inset of the tip in mm

addAirGap

addAirGap(steps: int = 10) -> bool

Add an air gap to the pipette tool.

PARAMETER	DESCRIPTION
steps	The number of steps to move the pipette tool. TYPE: int DEFAULT: 10

RETURNS	DESCRIPTION
bool	Whether the action is successful. TYPE: bool

attach

attach(tip_length: int | float) -> bool

Attach the tip to the pipette tool.

PARAMETER	DESCRIPTION
tip_length	The length of the tip to attach. TYPE: int | float

RETURNS	DESCRIPTION
bool	Whether the action is successful. TYPE: bool

blowout

blowout(home: bool = True, **kwargs) -> bool

Blowout liquid from tip

PARAMETER	DESCRIPTION
home	whether to home the pipette tool after blowing out TYPE: bool DEFAULT: True

RETURNS	DESCRIPTION
bool	whether the action is successful TYPE: bool

eject

eject() -> bool

Eject the tip from the pipette tool.

RETURNS	DESCRIPTION
bool	Whether the action is successful. TYPE: bool

home

home() -> bool

Home the pipette tool.

RETURNS	DESCRIPTION
bool	Whether the action is successful. TYPE: bool

isTipOn

isTipOn() -> bool

Check if the tip is on the pipette tool.

RETURNS	DESCRIPTION
bool	True if the tip is on the pipette tool, False otherwise. TYPE: bool

setSpeed

setSpeed(
    speed: int | float, as_default: bool = True
) -> bool

Set the speed of the pipette tool.

PARAMETER	DESCRIPTION
speed	The speed to set the pipette tool to. TYPE: float
as_default	Whether to set the speed as the default speed. TYPE: bool DEFAULT: True

RETURNS	DESCRIPTION
bool	Whether the action is successful. TYPE: bool