class instructions.RoMa(action: int, distance: float, force: int, xOffset: float, yOffset: float, zOffset: float, xyzSpeed: float, xyzMax: int, romaNo: int)

Bases: EvoScriPy.Instruction_Base.Instruction

15.60 Move RoMa Command This command is used to carry out simple RoMa movements without using a RoMa vector: The parameters of the Move RoMa command are as follows:

• ROMA-No.

Choose the RoMa you want to use (1 or 2) if your instrument is fitted with more than one.

• Open Gripper

This opens the gripper to the specified width (range: 55 to 140 mm).

Close Gripper

This closes the gripper to the specified width (range: 55 to 140 mm) using the specified force (range: 0 to 249). A Grip Error message will be output if no resistance is detected when gripping.

• Move to home position

This moves the RoMa to the specified home position. After completing a sequence of movements with the RoMa, you should move it back to its home (parking) position, out of the way of other objects on the worktable (see 9.6.4 “Defining the Home Position for a RoMa”,  9-63).

• Move relative to current position

This moves the RoMa relative to its current position. You must then specify the relative distances (range: -400 to 400 mm) and whether the RoMa should move at a particular speed (range: 0.1 to 400 mm/s) or at maximum speed. The movements in A and B are not aligned with the instrument axes, but with the current rotator position (angle). The movement in A is perpendicular to the gripper. Example #1: If the gripper points to the front (angle = 0°) and the A value is positive, then the RoMA will move to the left. Example #2: If the gripper points to the left (angle = 90°) and the A value is positive, then the RoMA will move to the back. The movement in B is in line with the gripper. Example #1: If the gripper points to the front (angle = 0°) and the B value is positive, then the RoMA will move to the front. Example #2: If the gripper points to the left (angle = 90°) and the B value is positive, then the RoMA will move to the left. See also 9.4.8.2 “RoMa Coordinate System”,  9-39.

RoMa_1 = 0

RoMa_2 = 1

__init__(action: int, distance: float, force: int, xOffset: float, yOffset: float, zOffset: float, xyzSpeed: float, xyzMax: int, romaNo: int)

Parameters:

• action – 0 = open gripper, 1 = close, 2 = move to home position, 3 = move relative to current position
• distance – 55 - 140, gripper distance in mm for opening or closing
• force – 0 - 249, force when closing gripper
• xOffset – -400 - 400, x-distance for relative move in mm
• yOffset (object) – -400 - 400, y-distance for relative move in mm
• zOffset – -400 - 400, z-distance for relative move in mm
• xyzSpeed – 0.1 - 400, speed in mm/s
• xyzMax – 0 = use xyzSpeed, 1 = use maximum speed
• romaNo – number of the RoMa performing the action: 0 = RoMa 1, 1 = RoMa 2

actualize_robot_state()

close_gripper = 1

home_position = 3

move_relative = 4

move_to = 2

open_gripper = 0

use_max_speed = 1

use_xyzSpeed = 0

validate_arg()

class instructions.activate_PMP(tipMask=None)

Bases: EvoScriPy.Instruction_Base.Instruction

A.15.4.12 Activate PMP (Worklist: Activate_PMP)

__init__(tipMask=None)

Initialize self. See help(type(self)) for accurate signature.

exec(mode=None)

validate_arg()

class instructions.active_Wash(wait=True, time=None, arm=None)

Bases: EvoScriPy.Instruction_Base.Instruction

A.15.4.16 Active WashStation (Worklist: Active_Wash)

__init__(wait=True, time=None, arm=None)

Initialize self. See help(type(self)) for accurate signature.

validate_arg()

class instructions.aspirate(tipMask=None, liquidClass=None, volume=None, labware=None, spacing=1, wellSelection=None, LoopOptions=[], RackName=None, Well=None, arm=None)

Bases: EvoScriPy.Instruction_Base.Pipetting

A.15.4.1 Aspirate command (Worklist: Aspirate) A - 125

__init__(tipMask=None, liquidClass=None, volume=None, labware=None, spacing=1, wellSelection=None, LoopOptions=[], RackName=None, Well=None, arm=None)

Parameters:

• liquidClass –
• volume –
• tipMask – int; selected tips, bit-coded (tip1 = 1, tip8 = 128)
• labware – Labware;
• spacing – int; tip spacing
• wellSelection – str;
• LoopOptions – list; of objects of class LoopOption.
• RackName –
• Well –
• arm –

static action()

validate_arg()

Evoware visual script generator enforce a compatibility between the arguments mask_tip and well selection. If they are not compatible the robot crash. :return:

class instructions.comment(text)

Bases: EvoScriPy.Instruction_Base.Instruction

A.15.4.21 Comment (Worklist: Comment)

__init__(text)

validate_arg()

class instructions.deactivate_PMP(tipMask=None)

Bases: EvoScriPy.Instruction_Base.Instruction

A.15.4.13 Deactivate PMP (Worklist: Deactivate_PMP)

__init__(tipMask=None)

Initialize self. See help(type(self)) for accurate signature.

exec(mode=None)

validate_arg()

class instructions.detect_Liquid(tipMask=None, liquidClass=None, labware=None, spacing=1, wellSelection=None, LoopOptions=None, arm=None, RackName=None, Well=None)

Bases: EvoScriPy.Instruction_Base.Pipetting

A.15.4.11 Detect Liquid (Worklist: Detect_Liquid) Liquid level detection is one of the options available for aspirating and dispensing and can be individually defined for each liquid class. The Detect Liquid command is used to carry out liquid level detection without pipetting and reports the liquid volume for each of the chosen wells in the labware. The volumes are returned in a set of variables DETECTED_VOLUME_x, where x is the tip number.

