Transfer Gui

This module contains the GUI panel for controlling liquid handling devices.

ATTRIBUTE	DESCRIPTION
`PRECISION`	The number of decimal places to display for liquid volumes TYPE: `int`
`TICK_INTERVAL`	The interval between ticks on the volume scale TYPE: `int`
`BUTTON_HEIGHT`	The height of the buttons in the panel TYPE: `int`
`BUTTON_WIDTH`	The width of the buttons in the panel TYPE: `int`
`SCALE_LENGTH`	The length of the volume scale in the panel TYPE: `int`

CLASS	DESCRIPTION
`Liquid`	A protocol for liquid handling devices
`LiquidPanel`	A GUI panel for controlling liquid handling devices

Documentation last updated: 2025-02-22

LiquidPanel

LiquidPanel(principal: Liquid | Proxy | None = None)

Bases: Panel

LiquidPanel is a GUI panel for controlling liquid handling devices

ATTRIBUTE	DESCRIPTION
`principal`	The liquid handling device to control TYPE: `Liquid \| Proxy \| None`
`title`	The title of the panel TYPE: `str`
`status`	The status of the liquid handling device TYPE: `str`
`reagent`	The current reagent in the liquid handling device TYPE: `str`
`capacity`	The capacity of the liquid handling device TYPE: `float`
`volume`	The current volume of liquid in the liquid handling device TYPE: `float`
`channel`	The current channel of the liquid handling device TYPE: `int`
`tip_on`	The status of the tip on the liquid handling device TYPE: `bool`
`volume_field`	The volume to aspirate/dispense TYPE: `float`
`speed_field`	The speed to aspirate/dispense TYPE: `float`
`button_height`	The height of the buttons in the GUI panel. TYPE: `int`
`button_width`	The width of the buttons in the GUI panel. TYPE: `int`
`precision`	The number of decimal places to which to round the robot's position and orientation. TYPE: `int`
`tick_interval`	The interval between tick marks on the rotation scales. TYPE: `int`

METHOD	DESCRIPTION
`update`	Update the status of the liquid handling device
`refresh`	Refresh the GUI panel
`addTo`	Add the GUI panel to a master widget
`aspirate`	Aspirate a volume of liquid from a container
`blowout`	Blowout the liquid from the pipette
`dispense`	Dispense a volume of liquid from the pipette
`empty`	Empty the liquid from the pipette
`fill`	Fill the pipette with liquid
`volumeTo`	Adjust the volume of liquid in the pipette to a specific value
`attach`	Attach a tip to the pipette
`eject`	Eject the tip from the pipette
`toggleTip`	Toggle the tip on the pipette
`bindObject`	Bind a principal object to the Panel.
`releaseObject`	Release the principal object from the Panel.
`bindWidget`	Bind a tkinter.Tk object to the Panel.
`releaseWidget`	Release the tkinter.Tk object from the Panel.
`show`	Show the Panel.
`close`	Close the Panel.
`getAttribute`	Get an attribute from the principal object.
`getAttributes`	Get multiple attributes from the principal object.
`execute`	Execute a method from the principal object.
`addPack`	Add a Panel to the layout using the pack geometry manager.
`addGrid`	Add a Panel to the layout using the grid geometry manager.
`addPanel`	Add a Panel to the layout.
`clearPanels`	Clear all the Panels from the layout.
`updateStream`	Update the Panel continuously.

Initialize the LiquidPanel

PARAMETER	DESCRIPTION
`principal`	The liquid handling device to control TYPE: `Liquid \| Proxy \| None` DEFAULT: `None`

aspirate(
    volume: float,
    speed: float | str | None = None,
    reagent: str | None = None,
)

Aspirate a volume of liquid from a container

PARAMETER	DESCRIPTION
`volume`	The volume of liquid to aspirate TYPE: `float`
`speed`	The speed at which to aspirate the liquid TYPE: `float \| str` DEFAULT: `None`
`reagent`	The reagent to aspirate TYPE: `str` DEFAULT: `None`

attach()

Attach a tip to the pipette

blowout()

Blowout the liquid from the pipette

dispense(volume: float, speed: float | str | None = None)

Dispense a volume of liquid from the pipette

PARAMETER	DESCRIPTION
`volume`	The volume of liquid to dispense TYPE: `float`
`speed`	The speed at which to dispense the liquid TYPE: `float \| str` DEFAULT: `None`

eject()

Eject the tip from the pipette

empty(speed: float | str | None = None)

Empty the liquid from the pipette

PARAMETER	DESCRIPTION
`speed`	The speed at which to empty the liquid TYPE: `float \| str` DEFAULT: `None`

fill(
    speed: float | str | None = None,
    reagent: str | None = None,
)

Fill the pipette with liquid

PARAMETER	DESCRIPTION
`speed`	The speed at which to fill the pipette TYPE: `float \| str` DEFAULT: `None`
`reagent`	The reagent to fill the pipette with TYPE: `str` DEFAULT: `None`

toggleTip()

Toggle the tip on the pipette

volumeTo(
    volume: float,
    speed: float | str | None = None,
    reagent: str | None = None,
)

Adjust the volume of liquid in the pipette to a specific value

PARAMETER	DESCRIPTION
`volume`	The volume to adjust to TYPE: `float`
`speed`	The speed at which to adjust the volume TYPE: `float \| str` DEFAULT: `None`
`reagent`	The reagent to use for the adjustment TYPE: `str` DEFAULT: `None`