Tricontinent

This module provides a class for handling TriContinent pumps.

CLASS	DESCRIPTION
`TriContinent`	Class for handling TriContinent pumps.
`Multi_TriContinent`	Class for handling multiple TriContinent pumps.
`Parallel_TriContinent`	Class for handling multiple TriContinent pumps in parallel.

Documentation last updated: 2025-02-22

TriContinent

TriContinent(
    port: str,
    capacity: float = 1000.0,
    *,
    output_right: bool,
    channel: int = 1,
    verbose: bool = False,
    simulation: bool = False,
    **kwargs,
)

Bases: LiquidHandler

TriContinent class for handling TriContinent pumps.

ATTRIBUTE	DESCRIPTION
`capacity`	The capacity of the pump. TYPE: `float`
`channel`	The channel of the pump. TYPE: `int`
`volume_resolution`	The volume resolution of the pump. TYPE: `float`
`pullback_steps`	The number of pullback steps. TYPE: `int`
`speed_in`	The speed of the pump when aspirating. TYPE: `int`
`speed_out`	The speed of the pump when dispensing. TYPE: `int`
`start_speed`	The start speed of the pump. TYPE: `int`
`acceleration`	The acceleration of the pump. TYPE: `int`
`valve_position`	The valve position of the pump. TYPE: `str`
`init_status`	The initialization status of the pump. TYPE: `bool`

METHOD	DESCRIPTION
`connect`	Connect to the pump.
`aspirate`	Aspirate desired volume of reagent.
`dispense`	Dispense desired volume of reagent.
`getState`	Get the settings of the pump.
`home`	Home the pump.
`setSpeed`	Set the speed of the pump.
`reverse`	Reverse the pump.
`setChannel`	Set the channel
`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 TriContinent class.

PARAMETER	DESCRIPTION
`port`	The port of the pump. TYPE: `str`
`capacity`	The capacity of the pump. Defaults to 1000.0. TYPE: `float` DEFAULT: `1000.0`
`output_right`	Whether the output valve is to the right. TYPE: `bool`
`channel`	The channel of the pump. Defaults to 1. TYPE: `int` DEFAULT: `1`
`verbose`	Whether to output extra information. Defaults to False. TYPE: `bool` DEFAULT: `False`
`simulation`	Whether to simulate the pump. Defaults to False. TYPE: `bool` DEFAULT: `False`

acceleration `property`

acceleration

Acceleration of the pump

init_status `property`

init_status

Initialization status of the pump

start_speed `property`

start_speed

Start speed of the pump

valve_position `property`

valve_position

Valve position of the pump

aspirate

aspirate(
    volume: float,
    speed: float | None = None,
    reagent: str | None = None,
    *,
    start_speed: int | None = None,
    pullback: bool = False,
    delay: int = 0,
    pause: bool = False,
    ignore: bool = False,
    blocking: bool = True,
    **kwargs,
) -> bool

Aspirate desired volume of reagent

PARAMETER	DESCRIPTION
`volume`	target volume TYPE: `float`
`speed`	speed to aspirate at. Defaults to None. TYPE: `float \| None` DEFAULT: `None`
`reagent`	name of reagent. Defaults to None. TYPE: `str \| None` DEFAULT: `None`
`start_speed`	start speed of the pump. Defaults to None. TYPE: `int \| None` DEFAULT: `None`
`pullback`	whether to perform pullback. Defaults to False. TYPE: `bool` DEFAULT: `False`
`delay`	time delay after aspirate. Defaults to 0. TYPE: `int` DEFAULT: `0`
`pause`	whether to pause for user intervention. Defaults to False. TYPE: `bool` DEFAULT: `False`
`ignore`	whether to aspirate reagent regardless. Defaults to False. TYPE: `bool` DEFAULT: `False`
`blocking`	whether to block the thread until the action is complete. Defaults to True. TYPE: `bool` DEFAULT: `True`

RETURNS	DESCRIPTION
`bool`	whether the action is successful TYPE: `bool`

dispense

dispense(
    volume: float,
    speed: float | None = None,
    *,
    start_speed: int | None = None,
    blowout: bool = False,
    delay: int = 0,
    pause: bool = False,
    ignore: bool = False,
    blocking: bool = True,
    **kwargs,
) -> bool

Dispense desired volume of reagent

PARAMETER	DESCRIPTION
`volume`	target volume TYPE: `float`
`speed`	speed to dispense at. Defaults to None. TYPE: `float \| None` DEFAULT: `None`
`start_speed`	start speed of the pump. Defaults to None. TYPE: `int \| None` DEFAULT: `None`
`blowout`	whether perform blowout. Defaults to False. TYPE: `bool` DEFAULT: `False`
`delay`	time delay after dispense. Defaults to 0. TYPE: `int` DEFAULT: `0`
`pause`	whether to pause for user intervention. Defaults to False. TYPE: `bool` DEFAULT: `False`
`ignore`	whether to dispense reagent regardless. Defaults to False. TYPE: `bool` DEFAULT: `False`
`blocking`	whether to block the thread until the action is complete. Defaults to True. TYPE: `bool` DEFAULT: `True`

RETURNS	DESCRIPTION
`bool`	whether the action is successful TYPE: `bool`

getState

getState() -> dict[str, int | str | bool]

Get the settings of the pump.

RETURNS	DESCRIPTION
`dict[str, int \| str \| bool]`	dict[str, int\|str\|bool]: The settings of the pump.

home

home()

Home the pump.

reverse

reverse()

Reverse the pump.

setChannel

setChannel()

Set the channel of the pump.

setSpeed

setSpeed(speed: float)

Set the speed of the pump.

PARAMETER	DESCRIPTION
`speed`	The speed of the pump. TYPE: `float`