__init__(tipMask=None, liquidClass=None, labware=None, spacing=1, wellSelection=None, LoopOptions=None, arm=None, RackName=None, Well=None)

Set labware to match wells.

Parameters:

• name – str; Instruction name
• tipMask – int; selected tips, bit-coded (tip1 = 1, tip8 = 128)
• labware – Labware; grid 1-67, site 0-127, the labware with the selected wells
• spacing – int; Tip Spacing The Tip Spacing parameter controls the distance between adjacent pipetting tips for this command. You can choose a different tip spacing for the source labware and the destination labware. Tip spacing is only relevant if you want to use more than one tip. A tip spacing of 1 means that the tips will be spread to match the distance between adjacent wells in the labware. A tip spacing of 2 will select every other well in the labware. You can only choose values for tip spacing which are meaningful for the labware geometry. The liquid handling arm achieves the highest mechanical accuracy when the tips are not spread. For high-density labware such as 1536-well microplates, you should choose tip spacing such that the tips are adjacent to one another (physical tip spacing 9 mm). Accordingly, for 1536-well microplates you should set tip spacing to 4 (every fourth well).
• wellSelection – str; list of wells. Converted to bit-coded well selection to be used.
• LoopOptions – list; of objects of class LoopOption.
• RackName –
• Well –
• arm –

static action()

class instructions.dispense(tipMask=None, liquidClass=None, volume=[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], labware=None, spacing=1, wellSelection=None, LoopOptions=[], RackName=None, Well=None, arm=None)

Bases: EvoScriPy.Instruction_Base.Pipetting

A.15.4.2 Dispense (Worklist: Dispense)

__init__(tipMask=None, liquidClass=None, volume=[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], labware=None, spacing=1, wellSelection=None, LoopOptions=[], RackName=None, Well=None, arm=None)

Set labware to match wells.

Parameters:

• name – str; Instruction name
• tipMask – int; selected tips, bit-coded (tip1 = 1, tip8 = 128)
• labware – Labware; grid 1-67, site 0-127, the labware with the selected wells
• spacing – int; Tip Spacing The Tip Spacing parameter controls the distance between adjacent pipetting tips for this command. You can choose a different tip spacing for the source labware and the destination labware. Tip spacing is only relevant if you want to use more than one tip. A tip spacing of 1 means that the tips will be spread to match the distance between adjacent wells in the labware. A tip spacing of 2 will select every other well in the labware. You can only choose values for tip spacing which are meaningful for the labware geometry. The liquid handling arm achieves the highest mechanical accuracy when the tips are not spread. For high-density labware such as 1536-well microplates, you should choose tip spacing such that the tips are adjacent to one another (physical tip spacing 9 mm). Accordingly, for 1536-well microplates you should set tip spacing to 4 (every fourth well).
• wellSelection – str; list of wells. Converted to bit-coded well selection to be used.
• LoopOptions – list; of objects of class LoopOption.
• RackName –
• Well –
• arm –

static action()

validate_arg()

Evoware visual script generator enforce a compatibility between the arguments mask_tip and well selection. If they are not compatible the robot crash. :return:

class instructions.dropDITI(tipMask=None, labware=None, AirgapVolume=0, AirgapSpeed=300, arm=None)

Bases: EvoScriPy.Instruction_Base.Pipette

A.15.4.6 Drop DITIs command (Worklist: DropDITI). pag A - 130 and 15 - 14

__init__(tipMask=None, labware=None, AirgapVolume=0, AirgapSpeed=300, arm=None)

Parameters:

• conditional – exec only if there are some tip to droop.
• tipMask –
• labware – Specify the worktable position for the DITI waste you want to use. You must first put a DITI waste in the Worktable at the required position.
• AirgapVolume – floating point, 0 - 100. airgap in μl which is aspirated after dropping the DITIs
• AirgapSpeed – int 1-1000. Speed for the airgap in μl/s
• arm –

actualize_robot_state()

exec(mode=None)

validate_arg()

Evoware visual script generator enforce a compatibility between the arguments mask_tip and well selection. If they are not compatible the robot crash. :return:

class instructions.execute(application, options, responseVariable, scope=0)

Bases: EvoScriPy.Instruction_Base.Instruction

A.15.4.20 Execute Application (Worklist: Execute)

__init__(application, options, responseVariable, scope=0)

validate_arg()

class instructions.execute_VBscript(filename, action=0)

Bases: EvoScriPy.Instruction_Base.Instruction

A.15.4.24 Execute VB Script (Worklist: Execute_VBscript)

__init__(filename, action=0)

Parameters:

• filename – Path and filename of the defined VB script.
• action – Use Waits, Continues and Waits_previous defined in subroutine

validate_arg()

class instructions.export(exportAll=True, formats=32, delete=False, compress=False, Raks=None, significantStep=1)

Bases: EvoScriPy.Instruction_Base.Instruction

A.15.4.17 Export Data (Worklist: Export)

__init__(exportAll=True, formats=32, delete=False, compress=False, Raks=None, significantStep=1)

Initialize self. See help(type(self)) for accurate signature.

dbase = 2

excel = 4

lotus = 1

paradox = 8

quattro = 16

text_with_delimiters = 32

validate_arg()

class instructions.getDITI(tipMask, type, options=0, arm=None)

Bases: EvoScriPy.Instruction_Base.DITIs

__init__(tipMask, type, options=0, arm=None)

A.15.4.5 Get DITIs (Worklist: GetDITI) …

The Get DITIs command is used to pick up DITIs (disposable tips) of the specified type from a DITI rack. Freedom EVOware keeps track of their position on the worktable and automatically picks up the next available unused DITIs of the chosen type. When you choose a DITI type in a script command, the pull-down list all of the LiHa DITI types which are currently configured in the labware database. When you want to pick up a DiTi, Freedom EVOware searches the worktable for a DITI rack which contains the DITI type you have specified in the script command. To configure Freedom EVOware for a new DITI type, create a new DITI rack or duplicate an existing DITI rack and give the new labware a suitable name (e.g. “ZipTip”). DiTi Index: Freedom EVOware automatically assigns a unique numeric index to each DITI type. You cannot edit the index manually. The DITI index is used e.g. by the Set DITI Type command in worklists and in advanced worklists. The DITI index is shown in the Edit Labware dialog box for the DITI labware (Well Dimensions tab). This function is deprecated in favor of getDITI2 which do not use index Currently only use … ?

Parameters:

• label –
• tipMask –
• type – int, 0-3. DITI index (see 9.4.5 “Labware Types and DITI Types”,  9-32, DITI Index).

validate_arg()

class instructions.getDITI2(tipMask=None, DITI_series: (<class 'str'>, <class 'EvoScriPy.labware.DITIrackType'>, <class 'EvoScriPy.labware.DITIrack'>, <class 'EvoScriPy.labware.DITIrackTypeSeries'>) = None, options=0, arm=None, AirgapVolume=0, AirgapSpeed=300)

Bases: EvoScriPy.Instruction_Base.DITIs

A.15.4.5 Get DITIs (Worklist: GetDITI) pag. A - 129 It take a labware type or name instead of the labware itself because the real robot take track of the next position to pick including the rack and the site (that is - the labware). It need a labware type and it know where to pick the next tip.

__init__(tipMask=None, DITI_series: (<class 'str'>, <class 'EvoScriPy.labware.DITIrackType'>, <class 'EvoScriPy.labware.DITIrack'>, <class 'EvoScriPy.labware.DITIrackTypeSeries'>) = None, options=0, arm=None, AirgapVolume=0, AirgapSpeed=300)

Parameters:

• tipMask –
• DITI_series – string or labware or labware_.Type? DiTi labware name
• options –
• arm –
• AirgapVolume – int. used to specify a system trailing airgap (STAG) which will be aspirated after mounting the DITIs. Volume in μl
• AirgapSpeed – int. Speed for the airgap in μl/s

actualize_robot_state()

exec(mode=None)

validate_arg()

class instructions.group(titel)

Bases: EvoScriPy.Instruction_Base.ScriptONLY

UNDOCUMENTED. Begging a group. MANUALLY set the group_end() !!!!

__init__(titel)

validate_arg()

class instructions.group_end

Bases: EvoScriPy.Instruction_Base.ScriptONLY

UNDOCUMENTED. Begging a group. MANUALLY set the group_end() !!!!

__init__()

validate_arg()

class instructions.mix(tipMask=None, liquidClass=None, volume=[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], labware=None, spacing=1, wellSelection=None, cycles=3, LoopOptions=[], RackName=None, Well=None, arm=None)

Bases: EvoScriPy.Instruction_Base.Pipetting

A.15.4.3 Mix (Worklist: Mix)

__init__(tipMask=None, liquidClass=None, volume=[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], labware=None, spacing=1, wellSelection=None, cycles=3, LoopOptions=[], RackName=None, Well=None, arm=None)

Set labware to match wells.

Parameters:

• name – str; Instruction name
• tipMask – int; selected tips, bit-coded (tip1 = 1, tip8 = 128)
• labware – Labware; grid 1-67, site 0-127, the labware with the selected wells
• spacing – int; Tip Spacing The Tip Spacing parameter controls the distance between adjacent pipetting tips for this command. You can choose a different tip spacing for the source labware and the destination labware. Tip spacing is only relevant if you want to use more than one tip. A tip spacing of 1 means that the tips will be spread to match the distance between adjacent wells in the labware. A tip spacing of 2 will select every other well in the labware. You can only choose values for tip spacing which are meaningful for the labware geometry. The liquid handling arm achieves the highest mechanical accuracy when the tips are not spread. For high-density labware such as 1536-well microplates, you should choose tip spacing such that the tips are adjacent to one another (physical tip spacing 9 mm). Accordingly, for 1536-well microplates you should set tip spacing to 4 (every fourth well).
• wellSelection – str; list of wells. Converted to bit-coded well selection to be used.
• LoopOptions – list; of objects of class LoopOption.
• RackName –
• Well –
• arm –

static action()

actualize_robot_state()

validate_arg()

Evoware visual script generator enforce a compatibility between the arguments mask_tip and well selection. If they are not compatible the robot crash. :return:

class instructions.moveLiha(zMove, zTarget, offset, speed, tipMask=None, labware=None, spacing=1, wellSelection=None, LoopOptions=[], RackName=None, Well=None, arm=None)

Bases: EvoScriPy.Instruction_Base.Pipette

A.15.4.14 Move LiHa (Worklist: MoveLiha - A - 135)see 15.21 “Move LiHa Command”, 15-33. The Move LiHa command is used to move the liquid handling arm (LiHa) from one position to another without performing an Aspirate or Dispense operation. Type of movement Choose X-Move, Y-Move or Z-Move to move only one axis of the LiHa. You can then specify the speed of the movement. Z-Move only moves the selected tips. The options Positioning with global Z-travel, Positioning with local Z-travel and Positioning with variable Z-travel move the LiHa to the labware at maximum speed. The chosen height for Z-Travel (the tip height which is used during the arm movement) only applies to the selected tips. The Z position of the unselected tips remains unchanged. If you choose Positioning with variable Z-travel, the required Z-Travel height is specified using the pre-defined variable LIHA_MOVE_HEIGHT (see 14.1.4.7 “LIHA_MOVE_HEIGHT”,  14-5). Z-Position Unless you have chosen X-Move or Y-Move in the Type of Movement field, you can specify the Z-Position to which the selected tips should be lowered at the end of the LiHa movement. The Z position of the unselected tips remains unchanged. Choose the required Z-position and then specify a Z offset in mm if required. A positive value for the offset lowers the tips.

__init__(zMove, zTarget, offset, speed, tipMask=None, labware=None, spacing=1, wellSelection=None, LoopOptions=[], RackName=None, Well=None, arm=None)

Parameters:

• zMove – int; type of movement: 0 = positioning with global z-travel 1 = positioning with local z-travel 2 = x-move 3 = y-move 4 = z-move
• zTarget – int; z-position after move: 0 = z-travel 1 = z-dispense 2 = z-start 3 = z-max 4 = global z-travel
• offset – float; in range (-1000, 1000) offset in mm added to z-position (parameter z_target)
• speed – float; in range (0.1, 400) move speed in mm/s if z_move is x-move, y-move or z-move
• tipMask – int; selected tips, bit-coded (tip1 = 1, tip8 = 128)
• labware – Labware;
• spacing – int; tip spacing
• wellSelection – str; bit-coded well selection
• LoopOptions – list; of objects of class LoopOption.
• RackName –
• Well –
• arm –

global_z_travel = 4

pos_global_z_travel = 0

pos_local_z_travel = 1

validate_arg()

Evoware visual script generator enforce a compatibility between the arguments mask_tip and well selection. If they are not compatible the robot crash. :return:

x_move = 2

y_move = 3

z_dispense = 1

z_max = 3

z_move = 4

z_start = 2

z_travel = 0

class instructions.notification(receiverGroup, AttachScreen_ShotFlag=False, emailSubject='', emailMessage='', action=0)

Bases: EvoScriPy.Instruction_Base.Instruction

A.15.4.25 Notification (Worklist: Notification)

__init__(receiverGroup, AttachScreen_ShotFlag=False, emailSubject='', emailMessage='', action=0)

Parameters:

• receiverGroup –
• AttachScreen_ShotFlag –
• emailSubject –
• action – 0 = send email now, 1 = send email on error, 2 = stop sending email on error

validate_arg()

class instructions.pickUp_DITIs(tipMask=None, labware=None, wellSelection=None, LoopOptions=[], type=None, arm=None, RackName=None, Well=None)

Bases: EvoScriPy.Instruction_Base.Pipette

A.15.4.8 Pick Up DITIs (Worklist: Pick Up_DITI) pag. A-131 and 15-16 The Pick Up DITIs command is used to pick up DITIs which have already been used and put back into a DITI rack with the Set DITIs Back command. You must specify the DITIs you want to pick up.

__init__(tipMask=None, labware=None, wellSelection=None, LoopOptions=[], type=None, arm=None, RackName=None, Well=None)

Set labware to match wells.

Parameters:

• name – str; Instruction name
• tipMask – int; selected tips, bit-coded (tip1 = 1, tip8 = 128)
• labware – Labware; grid 1-67, site 0-127, the labware with the selected wells
• spacing – int; Tip Spacing The Tip Spacing parameter controls the distance between adjacent pipetting tips for this command. You can choose a different tip spacing for the source labware and the destination labware. Tip spacing is only relevant if you want to use more than one tip. A tip spacing of 1 means that the tips will be spread to match the distance between adjacent wells in the labware. A tip spacing of 2 will select every other well in the labware. You can only choose values for tip spacing which are meaningful for the labware geometry. The liquid handling arm achieves the highest mechanical accuracy when the tips are not spread. For high-density labware such as 1536-well microplates, you should choose tip spacing such that the tips are adjacent to one another (physical tip spacing 9 mm). Accordingly, for 1536-well microplates you should set tip spacing to 4 (every fourth well).
• wellSelection – str; list of wells. Converted to bit-coded well selection to be used.
• LoopOptions – list; of objects of class LoopOption.
• RackName –
• Well –
• arm –

actualize_robot_state()

validate_arg()

Evoware visual script generator enforce a compatibility between the arguments mask_tip and well selection. If they are not compatible the robot crash. :return:

class instructions.pickUp_DITIs2(tipMask=None, labware=None, wellSelection=None, LoopOptions=[], arm=None, RackName=None, Well=None)

Bases: EvoScriPy.Instruction_Base.Pipette

A.15.4.8 Pick Up DITIs (Worklist: Pick Up_DITI) pag. A-131 and 15-16

NOT DOCUMENTED

The Pick Up DITIs command is used to pick up DITIs which have already been used and put back into a DITI rack with the Set DITIs Back command. You must specify the DITIs you want to pick up.

__init__(tipMask=None, labware=None, wellSelection=None, LoopOptions=[], arm=None, RackName=None, Well=None)

Set labware to match wells.

Parameters:

• name – str; Instruction name
• tipMask – int; selected tips, bit-coded (tip1 = 1, tip8 = 128)
• labware – Labware; grid 1-67, site 0-127, the labware with the selected wells
• spacing – int; Tip Spacing The Tip Spacing parameter controls the distance between adjacent pipetting tips for this command. You can choose a different tip spacing for the source labware and the destination labware. Tip spacing is only relevant if you want to use more than one tip. A tip spacing of 1 means that the tips will be spread to match the distance between adjacent wells in the labware. A tip spacing of 2 will select every other well in the labware. You can only choose values for tip spacing which are meaningful for the labware geometry. The liquid handling arm achieves the highest mechanical accuracy when the tips are not spread. For high-density labware such as 1536-well microplates, you should choose tip spacing such that the tips are adjacent to one another (physical tip spacing 9 mm). Accordingly, for 1536-well microplates you should set tip spacing to 4 (every fourth well).
• wellSelection – str; list of wells. Converted to bit-coded well selection to be used.
• LoopOptions – list; of objects of class LoopOption.
• RackName –
• Well –
• arm –

actualize_robot_state()

validate_arg()

Evoware visual script generator enforce a compatibility between the arguments mask_tip and well selection. If they are not compatible the robot crash. :return:

class instructions.pickUp_ZipTip(tipMask=None)

Bases: EvoScriPy.Instruction_Base.Pipette

A.15.4.10 Pickup ZipTip (Worklist: PickUp_ZipTip)

__init__(tipMask=None)

Set labware to match wells.

Parameters:

• name – str; Instruction name
• tipMask – int; selected tips, bit-coded (tip1 = 1, tip8 = 128)
• labware – Labware; grid 1-67, site 0-127, the labware with the selected wells
• spacing – int; Tip Spacing The Tip Spacing parameter controls the distance between adjacent pipetting tips for this command. You can choose a different tip spacing for the source labware and the destination labware. Tip spacing is only relevant if you want to use more than one tip. A tip spacing of 1 means that the tips will be spread to match the distance between adjacent wells in the labware. A tip spacing of 2 will select every other well in the labware. You can only choose values for tip spacing which are meaningful for the labware geometry. The liquid handling arm achieves the highest mechanical accuracy when the tips are not spread. For high-density labware such as 1536-well microplates, you should choose tip spacing such that the tips are adjacent to one another (physical tip spacing 9 mm). Accordingly, for 1536-well microplates you should set tip spacing to 4 (every fourth well).
• wellSelection – str; list of wells. Converted to bit-coded well selection to be used.
• LoopOptions – list; of objects of class LoopOption.
• RackName –
• Well –
• arm –

class instructions.set_DITI_Counter(type=None, posInRack=0, labware=None)

Bases: EvoScriPy.Instruction_Base.Pipette

A.15.4.7 Set Diti Position (Worklist: Set_DITI_Counter) pag. 15 - 15

If you are using DITIs, Freedom EVOware remembers the position in the DITI

rack of the last DITI which was fetched. When starting a new run, the Get DITIs command starts picking up DITIs at the next available position. After loading a new DITI rack onto the worktable during script runtime (e.g. using the RoMa), you should use the Set DITI Position command in your script to set the DITI Position counter to 1. This ensures that the next DITI is fetched from position 1 rather than from the middle of the new rack. You can specify the next position separately for each of the available DITI types (i.e. DITI racks on the worktable). Note: If you want to specify the next DITI position manually before the script or process is started, use the direct command Set DITI Position (see 5.4.1.3 “Direct commands”,  5-10) or create a maintenance script which contains the Set DITI Position command (see 6.4.2 “Run Maintenance”,  6-10). Note: DiTi handling is automatic in Freedom EVOware Plus. This command is only shown in the Control Bar if you are using DiTis on the LiHa. Freedom EVOware does not detect the LiHa tip type automatically. If you are using DITIs you must configure them manually (see 8.4.2.1 “LiHa (Liquid Handling Arm)”,  8-22). If your pipetting instrument is fitted with two liquid handling arms, the Set DITI Position command will be provided in the Control Bar for both arms. However, please note that the same DITI position counter (and the same pool of unused DITIs) is used by both arms.

__init__(type=None, posInRack=0, labware=None)

Set labware to match wells.

Parameters:

• name – str; Instruction name
• tipMask – int; selected tips, bit-coded (tip1 = 1, tip8 = 128)
• labware – Labware; grid 1-67, site 0-127, the labware with the selected wells
• spacing – int; Tip Spacing The Tip Spacing parameter controls the distance between adjacent pipetting tips for this command. You can choose a different tip spacing for the source labware and the destination labware. Tip spacing is only relevant if you want to use more than one tip. A tip spacing of 1 means that the tips will be spread to match the distance between adjacent wells in the labware. A tip spacing of 2 will select every other well in the labware. You can only choose values for tip spacing which are meaningful for the labware geometry. The liquid handling arm achieves the highest mechanical accuracy when the tips are not spread. For high-density labware such as 1536-well microplates, you should choose tip spacing such that the tips are adjacent to one another (physical tip spacing 9 mm). Accordingly, for 1536-well microplates you should set tip spacing to 4 (every fourth well).
• wellSelection – str; list of wells. Converted to bit-coded well selection to be used.
• LoopOptions – list; of objects of class LoopOption.
• RackName –
• Well –
• arm –

actualize_robot_state()

validate_arg()

Evoware visual script generator enforce a compatibility between the arguments mask_tip and well selection. If they are not compatible the robot crash. :return:

class instructions.set_DITI_Counter2(labware=None, posInRack=0, lastPos=False)

Bases: EvoScriPy.Instruction_Base.Pipette

A.15.4.7 Set Diti Position (Worklist: Set_DITI_Counter) NOT DOCUMENTED

example: Set_DITI_Counter2(“DiTi 1000ul”,”25”,”2”,”5”,0); last position

If you have activated the feature Optimize positions when fetching DITIs, Freedom EVOware fetches new DITIs either starting from the beginning of the DITI rack or starting from the end of the DITI rack, depending on the situation (see 8.4.2.1 “LiHa (Liquid Handling Arm)”,  8-22, Optimize positions when fetching DITIs). In this case, Freedom EVOware maintains two counters for the last used DITI position (for DITIs which are taken from the beginning of the rack and for DITIs which are taken from the end of the rack). Check this checkbox if you want to set the last used DITI position for the end counter instead of for the beginning counter. If you have activated the feature Optimize positions when fetching DITIs, after loading a new DITI rack onto the worktable during script runtime you should use the Set DITI Position command twice in your script, to set the beginning counter to 1 and the end counter to 96. The Set last position checkbox is inactive (grey) if you have not activated Optimize positions when fetching DITIs. If you have previously specified the last used DITI position, it will be ignored during script execution

__init__(labware=None, posInRack=0, lastPos=False)

Set labware to match wells.

Parameters:

• name – str; Instruction name
• tipMask – int; selected tips, bit-coded (tip1 = 1, tip8 = 128)
• labware – Labware; grid 1-67, site 0-127, the labware with the selected wells
• spacing – int; Tip Spacing The Tip Spacing parameter controls the distance between adjacent pipetting tips for this command. You can choose a different tip spacing for the source labware and the destination labware. Tip spacing is only relevant if you want to use more than one tip. A tip spacing of 1 means that the tips will be spread to match the distance between adjacent wells in the labware. A tip spacing of 2 will select every other well in the labware. You can only choose values for tip spacing which are meaningful for the labware geometry. The liquid handling arm achieves the highest mechanical accuracy when the tips are not spread. For high-density labware such as 1536-well microplates, you should choose tip spacing such that the tips are adjacent to one another (physical tip spacing 9 mm). Accordingly, for 1536-well microplates you should set tip spacing to 4 (every fourth well).
• wellSelection – str; list of wells. Converted to bit-coded well selection to be used.
• LoopOptions – list; of objects of class LoopOption.
• RackName –
• Well –
• arm –

actualize_robot_state()

validate_arg()

Evoware visual script generator enforce a compatibility between the arguments mask_tip and well selection. If they are not compatible the robot crash. :return:

class instructions.set_DITIs_Back(tipMask, labware: EvoScriPy.labware.DITIrack, wellSelection=None, LoopOptions=[], arm=None, RackName=None, Well=None)

Bases: EvoScriPy.Instruction_Base.Pipette

A.15.4.9 Set DITIs Back (Worklist: Set_DITIs_Back) return used DITIs to specified positions on a DITI rack for later use. This command requires the Lower DITI Eject option.

__init__(tipMask, labware: EvoScriPy.labware.DITIrack, wellSelection=None, LoopOptions=[], arm=None, RackName=None, Well=None)

Set labware to match wells.

Parameters:

• name – str; Instruction name
• tipMask – int; selected tips, bit-coded (tip1 = 1, tip8 = 128)
• labware – Labware; grid 1-67, site 0-127, the labware with the selected wells
• spacing – int; Tip Spacing The Tip Spacing parameter controls the distance between adjacent pipetting tips for this command. You can choose a different tip spacing for the source labware and the destination labware. Tip spacing is only relevant if you want to use more than one tip. A tip spacing of 1 means that the tips will be spread to match the distance between adjacent wells in the labware. A tip spacing of 2 will select every other well in the labware. You can only choose values for tip spacing which are meaningful for the labware geometry. The liquid handling arm achieves the highest mechanical accuracy when the tips are not spread. For high-density labware such as 1536-well microplates, you should choose tip spacing such that the tips are adjacent to one another (physical tip spacing 9 mm). Accordingly, for 1536-well microplates you should set tip spacing to 4 (every fourth well).
• wellSelection – str; list of wells. Converted to bit-coded well selection to be used.
• LoopOptions – list; of objects of class LoopOption.
• RackName –
• Well –
• arm –

actualize_robot_state()

validate_arg()

Evoware visual script generator enforce a compatibility between the arguments mask_tip and well selection. If they are not compatible the robot crash. :return:

class instructions.startTimer(timer=1)

Bases: EvoScriPy.Instruction_Base.Instruction

A.15.4.18 Start Timer (Worklist: StartTimer)

__init__(timer=1)

Parameters:timer (Expression) – expression, 1 - 100. number of timer to re-start. 1-1000?

validate_arg()

class instructions.subroutine(filename, action=0)

Bases: EvoScriPy.Instruction_Base.ScriptONLY

UNDOCUMENTED

Continues = 1

Waits = 0

Waits_previous = 2

__init__(filename, action=0)

validate_arg()

class instructions.transfer_rack(labware: EvoScriPy.labware.Labware, destination: EvoScriPy.labware.WorkTable.Location, vectorName: str = None, backHome: bool = True, slow: bool = True, lid: EvoScriPy.labware.Labware = None, cover: int = 0, romaNo: int = None)

Bases: EvoScriPy.Instruction_Base.Instruction

This command is used to transfer labware (e.g. a microplate) from one position to another with the plate robot (RoMa). If you have scanned the labware barcode and you move the labware with the Transfer Labware command, the barcode remains assigned to the labware (i.e. the labware data record) at the new location. In addition, pipetting information, if any, remains assigned to the labware (see 15.29 “Export Data Command”,  15- 50). Grip and release commands for the RoMa (used to pick up and put down the labware) are handled automatically. The required gripper spacing is taken from the advanced properties for the respective labware type (see 9.4.2 “Editing Labware, Advanced Tab”,  9-22): The parameters of the Transfer Labware command are as follows:

Move with

Choose the RoMa you want to use (1 or 2) if your instrument is fitted with more than one.

Vector

Choose the RoMa vector that you want to use to pick up the labware. Choose Narrow to pick up the labware on the narrow side; choose Wide to pick up the labware on the wide side. Choose User defined (Narrow) or (Wide) to pick up the labware on the narrow or wide side with a user-defined vector. In this case, you must choose the user-defined vector to use for picking up the labware at the source position and putting down it at the destination position in the two User Vector pull-down lists. User-defined vectors are created in the Control Bar (Robot Vectors section). See 5.4.1.4 “Robot Vectors”,  5-11. Above all if you did not create the user-defined vector yourself, we recommend you to check carefully that the vector moves the RoMa to the correct (i.e. intended) source and destination carrier positions before using it for pipetting. Tip: Test the RoMa vector in a script using the 3D simulation program EVOSim. Freedom EVOware will report an error when you complete the Transfer Labware command if the narrow or wide RoMa vector has not yet been created for the chosen labware type. It is best to create the required RoMa vectors in advance (see 9.6.2 “Teach Plate Robot Vector Dialog Box”,  9-60).

Transfer Labware command, Step 1

Specify the parameters for the source position:

• Source position

Select the current position of the labware by clicking on it in the Worktable Editor. Grid and Site then show the position you have chosen. The gray (protected) field Defined Carrier then shows the type of carrier at the chosen site and the gray (protected) field Defined Labware shows the type of labware at the chosen site. If you want to fetch the labware from a device such as a hotel or barcode scanner, click on the device icon. You then need to choose the site and the labware type. The list shows labware types which are allowed for the device (see 9.5 “Configuring Carriers”,  9-39, “Allowed Labware on this carrier”).

Transfer Labware command, Step 2

Specify the parameters for the labware lid. These parameters are only available for labware types which can be fitted with a lid:

• Lid handling

Check this checkbox if the labware has a lid. Choose Cover at source if you want to put on the lid before moving the labware. Choose Uncover at destination if you want to remove the lid after moving the labware to the destination position (i.e. the lid was already present). In either case, select the position for fetching or putting aside the lid by clicking on the site in the Worktable Editor. Grid and Site then show the position you have chosen. The gray (protected) field Defined Carrier shows the type of carrier on which the lid is placed/will be placed. You can only put aside lids on unused carrier sites.

Transfer Labware command, Step 3

Specify the parameters for the destination position:

• Destination Position

Select the required destination position of the labware by clicking on the site in the Worktable Editor. The destination site must be suitable for the labware type you are moving (see 9.5 “Configuring Carriers”,  9-39, “Allowed labware on this carrier”). Grid and Site then show the position you have chosen. The gray (protected) field Defined Carrier then shows the type of carrier at the chosen site. If you want to move the labware to a device such as a hotel or barcode scanner, click on the device icon. You then need to choose the site and the labware type. The list shows labware types which are allowed for the device (see 9.5 “Configuring Carriers”,  9-39, “Allowed Labware on this carrier”).

• Speed

Choose Maximum if you want the RoMa to move at maximum speed. Choose Taught in vector dialog if you want the RoMa to move at the speed specified in the RoMa vector.

• Move back to Home Position

Check this checkbox if you want the RoMa to move back to its home (parking) position after transferring the labware. See 9.6.4 “Defining the Home Position for a RoMa”,  9-63.

__init__(labware: EvoScriPy.labware.Labware, destination: EvoScriPy.labware.WorkTable.Location, vectorName: str = None, backHome: bool = True, slow: bool = True, lid: EvoScriPy.labware.Labware = None, cover: int = 0, romaNo: int = None)

Parameters:

• labware –
• destination –
• backHome – move back to home when finished ?
• lid –
• slow – use slow speed (as defined in RoMa vector)? (else use maximum speed)
• cover – 0 = cover at source , 1 = uncover at destination
• vectorName –

  name of RoMa vector to use (as in the Freedom EVOware configuration), choose from one of the following:

  Narrow DriveIN_Narrow DriveIN_Narrow DriveIN_Wide

• romaNo – number of the RoMa performing the action: 0 = RoMa 1, 1 = RoMa 2

actualize_robot_state()

validate_arg()

class instructions.userPrompt(text: str, sound: int = 1, closeTime: int = -1)

Bases: EvoScriPy.Instruction_Base.Instruction

A.15.4.22 User Prompt (Worklist: UserPrompt)

__init__(text: str, sound: int = 1, closeTime: int = -1)

validate_arg()

class instructions.variable(var_name, default, queryFlag=False, queryString='', checkLimits=False, lowerLimit=0.0, upperLimit=0.0, type=0, scope=0, InitMode=0, QueryAtStart=False)

Bases: EvoScriPy.Instruction_Base.Instruction

A.15.4.23 Set Variable (Worklist: Variable)

File_import = 2

Fixed_value = 0

Instance = 1

Numeric = 0

Run = 0

Script = 2

String = 1

User_query = 1

__init__(var_name, default, queryFlag=False, queryString='', checkLimits=False, lowerLimit=0.0, upperLimit=0.0, type=0, scope=0, InitMode=0, QueryAtStart=False)

Parameters:

• var_name – string2 ; name of variable
• default – Expression ; value assigned to variable or default value if user query
• queryFlag – bool
• queryString – String1 ; text shown in user query
• checkLimits – bool
• lowerLimit –
• upperLimit –
• type – type of variable; 0 = Numeric; 1 = String
• scope – scope of variable (see 6.4.6,  6-12):0 = Run; 1 = Instance; 2 = Script
• InitMode – 0 = Fixed value; 1 = User query; 2 = File import;
• QueryAtStart – bool ; 1 = Prompt for value at start of script

validate_arg()

class instructions.vector(name)

Bases: EvoScriPy.Instruction_Base.Instruction

15.61 RoMa Vector Command This command executes a RoMa vector, which is a predefined sequence of RoMa movements. You can also specify gripper actions at the Safe and End positions. See 9.6.1 “Using RoMa Vectors”,  9-59 for more information. The RoMa Vector command is intended for special RoMa movements and not for moving labware from one position to another - you should use the Transfer Labware command instead for this purpose. See also 15.61.1 “Moving labware with the RoMa Vector command”,  15-145. The parameters of the RoMa Vector command are as follows:

• RoMa-No.

Choose the RoMa you want to use (1 or 2) if your instrument is fitted with more than one.

• Use RoMa Vector

Choose the RoMa vector you want to use for the RoMa movement. The popup list shows the RoMa vectors which are currently defined in the Freedom EVOware database. The digit at the end of the vector name (e.g. Carousel_Narrow_1) indicates the RoMa for which the vector was defined (1 or 2). See also 9.6.1 “Using RoMa Vectors”,  9-59. You can also choose a user-defined vector. User-defined vectors are created in the Control Bar (Robot Vectors section). Then specify the grid position and carrier site for which the vector is intended. The Grid field is protected (gray) if you have chosen a vector for a device which is not positioned on the worktable (see Carrier is Device checkbox in the carrier definition). Tip: If you click on a carrier, the current grid position is shown in the small yellow tab at the bottom left.

• Move along RoMa Vector

Choose the required direction of the RoMa movement. Click And back if you want the RoMa to return to the Safe position after reaching the End position.

• Gripper action

Choose the gripper action which should be executed at the Safe position and at the End position. The required gripper spacing to pick up and release the labware is taken from the Grip Width and Release Width parameters in the chosen RoMa vector.

• Speed

Choose Maximum if you want the RoMa to move at maximum speed. Choose Slow if you want the RoMa to move at the speed specified in the RoMa vector.

15.61.1 Moving labware with the RoMa Vector command If you have scanned the labware barcode and you move the labware with the Transfer Labware command, the barcode remains assigned to the labware (i.e. the labware data record) at the new location. In addition, pipetting information, if any, remains assigned to the labware (see 15.29 “Export Data Command”,  15- 50). This is not the case with the RoMa Vector command. The barcode and the pipetting information are no longer available at the new location. This also applies analogously to the MCA96 Vector command and the MCA384 Vector command. Proceed as follows if you want to use a Vector command to move barcoded labware in special situations:  After scanning the barcode, assign it to a temporary variable (see

14.1.11 “Labware Attributes and String Variables”,  14-16).

 Move the labware.  Re-assign the barcode from the temporary variable to the labware. This workaround transfers the barcode but not the pipetting information.

class instructions.waitTimer(timer=1, timeSpan=None)

Bases: EvoScriPy.Instruction_Base.Instruction

A.15.4.19 Wait for Timer (Worklist: WaitTimer)

__init__(timer=1, timeSpan=None)

Parameters:

• timeSpan – expression, 0.02 - 86400. duration
• timer – expression, 1 - 100. number of timer to re-start. 1-1000?

validate_arg()

class instructions.wash_tips(tipMask=None, WashWaste=None, WashCleaner=None, wasteVol=100, wasteDelay=50, cleanerVol=10, cleanerDelay=50, Airgap=0.0, airgapSpeed=50, retractSpeed=100, FastWash=False, lowVolume=False, atFrequency=0, RackName=None, Well=None, arm=None)

Bases: EvoScriPy.Instruction_Base.Pipette

A.15.4.4 Wash Tips (Worklist: Wash) pag. A - 128; pag. 15 - 8.

to flush and wash fixed tips or to flush DITI

adapters using a wash station. It is not intended for flushing DITI tips (DITI tips should not normally be flushed). Tips should be washed as often as necessary, e.g. after a pipetting sequence and before taking a new sample. DITI adapters should be flushed after replacing the DITIs several times to renew the system liquid column in the DITI adapters. This ensures maximum pipetting accuracy.

__init__(tipMask=None, WashWaste=None, WashCleaner=None, wasteVol=100, wasteDelay=50, cleanerVol=10, cleanerDelay=50, Airgap=0.0, airgapSpeed=50, retractSpeed=100, FastWash=False, lowVolume=False, atFrequency=0, RackName=None, Well=None, arm=None)

Parameters:

• tipMask –
• WashWaste – labware ; the waste you want to use. You must first put a wash station with waste unit in the Worktable Editor at the required position.
• WashCleaner – labware ; the cleaner you want to use. You must first put a wash station with cleaner unit in the Worktable Editor at the required position. Choose a shallow cleaner if you only need to clean the ends of the tips. Choose a deep cleaner if there is a possibility of contamination along the shaft of the tip. The deep cleaner requires a larger volume of system liquid and cleaning takes somewhat longer. The wash cycle is skipped if you are flushing DITI adapters and Use Cleaner is ignored in this case.
• wasteVol – int ; volume [in mL !!] of system liquid which should be used to flush the inside of the tips. Flushing takes place with the tips positioned above the waste of the specified wash station (tip height for fixed tips = Z-dispense; tip height for DITI adapters = Z-travel).
• wasteDelay –
• cleanerVol – int ; Specify the volume of system liquid which should be used to wash the outside of the tips. Washing takes place with the tips lowered into the cleaner of the specified wash station (tip height = Z-max). The wash cycle is skipped if you are flushing DITI adapters and Volume in Cleaner is ignored in this case.
• cleanerDelay –
• Airgap –
• airgapSpeed –
• retractSpeed –
• FastWash –
• lowVolume –
• atFrequency –
• RackName –
• Well –
• arm –

validate_arg()

Evoware visual script generator enforce a compatibility between the arguments mask_tip and well selection. If they are not compatible the robot crash. :return:

class instructions.waste(action=0)

Bases: EvoScriPy.Instruction_Base.Instruction

A.15.4.15 Waste (Worklist: Waste)

__init__(action=0)

Initialize self. See help(type(self)) for accurate signature.

actions = range(0, 6)

activate_waste_1 = 1

activate_waste_2 = 2

activate_waste_3 = 3

deactivate_all_wastes = 4

deactivate_system = 5

init_system = 0

validate_arg()