device driver user guide
TRANSCRIPT
Device Driver User Guide
December 2005
VWorks3 version 22.x and BenchWorks version 18.x
Velocity113565 Haven AvenueMenlo Park CA 94025USA
Phone: 650-846-6600Fax: 650-846-6620Service: 1-800-979-4811Sales: 1-866-428-9811Email: [email protected]://www.velocity11.com
Copyright 2005 Velocity11
The information provided in this guide is intended to be accurate and reliable. However, Velocity11 does not assume responsibility for its use or for any infringements upon the rights of third parties that may result from its use.
The transfer of this guide, in any manner or form, to a representative of another company is strictly forbidden.
BioCel, BenchCel, PlateLoc, Velocity11, and VPrep are registered trademarks of Velocity11.
BenchWorks, IWorks, and VWorks are trademarks of Velocity11.
Microsoft and Windows are registered trademarks of the Microsoft Corporation in the United States and other countries.
All other trademarks are the sole property of their respective owners.
Table of ContentsDevice Driver User Guide
i
Chapter 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1Who should read this guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2About Velocity11 user guides . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3What this guide covers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5About devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7About profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8About diagnostics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Opening diagnostics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10About device drivers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Installing device drivers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Adding devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15Setting the properties for a device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Adding and configuring Sub Process tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Using JavaScript to set task parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Chapter 2. Analyst GT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Workflow for configuring the Analyst GT. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Creating an Analyst GT profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27Setting Analyst GT task parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Using Analyst GT Diagnostics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Chapter 3. Cavro Pump . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35Workflow for configuring the Cavro Pump. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Creating a Cavro Pump profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Setting the Cavro Pump task parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39Using Cavro Pump Diagnostics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Chapter 4. FlexDrop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47Workflow for configuring the FlexDrop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48Creating a FlexDrop profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49Setting FlexDrop task parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51Using FlexDrop Diagnostics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Contents
Table of ContentsDevice Driver User Guide
ii
Chapter 5. FLIPR Tetra . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59Workflow for configuring the FLIPR Tetra. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60Creating a FLIPR Tetra profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61About FLIPR Tetra device locations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63About FLIPR Tetra tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64Setting the FLIPR Tetra Change Instance task parameters . . . . . . . . . . . . . . . . . . . 65Setting the FLIPR Tetra Load Tips and Unload Tips task parameters. . . . . . . . . . . . 67Setting FLIPR Tetra Loop task parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68Setting FLIPR Tetra Run Protocol task parameters. . . . . . . . . . . . . . . . . . . . . . . . . 69Using FLIPR Tetra Diagnostics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Chapter 6. Generic RS-232 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75Workflow for configuring the Generic RS-232 driver . . . . . . . . . . . . . . . . . . . . . . . . 76Creating a Generic RS-232 profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77Setting the Generic RS-232 task parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78Using Generic RS-232 Diagnostics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Chapter 7. IN Cell Analyzer 1000 . . . . . . . . . . . . . . . . . . . . . . . 87Workflow for configuring the IN Cell Analyzer 1000 . . . . . . . . . . . . . . . . . . . . . . . . 88Creating an IN Cell Analyzer 1000 profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88Setting IN Cell Analyzer 1000 task parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . 91Using IN Cell Analyzer 1000 Diagnostics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Chapter 8. KiNEDx Robot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97Workflow for configuring the KiNEDx Robot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98Creating a KiNEDx Robot profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98Using KiNEDx Robot Diagnostics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
Chapter 9. LEADseeker. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105Workflow for configuring the LEADseeker . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106Creating a LEADseeker profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107Setting LEADseeker task parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108Using LEADseeker Diagnostics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
Table of ContentsDevice Driver User Guide
iii
Chapter 10. Multimek . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113Workflow for configuring the Multimek. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114Creating and managing Multimek profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115About the high-level Multimek tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119About the low-level Multimek tasks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121Setting high-level Multimek Aspirate task parameters . . . . . . . . . . . . . . . . . . . . . 123Setting Multimek Change Instance task parameters . . . . . . . . . . . . . . . . . . . . . . 125Setting high-level Multimek Dispense task parameters. . . . . . . . . . . . . . . . . . . . . 126Setting high-level Multimek Empty Tips task parameters . . . . . . . . . . . . . . . . . . . 129Setting Multimek Loop task parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131Setting high-level Multimek Mix task parameters . . . . . . . . . . . . . . . . . . . . . . . . . 132Setting high-level Multimek Run Macro task parameters. . . . . . . . . . . . . . . . . . . . 134Setting low-level (simple) Multimek task parameters . . . . . . . . . . . . . . . . . . . . . . 135Setting low-level Multimek Move Axes task parameters . . . . . . . . . . . . . . . . . . . . 137About Multimek Diagnostics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140Jogging and teaching the Multimek. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141Executing Multimek tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
Chapter 11. PlateHub . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147Workflow for configuring the PlateHub. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148Creating a PlateHub profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149Setting the PlateHub task parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151Using PlateHub Diagnostics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
Chapter 12. PlateStak . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157Workflow for configuring the PlateStak . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158Creating a PlateStak profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159About PlateStak device locations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160Setting PlateStak task parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161Using PlateStak Diagnostics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
Chapter 13. Rake . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167Workflow for configuring the Rake. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168Creating a Rake profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169Setting Rake task parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171Using Rake Diagnostics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
Chapter 14. SoftMax Pro . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177Workflow for configuring the SoftMax Pro . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178Creating a SoftMax Pro profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178Setting the SoftMax Pro task parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180Using SoftMax Pro Diagnostics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
Table of ContentsDevice Driver User Guide
iv
Chapter 15. StoreX/CytomatPLC . . . . . . . . . . . . . . . . . . . . . . . 185Updating device and protocol files for StoreX . . . . . . . . . . . . . . . . . . . . . . . . . . . 186Workflow for configuring the StoreX/CytomatPLC . . . . . . . . . . . . . . . . . . . . . . . . 188Creating a StoreX/CytomatPLC profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189Setting StoreX/CytomatPLC task parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . 192Using StoreX/CytomatPLC Diagnostics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
Chapter 16. Symbol MiniScan BCS . . . . . . . . . . . . . . . . . . . . 199Workflow for configuring the Symbol MiniScan BCS . . . . . . . . . . . . . . . . . . . . . . . 200Creating a Symbol MiniScan BCS profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201Setting Symbol MiniScan BCS task parameters . . . . . . . . . . . . . . . . . . . . . . . . . 202Using Symbol MiniScan BCS Diagnostics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
Chapter 17. Translator Robot . . . . . . . . . . . . . . . . . . . . . . . . . . 207Workflow for configuring the Translator Robot . . . . . . . . . . . . . . . . . . . . . . . . . . . 208Creating a Translator Robot profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209Using Translator Robot Diagnostics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
Chapter 18. ViewLux . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215Workflow for configuring the ViewLux . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216Creating a ViewLux profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217Setting ViewLux task parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219Using ViewLux Diagnostics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
Index. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
1Chapter 1: Introduction
Device Driver User GuideThis chapter introduces Velocity11 device drivers and provides some basic procedures that are needed to use them.
A Velocity11 device driver is software that plugs into VWorks or BenchWorks to allow them to control a specific instrument or robot.
Before reading this guide, you should be familiar with the VWorks or BenchWorks user interface. Information about using VWorks or BenchWorks can be found in the VWorks User Guide or BenchCel User Guide.
To set up and use Velocity11 device drivers, become familiar with the content in this guide as well as the guides for the instruments that use VWorks or BenchWorks software.
Introduction 1
Chapter 1: IntroductionDevice Driver User Guide
2
Who should read this guide
Job roles This user guide is for people with the following job roles:
Related information
Job role Responsibilities
Integrator Someone who writes software and configures hardware controlled by device drivers.
Lab manager, administrator, or technician
Someone who is responsible for:
❑ Installing device drivers
❑ Managing device drivers
❑ Developing the applications that are run using device drivers
❑ Solving the more challenging problems that may arise
❑ Developing training materials and standard operating procedures for Operators
Operator Someone who performs the daily production work using the device and solves routine problems.
Your organization may choose to create its own procedures for operators based on the information in this guide.
For information about... See...
Contacting Velocity11 http://www.velocity11.com/contact.html
Accessing online help “About Velocity11 user guides” on page 3
Reporting problems “About devices” on page 7
Device drivers “About device drivers” on page 11
3Chapter 1: IntroductionDevice Driver User Guide
About Velocity11 user guides
About this topic This topic describes the different formats of Velocity11 documentation.
Each Velocity11 user guide is delivered to you as:
❑ Online help
❑ A PDF file
❑ A printed book
The information in each format is the same but each format has different benefits.
Where to find the user guides
Online help
The online help is automatically added to your computer with the software installation.
PDFYou can find the BenchCel User Guide or BioCel User Guide and the Device Driver User Guide in PDF format on the software CD-ROM. You need to copy the files onto your computer. They are not automatically installed with the software.
Note: You can also download the latest version of any PDF from our website at www.velocity11.com/techdocs/docdownloadpage.html.
Online help The online help is the best format to use when you are working at the computer and when you want to perform fast or advanced searches for information. It is also the only format in color.
To open the online help for BenchWorks:
1. Open the main BenchWorks help:
a. If you are currently in the BenchWorks application, press F1.
b. If you are not currently in the BenchWorks application, open help.html in: C:\Program files\Velocity11\BenchWorks\HelpSystem\benchworks_ug.
Place a shortcut to this file on your desktop for future use.
2. Open the help for the BenchWorks drivers:
a. Navigate to C:\Program files\Velocity11\BenchWorks\HelpSystem\devicedriver_ug\help.html.
b. Opening help.html.
To open the online help for VWorks:
1. If you are currently in the VWorks application:
a. Click the question mark button to toggle on the help mode.
b. Click anywhere in the application.
Chapter 1: IntroductionDevice Driver User Guide
4
Follow the links to take you to either the relevant part of the VWorks help or the device drivers help.
Note: You can go directly to the VWorks help by choosing Help > VWorks Help.
2. If you are not currently in the VWorks application, you can open help.html in both:
a. C:\VWorks Workspace\bin\HelpSystem\vworks_ug for the main help.
b. C:\VWorks Workspace\bin\HelpSystem\devicedriver_ug for the device driver help.
Main features
The online help includes a navigation pane, content pane, and navigation buttons.
The navigation pane has four tabs. The Contents, Index, and Search tabs provide different ways to locate information. The Using tab contains information about using the help system.
The content pane displays the online help topics.
Navigation buttons in the content pane allow you to navigate through the pages.
PDF user guides Computer requirementsTo open a user guide in PDF format, you need an Acrobat viewer. You can either use the viewer that is built into Adobe Acrobat, or you can download the free Adobe Reader application from http://www.adobe.com/support/downloads/main.html.
Navigation pane Content pane Navigation buttons
5Chapter 1: IntroductionDevice Driver User Guide
Printing and searching
We provide user guides in PDF format mainly for printing additional copies. You can use them for simple searches from the Find button, although these searches are much slower than online help searches:
More information
For more information about using PDF documents, see the Adobe Acrobat PDF help system that can be accessed from your Acrobat viewer.
Related information
What this guide covers
About this topic This topic gives an overview of what procedures and information are provided in this user guide.
This guide explains how to:
❑ Install the driver for the device
❑ Configure the device in the device manager
❑ Set and use the tasks associated with the device
❑ Use Device Diagnostics
Also read Information about device drivers not covered in this guide and about running VWorks or BenchWorks can be found in the VWorks User Guide or the BenchCel User Guide.
For information about... See...
Who this guide is for “Who should read this guide” on page 2
What’s in this guide “What this guide covers” on page 5
Device driver plug-ins “About device drivers” on page 11
Chapter 1: IntroductionDevice Driver User Guide
6
Driver version To find version information for a driver in VWorks:
1. Start VWorks.
2. Click Help and select About VWorks.
The About VWorks dialog box lists the version numbers of all the current software for all the devices and plug-ins.
To find version information for a driver in BenchWorks:
1. Start BenchWorks.
2. Click Help and select About BenchWorks.
The About BenchWorks dialog box lists the version numbers of all the current software for all the devices and plug-ins.
Firmware version Some devices have firmware installed on them. Because each device is different, the version number may not be the same for all devices.
To find version information for device firmware:
1. Open the Device Diagnostics dialog box.
2. Click About.
The About Device Control message box appears displaying the current version of firmware.
What this guide does not cover
This guide does not cover the following:
❑ The operation of the device
❑ The operation of VWorks or BenchWorks
❑ Velocity11 instruments, such as the PlateLoc, VCode, and VPrep when used in stand-alone mode
VWorks or BenchWorks compatibility
If you have purchased a device driver plug-in and are installing it yourself, check with the Velocity11 Service Center to be sure your version of VWorks or BenchWorks and the device driver plug-in are using the same version of IWorks.
Related informationFor information about... See...
Who this guide is for “Who should read this guide” on page 2
User documentation “About Velocity11 user guides” on page 3
Device driver plug-ins “About device drivers” on page 11
7Chapter 1: IntroductionDevice Driver User Guide
About devices
About this topic This topic gives a definition of a Velocity11 device and the device file.
Read this topic if you are unfamiliar with Velocity11 instruments and VWorks or BenchWorks.
Device defined A device is an item on your lab automation system that has an entry in the device manager. A device can be a robot, an instrument, or a location on the lab automation system that can hold a piece of labware.
Examples of devices:
❑ Velocity11 robot
❑ Human robot
❑ PlateLoc Thermal Plate Sealer
❑ Labcyte Echo550
❑ Platepad
❑ VPrep shelf
❑ Waste
Device file defined The data entered into the device manager and saved as a device file contains the configuration information for your devices.
Device file location Device files have the file name format file name.dev and are stored in the folder location that you specify when saving the file.
Related informationFor information about... See...
Device diagnostics “About diagnostics” on page 9
Device profiles “About profiles” on page 8
Adding a device to the device manager
“Adding devices” on page 15
Chapter 1: IntroductionDevice Driver User Guide
8
About profiles
About this topic This topic describes what profiles are and what they do.
Read this topic if you are an administrator in charge of managing Velocity11 devices.
Profiles defined A profile contains the initialization settings needed for communication between a device and device driver. The data in a profile is used by VWorks or BenchWorks to identify each device on the network.
A profile can also contain other basic settings that you are unlikely to want to change once set up.
Because profiles identify each device, every device on the network must have its own profile.
You can create, modify, and delete profiles as you need to.
Stored settings Profiles are stored in the Windows registry.
The settings stored in a device driver profile include:
❑ Whether the device is connected using serial or Ethernet
❑ If the device is connected using Ethernet, the Device ID of the device on the network
❑ If the device is connected using serial, the COM port that the controlling computer uses for communication
Related informationFor information about... See...
Device drivers “About device drivers” on page 11
Adding a device to the device manager
“Adding devices” on page 15
Opening device diagnostics “Opening diagnostics” on page 10
9Chapter 1: IntroductionDevice Driver User Guide
About diagnostics
About this topic This topic gives an overview of diagnostics software.
Read this topic if you need to set up or troubleshoot a device running VWorks or BenchWorks.
Background Devices can be controlled in real time directly through the VWorks or BenchWorks diagnostics software using simple commands.
Diagnostics software is used for:
❑ Troubleshooting
❑ Setting teachpoints
❑ Performing manual operations outside a protocol
For example, if an error occurs during a run that leaves a plate and the robot where they should not be, you can use robot diagnostics to move the plate and return the robot to its home position.
Types of diagnostics software
Instruments manufactured by Velocity11 include their own diagnostics software. You can find instructions for using this software in the relevant user guide.
Related informationFor information about... See...
Opening diagnostics “Opening diagnostics” on page 10
Adding a device to the device manager
“Adding devices” on page 15
Device drivers “About device drivers” on page 11
The definition of devices “About devices” on page 7
Chapter 1: IntroductionDevice Driver User Guide
10
Opening diagnostics
About this topic Every device has diagnostics software to assist you with troubleshooting and setting up the device. This topic describes how to open a device’s diagnostics in VWorks or BenchWorks.
Read this topic if you need to access a device’s diagnostics to perform a device setup task or manually operate a device.
Procedure To open device diagnostics:
1. Click the Device Manager tab.
2. Select the device from the Device List toolbar.
Expand the general name of the device, if necessary.
3. Select the device with which you want to communicate.
4. Click Device diagnostics located at the bottom of the Device List toolbar.
The device driver’s Diagnostics dialog box opens.
Related informationFor information about... See...
Diagnostics “About diagnostics” on page 9
About device drivers “About device drivers” on page 11
Adding a device to the device manager
“Adding devices” on page 15
Setting generic device properties “Setting the properties for a device” on page 17
11Chapter 1: IntroductionDevice Driver User Guide
About device drivers
About this topic This topic describes what device drivers are and what they do.
Velocity11 device drivers enable devices to work with VWorks or BenchWorks.
Read this topic if you are:
❑ An administrator in charge of installing device drivers and managing Velocity11 devices
❑ A lab automation system integrator who writes software and configures hardware controlled by VWorks or BenchWorks
Device driver defined
A Velocity11 device driver enables VWorks or BenchWorks to control and communicate with the specific type of device. Each type of device that you operate with VWorks or BenchWorks requires a device driver.
For example, VWorks uses the:
❑ VPrep device driver to communicate with the Velocity11 VPrep instrument
❑ Softmax Reader device driver to communicate with Molecular Devices readers
Plug-in defined A plug-in is a software program that when added to another program extends it.
Plug-in device drivers
Some device drivers are incorporated directly into the VWorks or BenchWorks application. Other device drivers are distributed as plug-ins. All the device drivers covered in this guide are the plug-in type.
Advantages of distributing device drivers as plug-ins are:
❑ You only need to install the plug-ins for the devices you use
❑ When new plug-ins become available, they can be easily added—no need to re-install the VWorks or BenchWorks application
IWorks interface The device driver plug-ins and VWorks or BenchWorks use IWorks as a common interface to communicate with each other. Using a common interface allows the creation of a device driver plug-in without the necessity of changing the software.
!! IMPORTANT !! Both VWorks or BenchWorks and the device driver must be using the same version of IWorks to work properly.
Writing your own device driver
If you are a lab automation system integrator who writes software and configures hardware controlled by VWorks or BenchWorks, you can write your own driver plug-in for a new device. Contact the Velocity11 Service Center for information about how to do this.
Chapter 1: IntroductionDevice Driver User Guide
12
What functions do the device drivers provide?
Once installed, the following items are enabled:
❑ Tasks associated with the device.
Device-specific tasks appear in the Protocol Tasks list and are available for use in protocol editor processes.
❑ Task parameters associated with the device.
Device-specific task parameters appear in the Protocol Task Parameters toolbar. These determine the conditions with which to execute the tasks of the device.
❑ Diagnostic commands specific to the device.
Device-specific diagnostic commands and options appear in the Device Diagnostics dialog box. These commands enable direct control of the device.
Related informationFor information about... See...
Adding a device to the device manager
“Adding devices” on page 15
Opening diagnostics “Opening diagnostics” on page 10
Installing a device driver “Installing device drivers” on page 13
Devices “About devices” on page 7
13Chapter 1: IntroductionDevice Driver User Guide
Installing device drivers
About this topic Devices are integrated into VWorks or BenchWorks using device driver plug-ins. Plug-ins need to be installed before the device can be configured and used.
This topic describes how to install device drivers if they are not already installed on your system. Read this topic if you are an administrator in charge of managing Velocity11 devices.
Procedure To install device drivers:
1. Insert the device driver installation disc into the CD-ROM of the computer running VWorks or BenchWorks.
2. Follow the on-screen instructions for installation, selecting the default values when available.
3. When finished, exit VWorks or BenchWorks.
4. Log off Windows and restart your computer.
5. Start VWorks or BenchWorks.
Workflows for setting up devices
This table lists where to find the workflow for setting up a specific device.
For this application...
The default location for the device driver is...
VWorks C:\VWorks Workspace\bin\plugins
BenchWorks C:\Program Files\Velocity11\BenchWorks\plugins
For this device... Look here to find the workflow...
Molecular Devices Analyst GT Multimode Reader
“Workflow for configuring the Analyst GT” on page 26
Tecan Systems Cavro Syringe Pump
“Workflow for configuring the Cavro Pump” on page 36
Heraeus Cytomat PLC “Workflow for configuring the StoreX/CytomatPLC” on page 188
PerkinElmer FlexDrop Precision Reagent Dispenser
“Workflow for configuring the FlexDrop” on page 48
Molecular Devices FLIPRTETRA “Workflow for configuring the FLIPR Tetra” on page 60
Amersham Biosciences IN Cell Analyzer 1000
“Workflow for configuring the IN Cell Analyzer 1000” on page 88
Peak Robotics KiNEDx Robot “Workflow for configuring the KiNEDx Robot” on page 98
Chapter 1: IntroductionDevice Driver User Guide
14
Related information
Amersham Biosciences LEADseeker Multimodality Imaging System
“Workflow for configuring the LEADseeker” on page 106
Beckman Multimek “Workflow for configuring the Multimek” on page 114
Velocity11 PlateHub Labware Carousel
“Workflow for configuring the PlateHub” on page 148
PerkinElmer PlateStak “Workflow for configuring the PlateStak” on page 158
Rake “Workflow for configuring the Rake” on page 168
Generic RS-232 “Workflow for configuring the Generic RS-232 driver” on page 76
Molecular Devices SoftMax Pro “Workflow for configuring the SoftMax Pro” on page 178
LiCONiC STX-Series and STR-Series Automated Precision Incubator
“Workflow for configuring the StoreX/CytomatPLC” on page 188
Symbol Technologies MiniScan bar code scanner
“Workflow for configuring the Symbol MiniScan BCS” on page 200
Robo Cylinder Translator Robot “Workflow for configuring the Translator Robot” on page 208
PerkinElmer ViewLux ultraHTS Microplate Imager
“Workflow for configuring the ViewLux” on page 216
For this device... Look here to find the workflow...
For information about... See...
Device drivers “About device drivers” on page 11
The next step for configuring a device
“Adding devices” on page 15
Opening diagnostics “Opening diagnostics” on page 10
15Chapter 1: IntroductionDevice Driver User Guide
Adding devices
About this topic To configure your lab automation system to use an instrument, you need to add it to a device file in VWorks or BenchWorks. The VWorks or BenchWorks device manager uses the information in the device file to communicate and operate the device within the automation system.
This topic describes how to:
❑ Create a new device file (if one does not already exist)
❑ Add devices
❑ Save the device file
Read this topic if you are an administrator in charge of managing Velocity11 devices.
Procedure To add devices to a device file:
1. Make sure that the devices are physically networked to the VWorks or BenchWorks computer and turned on.
2. Start VWorks or BenchWorks and login as an Administrator.
3. Do one of the following:
If you have an existing device file that you want to add to, select File > Device File, click Open, and select your device file.
If you are creating a new device file, select File > Device File and click New.
4. Click the Device Manager tab.
5. Click New device in the Device List toolbar and enter a name for the device you are adding.
6. In the device manager, set the Device type.
The default type is Plate Pad, Standard.
7. Repeat step 5 and step 6 for each device.
8. Select File > Device File > Save.
If you are creating a new device file, you are prompted to enter a name for your device file.
Alternatively, you can select File > Save All. This saves the device file and the current protocol file at the same time.
Chapter 1: IntroductionDevice Driver User Guide
16
Workflows for setting up devices
This table lists where to find the workflow for setting up a specific device.
The next step is to create a profile for your device.
For this device... Look here to find the workflow...
Molecular Devices Analyst GT Multimode Reader
“Workflow for configuring the Analyst GT” on page 26
Tecan Systems Cavro Syringe Pump
“Workflow for configuring the Cavro Pump” on page 36
Heraeus Cytomat PLC “Workflow for configuring the StoreX/CytomatPLC” on page 188
PerkinElmer FlexDrop Precision Reagent Dispenser
“Workflow for configuring the FlexDrop” on page 48
Molecular Devices FLIPRTETRA “Workflow for configuring the FLIPR Tetra” on page 60
Amersham Biosciences IN Cell Analyzer 1000
“Workflow for configuring the IN Cell Analyzer 1000” on page 88
Peak Robotics KiNEDx Robot “Workflow for configuring the KiNEDx Robot” on page 98
Amersham Biosciences LEADseeker Multimodality Imaging System
“Workflow for configuring the LEADseeker” on page 106
Beckman Multimek “Workflow for configuring the Multimek” on page 114
Velocity11 PlateHub Labware Carousel
“Workflow for configuring the PlateHub” on page 148
PerkinElmer PlateStak “Workflow for configuring the PlateStak” on page 158
Rake “Workflow for configuring the Rake” on page 168
Generic RS-232 “Workflow for configuring the Generic RS-232 driver” on page 76
Molecular Devices SoftMax Pro “Workflow for configuring the SoftMax Pro” on page 178
LiCONiC STX-Series and STR-Series Automated Precision Incubator
“Workflow for configuring the StoreX/CytomatPLC” on page 188
Symbol Technologies MiniScan bar code scanner
“Workflow for configuring the Symbol MiniScan BCS” on page 200
Robo Cylinder Translator Robot “Workflow for configuring the Translator Robot” on page 208
17Chapter 1: IntroductionDevice Driver User Guide
Related information
Setting the properties for a device
About this topic The device properties provide VWorks or BenchWorks with additional information about the device’s current configuration, such as which profile to use, and stores the information in the device file. The device file is automatically loaded when you open a protocol.
The device properties need to be set when configuring the device. Typically, these properties only need to be set once. This topic describes how to set the following device properties:
❑ General
❑ Teachpoint
❑ Bar code
❑ Location (for devices with multiple teachpoints)
❑ Device Properties
Read this topic if you are an Administrator in charge of managing Velocity11 devices.
Before you start Make sure that you have installed the device driver plug-in and have added the device to the device manager.
See “Related information” for procedures on how to do these tasks.
PerkinElmer ViewLux ultraHTS Microplate Imager
“Workflow for configuring the ViewLux” on page 216
For this device... Look here to find the workflow...
For information about... See...
Device drivers “About device drivers” on page 11
Setting generic device properties “Setting the properties for a device” on page 17
Adding a sub-process to a protocol “Adding and configuring Sub Process tasks” on page 20
Opening diagnostics “Opening diagnostics” on page 10
Chapter 1: IntroductionDevice Driver User Guide
18
Setting general properties
To set the general properties for a device:
1. Click the Device Manager tab.
2. Select the device from the Device List toolbar. (Expand the device name, if necessary.)
Note: For devices with Locations, see “Setting location properties” on page 19. If no Locations, continue with step 3.
3. In the General group, set the following:
a. Approach height. This is the height to raise the robot gripper above the teachpoint when the robot moves the plate horizontally towards or away from it.
b. Allowed/prohibited labware. Click the adjacent field to open the dialog box. Move the labware classes by selecting them and clicking one of the arrow buttons.
4. In the Device Properties, select the desired profile if it is not already selected.
5. Select File > Device File > Save to save the changes to the device file.
Setting teachpoints Teachpoints are the coordinates in space that a robot travels to in order to interact with a device. Only the devices that are accessible by robots are able to have teachpoints.
To set the teachpoint properties:
1. Open the Device Properties page.
2. In the Teachpoints property group, set the following:
a. Device is accessible from robot robot’s name. Choose Yes or No.
b. Teachpoint for robot robot’s name. Choose a file.
19Chapter 1: IntroductionDevice Driver User Guide
Setting bar code location
If your device has a bar code reader, indicate where the reader is located.
To set the bar code readers property:
1. In the Bar Code Readers property group, set the side that has the bar code to Yes.
2. Enter the COM port number to which the device is connected.
Setting location properties
For devices that have more than one robot-accessible labware position, the approach height, allowable/prohibited labware, teachpoint, and bar code properties are located under Location groups.
To set the Location properties:
1. Set the Teachpoints. Follow the procedure in “Setting teachpoints” on page 18.
2. Set the Approach height and Allowed/prohibited labware. Follow the procedure in “Setting general properties” on page 18.
3. Set the Bar code Readers location. Follow the procedure in “Setting bar code location” on page 19.
4. Assign the Labware used by the location by selecting the correct labware type from the list.
5. In the Device Properties, select the desired profile if it is not already selected.
6. Select File > Device File > Save to save the changes to the device file.
Chapter 1: IntroductionDevice Driver User Guide
20
Related information
Adding and configuring Sub Process tasks
About this topic This topic describes how to add a sub-process to a protocol and configure it. Read this topic if you are an Administrator or Technician and are responsible for creating protocols in VWorks or BenchWorks.
Before you read this Before you read this topic, become familiar with the topics in the VWorks User Guide or BenchCel User Guide describing what a protocol is and how it is created.
Sub Process task defined
Sub-process tasks indicate the existence of a subroutine within a protocol. Sub-processes typically contain a series of liquid handling tasks used by devices such as the VPrep or Multimek.
Adding a Sub Process task
The first step in creating a pipette process is to add a sub-process task to the protocol editor. Drag the Sub Process icon into the protocol process.
Setting Sub Process task parameters
When you add the Sub Process task, a new sub-process is started in the pipette process editor. This process is identified by its sub-process link icon.
For information about... See...
Device drivers “About device drivers” on page 11
Installing a device driver plug-in “Installing device drivers” on page 13
Profiles “About profiles” on page 8
Adding a device to the device manager
“Adding devices” on page 15
Opening the device properties “Adding devices” on page 15
Opening diagnostics “Opening diagnostics” on page 10
Next step: You are now ready to create protocols that use your device.
Information about setting up tasks in the chapter for your device
21Chapter 1: IntroductionDevice Driver User Guide
Because you can have more than one sub-process in a protocol, you must link the Sub Process task to the correct sub-process.
To link the Sub Process task to the correct sub-process:
1. In the Protocol Editor, add a Sub Process task to the protocol and then select it in the protocol sequence.
2. In the Protocol Task Parameters toolbar, select the sub-process that you want to use for this pipetting task from the Use Sub Process list box.
3. If there is only one sub-process and you need to create a second one, click Add New.
Associating the sub-process to a device
Because you can have more than one device that uses sub-processes on a lab automation system, you must link each sub-process link icon with one or more devices that you want the sub-process to be able to use. You do this by setting the parameter for the sub-process link icon.
To link a Sub Process task to a device:
1. In the Pipette Process Editor, select the Sub Process link icon.
2. In the Available devices list of the Pipette Task Parameters toolbar, select one or more pipettors to link to and click Add.
Chapter 1: IntroductionDevice Driver User Guide
22
The selected pipettors move to the lower box and become available for use.
Related information
Using JavaScript to set task parameters
About this topic JavaScript programs (scripts) can be used to change the parameters of a protocol task immediately before it is scheduled. This extends the capability of VWorks or BenchWorks because the parameters can be changed dynamically during a run, based on the following:
❑ Information passed from an external source, such as a database
❑ The number of times the protocol has cycled
❑ Feedback on changing conditions during the run
This topic describes the use of JavaScript to set task parameters in a protocol.
For information about... See...
Device drivers “About device drivers” on page 11
Setting common device properties “Setting the properties for a device” on page 17
Adding a device to the device manager
“Adding devices” on page 15
Creating protocols ❑ VWorks User Guide
❑ BenchCel User Guide
23Chapter 1: IntroductionDevice Driver User Guide
Read this topic if you are an Administrator or Technician responsible for creating VWorks or BenchWorks protocols and want to add functionality to a task using JavaScript.
Where scripts are written
Scripts can be written in two ways:
❑ Directly into the text box in the Advanced Settings tab of the Task Parameters toolbar
❑ As an external file that is located by clicking Browse in the Advanced Settings tab and navigating to its location on the hard drive
Note: You can also call an external file by imbedding the “open()” function in the text field.
The following screenshot shows a short script that prints the parameters of a task to the log toolbar, just before the task runs. In this case, the script is written directly in the Advanced Settings text box.
For more information about using JavaScript, refer to the VWorks User Guide or the BenchCel User Guide.
Related informationFor information about... See...
Using JavaScript in protocols ❑ VWorks User Guide
❑ BenchCel User Guide
Adding tasks to protocols ❑ VWorks User Guide
❑ BenchCel User Guide
Chapter 1: IntroductionDevice Driver User Guide
24
25Chapter 2: Analyst GT
Device Driver User GuideThe Molecular Devices Analyst GT Multimode Reader can be configured to work in lab automation systems using VWorks or BenchWorks.
The Analyst GT is a microplate reader that detects fluorescence polarization (FP), fluorescence intensity, time-resolved fluorescence energy transfer (TR-FRET), luminescence, and absorbance.
This chapter describes how to:
❑ Install the Analyst GT device driver
❑ Configure the Analyst GT
❑ Set the Analyst GT task parameters
❑ Use Analyst GT Diagnostics
Analyst GT 2
Chapter 2: Analyst GTDevice Driver User Guide
26
Workflow for configuring the Analyst GT
About this topic This topic presents the workflow for configuring the Analyst GT device driver.
Read this topic if you are an Administrator responsible for setting up devices in VWorks or BenchWorks.
Workflow
Related information
Step Topic
1. “Installing device drivers” on page 13
You may have already done this.
2. “Adding devices” on page 15
3. “Creating an Analyst GT profile” on page 27
4. “Setting the properties for a device” on page 17
For information about... See...
Device drivers “About device drivers” on page 11
Setting Analyst GT task parameters “Setting Analyst GT task parameters” on page 29
Using Analyst GT Diagnostics “Using Analyst GT Diagnostics” on page 31
27Chapter 2: Analyst GTDevice Driver User Guide
Creating an Analyst GT profile
About this topic Profiles contain the initialization settings that enable VWorks or BenchWorks to identify and communicate with the Analyst GT. Every device within the automation system must have its own profile. Once created, you will probably not need to make changes to the profile.
This topic describes how to create a profile for the Analyst GT.
Read this topic if you are an Administrator responsible for setting up devices in VWorks or BenchWorks.
Before you start Before you create a profile, you need to have installed the Analyst GT device driver and added the Analyst GT to the device manager.
Procedure To create an Analyst GT profile:
1. Open the Analyst GT Diagnostics.
2. Click the Profiles tab.
3. Click Create a new profile.
4. Enter a name for the profile and click OK.
The name appears in the Profile name field.
5. In the Profile Attributes group box, set the following:
Setting Description
ID Serial number of the instrument. This instructs the software how to locate the IP address of the instrument.
See the Analyst GT user documentation for more information.
Chapter 2: Analyst GTDevice Driver User Guide
28
6. Click Update this profile.
Related information
Stub mode (for debugging without installing MD Analyst ActiveX Suite)
When checked, the Analyst GT Active X is disabled.
This feature is typically used by software developers who do not require a functioning instrument for their purpose.
Default output filename Path to the Analyst GT data output file.
Append the following attributes to the output
❑ Date / time stamp
❑ South bar code
❑ West bar code
❑ North bar code
❑ East bar code
When selected, the output data file names are appended with:
❑ Current date and time
❑ Bar code located on the direction side
Setting Description
For information about... See...
Opening diagnostics “Opening diagnostics” on page 10
Adding the Analyst GT to the device manager
“Adding devices” on page 15
The next step “Setting the properties for a device” on page 17
The workflow this procedure belongs to
“Workflow for configuring the Analyst GT” on page 26
Using Analyst GT Diagnostics “Using Analyst GT Diagnostics” on page 31
Using Analyst GT tasks “Setting Analyst GT task parameters” on page 29
29Chapter 2: Analyst GTDevice Driver User Guide
Setting Analyst GT task parameters
About this topic After the device has been added to the device file, the tasks associated with the Analyst GT become available in the protocol editor. When a task is added to a protocol, you need to set the parameters for it. This includes choosing which Analyst GT (if there is more than one) and what method to use.
This topic describes the tasks and their parameters.
Read this topic if you are:
❑ An Administrator or Technician responsible for creating protocols
❑ An Operator who wants to make changes to the Analyst GT task parameters in a protocol
About Analyst GT tasks
The Analyst GT device driver adds two tasks to VWorks or BenchWorks software. These tasks are used to deliver commands to the Analyst GT during the execution of a protocol.
The Analyst GT tasks are represented by icons in the Pre/Post Protocol Tasks toolbar (Set Lamp State task) and the Protocol Tasks toolbar (Execute Method task):
The tasks’ functions and the protocol processes for which they are available are shown in the table below.
Setting Set Lamp State (Analyst GT) task parameters
To set the Set Lamp State (Analyst GT) task parameters:
1. Add the task to the desired pre-protocol or post-protocol process.
2. Move the Analyst GT or Analyst GTs that you want to use to the right field using the Add and Remove buttons.
3. Set Turn lamp on to Yes.
Task Function Available in this editor
Set Lamp State (Analyst GT)
Turns the lamp on and off Pre and post-protocol
Execute Method (Analyst GT)
Executes selected method Protocol
Chapter 2: Analyst GTDevice Driver User Guide
30
Setting Execute Method task parameters
To set the Execute Method (Analyst GT) task parameters:
1. Add the task to the desired protocol process.
2. Move the Analyst GT or Analyst GTs that you want to use to the right field using the Add and Remove buttons.
3. Set the “Execute Method” properties.
Property Description
Method List that enables you to select the method you want to use. For the definition of methods, see the Analyst GT user documentation.
Output filename Path to the data output file of the Analyst GT. Default is the path set in the Analyst GT profile.
Changing the file name here does not affect the default file name chosen in the Profiles page.
Tip. To open the browser box, click in the field to the right of the Output name field. Then, click the grey button that appears. (See figure below.)
Display progress If you select Yes, the Control page of Analyst GT Diagnostics appears, displaying the progress of the run.
31Chapter 2: Analyst GTDevice Driver User Guide
Related information
Using Analyst GT Diagnostics
About this topic This topic describes using Analyst GT Diagnostics to:
❑ Manage profiles
❑ Run a method
❑ View a data file
❑ Perform Analyst GT tasks
For information on performing Analyst GT tasks using diagnostics, refer to the Analyst GT user documentation.
Read this topic if you are:
❑ An Administrator who wants to manage Analyst GT profiles
❑ A Technician or Operator who wants to use Analyst GT Diagnostics to troubleshoot or operate the Analyst GT
Managing profiles To manage Analyst GT profiles:
1. Open the Analyst GT Diagnostics.
2. Click the Profiles tab.
For information about... See...
The workflow that this procedure belongs to
“Workflow for configuring the Analyst GT” on page 26
Creating protocols, pre-protocols, post-protocols, and pipette processes
❑ VWorks User Guide
❑ BenchCel User Guide
Opening Analyst GT device properties page
“Adding devices” on page 15
Using Analyst GT Diagnostics “Using Analyst GT Diagnostics” on page 31
Chapter 2: Analyst GTDevice Driver User Guide
32
3. Select a profile from the Profile name list.
4. Perform the desired management task.
Management tasks include the following:
Updating the profile. Use this command to save edits to an existing profile.
Copying a profile.
Renaming a profile.
Deleting a profile.
Initializing a profile. Use this command to reset the device with the selected profile.
Running a method To run an Analyst GT method:
1. Open Analyst GT Diagnostics.
2. Click the Controls tab.
3. Select the method you want to run from the Type list.
4. Place the plate on the Analyst GT stage and click Load.
5. Click Start to run the method.
33Chapter 2: Analyst GTDevice Driver User Guide
Viewing an Analyst GT data file
To view an Analyst GT data file:
1. Open Analyst GT Diagnostics.
2. Click the Controls tab.
3. Click View Data and navigate to the file you want to view.
4. Click Open.
Related informationFor information about... See...
Using Analyst GT Diagnostics Analyst GT user documentation
Opening diagnostics “Opening diagnostics” on page 10
Workflow for configuring the Analyst GT
“Workflow for configuring the Analyst GT” on page 26
Creating a Analyst GT profile “Creating an Analyst GT profile” on page 27
Chapter 2: Analyst GTDevice Driver User Guide
34
35Chapter 3: Cavro Pump
Device Driver User GuideThe Tecan Systems Cavro Pump is a multi-port pump device.
It can be configured to work in a lab automation system using VWorks or BenchWorks.
This chapter describes how to:
❑ Install the Cavro Pump device driver plug-in
❑ Configure the Cavro Pump
❑ Set the Cavro Pump task parameters
❑ Use Cavro Pump Diagnostics
Cavro Pump 3
Chapter 3: Cavro PumpDevice Driver User Guide
36
Workflow for configuring the Cavro Pump
About this topic Before you can use the Cavro Pump tasks in a protocol, you need to configure the device in VWorks or BenchWorks.
This topic provides the workflow for configuring the Cavro Pump device driver. Read this topic if you are an Administrator responsible for setting up devices in VWorks or BenchWorks.
Workflow
Related information
Creating a Cavro Pump profile
About this topic Profiles contain the initialization settings that enable VWorks or BenchWorks to identify and communicate with the device. Every device within the automation system must have its own profile. Once created, you will probably not need make changes to the profile.
This topic describes how to create a profile for the Cavro Pump device. Read this topic if you are an Administrator responsible for setting up devices in VWorks or BenchWorks.
Before you start Before you can create a Cavro Pump profile, you need to install the device driver and add the Cavro Pump to the device manager.
Step Topic
1. “Installing device drivers” on page 13
2. “Adding devices” on page 15
3. “Creating a Cavro Pump profile” on page 36
4. “Setting the properties for a device” on page 17
For information about... See...
Device drivers “About device drivers” on page 11
Setting Cavro Pump task parameters
“Setting the Cavro Pump task parameters” on page 39
Using Cavro Pump Diagnostics “Using Cavro Pump Diagnostics” on page 43
37Chapter 3: Cavro PumpDevice Driver User Guide
Procedure To create a profile for the Cavro Pump:
1. Open Cavro Pump Diagnostics.
2. Click the Profiles tab.
3. Click Create a new profile.
4. Enter a name for the profile and click OK.
The name appears in the Profile name field.
Setting profile attributes
To set the Profile Attributes:
1. Select the Serial port (COM port) the computer is using to communicate to the Cavro Pump from the list box.
2. In the text field, enter the Maximum number of motor steps for the pump.
This number is provided in the Cavro Operators Manual.
3. In the text field, enter the Syringe volume for the Cavro Pump.
This number is provided in the Cavro Operators Manual.
4. If your Cavro Pump has the Micro-step feature, select this check box.
Refer to the Cavro Operators Manual to determine if your pump has this feature.
5. In the text field, enter the Prime volume (in µL) with which to prime the system.
Priming is usually performed once to fill the tubing and eliminate air bubbles. The volume to prime with depends on the capacity of the tubing.
Chapter 3: Cavro PumpDevice Driver User Guide
38
6. Select the desired Transfer, Load, Aspirate, and Dispense Speed codes from the respective list boxes.
Refer to the Cavro Operators Manual for the definition of these parameters.
7. If you want all communication between the Cavro Pump and the computer to be documented, select the Enable logging check box, click the ellipsis button, and set the path for the log file.
8. Click OK to save the profile and close the dialog box.
Related informationFor information about... See...
The workflow this procedure belongs to
“Workflow for configuring the Cavro Pump” on page 36
The next step “Setting the properties for a device” on page 17
Profiles “About profiles” on page 8
Opening the Cavro Pump Diagnostics
“Opening diagnostics” on page 10
Adding a device to the device manager
“Adding devices” on page 15
Setting Cavro Pump task parameters
“Setting the Cavro Pump task parameters” on page 39
Using Cavro Pump Diagnostics “Using Cavro Pump Diagnostics” on page 43
39Chapter 3: Cavro PumpDevice Driver User Guide
Setting the Cavro Pump task parameters
About this topic After a task has been added to a protocol, you need to set the parameters for it. This includes choosing which pump (if there is more than one) and what volume to use.
This topic describes what the Cavro Pump tasks are and how to set their parameters. You should read this topic if you are:
❑ An Administrator or Technician who creates protocols
❑ If you are an Operator running a protocol and need to edit the Cavro Pump task parameters
About Cavro Pump tasks
The Cavro Pump adds five tasks to VWorks or BenchWorks software. These tasks are used to deliver commands to the Cavro Pump during the execution of a protocol.
The Cavro Pump tasks are represented by icons in the Protocol Task toolbar:
The function of the task and the protocol editor for which they are available are shown in the table below.
Task Function Available in this editor
Aspirate Draws volume from the destination Pre-protocol, protocol, and post-protocol
Dispense Dispenses volume into the destination
Pre-protocol, protocol, and post-protocol
Load Loads the syringe to the volume from the source
Pre-protocol, protocol, and post-protocol
Prime Loads from the source and dispenses the volume to the destination
Pre- and post-protocol
Transfer Loads from the source and dispenses the volume to the destination
Pre-protocol, protocol, and post-protocol
Chapter 3: Cavro PumpDevice Driver User Guide
40
Setting Aspirate task parameters
To set the Aspirate task parameters:
1. Add the Aspirate task to a protocol.
2. In the Protocol Task Parameters toolbar, select the pump you want to use for the task:
a. Make sure the Task Settings tab is displayed.
b. In the left field, click the pump you want to use.
c. Click Add.
The pump name moves from the left field to the right field.
3. Set the volume to aspirate:
a. Make sure that the Aspirate Properties tree is expanded.
b. Double-click in the field adjacent to Volume.
c. Type in the volume.
Setting Dispense task parameters
To set the Dispense task parameters:
1. Add the Dispense task to a protocol.
2. In the Protocol Task Parameters toolbar, select the pump you want to use for the task:
a. Make sure the Task Settings tab is displayed.
b. In the left field, click the pump you want to use.
c. Click Add.
The pump name moves from the left field to the right field.
41Chapter 3: Cavro PumpDevice Driver User Guide
3. Set the volume to dispense:
a. Make sure that the Dispense Properties tree is expanded.
b. Double-click in the field adjacent to Volume.
c. Type in the volume to be dispensed to the destination.
Setting Load task parameters
To set the Load task parameters:
1. Add the Load task to a protocol.
2. In the Protocol Task Parameters toolbar, select the pump you want to use for the task:
a. Make sure the Task Settings tab is displayed.
b. In the left field, click the pump you want to use.
c. Click Add.
The pump name moves from the left field to the right field.
3. Set the volume to load into the syringe:
a. Make sure that the Load Properties tree is expanded.
b. Double-click in the field adjacent to Volume.
c. Type in the volume that will be loaded into the syringe.
Chapter 3: Cavro PumpDevice Driver User Guide
42
Setting Prime task parameters
The Prime task is only available for pre- and post-protocol processes and setting the volume must be done in the Profiles page of the Cavro Pump Diagnostics dialog box.
To set the Prime task parameters:
1. Add the Prime task to either a pre- or post-protocol process.
2. In the Protocol Task Parameters toolbar, select the pump you want to use for the task:
a. Make sure the Task Settings tab is displayed.
b. In the left field, click the pump you want to use.
c. Click Add.
The pump name moves from the left field to the right field.
Setting Transfer task parameters
To set the Transfer task parameters:
1. Add the Transfer task to a protocol.
2. In the Protocol Task Parameters toolbar, select the pump you want to use for the task:
a. Make sure the Task Settings tab is displayed.
b. In the left field, click the pump you want to use.
c. Click Add.
The pump name moves from the left field to the right field.
3. Set the volume to transfer:
a. Make sure that the Transfer Properties tree is expanded.
b. Double-click in the field adjacent to Volume.
c. Type in the volume to be transferred from the source to the destination.
43Chapter 3: Cavro PumpDevice Driver User Guide
Related information
Using Cavro Pump Diagnostics
About this topic Cavro Pump Diagnostics is used to manage profiles and operate the device in real time to enable setup and troubleshooting of the device.
This topic describes how to use Cavro Pump Diagnostics. Read this topic if you are:
❑ An Administrator who wants to manage Cavro Pump profiles
❑ A Technician or Operator who wants to use Cavro Pump Diagnostics to troubleshoot or operate the device in real time
Managing profiles To manage profiles:
1. Open Cavro Pump Diagnostics.
2. Click the Profiles tab.
3. Select a profile from the Profile name list.
4. Perform the desired management task.
Management tasks include the following:
Updating the profile. Use this command to save edits to an existing profile.
Copying a profile.
Renaming a profile.
Deleting a profile.
Initializing a profile. Use this command to reset the device with the selected profile.
For information about... See...
The workflow this procedure belongs to
“Workflow for configuring the Cavro Pump” on page 36
Opening Cavro Pump device properties page
“Adding devices” on page 15
Chapter 3: Cavro PumpDevice Driver User Guide
44
To operate the Cavro Pump in real time
To operate the Cavro Pump in real time:
1. Open Cavro Pump Diagnostics.
2. Click the Actions tab.
3. Operate the pump as desired. Use the table below as a reference.
Item Description
Speed code Sets the speed of the Pump Actions. For an explanation of what the values mean, see your Cavro Operators Manual.
Syringe liquid volume Displays the current volume in the syringe. The reading is updated constantly, except during a pump action.
Device busy An indicator light that when lit indicates that a pump action is in progress.
Enable sensors Select this option to turn on the Syringe liquid volume display and Device busy indicator.
Clear this option to turn off the Syringe liquid display volume and Device busy indicator to reduce communication traffic between the device and computer.
Home Homes the syringe and resets the syringe volume to zero.
Close pump Ends all communication between the device and computer.
Stop Interrupts the pump action.
45Chapter 3: Cavro PumpDevice Driver User Guide
Related information
Pump Actions Enter the volume in the field next to the desired action.
Click to perform the indicated action.
Note: The Prime volume is a profile property. You can change the Prime volume in the Profiles page.
Communications Traffic
A log that tracks the communication between the device and computer.
Item Description
For information about... See...
Opening Cavro Pump Diagnostics “Opening diagnostics” on page 10
Creating a profile “Creating a Cavro Pump profile” on page 36
Setting the Cavro Pump task parameters
“Setting the Cavro Pump task parameters” on page 39
Adding a device to the device manager
“Adding devices” on page 15
Chapter 3: Cavro PumpDevice Driver User Guide
46
47Chapter 4: FlexDrop
Device Driver User GuideThe PerkinElmer FlexDrop Precision Reagent Dispensers are automated liquid dispensers.
Dispense volumes range from 200 nL to 2.0 mL. FlexDrop instruments can be configured to work in lab automation systems using VWorks or BenchWorks.
This chapter describes how to:
❑ Install the FlexDrop device driver
❑ Configure the FlexDrop
❑ Set the FlexDrop task parameters
❑ Use FlexDrop Diagnostics
FlexDrop 4
Chapter 4: FlexDropDevice Driver User Guide
48
Workflow for configuring the FlexDrop
About this topic This topic presents the workflow for configuring the FlexDrop device driver.
Read this topic if you are an Administrator responsible for setting up devices in VWorks or BenchWorks.
Workflow
Related information
Step Topic
1. “Installing device drivers” on page 13
You may have already done this.
2. “Adding devices” on page 15
3. “Creating a FlexDrop profile” on page 49
4. “Setting the properties for a device” on page 17
For information about... See...
Device drivers “About device drivers” on page 11
Setting FlexDrop task parameters “Setting FlexDrop task parameters” on page 51
Using FlexDrop Diagnostics “Using FlexDrop Diagnostics” on page 56
49Chapter 4: FlexDropDevice Driver User Guide
Creating a FlexDrop profile
About this topic This topic describes how to create a profile for the FlexDrop. Creating a profile is an essential step for setting up the FlexDrop device driver.
Read this topic if you are an Administrator responsible for setting up devices in VWorks or BenchWorks.
Before you start Before you create a profile, you need to have added the FlexDrop to the device manager.
Procedure To create a FlexDrop profile:
1. Open the FlexDrop Diagnostics.
2. Click the Profiles tab.
3. Click Create a new profile.
4. In the Create Profile dialog box, enter a name for the profile and click OK.
The name appears in the Profile name field.
5. In the Profile Parameters group box, set the following:
Setting Description
Serial port The port connecting the FlexDrop to the controlling computer.
Number of bottles The maximum number of bottles that you want to use on your FlexDrop.
Chapter 4: FlexDropDevice Driver User Guide
50
6. Click Update this profile to save the profile.
Related information
Prime/purge timeout This is the length of time VWorks or BenchWorks waits for a prime or purge action to complete before displaying an error message. The default value is 200,000 ms (around 3 min).
Dispense timeout This is the length of time VWorks or BenchWorks waits for a dispense action to complete before displaying an error message. The default value is 200,000 ms (around 3 min).
Run protocol timeout This is the length of time VWorks or BenchWorks waits for a FlexDrop protocol to complete before displaying an error message. The default value is 200,000 ms (around 3 min).
FlexDrop protocols are performed either as tasks in the VWorks or BenchWorks protocol or directly through diagnostics.
❑ Bottle A reagent
❑ Bottle B reagent
❑ Bottle C reagent
❑ Bottle D reagent
Specify the reagent in each bottle.
This can also be specified in the pre-protocol using the Set Reagent task.
The reagent list is stored in the FlexDrop instrument. To edit the list, use the FlexDrop’s interface.
Enable logging If you want the communication between the FlexDrop and the computer to be documented, select this check box.
Log file If you selected the Enable logging check box, click the ellipsis button and set the path and name for the log file.
If you don’t specify a log file, the default is used: ..\VWorks Workspace\bin\FlexDropCommunicationLog.txt
Setting Description
For information about... See...
Opening diagnostics “Opening diagnostics” on page 10
Adding the FlexDrop to the device manager
“Adding devices” on page 15
The next step “Setting the properties for a device” on page 17
The workflow this procedure belongs to
“Workflow for configuring the FlexDrop” on page 48
Using diagnostics “Using FlexDrop Diagnostics” on page 56
51Chapter 4: FlexDropDevice Driver User Guide
Setting FlexDrop task parameters
About this topic After the device has been added to the device file, the tasks associated with the FlexDrop become available in the protocol editor. When a task is added to a protocol, you need to set the parameters for it. This includes choosing which FlexDrop (if there is more than one) and, for example, what reagents and volumes to use.
This topic describes the tasks and their parameters.
Read this topic if you are:
❑ An Administrator or Technician responsible for creating protocols
❑ An Operator who wants to make changes to the FlexDrop task parameters in a protocol
About FlexDrop tasks
The FlexDrop device driver adds five tasks to VWorks or BenchWorks software. These tasks are used to deliver commands to the FlexDrop during the execution of a protocol.
The FlexDrop tasks are represented by icons in the Protocol Tasks toolbar and the Pre/Post Protocol Tasks toolbar:
The tasks’ functions and the protocol processes for which they are available are shown in the table below.
Using FlexDrop tasks “Setting FlexDrop task parameters” on page 51
Profiles “About profiles” on page 8
For information about... See...
Task Function Available in this editor
Set reagent (FlexDrop)
This pre-protocol task specifies which reagent is in which bottle.
These settings override the similar settings made in the FlexDrop’s profile.
Pre-protocol and post-protocol
Chapter 4: FlexDropDevice Driver User Guide
52
Setting Set reagent (FlexDrop) task parameters
To set the Set reagent (FlexDrop) task parameters:
1. Add the Set reagent (FlexDrop) task to the desired protocol process.
2. Move the FlexDrop or FlexDrops that you want to use to the right field using the Add and Remove buttons.
3. Set the “Set reagent” properties for each bottle.
4. Select File > Device File > Save to save the changes to the device file.
Dispense (FlexDrop)
Dispenses volume into the destination wells. The volumes, reagents, and destination wells are set in the task properties.
Pre-protocol, protocol, and post-protocol
Prime (FlexDrop)
Primes the FlexDrop.
Note: The prime volume cannot be set in VWorks or BenchWorks.
Pre-protocol, protocol, and post-protocol
Purge (FlexDrop)
Purges the FlexDrop.
Note: The purge volume cannot be set in VWorks or BenchWorks.
Pre-protocol, protocol, and post-protocol
Run protocol (FlexDrop)
Executes a protocol that is stored in the FlexDrop instrument.
Pre-protocol, protocol, and post-protocol
Task Function Available in this editor
Property Description
❑ Bottle A reagent
❑ Bottle B reagent
❑ Bottle C reagent
❑ Bottle D reagent
Specify the reagent in each bottle.
The reagent list is stored in the FlexDrop instrument. To edit the list, use the FlexDrop’s interface.
53Chapter 4: FlexDropDevice Driver User Guide
Setting Dispense (FlexDrop) task parameters
To set the Dispense (FlexDrop) task parameters:
1. Add the Dispense (FlexDrop) task to the desired protocol process.
2. In the parameters toolbar, make sure the Task Settings tab is displayed.
3. Move the FlexDrop or FlexDrops that you want to use to the right field using the Add and Remove buttons.
4. Set the “Dispense” properties.
Property Description
Plate type The plate type list is stored in the FlexDrop instrument.
❑ Bottle A volume (0-400 µL)
❑ Bottle B volume (0-400 µL)
❑ Bottle C volume (0-400 µL)
❑ Bottle D volume (0-400 µL)
The volume of each reagent to dispense.
❑ Bottle A columns
❑ Bottle B columns
❑ Bottle C columns
❑ Bottle D columns
❑ Click in the blank field to open the Well Selection dialog box.
❑ Click wells to choose the columns into which the reagent will be dispensed.
❑ Click OK to close the dialog box.
Chapter 4: FlexDropDevice Driver User Guide
54
5. Select File > Device File > Save to save the changes to the device file.
Setting Prime (FlexDrop) task parameters
To set the Prime (FlexDrop) task parameters:
1. Add the Prime (FlexDrop) task to the desired protocol process.
2. Move the FlexDrop or FlexDrops that you want to use to the right field using the Add and Remove buttons.
3. Set the “Prime” properties for each bottle.
4. Select File > Device File > Save to save the changes to the device file.
Setting Purge (FlexDrop) task parameters
To set the Purge (FlexDrop) task parameters:
1. Add the Purge (FlexDrop) task to the desired protocol process.
2. Move the FlexDrop or FlexDrops that you want to use to the right field using the Add and Remove buttons.
3. Set the “Purge” properties for each bottle.
4. Select File > Device File > Save to save the changes to the device file.
55Chapter 4: FlexDropDevice Driver User Guide
Setting Run protocol (FlexDrop) task parameters
To set the Run protocol (FlexDrop) task parameters:
1. Add the Run protocol (FlexDrop) task to the desired protocol process.
2. Move the FlexDrop or FlexDrops that you want to use to the right field using the Add and Remove buttons.
3. Set the Protocol.
The protocols saved in the FlexDrop instrument are available for selection. (These are different from the protocols created in VWorks or BenchWorks.)
4. Select File > Device File > Save to save the changes to the device file.
Related informationFor more information about... See...
The workflow that this procedure belongs to
“Workflow for configuring the FlexDrop” on page 48
Creating protocols, pre-protocols, post-protocols, and pipette processes
❑ VWorks User Guide
❑ BenchCel User Guide
Opening FlexDrop device properties page
“Adding devices” on page 15
Using diagnostics “Using FlexDrop Diagnostics” on page 56
Chapter 4: FlexDropDevice Driver User Guide
56
Using FlexDrop Diagnostics
About this topic This topic describes using FlexDrop Diagnostics to:
❑ Execute specific operations, such as dispense and prime
❑ Manage profiles
Read this topic if you are:
❑ An Administrator who wants to manage FlexDrop profiles
❑ A Technician or Operator who wants to use FlexDrop Diagnostics to troubleshoot or operate the FlexDrop without running a protocol
Managing profiles To manage FlexDrop profiles:
1. Open the FlexDrop Diagnostics.
2. Click the Profiles tab.
3. Select a profile from the Profile names list.
4. Perform the desired management task.
Management tasks include the following:
Updating the profile. Use this command to save edits to an existing profile.
Copying a profile.
Renaming a profile.
Deleting a profile.
Initializing a profile. Use this command to reset the device with the selected profile.
57Chapter 4: FlexDropDevice Driver User Guide
Operating the FlexDrop
To operate the FlexDrop:
1. Open the FlexDrop Diagnostics.
2. Click the Actions tab.
3. Select the reagent you want to use from the Bottle list.
4. Select the number of wells from the Plate type list.
5. Enter the volume of the action in the text field.
6. Select the columns for which you want the action to occur.
Click on a well to select its column.
7. If you are priming or purging, choose a waste or recover option.
8. Click the desired action.
Note: Click Stop to interrupt the action.
Running a protocol To run a protocol on the FlexDrop:
1. Open the FlexDrop Diagnostics.
2. Click the Actions tab.
3. Select the FlexDrop protocol that you want to run.
These are protocols that have been created on the FlexDrop.
4. Click Run protocol.
Note: Click Stop to interrupt the protocol run.
Chapter 4: FlexDropDevice Driver User Guide
58
Resetting the FlexDrop
When the FlexDrop stage motor encounters resistance, you receive an error message and have to reset the motor to continue.
To reset the FlexDrop motor:
1. Open the FlexDrop Diagnostics.
2. Click the Action tab.
3. Click Clear motor fault.
4. Click Retry, if appropriate.
Related informationFor more information about... See...
Opening diagnostics “Opening diagnostics” on page 10
Workflow for configuring the FlexDrop
“Workflow for configuring the FlexDrop” on page 48
Creating a FlexDrop profile “Creating a FlexDrop profile” on page 49
59Chapter 5: FLIPR Tetra
Device Driver User GuideMolecular Devices FLIPRTETRA is a multifunction device that performs simultaneous liquid transfer and multi-wavelength kinetic readings on 96-, 384-, and 1536-well microplates.
The FLIPRTETRA can be integrated into a lab automation system using VWorks or BenchWorks.
This chapter describes how to:
❑ Install the FLIPRTETRA device driver plug-in
❑ Configure the Molecular Devices FLIPRTETRA device
❑ Set the FLIPRTETRA task parameters
❑ Use FLIPRTETRA Diagnostics
FLIPR Tetra 5
Chapter 5: FLIPR TetraDevice Driver User Guide
60
Workflow for configuring the FLIPR Tetra
About this topic Before you can add FLIPRTETRA tasks to protocols, the device driver for it needs to be installed and the device configured in VWorks or BenchWorks.
This topic provides the workflow for configuring the FLIPRTETRA device. Read this topic if you are an Administrator who wants to set up a FLIPRTETRA in VWorks or BenchWorks.
Workflow
Related information
Step Topic
1. “Installing device drivers” on page 13
2. “Adding devices” on page 15
3. “Setting the properties for a device” on page 17
4. “Creating a FLIPR Tetra profile” on page 61
For information about... See...
Device drivers “About device drivers” on page 11
Setting FLIPRTETRA task parameters ❑ “Adding and configuring Sub Process tasks” on page 20
❑ “Setting the FLIPR Tetra Change Instance task parameters” on page 65
❑ “Setting the FLIPR Tetra Load Tips and Unload Tips task parameters” on page 67
❑ “Setting FLIPR Tetra Loop task parameters” on page 68
❑ “Setting FLIPR Tetra Run Protocol task parameters” on page 69
Using FLIPRTETRA Diagnostics “Using FLIPR Tetra Diagnostics” on page 71
61Chapter 5: FLIPR TetraDevice Driver User Guide
Creating a FLIPR Tetra profile
About this topic Profiles contain the initialization settings that enable VWorks or BenchWorks to identify and communicate with the FLIPRTETRA. Every device within the automation system must have its own profile. Once created, you will probably not need to make changes to the profile.
This topic describes how to create a profile for the FLIPRTETRA device. Read this topic if you are an Administrator who wants to set up a FLIPRTETRA in VWorks or BenchWorks.
Before you create a profile
Before you can create a profile, you must install the FLIPRTETRA device driver and add the FLIPRTETRA to the device manager.
Procedure To create a FLIPRTETRA profile:
1. Open FLIPR Tetra Diagnostics.
2. Click the Profiles tab.
3. Click Create a new profile, enter a name, and click OK.
Default values appear in the previously empty fields.
4. Optionally, enter new values for the Timeouts.
Timeouts are the amount of time VWorks or BenchWorks software will wait for a response from ScreenWorks software, which is communicating to the FLIPRTETRA, before displaying an error message.
5. Enter the FLIPRTETRA IP address and Port location used for the ethernet connection.
6. If necessary, change the Protocol directory:
Chapter 5: FLIPR TetraDevice Driver User Guide
62
a. Click the ellipsis button.
b. In the Browse for Folder dialog box, navigate to the directory where the FLIPRTETRA protocols are stored.
c. Select the folder and click OK.
Note: The protocol directory should be located on the same computer as ScreenWorks.
7. Select the correct head size (corresponding to 96-, 384- or 1536-wells) from the Head Type list box.
8. Select Log communication if you want to record a log of all communication events.
9. Click OK to save the settings and close the dialog box.
Related informationFor information about... See...
The next step “Setting the properties for a device” on page 17
The workflow this procedure belongs to
“Workflow for configuring the FLIPR Tetra” on page 60
Opening FLIPRTETRA Diagnostics “Opening diagnostics” on page 10
Profiles “About profiles” on page 8
63Chapter 5: FLIPR TetraDevice Driver User Guide
About FLIPR Tetra device locations
About this topic This topic lists which ScreenWorks positions correspond to the Location names in VWorks or BenchWorks. You need to know this when you set the device properties for the FLIPRTETRA.
Read this topic if you are an Administrator who wants to set up a FLIPRTETRA in VWorks or BenchWorks.
About FLIPRTETRA device locations
The FLIPRTETRA contains five locations that are accessible by the pipette head:
Related information
In ScreenWorks, position... Corresponds to Location (in VWorks or BenchWorks)...
1, 2 (source) Source 1 and Source 2
3 (read) Read
4 (tips) Source 3/Tips
5 (for tip washing) Stage
For information about... See...
Setting FLIPRTETRA device properties
“Setting the properties for a device” on page 17
Configuring the FLIPRTETRA “Workflow for configuring the FLIPR Tetra” on page 60
Chapter 5: FLIPR TetraDevice Driver User Guide
64
About FLIPR Tetra tasks
About this topic After you have set up the FLIPRTETRA in VWorks or BenchWorks, you can add FLIPRTETRA tasks to protocols. This topic provides an overview of the tasks for FLIPRTETRA device.
Read this topic if you are:
❑ An Administrator or Technician who wants to create protocols using the FLIPRTETRA
❑ An Operator who needs to make protocol-specific changes to some of the task parameters
FLIPRTETRA tasks There are six tasks associated with FLIPRTETRA :
❑ Change Instance
❑ Load Tips
❑ Loop
❑ Run Protocol
❑ Unload Tips
❑ Sub Process
The first five tasks are associated with the pipette process editor and the last task is associated with the protocol editor. The Sub Process task is used to link a series of pipette tasks to a protocol.
Related informationFor information about... See...
Device drivers “About device drivers” on page 11
Adding a Sub Process task “Adding and configuring Sub Process tasks” on page 20
Using FLIPRTETRA Diagnostics “Using FLIPR Tetra Diagnostics” on page 71
Adding tasks to protocols ❑ VWorks User Guide
❑ BenchCel User Guide
65Chapter 5: FLIPR TetraDevice Driver User Guide
Setting the FLIPR Tetra Change Instance task parameters
About this topic At times your experimental protocol may call for a repeated action to multiple plates and the Change Instance task enables you to do that. The Change Instance task is available in the Pipette Process Editor after you have added a Sub Process (FLIPR Tetra) task to a protocol.
This topic describes how to set the Change Instance task parameters. Read this topic if you are:
❑ An Administrator or Technician who creates protocols using the FLIPRTETRA
❑ An Operator who needs to make edits to some of the FLIPRTETRA task parameters
Change Instance task defined
The Change Instance pipette task instructs the robotic system to change plates.
Note: Because FLIPRTETRA has an internal plate handler, it is considered to be a robot by VWorks or BenchWorks.
Change Instance task example
An example which uses this task is shown below.
In this example, a new plate is brought in after the Run Flipr protocol task is executed. After the new plate is brought in, the loop repeats and the Run Flipr protocol task is repeated, in this case, 10 times.
Examples of actions that could occur within the Flipr protocol are:
❑ Dispensing a source reagent into a read plate and repeating this for 10 replicate plates
❑ Aspirating a large volume from a mother (source) plate and then dispensing a portion of this volume to daughter plates
Chapter 5: FLIPR TetraDevice Driver User Guide
66
Procedure To set Change Instance pipette task parameters:
1. Set up a protocol and pipette processes following the example shown above.
2. From the list box in the Pipette Task Parameters toolbar, select the plate on which to change instance.
3. If you are using a script in the protocol that involves task skipping, select the Spawn plate only when needed check box to force the robot to only bring in the next plate when the Change Instance task is reached.
The script may otherwise override this flow.
Related informationFor information about... See...
Device drivers “About device drivers” on page 11
Workflow for setting up FLIPRTETRA Workflow for configuring the FLIPR Tetra
Using FLIPRTETRA Diagnostics Using FLIPR Tetra Diagnostics
Adding a Sub Process task “Adding and configuring Sub Process tasks” on page 20
67Chapter 5: FLIPR TetraDevice Driver User Guide
Setting the FLIPR Tetra Load Tips and Unload Tips task parameters
About this topic This topic describes how to set the Load Tips and Unload Tips task parameters. These tasks are only available in the Pipette Process Editor after you have added a Sub Process (FLIPR Tetra) task to a protocol.
Read this topic if you are:
❑ An Administrator or Technician who creates protocols for FLIPRTETRA
❑ An Operator who needs to make a change to these tasks in a protocol
Load and Unload Tips task defined
The Load Tips and Unload Tips instructs the FLIPRTETRA pipette head to go to the stage position that has tips and either load or unload them.
Procedure To set Load and Unload Tips task parameters:
1. Add a Load Tips or Unload Tips task to a protocol.
2. In the Pipette Task Parameters toolbar, click Tips position, plate and then select the labware in the tips position from the list box.
A new Tips position, location property appears.
3. Click Tips position, location and then select the stage position of the tips from the list.
Related informationFor information about... See...
Adding tasks to protocols ❑ VWorks User Guide
❑ BenchCel User Guide
About Sub Process tasks “Adding and configuring Sub Process tasks” on page 20
Using FLIPRTETRA Diagnostics “Using FLIPR Tetra Diagnostics” on page 71
Chapter 5: FLIPR TetraDevice Driver User Guide
68
Setting FLIPR Tetra Loop task parameters
About this topic This topic describes how to set the Loop task parameters. The Loop task becomes available in the Pipette Process Editor after you have added a Sub Process (FLIPR Tetra) task to a protocol.
Read this topic if you are:
❑ An Administrator or Technician who creates protocols for FLIPRTETRA
❑ An Operator who needs to make a change to this task in a protocol, such as the number of times the loop should repeat
Loop task defined The Loop task allows you to repeat a set of tasks within a process.
Procedure This procedure is illustrated with an example in which a FLIPRTETRA protocol is run on 10 different plates with a change of tips between each plate.
To set the FLIPRTETRA Loop task parameters:
1. In the Pipette Process Editor, construct the process you want to repeat.
2. Select the Loop task icon in the Pipette Task list and drag it into the process in front of the first task that you want to be in the loop.
In this example, it is Load Tips.
A Loop task and End of loop task icons are added to the process.
3. Drag the End of loop task icon to the right side of the last task you want to be in the loop.
69Chapter 5: FLIPR TetraDevice Driver User Guide
4. Select the Loop task icon and in the Pipette Task Parameters toolbar, enter the number of times you want the tasks inside the loop to run.
Related information
Setting FLIPR Tetra Run Protocol task parameters
About this topic The Run Protocol task is available in the Pipette Process Editor after a Sub Process task has been added to a protocol. This topic describes how to set the Run Protocol task parameters.
Read this topic if you are:
❑ An Administrator or Technician who writes protocols for the FLIPRTETRA
❑ An Operator who needs to make changes to the parameters of this task at the protocol run time
Run Protocol task defined
A Run Protocol task executes a protocol that you have created in ScreenWorks using the source and read plates you have designated in the Pipette Task Parameters toolbar.
Procedure To set the FLIPRTETRA Run Protocol task parameters:
1. Add the Run Protocol task to a protocol.
2. In the Pipette Task Parameters toolbar, click Protocol File and then select the desired protocol file from the list box.
For information about... See...
Adding tasks to protocols ❑ VWorks User Guide
❑ BenchCel User Guide
About sub-processes “Adding and configuring Sub Process tasks” on page 20
Using FLIPRTETRA Diagnostics “Using FLIPR Tetra Diagnostics” on page 71
Chapter 5: FLIPR TetraDevice Driver User Guide
70
3. Click on each of appropriate plate positions and then select the plate name from the list box.
A plate location property appears.
4. Click the plate location and select the location of the plate from the list box.
Related informationFor information about... See...
Adding tasks to protocols ❑ VWorks User Guide
❑ BenchCel User Guide
Sub-processes “Adding and configuring Sub Process tasks” on page 20
Using FLIPRTETRA Diagnostics “Using FLIPR Tetra Diagnostics” on page 71
Users and permissions “Who should read this guide” on page 2
71Chapter 5: FLIPR TetraDevice Driver User Guide
Using FLIPR Tetra Diagnostics
About this topic This topic describes how to:
❑ View connection, instrument, and plate status
❑ View current status of instrument subsystems
❑ Execute instrument operations
❑ Reset the device
❑ Manage profiles, operation timeouts and connection details
Read this topic if you are:
❑ An Administrator who wants to manage FLIPRTETRA profiles
❑ A Technician or Operator who wants to troubleshoot the device or needs to operate the device without running a protocol
Viewing connection, instrument and plate status
To view connection and instrument status:
1. Open FLIPR Tetra Diagnostics.
2. Click the Status tab.
3. Make sure that the Enable sensors check box is selected.
Chapter 5: FLIPR TetraDevice Driver User Guide
72
Executing instrument operations
To execute FLIPRTETRA operations:
1. Open the FLIPR Tetra Diagnostics dialog box.
2. Click the Status tab.
3. From the list box next to the Loadplate button, select the position which has the plate you want to control.
4. Click the desired operation: Loadplate, Load tips, or Wash tips.
5. To execute an experiment, select the ScreenWorks protocol from the list box next to the Run experiment button.
6. Click Run experiment.
Resetting FLIPRTETRA If an error has occurred while using the FLIPRTETRA, you may have to clear the error and reset the FLIPRTETRA device. This is performed in the FLIPR Tetra Diagnostics dialog box.
To reset the FLIPRTETRA:
1. Open FLIPR Tetra Diagnostics.
2. Click the Status tab.
If an error occurs, the Device error indicator is lit and the Clear error and Reset Device buttons enabled.
3. Click Clear error and then click Reset Device.
Viewing subsystem status
To view status of FLIPRTETRA subsystems:
1. Open FLIPR Tetra Diagnostics.
2. Click the Other tab.
This page is for viewing only.
73Chapter 5: FLIPR TetraDevice Driver User Guide
Managing profiles, operation timeouts and connection details
To manage FLIPRTETRA profiles, timeouts, and connection details:
1. Open FLIPR Tetra Diagnostics.
2. Click the Profile tab.
3. Select a profile from the Profile name list.
4. Perform the desired management task.
Management tasks include the following:
Chapter 5: FLIPR TetraDevice Driver User Guide
74
Updating the profile. Use this command to save edits to an existing profile.
Copying a profile.
Renaming a profile.
Deleting a profile.
Initializing a profile. Use this command to reset the device with the selected profile.
For more information about making changes to the Timeouts or Connection Details, look in “Related information” on page 74.
Related informationFor information about... See...
Opening FLIPRTETRA Diagnostics “Opening diagnostics” on page 10
Workflow for setting up a FLIPRTETRA
“Workflow for configuring the FLIPR Tetra” on page 60
Making changes to timeouts or connection details
“Creating a FLIPR Tetra profile” on page 61
75Chapter 6: Generic RS-232
Device Driver User GuideThe Generic RS-232 device driver allows you to configure devices that use an RS-232 serial connection in a lab automation system using VWorks or BenchWorks.
This chapter describes how to:
❑ Install the Generic RS-232 device driver plug-in
❑ Configure the Generic RS-232 device
❑ Set the Generic RS-232 task parameters
❑ Use Generic RS-232 Diagnostics
Generic RS-232 6
Chapter 6: Generic RS-232Device Driver User Guide
76
Workflow for configuring the Generic RS-232 driver
About this topic Before you can use the Generic RS-232 task in a protocol, you have to configure the Generic RS-232 driver.
This topic presents the workflow for configuring the Generic RS-232 driver. Read this topic if you are an Administrator responsible for setting up devices in VWorks or BenchWorks.
Workflow
Related information
Step Topic
1. “Installing device drivers” on page 13
2. “Adding devices” on page 15
3. “Creating a Generic RS-232 profile” on page 77
4. “Setting the properties for a device” on page 17
For information about... See...
Device drivers “About device drivers” on page 11
Setting Generic RS-232 task parameters
“Setting the Generic RS-232 task parameters” on page 78
Using Generic RS-232 Diagnostics “Using Generic RS-232 Diagnostics” on page 83
77Chapter 6: Generic RS-232Device Driver User Guide
Creating a Generic RS-232 profile
About this topic Profiles contain the initialization settings that enable VWorks or BenchWorks to identify and communicate with the Generic RS-232. Every device within the automation system must have its own profile. Once created, you will probably not need make changes to the profile.
This topic describes how to create a profile for the Generic RS-232 device driver. Read this topic if you are an Administrator responsible for setting up devices in VWorks or BenchWorks.
Before you start Before you can create a profile, you must install the Generic RS-232 driver plug-in and add the Generic RS-232 to the device manager.
Procedure To create a Generic RS-232 profile:
1. Open Generic RS-232 Diagnostics.
2. Click the Profiles tab.
3. Click Create a new profile.
4. Enter a name and click OK.
5. Choose the Profile Attributes. These include the following.
COM port parameter Description
Serial port Port used to communicate to the device.
Bits per second The speed of data transfer between the computer and device
Data bits How long a single data series is when being transmitted: 5, 6, 7, or 8
Parity Sets the type of error checking: none, odd or even, mark, or space
Stop bits Number of bits that indicate the end of a byte: 1, 1.5, or 2
Chapter 6: Generic RS-232Device Driver User Guide
78
6. Click Update this profile and close the dialog box.
Related information
Setting the Generic RS-232 task parameters
About this topic When you add a Generic RS-232 task to a protocol, you need to set the parameters for the task.
This topic describes how to set the Generic RS-232 device driver task parameters. Read this topic if you are:
❑ An Administrator or Technician responsible for creating protocols
❑ An Operator who wants to make changes to task the Generic RS-232 task parameters in a protocol
Generic RS-232 tasks defined
There are four tasks associated with the Generic RS-232:
❑ Send. Sends an ASCII string to the device using the Generic RS-232 device driver.
❑ Receive. Instructs VWorks or BenchWorks to indicate that the sent task was performed by the device.
❑ Send and Receive. Synchronizes a send and receive task so they both occur sequentially.
Flow control Determines how the speed of data flow is controlled: Xon/Xoff, none, or hardware
COM port parameter Description
For information about... See...
Opening diagnostics “Opening diagnostics” on page 10
The next step “Setting the properties for a device” on page 17
The workflow this procedure belongs to
“Workflow for configuring the Generic RS-232 driver” on page 76
Using JavaScript to write task parameters
❑ VWorks User Guide
❑ BenchCel User Guide
Using Generic RS-232 Diagnostics “Using Generic RS-232 Diagnostics” on page 83
Profiles “About profiles” on page 8
79Chapter 6: Generic RS-232Device Driver User Guide
❑ Wait for location. Instructs VWorks or BenchWorks to wait until the previous Generic RS-232 task finishes executing before going to the next task.
Setting the Send task parameters
To set the Send task parameters:
1. Add the Send task to a protocol.
2. In the Protocol Task Parameters toolbar, select the Generic RS-232 driver the device is using:
a. Click the name of the Generic RS-232 driver on the left side.
b. Click Add.
The name appears on the right side.
3. If necessary, expand Send properties.
4. Enter the command string.
All commands must be in ASCII. The software supports common escape sequence for sending commands. To send HEX numbers, precede commands with backslash x (\x).
Setting the Receive task parameters
To set the Receive task parameters:
1. Add the Receive task to a protocol.
2. In the Protocol Task Parameters toolbar, select the Generic RS-232 driver the device is using:
a. Click the name of the Generic RS-232 driver on the left side.
b. Click Add.
The name appears on the right side.
Chapter 6: Generic RS-232Device Driver User Guide
80
3. If necessary, expand Receive properties.
4. Select the Receive Mode.
The Receive Mode is the way in which VWorks or BenchWorks acknowledges that the command has been executed. Use the table below as a guide for the receive mode types.
5. Enter the value into the appropriate field, depending on your receive mode selection.
The Timeout value has a different meaning, depending on the receive mode you choose. If you select Wait for timeout as the receive mode, this value is the time VWorks or BenchWorks should wait (in milliseconds) before sending a signal. If you select any other receive mode, this value indicates the time to wait (in milliseconds) before VWorks or BenchWorks displays a message stating that the command has not been performed.
6. If you did not choose Wait for timeout as the Receive Mode, in the Time out field, enter a time to wait before a message is displayed stating that the command has not been performed.
If you are using a VWorks or BenchWorks scripting variable and want to retrieve its value, you must add the retrieval command to a task that occurs after this task is completed.
Receive Mode Description
Wait for timeout Signal is sent when the time, set by the user, is reached.
Wait for number of bytes Signal is sent when the number of bytes, set by the user, is reached.
Look for delimiters Signal is sent when delimiters, set by the user, are encountered.
Delimiters are characters that occur at the end of a command.
Look for exact string Signal is sent when a defined character string, set by the user, is encountered.
81Chapter 6: Generic RS-232Device Driver User Guide
Setting Send and Receive task parameters
To set the Send and Receive task parameters:
1. Add the Send and Receive task to a protocol.
2. In the Protocol Task Parameters toolbar, select the Generic RS-232 driver the device is using:
a. Click the name of the Generic RS-232 driver on the left side.
b. Click Add.
The name appears on the right side.
3. If necessary, expand Send, Receive properties.
4. Select the desired Receive Mode. See step 4 from the above procedure for information on receive modes.
5. Enter the value into the appropriate field, depending on your receive mode selection.
The Timeout value has a different meaning, depending on the receive mode you choose. If you select Wait for timeout as the receive mode, this value is the time VWorks or BenchWorks should wait (in milliseconds) before sending a signal. If you select any other receive mode, this value indicates the time to wait (in milliseconds) before VWorks or BenchWorks displays a message stating that the command has not been performed.
6. If you did not choose Wait for timeout as the Receive Mode, in the Time out field, enter a time to wait before a message is displayed stating that the command has not been performed.
If you are using a VWorks or BenchWorks scripting variable and want to retrieve its value, you must add the retrieval command to a task that occurs after this task is completed. See “About the Wait For Location task” on page 81 for more information.
About the Wait For Location task
Use this task when you want to retrieve the value of the VWorks or BenchWorks scripting variable. In VWorks or BenchWorks, JavaScripts are executed before tasks are completed, so to retrieve the scripting variable, the task has to be completed first. By using the Wait For Location task, you instruct VWorks or BenchWorks to wait until previous
Chapter 6: Generic RS-232Device Driver User Guide
82
Generic RS-232 tasks are finished and all scripts have been executed before going on to the next task.
Setting the Wait For Location task parameters
To set the Wait For Location task parameters:
1. Add the Wait For Location after the Receive or Send and Receive task in a protocol.
2. Click the task icon to select it.
3. In the Task Settings page of the Protocol Task Parameters toolbar, select the Generic RS-232 device from the Which device... list box.
4. In the Advanced Settings page, enter the command that will retrieve the variable.
The command may be entered on any task that occurs after the task from which it was generated.
Related informationFor information about... See...
Adding tasks to protocols ❑ VWorks User Guide
❑ BenchCel User Guide
Workflow for configuring the Generic RS-232
“Workflow for configuring the Generic RS-232 driver” on page 76
Using Generic RS-232 Diagnostics “Using Generic RS-232 Diagnostics” on page 83
83Chapter 6: Generic RS-232Device Driver User Guide
Using Generic RS-232 Diagnostics
About this topic This topic describes how to use the Generic RS-232 Diagnostics to manage profiles and perform commands. Read this topic if you are:
❑ An Administrator who wants to manage Generic RS-232 profiles
❑ An Technician or Operator who wants to set up or troubleshoot communications between the device and VWorks or BenchWorks
Managing profiles To manage profiles:
1. Open the Generic RS-232 Diagnostics.
2. Click the Profiles tab.
3. Select a profile from the Profile names list.
4. Perform the desired management task.
Management tasks include the following:
Updating the profile. Use this command to save edits to an existing profile.
Copying a profile.
Renaming a profile.
Deleting a profile.
Initializing a profile. Use this command to reset the device with the selected profile.
Chapter 6: Generic RS-232Device Driver User Guide
84
Communicating with the device
To send a command:
1. Open the Generic RS-232 Diagnostics.
2. Click the Controls tab.
3. Enter the command in the field at the top of the dialog box.
The command must contain only ASCII characters. The software supports common escape sequences for sending commands. To send HEX numbers, precede commands with a backslash x (\x).
4. Click Send.
To receive a response:
1. Select how you want to receive a signal from the Receive Mode list. See step 4 from the procedure “To receive a response:” on page 84 for information on receive modes.
2. Enter the values in the appropriate fields, depending on your receive mode selection.
The Timeout value has a different meaning, depending on the receive mode you choose. If you select Wait for timeout as the receive mode, this value is the time VWorks or BenchWorks should wait before sending a signal. If you select any other receive mode, this value indicates the time to wait (in milliseconds) before VWorks or BenchWorks displays a message stating that the command has not been performed.
If you select continuous mode, the Generic RS-232 device will be in a continuous receive mode until you exit from it. To exit, select another Receive Mode type.
85Chapter 6: Generic RS-232Device Driver User Guide
3. If you did not choose Wait for timeout as the Receive Mode in the Timeout field, enter a time to wait before a message is displayed stating that the command has not been performed.
4. Select the type of code you want the receive string displayed in, in the log window.
5. Click Receive.
Note: To send a command and receive a response synchronously, click Send and Receive.
Related informationFor information about... See...
Workflow for configuring a Generic RS-232 driver
“Workflow for configuring the Generic RS-232 driver” on page 76
Adding a device driver to the device manager
“Adding devices” on page 15
Creating a Generic RS-232 profile “Creating a Generic RS-232 profile” on page 77
Profiles “About profiles” on page 8
Chapter 6: Generic RS-232Device Driver User Guide
86
87Chapter 7: IN Cell Analyzer 1000
Device Driver User GuideThe Amersham Biosciences IN Cell Analyzer 1000 system can be configured to work in lab automation systems using VWorks or BenchWorks.
The IN Cell Analyzer 1000 is an automated epifluorescence-based microscope system for assay development and cellular analysis.
This chapter describes how to:
❑ Install the IN Cell Analyzer 1000 device driver
❑ Configure the IN Cell Analyzer 1000
❑ Set the IN Cell Analyzer 1000 task parameters
❑ Use IN Cell Analyzer 1000 Diagnostics
IN Cell Analyzer 1000 7
Chapter 7: IN Cell Analyzer 1000Device Driver User Guide
88
Workflow for configuring the IN Cell Analyzer 1000
About this topic This topic presents the workflow for configuring the IN Cell Analyzer 1000 device driver.
Read this topic if you are an Administrator responsible for setting up devices in VWorks or BenchWorks.
Workflow
Related information
Creating an IN Cell Analyzer 1000 profile
About this topic This topic describes how to create a profile for the IN Cell Analyzer 1000. Creating a profile is an essential step for setting up the IN Cell Analyzer 1000 device driver.
Read this topic if you are an Administrator responsible for setting up devices in VWorks or BenchWorks.
Before you start Before you create a profile, you need to have added the IN Cell Analyzer 1000 to the device manager.
Step Topic
1. “Installing device drivers” on page 13
You may have already done this.
2. “Adding devices” on page 15
3. “Creating an IN Cell Analyzer 1000 profile” on page 88
4. “Setting the properties for a device” on page 17
For information about... See...
Device drivers “About device drivers” on page 11
Setting IN Cell Analyzer 1000 task parameters
“Setting IN Cell Analyzer 1000 task parameters” on page 91
Using IN Cell Analyzer 1000 Diagnostics
“Using IN Cell Analyzer 1000 Diagnostics” on page 92
89Chapter 7: IN Cell Analyzer 1000Device Driver User Guide
Procedure To create a IN Cell Analyzer 1000 profile:
1. Open the IN Cell Analyzer 1000 Diagnostics.
2. Click the Profiles tab.
3. Click Create a new profile.
4. In the Create Profile dialog box, enter a name for the profile and click OK.
The name appears in the Profile name field.
5. In the Profile Settings group box, set the following:
Setting Description
Base destination folder for storing images
Click the ellipsis button to set the directory where the IN Cell image files will be saved.
Protocol name Select this to have the image files saved in a sub-directory named with the IN Cell Analyzer 1000 protocol name.
Plate name Select this to have the image files saved in a sub-directory named with the plate name.
Date / time stamp When selected, the output data directory names are appended with the current date and time.
❑ Date / time stamp
❑ South bar code
❑ West bar code
❑ North bar code
❑ East bar code
Select what data you want included in the plate name.
If none of these are selected, the IN Cell Analyzer 1000 default timestamp is used as the plate name.
Chapter 7: IN Cell Analyzer 1000Device Driver User Guide
90
If both the Protocol name and Plate name check boxes are selected, the directory structure for the IN Cell Analyzer 1000 image files will look like this:
Related informationFor information about... See...
Opening diagnostics “Opening diagnostics” on page 10
Device drivers “About device drivers” on page 11
Adding the IN Cell Analyzer 1000 to the device manager
“Adding devices” on page 15
The next step “Setting the properties for a device” on page 17
The workflow this procedure belongs to
“Workflow for configuring the IN Cell Analyzer 1000” on page 88
Using diagnostics “Using IN Cell Analyzer 1000 Diagnostics” on page 92
Using IN Cell Analyzer 1000 tasks “Setting IN Cell Analyzer 1000 task parameters” on page 91
Profiles “About profiles” on page 8
91Chapter 7: IN Cell Analyzer 1000Device Driver User Guide
Setting IN Cell Analyzer 1000 task parameters
About this topic After the device has been added to the device file, the tasks associated with the IN Cell Analyzer 1000 become available in the protocol editor. When a task is added to a protocol, you need to set the parameters for it. This includes choosing which IN Cell Analyzer 1000 (if there is more than one).
This topic describes the tasks and their parameters.
Read this topic if you are:
❑ An Administrator or Technician responsible for creating protocols
❑ An Operator who wants to make changes to the IN Cell Analyzer 1000 task parameters in a protocol
About IN Cell Analyzer 1000 tasks
The IN Cell Analyzer 1000 device driver adds one task to VWorks or BenchWorks software. This task is used to deliver commands to the IN Cell Analyzer 1000 during the execution of a protocol.
This task executes an IN Cell Analyzer 1000 protocol. These protocols are created using the IN Cell Analyzer 1000 software. When the task executes the IN Cell Analyzer 1000 software automatically opens so you can observe the progress.
The Run Protocol (IN Cell Analyzer 1000) task is represented by this icon in the Protocol Tasks toolbar:
Setting Run Protocol (IN Cell Analyzer) task parameters
To set the Run Protocol (IN Cell Analyzer) task parameters:
1. Add the Run Protocol (IN Cell Analyzer) task to the desired protocol process.
2. In the parameters toolbar, make sure the Task Settings tab is displayed.
3. Move the IN Cell Analyzer 1000 or IN Cell Analyzer 1000s that you want to use to the right field using the Add and Remove buttons.
Chapter 7: IN Cell Analyzer 1000Device Driver User Guide
92
4. Set the Protocol Name.
The protocols created in the IN Cell Analyzer 1000 software are available for selection. (These are different from the protocols created in VWorks or BenchWorks.)
5. Select File > Device File > Save to save the changes to the device file.
Related information
Using IN Cell Analyzer 1000 Diagnostics
About this topic This topic describes using IN Cell Analyzer 1000 Diagnostics to:
❑ Manage profiles
❑ Execute specific operations, such as extending the stage and running an IN Cell Analyzer 1000 protocol
Read this topic if you are:
❑ An Administrator who wants to manage IN Cell Analyzer 1000 profiles or set robot teachpoints
❑ A Technician or Operator who wants to use IN Cell Analyzer 1000 Diagnostics to troubleshoot or operate the IN Cell Analyzer 1000 without running a protocol
For more information about... See...
The workflow that this procedure belongs to
“Workflow for configuring the IN Cell Analyzer 1000” on page 88
Creating protocols, pre-protocols, post-protocols, and pipette processes
❑ VWorks User Guide
❑ BenchCel User Guide
Opening IN Cell Analyzer 1000 device properties page
“Adding devices” on page 15
Using diagnostics “Using IN Cell Analyzer 1000 Diagnostics” on page 92
93Chapter 7: IN Cell Analyzer 1000Device Driver User Guide
Managing profiles To manage IN Cell Analyzer 1000 profiles:
1. Open the IN Cell Analyzer 1000 Diagnostics.
2. Click the Profiles tab.
3. Select a profile from the Profile names list.
4. Perform the desired management task.
Management tasks include the following:
Updating the profile. Use this command to save edits to an existing profile.
Copying a profile.
Renaming a profile.
Deleting a profile.
Initializing a profile. Use this command to reset the device with the selected profile.
Extending the stage on the IN Cell Analyzer 1000
You may want to extend the stage on the IN Cell Analyzer 1000 when you are setting robot teachpoints or before you run an IN Cell Analyzer 1000 protocol directly from the Controls diagnostics page.
To extend the stage on the IN Cell Analyzer 1000:
1. Open the IN Cell Analyzer 1000 Diagnostics.
2. Click the Controls tab.
Chapter 7: IN Cell Analyzer 1000Device Driver User Guide
94
3. Click Extend Stage.
Running a protocol To run a protocol on the IN Cell Analyzer 1000:
1. Open the IN Cell Analyzer 1000 Diagnostics.
2. Click the Controls tab.
3. Click Refresh to update the list box with the current protocols from the IN Cell Analyzer 1000.
4. Select the IN Cell Analyzer 1000 protocol that you want to run.
These are protocols that have been created on the IN Cell Analyzer 1000.
5. Click Run protocol.
The IN Cell Analyzer 1000 software automatically opens so you can observe the progress of the protocol.
Note: Click Abort Protocol to stop the IN Cell Analyzer 1000 protocol run.
95Chapter 7: IN Cell Analyzer 1000Device Driver User Guide
Related informationFor more information about... See...
Opening diagnostics “Opening diagnostics” on page 10
Workflow for configuring the IN Cell Analyzer 1000
“Workflow for configuring the IN Cell Analyzer 1000” on page 88
Creating a IN Cell Analyzer 1000 profile
“Creating an IN Cell Analyzer 1000 profile” on page 88
Chapter 7: IN Cell Analyzer 1000Device Driver User Guide
96
97Chapter 8: KiNEDx Robot
Device Driver User GuideThe Peak Robotics KiNEDx is a cylindrical, four-axis robot.
This chapter describes how to:
❑ Install the KiNEDx Robot device driver plug-in
❑ Configure the KiNEDx Robot device
❑ Use the KiNEDx Robot Diagnostics
KiNEDx Robot 8
Chapter 8: KiNEDx RobotDevice Driver User Guide
98
Workflow for configuring the KiNEDx Robot
About this topic Before you can use the KiNEDx Robot tasks in a protocol, you need to add the KiNEDx Robot to the device manager and configure it in VWorks or BenchWorks.
This topic presents the workflow for configuring the KiNEDx Robot device driver. Read this topic if you are an Administrator responsible for setting up a KiNEDx Robot device.
Workflow
Related information
Creating a KiNEDx Robot profile
About this topic Profiles contain the initialization settings that enable VWorks or BenchWorks to identify and communicate with the KiNEDx Robot. Every device within the automation system must have its own profile. Once created, you will probably not need make changes to the profile.
This topic describes how to create a profile for the KiNEDx Robot device. Read this topic if you are an Administrator responsible for configuring the KiNEDx Robot in VWorks or BenchWorks.
Before you start Before you can create a profile, the KiNEDx Robot device driver needs to be installed and the device added to the device manager.
Step Topic
1. “Installing device drivers” on page 13
2. “Adding devices” on page 15
3. “Creating a KiNEDx Robot profile” on page 98
4. “Setting the properties for a device” on page 17
For information about... See...
Device drivers “About device drivers” on page 11
Using KiNEDx Robot Diagnostics “Using KiNEDx Robot Diagnostics” on page 100
99Chapter 8: KiNEDx RobotDevice Driver User Guide
Procedure To create a KiNEDx Robot profile:
1. Open KiNEDx Robot Driver Diagnostics.
2. Click the Profiles tab.
3. In the Profile Management group box, click Create a new profile.
4. Enter a name and click OK.
5. Choose Initialization Files for the profile:
a. Click the Parameters file ellipsis button and set the path to the KiNEDx Robot’s parameter file.
This file comes with the instrument.
b. Click the Teachpoints file ellipsis button and set the path to the teachpoint file.
6. Optionally, change the Speed Definitions.
Default settings are slow (25% of max), medium (50% of max), and fast (100% of max).
7. Optionally, select Always rehome... to have the robot rehome every time it initializes.
Not selecting this option instructs the robot to skip the homing routine if the power to the robot has not been interrupted since the last robot initialization.
8. Select Check plate sensor after plate pickup to enable the sensor that checks whether the robot has picked up a plate.
Chapter 8: KiNEDx RobotDevice Driver User Guide
100
Related information
Using KiNEDx Robot Diagnostics
About this topic Use the KiNEDx Robot Diagnostics to:
❑ Manage profiles
❑ Move the robot for diagnostic purposes
❑ Create teachpoints using the KiNEDx Robot software
❑ View the KiNEDx Robot status
Read this topic if you are:
❑ An Administrator who wants to manage profiles or run diagnostics
❑ A Technician or Operator who wants to use diagnostics for troubleshooting and creating teachpoints
Managing profiles To manage profiles:
1. Open KiNEDx Robot Driver Diagnostics.
2. Click the Profiles tab.
3. Select a profile from the Profiles name list.
4. Perform the desired management task.
Management tasks include the following:
Updating the profile. Use this command to save edits to an existing profile.
Copying a profile.
Renaming a profile.
Deleting a profile.
Initializing a profile. Use this command to reset the device with the selected profile.
For information about... See...
Profiles “About profiles” on page 8
The next step “Setting the properties for a device” on page 17
Using KiNEDx Robot Diagnostics “Using KiNEDx Robot Diagnostics” on page 100
101Chapter 8: KiNEDx RobotDevice Driver User Guide
Moving the KiNEDx Robot in one direction
To open and close the grippers:
1. Open KiNEDx Robot Driver Diagnostics.
2. Click the Control tab.
3. Optionally, select a Robot speed.
4. Click Open gripper or Close gripper to open or close the grippers at their current positions.
To retract the KiNEDx Robot’s elbow:
1. Click Retract elbow to command the robot to retract its arm all the way to ensure a minimal footprint.
To move the arm in the Z direction:
1. Enter a value (in millimeters) that you want to move the arm in the Z direction.
The distance moved is relative to the current position of the robot arm.
2. Click Move Z.
Performing a simple move
To perform a simple move:
1. Open KiNEDx Robot Driver Diagnostics.
2. Click the Control tab.
3. Optionally, select a Robot speed.
4. Use the controls in the Simple Move group box to depart from a position and move to a designated teachpoint:
a. From the Teachpoint list box, select the teachpoint you want to move to.
b. Optionally, modify the move by entering values for the following:
Property Description
Departure height Distance above the departure location that the grippers should move to before picking up the plate.
Chapter 8: KiNEDx RobotDevice Driver User Guide
102
c. Click Move to execute the command.
Moving between teachpoints
To move from one teachpoint to another:
1. Open KiNEDx Robot Driver Diagnostics.
2. Click the Control tab.
3. Optionally, select a Robot speed.
4. Select the Source teachpoint from the list box.
This is where the robot picks a plate from.
5. Optionally, modify this move by entering different values for the Departure height and Offset.
6. Select the Destination teachpoint from the list box.
This is where the robot places a plate.
7. Optionally, modify this move by entering different values for the Arrival height and Offset.
8. Click Move to execute the pick and place moves.
Note: Click Swap source and destination to move from the destination teachpoint to the source teachpoint.
Arrival height Distance above the offset and teachpoint that the grippers should move to before placing the plate.
Offset Distance from the bottom of the plate to where the grippers grab the plate.
Push-down overextend Distance beyond the teachpoint and offset that the grippers move to to ensure secure plate placement.
Property Description
103Chapter 8: KiNEDx RobotDevice Driver User Guide
Viewing robot positions
To view the KiNEDx Robot’s current position:
1. Open KiNEDx Robot Driver Diagnostics.
2. Click the Control tab.
3. Select Enable KiNEDx Robot Status.
The current positions are displayed.
Creating teachpoints To create KiNEDx Robot teachpoints:
1. Open KiNEDx Robot Driver Diagnostics.
2. Click the Control tab.
3. Click Launch Peak KiNEDx teach GUI.
This opens the interface of the KiNEDx software enabling you to create teachpoints.
Related informationFor information about... See...
Device drivers “About device drivers” on page 11
Creating a KiNEDx profile “Creating a KiNEDx Robot profile” on page 98
Parameter files KiNEDx user documentation
Creating teachpoints KiNEDx user documentation
Chapter 8: KiNEDx RobotDevice Driver User Guide
104
105Chapter 9: LEADseeker
Device Driver User GuideAmersham Biosciences LEADseeker Multimodality Imaging System can be configured to work in lab automation systems using VWorks or BenchWorks.
The LEADseeker is high-throughput, multimode imaging system that detects fluorescence polarization (FP), time-resolved fluorescence (TRF), and radiometric imaging.
This chapter describes how to:
❑ Install the LEADseeker device driver
❑ Configure the LEADseeker
❑ Set the LEADseeker task parameters
❑ Use LEADseeker Diagnostics
LEADseeker 9
Chapter 9: LEADseekerDevice Driver User Guide
106
Workflow for configuring the LEADseeker
About this topic This topic presents the workflow for configuring the LEADseeker device driver.
Read this topic if you are an Administrator responsible for setting up devices in VWorks or BenchWorks.
Workflow
Related information
Step Topic
1. “Installing device drivers” on page 13
You may have already done this.
2. “Adding devices” on page 15
3. “Creating a LEADseeker profile” on page 107
4. “Setting the properties for a device” on page 17
For information about... See...
Device drivers “About device drivers” on page 11
Setting LEADseeker task parameters
“Setting LEADseeker task parameters” on page 108
Using LEADseeker Diagnostics “Using LEADseeker Diagnostics” on page 110
107Chapter 9: LEADseekerDevice Driver User Guide
Creating a LEADseeker profile
About this topic This topic describes how to create a profile for the LEADseeker. Creating a profile is an essential step for setting up the LEADseeker device driver.
Read this topic if you are an Administrator responsible for setting up devices in VWorks or BenchWorks.
Before you start Before you create a profile, you need to have added the LEADseeker to the device manager.
Procedure To create a LEADseeker profile:
1. Open the LEADseeker Diagnostics.
2. Click the Profiles tab.
3. Click Create a new profile.
4. Enter a name for the profile and click OK.
The name appears in the Profile name field.
5. In the Profile Attributes group box, set the following:
Setting Description
COM port The port connecting the LEADseeker to the controlling computer.
Simulate When selected, allows you to operate the software in the absence of a LEADseeker device.
Note: This option is for software developer’s use.
Chapter 9: LEADseekerDevice Driver User Guide
108
Related information
Setting LEADseeker task parameters
About this topic After the device has been added to the device file, the tasks associated with the LEADseeker become available in the protocol editor. When a task is added to a protocol, you need to set the parameters for it. This includes choosing which LEADseeker (if there is more than one) and what protocol to use.
This topic describes the tasks and their parameters.
Read this topic if you are:
❑ An Administrator or Technician responsible for creating protocols
❑ An Operator who wants to make changes to the LEADseeker task parameters in a protocol
Append the following attributes to the output filename:
❑ Date / time stamp
❑ South bar code
❑ West bar code
❑ North bar code
❑ East bar code
When selected, the output data file names are appended with:
❑ Current date and time
❑ Bar code located on the direction side
Setting Description
For information about... See...
Opening diagnostics “Opening diagnostics” on page 10
Adding the LEADseeker to the device manager
“Adding devices” on page 15
The next step “Setting the properties for a device” on page 17
The workflow this procedure belongs to
“Workflow for configuring the LEADseeker” on page 106
Using diagnostics “Using LEADseeker Diagnostics” on page 110
Using LEADseeker tasks “Setting LEADseeker task parameters” on page 108
109Chapter 9: LEADseekerDevice Driver User Guide
About LEADseeker tasks
The LEADseeker device driver adds one task to VWorks or BenchWorks software. This task is used to deliver the read commands to the LEADseeker during the execution of a protocol.
The LEADseeker task is represented by this icon in the Protocols Task toolbar:
This task is available in the protocol editor.
Setting Read (LEADseeker Reader) task parameters
To set the Read (LEADseeker Reader) task parameters:
1. Add the Read (LEADseeker Reader) task to the desired protocol process.
2. Move the LEADseeker or LEADseekers that you want to use to the right field using the Add and Remove buttons.
3. Set the “Read” properties.
4. Click Update this profile.
Property Description
Protocol Protocols created in LEADseeker software.
Refer to LEADseeker user documentation.
Output file path Type the name of the output file.
This file is saved to the computer running the LEADseeker. Enter the file name only (illegal characters cannot be entered). This file name is then appended according to the options selected in the profile.
If the file already exists, it will be overwritten.
Chapter 9: LEADseekerDevice Driver User Guide
110
Related information
Using LEADseeker Diagnostics
About this topic This topic describes using LEADseeker Diagnostics to:
❑ Manage profiles
❑ Run a LEADseeker protocol
Read this topic if you are:
❑ An Administrator who wants to manage LEADseeker profiles
❑ A Technician or Operator who wants to use LEADseeker Diagnostics to troubleshoot or operate the LEADseeker without running a protocol
Managing profiles To manage LEADseeker profiles:
1. Open the LEADseeker Diagnostics.
2. Click the Profiles tab.
For more information about... See...
The workflow that this procedure belongs to
“Workflow for configuring the LEADseeker” on page 106
Creating protocols, pre-protocols, post-protocols, and pipette processes
❑ VWorks User Guide
❑ BenchCel User Guide
Opening LEADseeker device properties page
“Adding devices” on page 15
Using LEADseeker Diagnostics “Using LEADseeker Diagnostics” on page 110
111Chapter 9: LEADseekerDevice Driver User Guide
3. Select a profile from the Profile names list.
4. Perform the desired management task.
Management tasks include the following:
Updating the profile. Use this command to save edits to an existing profile.
Copying a profile.
Renaming a profile.
Deleting a profile.
Initializing a profile. Use this command to reset the device with the selected profile.
Running a LEADseeker protocol
To run a LEADseeker protocol:
1. Open LEADseeker Diagnostics.
2. Click the Controls tab.
3. Click Open door.
Chapter 9: LEADseekerDevice Driver User Guide
112
4. Place your plate in the LEADseeker.
5. Click Close door.
6. Click Refresh list to display the available protocols.
7. Select a protocol.
8. If you want to save the data from the read, enter a Filename.
The data is saved to the file located on the LEADseeker’s computer.
9. Click Run protocol.
Related informationFor more information about... See...
Opening diagnostics “Opening diagnostics” on page 10
Workflow for configuring the LEADseeker
“Workflow for configuring the LEADseeker” on page 106
Creating a LEADseeker profile “Creating a LEADseeker profile” on page 107
113Chapter 10: Multimek
Device Driver User GuideThe Beckman Multimek Pipettor is a liquid dispensing device that can be configured to work in a lab automation system using VWorks or BenchWorks.
This chapter describes how to:
❑ Install the Multimek device driver plug-in
❑ To configure the Multimek
❑ Set the Multimek task parameters
❑ Use Multimek Diagnostics
Multimek 10
Chapter 10: MultimekDevice Driver User Guide
114
Workflow for configuring the Multimek
About this topic Before you can use the Multimek tasks in protocols, the Multimek needs to be configured in VWorks or BenchWorks.
This topic provides the workflow for configuring the Multimek device in VWorks or BenchWorks. Read this topic if you are an Administrator who is responsible for setting up a Multimek device.
Workflow
Related information
Step Topic
1. “Installing device drivers” on page 13
2. “Adding devices” on page 15
3. “Creating and managing Multimek profiles” on page 115
4. “Setting the properties for a device” on page 17
For information about... See...
Device drivers “About device drivers” on page 11
Setting Multimek task parameters “About the high-level Multimek tasks” on page 119
Using Multimek Diagnostics “About Multimek Diagnostics” on page 140
115Chapter 10: MultimekDevice Driver User Guide
Creating and managing Multimek profiles
About this topic Profiles contain the initialization settings that enable VWorks or BenchWorks to identify and communicate with the Multimek. Every device within the automation system must have its own profile. Once created, you will probably not need make changes to the profile.
This topic describes how to create a profile for the Multimek device. Read this topic if you are an Administrator who is responsible for setting up a Multimek.
Before you start Before you create a profile, you need to install the Multimek device driver plug-in and add the Multimek to the device manager.
Procedures To create a profile for the Multimek:
1. Open Multimek Diagnostics.
2. Click the Profile tab.
3. Click Create a new profile.
4. Enter a name for the profile and click OK.
Chapter 10: MultimekDevice Driver User Guide
116
5. Choose the Communication and I/O settings:
a. From the list box, select the Serial port (COM port) that the computer is using to communicate to the Multimek.
b. Enter the number of the Ready channel.
This number is the digital input channel which signals the tip-loading robot is ready to perform an operation.
c. Enter the number of the Halted channel.
This number is the digital input channel which signals the tip-loading robot is in a halted state.
d. Enter the number of the Deliver tips channel.
This number is the digital output channel which signals the tip-loading robot to deliver new tip tray to the depot.
e. Enter the number of the Remove tips channel.
This number is the digital output channel which signals the tip-loading robot to remove the tip tray from the depot.
6. Choose the Head Configuration settings:
a. Select the head the Multimek is using.
b. Select the Head type from the list box.
The Head type specifies the number of channels in the head and the volume capacity of the head.
c. Enter the maximum volume for the tips attached to the pipette head.
7. Choose the Frame Configuration settings:
a. From the list, select the location for which you are configuring the Multimek.
b. Select the Location type from the list.
Available for plates. A location to which the robot can place a plate.
Not available for plates. A location that is not available for placing plates or for pipetting operations for example, a tip depot.
c. If this frame can be used to discard tips, select the Can be used to trash tips check box.
d. Enter the number of steps for the Plate bottom position.
This distance is the Z-axis position at which the tips and the bottom of the labware are at the same height.
8. Choose the profile Options:
a. Select the appropriate plate type for which the Multimek was taught.
These are the frame teachpoints set at the center of the A1 well.
b. Select the Position of the A1 corner from the list box.
117Chapter 10: MultimekDevice Driver User Guide
Front is defined as the side of the frame closest to the manual-entry keypad.
c. Enter the Tip safety distance, in millimeters.
This is the height above the labware at which tips approach before dipping into the set of wells and, similarly, the height above the labware that the tips rise to before leaving the set of wells.
9. Choose the Robotic/Human Access settings.
These options depend on your systems’ setup. If you choose to move the head for access, then select the position from which you want access.
10. Click OK to save the profile and close the dialog box.
To manage Multimek profiles:
1. Open the Multimek Diagnostics.
2. Click the Profile tab.
3. Select a profile from the Profiles name list.
Chapter 10: MultimekDevice Driver User Guide
118
4. Perform the desired management task.
Management tasks include the following:
Updating the profile. Use this command to save edits to an existing profile.
Copying a profile.
Renaming a profile.
Deleting a profile.
Initializing a profile. Use this command to reset the device with the selected profile.
Related informationFor information about... See...
The next step “Setting the properties for a device” on page 17
The workflow this procedure belongs to
“Workflow for configuring the Multimek” on page 114
Adding the Multimek to the device manager
“Adding devices” on page 15
Profiles “About profiles” on page 8
Setting Multimek task parameters ❑ “About the high-level Multimek tasks” on page 119
❑ “Setting high-level Multimek Aspirate task parameters” on page 123
❑ “Setting low-level (simple) Multimek task parameters” on page 135
Opening Multimek Diagnostics “Opening diagnostics” on page 10
Using Multimek Diagnostics “About Multimek Diagnostics” on page 140
119Chapter 10: MultimekDevice Driver User Guide
About the high-level Multimek tasks
About this topic The Multimek driver adds 17 tasks to VWorks or BenchWorks software. These tasks are used to deliver commands to the Multimek during the execution of a pre-protocol, pipette or post-protocol process within a protocol. These tasks are further divided into:
❑ High level
❑ Low level
This topic lists the Multimek high-level tasks and describes what they do. Read this topic if you are:
❑ An Administrator or Technician who writes protocols using the Multimek
❑ An Operator who needs to edit Multimek tasks in a protocol
The Multimek high-level tasks are represented by the following icons.
Multimek high-level tasks defined
High-level tasks are made up of a series of commands that when executed, perform a single operation. Most of the time you will be using these tasks to execute a protocol. The following table describes the functions of the high-level tasks and the protocol processes for which they are available.
High-level task Function Available in this editor
Setting task parameter procedure
Aspirate Draws a volume according to all the conditions specified in the task parameters toolbar.
Pipette “Setting high-level Multimek Aspirate task parameters” on page 123
Change Instance Instructs VWorks or BenchWorks to perform subsequent operations using a new plate.
Pipette “Setting Multimek Change Instance task parameters” on page 125
Chapter 10: MultimekDevice Driver User Guide
120
About the Deliver Tip Trays task
There are no task parameters for this task. This is a task that is executed by the tip-loader and is configured in the Multimek profile.
If necessary, use the commands in the Jog/Teach page of the Multimek Diagnostics dialog box to troubleshoot this task.
About the Remove Tip Tray task
There are no task parameters for this task because the Multimek plate handler knows that tips are always placed on Frame 5.
Dispense Dispenses a volume according to all the conditions specified in the task parameters toolbar.
Pipette “Setting high-level Multimek Dispense task parameters” on page 126
Deliver Tip Tray Instructs the tip-loader to deliver a tray of tips to a designated location.
Pre-, pipette, and post-protocol
“About the Deliver Tip Trays task” on page 120
Empty Tips Dispense the entire volume of the pipette tip according to the conditions specified in the task parameter toolbar.
Pre-, pipette, and post-protocol
“Setting high-level Multimek Empty Tips task parameters” on page 129
Loop Instructs VWorks or BenchWorks to repeat all enclosed tasks in the pipette process for the number of times and according to the conditions entered in the task parameter toolbar.
Pipette and protocol
“Setting Multimek Loop task parameters” on page 131
Mix Instructs the pipette head to aspirate and dispense into the same well for the number of times and according to the conditions entered in the task parameters toolbar.
Pipette “Setting high-level Multimek Mix task parameters” on page 132
Remove Tip Tray Instructs the tip-loader to remove a tray of tips from one location and place it in another location.
Pre-, pipette, and post-protocol
“About the Remove Tip Tray task” on page 120
Run Macro Instructs the pipette head to execute the named script contained in the Multimek’s memory.
Pre-, pipette, and post-protocol
“Setting high-level Multimek Run Macro task parameters” on page 134
Sub Process Adds a pipette process to the protocol process.
Protocol “About the Sub Process task” on page 121
High-level task Function Available in this editor
Setting task parameter procedure
121Chapter 10: MultimekDevice Driver User Guide
About the Sub Process task
This task is used to add a sub-routine of a series of pipette tasks to a protocol. See “Related information” on page 121 for a procedure on how to set up a Multimek Sub Process task.
Related information
About the low-level Multimek tasks
About this topic The Multimek driver adds 17 tasks to VWorks or BenchWorks software. These tasks are used to deliver commands to the Multimek during the execution of a pre-protocol, pipette or post-protocol process within a protocol. These tasks are further divided into:
❑ High level
❑ Low level
This topic lists the Multimek low-level tasks and describes what they do. Read this topic if you are:
❑ An Administrator or Technician who writes protocols using the Multimek
❑ An Operator who needs to edit Multimek tasks in a protocol
The Multimek low-level tasks are represented by the following icons.
For information about... See...
Multimek low-level tasks “About the low-level Multimek tasks” on page 121
Adding tasks to protocols ❑ VWorks User Guide
❑ BenchCel User Guide
Adding and configuring a sub-process
“Adding and configuring Sub Process tasks” on page 20
Using Multimek Diagnostics “About Multimek Diagnostics” on page 140
Chapter 10: MultimekDevice Driver User Guide
122
Multimek low-level tasks defined
Low-level tasks are single commands that when executed perform a single operation. Typically, these tasks are only used in the lab automation setup and not required for most applications.
The following table describes the functions of the low-level tasks and the protocol processes for which they are available.
Related information
Low-level task Function Available in this editor
Setting task parameter procedure
Aspirate (simple) Draws a specified volume from its current position.
Pipette “Setting low-level (simple) Multimek task parameters” on page 135
Dispense (simple) Dispenses a specified volume to a specified plate position.
Pipette “Setting low-level (simple) Multimek task parameters” on page 135
Empty Tips (simple) Dispenses a specified volume at its current position.
Pre-, pipette, and post-protocol
“Setting low-level (simple) Multimek task parameters” on page 135
Move X-Y Axes Moves the pipette head relative to its current position in the X (left/right) and Y (forward/backward) directions as specified in the task.
Pipette “Setting low-level Multimek Move Axes task parameters” on page 137
Move Z Axis (absolute)
Moves the pipette head relative to its zero position in the Z direction (up/down) as specified in the task.
Pipette “Setting low-level Multimek Move Axes task parameters” on page 137
Move Z Axis (relative)
Moves the pipette head in the Z (up/down) direction, relative to its current position as specific in the task.
Pipette “Setting low-level Multimek Move Axes task parameters” on page 137
Move to Plate/Frame Moves to the teachpoint of the selected frame/position.
Pipette “Setting low-level Multimek Move Axes task parameters” on page 137
For information about... See...
Multimek high-level tasks “About the high-level Multimek tasks” on page 119
Adding tasks to protocols ❑ VWorks User Guide
❑ BenchCel User Guide
Configuring a sub-process “Adding and configuring Sub Process tasks” on page 20
123Chapter 10: MultimekDevice Driver User Guide
Setting high-level Multimek Aspirate task parameters
About this topic After a task has been added to a pre-protocol, pipette (sub-process), or post-protocol process, you need to set the parameters for it. This topic describes how to set the parameters for the high-level Multimek Aspirate task.
Read this topic if you are:
❑ An Administrator or Technician who writes protocols using the Multimek
❑ An Operator who needs to edit Multimek tasks in a protocol
Before you start To make pipette tasks available, you first need to add and configure a Sub Process task.
Setting Aspirate tasks parameters
To set the Aspirate task parameters:
1. Add the Aspirate task to a protocol.
2. In the Pipette Task Parameters toolbar, make sure the Task Settings tab is displayed and Aspirate Properties is expanded.
3. Double-click in the field next to Plate/Frame and select the desired position from which to aspirate from the list box.
4. Enter the Volume to aspirate from each quadrant.
5. Enter the Pre-aspirate volume.
This is the volume to aspirate before the tips enter the wells, to create an air gap.
Using Multimek Diagnostics “About Multimek Diagnostics” on page 140
For information about... See...
Chapter 10: MultimekDevice Driver User Guide
124
6. Enter the Post-aspirate volume.
This is the volume to aspirate after the tips leave the wells, to create a second air gap.
7. Enter the Distance from well bottom (in millimeters), you want the tip to be from the bottom of the well at the start of aspiration.
8. Enter the Dynamic tip retraction rate (mm/µL).
This is the speed at which the tips need to move into the well during aspiration in order to maintain the tips at the same relative position to the liquid.
9. From the Number of tip touches list box, select the number of times you want the tips to touch the well after aspiration and withdrawal from the liquid.
The maximum number of tip touches is four, one for each side of the well. At the end of each touch, the tip returns to the center of the well.
10. Enter the Tip touch retract distance (in millimeters) you want the tips to pull back away from the well before it executes the tip touch command.
11. Double-click in the field next to Quadrants to open the Well Selection dialog box.
Note: Quadrants may be selected only when you are using a 384-well plate with a 96-tip pipette head.
Click on one of the four upper-left corner wells to select a quadrant. Selected wells are displayed as filled.
Quadrants are represented as follows:
12. From the Liquid class list, select the appropriate liquid type.
Choosing a liquid type tells the software how you want to handle the liquid. If you select <none>, then proceed to the next two steps to set the pipette head travel and aspiration velocity.
13. If you selected <none> for the Liquid class, then enter the Z axis velocity.
This is the speed you want the pipette head to move up and down (into and out of the plate).
14. If you selected <none> for the Liquid class, then enter the D axis velocity.
This is the speed you want the internal pipettor to aspirate.
Selecting well... Selects quadrant...
A1 1
B1 3
A2 2
B2 4
125Chapter 10: MultimekDevice Driver User Guide
Related information
Setting Multimek Change Instance task parameters
About this topic After a task has been added to a pre-protocol, pipette (sub-process), or post-protocol process, you need to set the parameters for it. This topic describes how to set the parameters for the high-level Multimek Change Instance task.
Typically the Change Instance task is used in conjunction with the Loop task to perform the same operation on different plates.
Read this topic if you are:
❑ An Administrator or Technician who writes protocols using the Multimek
❑ An Operator who needs to edit Multimek tasks in a protocol
Before you start To make pipette tasks available, you first need to add and configure a Sub Process task.
Setting Change Instance task parameters
To set the Change Instance task parameters:
1. Add the Change Instance task to a protocol.
2. In the Protocol Task Parameters toolbar, select the plate to change instance on from the list box.
For information about... See...
Adding tasks to protocols ❑ VWorks User Guide
❑ BenchCel User Guide
Multimek tasks ❑ “About the high-level Multimek tasks” on page 119
❑ “About the low-level Multimek tasks” on page 121
Configuring a Sub Process task “Adding and configuring Sub Process tasks” on page 20
Adding the Multimek to the device driver
“Adding devices” on page 15
Using Multimek Diagnostics “About Multimek Diagnostics” on page 140
Creating a profile “Creating and managing Multimek profiles” on page 115
Chapter 10: MultimekDevice Driver User Guide
126
3. Select the Spawn control check box to force VWorks or BenchWorks to only bring in the next plate when the Change Instance task is reached.
Related information
Setting high-level Multimek Dispense task parameters
About this topic After a task has been added to a pre-protocol, pipette (sub-process), or post-protocol process, you need to set the parameters for it. This topic describes how to set the parameters for the high-level Multimek Dispense task.
Read this topic if you are:
❑ An Administrator or Technician who writes protocols using the Multimek
❑ An Operator who needs to edit Multimek tasks in a protocol
Before you start To make pipette tasks available, you first need to add and configure a Sub Process task.
For information about... See...
Adding tasks to protocols ❑ VWorks User Guide
❑ BenchCel User Guide
Multimek tasks ❑ “About the high-level Multimek tasks” on page 119
❑ “About the low-level Multimek tasks” on page 121
Configuring a Sub Process task “Adding and configuring Sub Process tasks” on page 20
Adding the Multimek to the device driver
“Adding devices” on page 15
Using Multimek Diagnostics “About Multimek Diagnostics” on page 140
Creating a profile “Creating and managing Multimek profiles” on page 115
127Chapter 10: MultimekDevice Driver User Guide
Setting Dispense task parameters
To set the Dispense task parameters:
1. Add the Dispense task to a protocol.
2. In the Pipette Task Parameters toolbar, make sure the Task Settings tab is displayed and Dispense Properties is expanded.
3. From the Plate/Frame list box, select the position to dispense to.
4. Enter the Volume to dispense.
5. Enter the Blowout volume to expel in the last dispense.
The actual volume used for blowout equals the value entered for the dispense Volume plus the value entered for the Blowout volume.
6. Enter the Distance from well bottom (in millimeters) you want the tip to be from the bottom of the well at the start of dispensing.
7. Enter the Dynamic tip retraction rate (mm/µL) at which you want the tips to move out of the well during the dispense in order to maintain the tips at the same relative position to the liquid.
8. From the Number of tip touches list box, select the number of times you want the tips to touch the well after dispensing and withdrawing from the liquid.
The maximum number of tip touches is four, one for each side of the well. At the end of each tip touch, the tip returns to the center of the well.
9. Enter the Tip touch retract distance (in millimeters) you want the tips to pull back away from the well before it executes the tip touch command.
10. Double-click in the field adjacent to Quadrants to open the Well Selection dialog box.
Note: Quadrants may be selected only when you are using a 384-well plate with a 96-tip pipette head.
Click on one of the four upper-left corner wells to select a quadrant. Selected wells are displayed as filled.
Quadrants are represented as follows:
Selecting well... Selects quadrant...
A1 1
B1 3
Chapter 10: MultimekDevice Driver User Guide
128
11. Select the appropriate liquid type from the Liquid class list box.
Choosing a liquid type tells the software how you want to handle the liquid. If you select <none>, then proceed to the next two steps to set the pipette head travel and dispense velocity.
12. If you selected <none> for the Liquid class, then enter the Z axis velocity you want the pipette head to move up and down (into and out of the plate).
13. If you selected <none> for the Liquid class, then enter the D axis velocity you want the internal pipettor to dispense at.
Related information
A2 2
B2 4
Selecting well... Selects quadrant...
For information about... See...
Adding tasks to protocols ❑ VWorks User Guide
❑ BenchCel User Guide
Multimek tasks ❑ “About the high-level Multimek tasks” on page 119
❑ “About the low-level Multimek tasks” on page 121
Configuring a Sub Process task “Adding and configuring Sub Process tasks” on page 20
Adding the Multimek to the device driver
“Adding devices” on page 15
Using Multimek Diagnostics “About Multimek Diagnostics” on page 140
Creating a profile “Creating and managing Multimek profiles” on page 115
129Chapter 10: MultimekDevice Driver User Guide
Setting high-level Multimek Empty Tips task parameters
About this topic After a task has been added to a pre-protocol, pipette (sub-process), or post-protocol process, you need to set the parameters for it. This topic describes how to set the parameters for the high-level Multimek Empty Tips task.
Read this topic if you are:
❑ An Administrator or Technician who writes protocols using the Multimek
❑ An Operator who needs to edit Multimek tasks in a protocol
Setting Empty Tips task parameters
To set the Empty Tips task parameters:
1. Add the Empty Tips task to a protocol.
2. In the Pipette Task Parameters toolbar, make sure the Task Settings tab is displayed and Empty Tips Properties is expanded.
3. From the Plate/Frame list box, select the desired position to which to empty tips.
4. Enter the Distance from well bottom (in millimeters) you want the tip to be from the bottom of the well at the start of emptying.
5. Enter the Dynamic tip retraction rate (mm/µL) at which you want the tips to move out of the well during the emptying in order to maintain the tips at the same relative position to the liquid.
6. From the Number of tip touches list box, select the number of times you want the tips to touch the well after emptying and withdrawing from the liquid.
The maximum number of tip touches is four, one for each side of the well. At the end of each tip touch, the tip returns to the center of the well.
7. Enter the Tip touch retract distance (in millimeters) you want the tips to pull back away from the well before it executes the tip touch command.
8. Double-click in the field next to Quadrants to open the Well Selection dialog box.
Chapter 10: MultimekDevice Driver User Guide
130
Note: Quadrants may be selected only when you are using a 384-well plate with a 96-tip pipette head.
Click on one of the four upper-left corner wells to select a quadrant. Selected wells are displayed as filled.
Quadrants are represented as follows:
9. From the Liquid class list, select the appropriate liquid type.
Choosing a liquid type tells the software how you want to handle the liquid. If you select <none>, then proceed to the next two steps to set the pipette head travel and emptying velocity.
10. If you selected <none> for the Liquid class, then enter the Z axis velocity you want the pipette head to move up and down (into and out of the plate).
11. If you selected <none> for the Liquid class, then enter the D axis velocity you want the internal pipettor to empty.
Related information
Selecting well... Selects quadrant...
A1 1
B1 2
A2 3
B2 4
For information about... See...
Adding tasks to protocols ❑ VWorks User Guide
❑ BenchCel User Guide
Multimek tasks ❑ “About the high-level Multimek tasks” on page 119
❑ “About the low-level Multimek tasks” on page 121
Configuring a Sub Process task “Adding and configuring Sub Process tasks” on page 20
Adding the Multimek to the device driver
“Adding devices” on page 15
Using Multimek Diagnostics “About Multimek Diagnostics” on page 140
Creating a profile “Creating and managing Multimek profiles” on page 115
131Chapter 10: MultimekDevice Driver User Guide
Setting Multimek Loop task parameters
About this topic After a task has been added to a pre-protocol, pipette (sub-process), or post-protocol process, you need to set the parameters for it. This topic describes how to set the parameters for the Multimek Loop task.
Read this topic if you are:
❑ An Administrator or Technician who writes protocols using the Multimek
❑ An Operator who needs to edit Multimek tasks in a protocol
Setting Loop task parameters
To set the Loop task parameters:
1. Add the Loop task to a protocol.
2. In the Pipette Task Parameters toolbar, make sure the Task Settings tab is displayed and Loop Properties is expanded.
3. Enter the number of times you want the task or tasks repeated in the Number of times to loop field.
Related informationFor information about... See...
Adding tasks to protocols ❑ VWorks User Guide
❑ BenchCel User Guide
Multimek tasks ❑ “About the high-level Multimek tasks” on page 119
❑ “About the low-level Multimek tasks” on page 121
Configuring a Sub Process task “Adding and configuring Sub Process tasks” on page 20
Adding the Multimek to the device driver
“Adding devices” on page 15
Using Multimek Diagnostics “About Multimek Diagnostics” on page 140
Creating a profile “Creating and managing Multimek profiles” on page 115
Chapter 10: MultimekDevice Driver User Guide
132
Setting high-level Multimek Mix task parameters
About this topic After a task has been added to a pre-protocol, pipette (sub-process), or post-protocol process, you need to set the parameters for it. This topic describes how to set the parameters for the high-level Multimek Mix task.
Read this topic if you are:
❑ An Administrator or Technician who writes protocols using the Multimek
❑ An Operator who needs to edit Multimek tasks in a protocol
Before you start To make pipette tasks available, you first need to add and configure a Sub Process task.
Setting Mix task parameters
To set the Mix task parameters:
1. Add the Mix task to a protocol.
2. In the Pipette Task Parameters toolbar, make sure the Task Settings tab is displayed and Mix Properties is expanded.
3. From the Plate/Frame list box, select the desired position at which to mix.
4. Enter the Number of cycles where one cycle = one aspiration + one dispense.
5. Enter the Volume you want to mix.
6. Enter the Pre-aspirate volume to aspirate before the tips enter the wells, to create an air gap.
7. Enter the Blowout volume to expel in the last dispense.
The Blowout volume equals the value entered for the dispense Volume plus the value entered for the Blowout volume.
8. Enter the Distance from well bottom (in millimeters) you want the tip to be from the bottom of the well at the start of dispensing.
133Chapter 10: MultimekDevice Driver User Guide
9. Enter the Dynamic tip retraction rate (mm/µL) at which you want the tips to move out of the well during the mix in order to maintain the tips at the same relative position to the liquid.
10. From the Number of tip touches list box, select the number of times you want the tips to touch the well after mixing and withdrawing from the liquid.
The maximum number of tip touches is four, one for each side of the well. At the end of each tip touch, the tip returns to the center of the well.
11. Enter the Tip touch retract distance (in millimeters) you want the tips to pull back away from the well before it executes the tip touch command.
12. Double-click in the field next to Quadrants to open the Well Selection dialog box.
Note: Quadrants may be selected only when you are using a 384-well plate with a 96-tip pipette head.
Click on one of the four upper-left corner wells to select a quadrant. Selected wells are displayed as filled.
Quadrants are represented as follows:
13. From the Liquid class list, select the appropriate liquid type.
Choosing a liquid type tells the software how you want to handle the liquid. If you select <none>, then proceed to the next two steps to set the pipette head travel and emptying velocity.
14. If you selected <none> for the Liquid class, then enter the Z axis velocity you want the pipette head to move up and down (into and out of the plate).
15. If you selected <none> for the Liquid class, then enter the D axis velocity you want the internal pipettor to aspirate and dispense.
Related information
Selecting well... Selects quadrant...
A1 1
B1 2
A2 3
B2 4
For information about... See...
Adding tasks to protocols ❑ VWorks User Guide
❑ BenchCel User Guide
Multimek tasks ❑ “About the high-level Multimek tasks” on page 119
❑ “About the low-level Multimek tasks” on page 121
Chapter 10: MultimekDevice Driver User Guide
134
Setting high-level Multimek Run Macro task parameters
About this topic After a task has been added to a pre-protocol, pipette (sub-process), or post-protocol process, you need to set the parameters for it. This topic describes how to set the parameters for the high-level Multimek Run Macro task.
Read this topic if you are:
❑ An Administrator or Technician who writes protocols using the Multimek
❑ An Operator who needs to edit Multimek tasks in a protocol
Setting Run Macro task parameters
To set Run Macro task parameters:
1. Add the Run Macro task to a protocol.
2. Expand Run Macro properties group.
3. If the macro is associated with a plate or location, select it from the Plate/Location, plate list.
This instructs VWorks or BenchWorks to leave the plate at the position.
4. Enter the Macro name.
Macros are created in the Multimek software and then are called up by VWorks or BenchWorks.
Configuring a Sub Process task “Adding and configuring Sub Process tasks” on page 20
Adding the Multimek to the device driver
“Adding devices” on page 15
Using Multimek Diagnostics “About Multimek Diagnostics” on page 140
Creating a profile “Creating and managing Multimek profiles” on page 115
For information about... See...
135Chapter 10: MultimekDevice Driver User Guide
5. Enter a Timeout value.
This is the length of time VWorks or BenchWorks waits for the macro to complete before displaying an error message.
Related information
Setting low-level (simple) Multimek task parameters
About this topic After a task has been added to a pre-protocol, pipette (sub-process), or post-protocol process, you set the parameters for it. This topic describes the parameters for the low-level (simple) Multimek tasks, Aspirate, Dispense, and Empty Tips.
Read this topic if you are an Administrator or Technician who is using low-level Multimek tasks to develop a protocol.
Before you start To make pipette tasks available, you first need to add and configure a Sub Process task.
Setting Aspirate (Simple) task parameters
To set the Aspirate (Simple) task parameters:
1. Add the Aspirate (Simple) task to a protocol.
2. In the Pipette Task Parameters toolbar, make sure the Task Settings tab is displayed and Aspirate (Simple) Properties is expanded.
For information about... See...
Adding tasks to protocols ❑ VWorks User Guide
❑ BenchCel User Guide
Multimek tasks ❑ “About the high-level Multimek tasks” on page 119
❑ “About the low-level Multimek tasks” on page 121
Configuring a Sub Process task “Adding and configuring Sub Process tasks” on page 20
Adding the Multimek to the device driver
“Adding devices” on page 15
Using Multimek Diagnostics “About Multimek Diagnostics” on page 140
Creating a profile “Creating and managing Multimek profiles” on page 115
Chapter 10: MultimekDevice Driver User Guide
136
3. From the Plate/Frame list, select the position from which to aspirate.
4. Enter the Volume to aspirate.
5. Enter the D axis velocity at which you want the internal pipettor to aspirate.
Setting Dispense (Simple) task parameters
To set the Dispense (Simple) task parameters:
1. Add the Dispense (Simple) task to a protocol.
2. In the Pipette Task Parameters toolbar, make sure the Task Settings tab is displayed and Dispense (Simple) Properties is expanded.
3. From the Plate/Frame list box, select the desired position from which to dispense.
4. Enter the Volume to dispense.
5. Enter the D axis velocity at which you want the internal pipettor to dispense.
Setting Empty Tips (Simple) task parameters
To set the Empty Tips (Simple) task parameters:
1. Add the Empty Tips (Simple) task to a protocol.
2. In the Pipette Task Parameters toolbar, make sure the Task Settings tab is displayed and Empty Tips Properties is expanded.
3. From the Plate/Frame list box, select the position to which to empty the tips.
4. Enter the Z Axis empty position.
This is the number of steps you want the internal pipettor to move to empty the tips.
137Chapter 10: MultimekDevice Driver User Guide
Related information
Setting low-level Multimek Move Axes task parameters
About this topic After a task has been added to a pre-protocol, pipette (sub-process), or post-protocol process, you set the parameters for it. This topic describes the parameters for the low-level Multimek Move Axes tasks.
Read this topic if you are an Administrator or Technician who is using low-level Multimek tasks to develop a protocol.
Setting Move X-Y Axes task parameters
To set the Move X-Y Axes task parameters:
1. Add the Move X-Y Axes task to a protocol.
2. Expand the Move X-Y Axes Properties group.
3. From the Plate/Frame list box, select the plate for which you are creating the Move X-Y task.
For information about... See...
Adding tasks to protocols ❑ VWorks User Guide
❑ BenchCel User Guide
Multimek tasks ❑ “About the high-level Multimek tasks” on page 119
❑ “About the low-level Multimek tasks” on page 121
Configuring a Sub Process task “Adding and configuring Sub Process tasks” on page 20
Adding the Multimek to the device driver
“Adding devices” on page 15
Using Multimek Diagnostics “About Multimek Diagnostics” on page 140
Creating a profile “Creating and managing Multimek profiles” on page 115
Chapter 10: MultimekDevice Driver User Guide
138
4. Enter the X axis relative motion.
This is the distance (in millimeters) that you want the pipette head to move in the x (left/right) direction relative to its current position.
5. Enter the Y axis relative motion.
This is the distance (in millimeters) that you want the pipette head to move in the y (right/left) direction relative to its current position.
6. Enter the X,Y axis velocity you want the head to move in the X and Y directions.
Setting Move Z Axis (Absolute) task parameters
To set the Move Z Axis (Absolute) task parameters:
1. Add the Move Z Axis (Absolute) task to a protocol.
2. Expand the Move Z Axis (Absolute) properties group.
3. From the Plate/Frame list box, select the plate for which you are creating the Move Z task.
4. Enter the Z axis absolute motion.
This is the distance (in millimeters) that you want the pipette head to move in the Z (up/down) direction relative to its zero position in the Z direction.
5. Enter the Z axis velocity at which the head will move when going to the frame.
Setting Move Z Axis (Relative) task parameters
To set the Move Z Axis (Relative) task parameters:
1. Add the Move Z Axis (Relative) task to a protocol.
2. Expand the Move Z Axis (Relative) properties group.
3. Enter the Z axis relative motion.
4. This is the distance (in millimeters) that you want the pipette head to move in the Z (up/down) direction relative to its current position.
5. Enter the Z axis velocity you want the head to move in the Z direction.
139Chapter 10: MultimekDevice Driver User Guide
Setting Move to Plate/Frame task parameters
To set the Move to Plate/Frame task parameters:
1. Add the Move to Plate/Frame task to a protocol.
2. Expand the Move to Plate/Frame properties group.
3. From the Plate/Frame list, select the frame that has the plate you want to move to.
4. Enter the X,Y axis velocity you want the head to move to the selected frame.
Related informationFor information about... See...
Advanced settings “Using JavaScript to set task parameters” on page 22
Multimek tasks ❑ “About the high-level Multimek tasks” on page 119
❑ “About the low-level Multimek tasks” on page 121
Configuring a Sub Process task “Adding and configuring Sub Process tasks” on page 20
Adding tasks to protocols ❑ VWorks User Guide
❑ BenchCel User Guide
Using Multimek Diagnostics “About Multimek Diagnostics” on page 140
Chapter 10: MultimekDevice Driver User Guide
140
About Multimek Diagnostics
About this topic Use Multimek Diagnostics to:
❑ Move the pipette head
❑ Home the pipette head
❑ Edit teachpoints
❑ Monitor tip loader activity and head position
❑ Execute pipetting commands
This topic gives an overview of these tasks. Read this topic if you want to troubleshoot the Multimek or for another reason want to operate the Multimek without running a protocol.
About the Jog/Teach page
Use the Jog/Teach page of Multimek Diagnostics to control and monitor the pipette head’s movements. This includes the following:
A log window at the bottom of the dialog box records all movement events.
About the Processes page
Use the Processes page of the Multimek Diagnostics to execute pipette head commands. This includes the following:
This action Enables you to...
Moving incrementally in the X, Y, and Z directions
Fine-tune existing teachpoints
Moving to selected teachpoints Quickly move the head to a plate stage
Homing the pipette head Reset the head by re-homing to the X,Y or Z directions
Monitoring the input and output channels assigned to the tip loader
Test and troubleshoot the connection to the tip loader
Monitoring head position Know the current coordinates of the pipette head
Switching to computer control Re-gain remote control of the pipette head
This action Enables you to...
Executing all pipette tasks Modify and test each pipette function
Editing labware parameters Access the labware database editor so you can edit the labware database
Editing liquid handling parameters
Access the liquid library editor so you can edit liquid-handling parameters
141Chapter 10: MultimekDevice Driver User Guide
A log window at the bottom of the dialog box records all executed processes.
Related information
Jogging and teaching the Multimek
About this topic This topic describes how to use the commands on the Jog/Teach page of Multimek Diagnostics to monitor and control the movements of the pipette head.
Read this topic if you want to monitor or move the Multimek for diagnostic purposes.
Choosing display units
About unit display
You can choose whether to display the measurement values of this page in steps (a defined number of steps equals one motor revolution) or in engineering units (millimeters). Since the Multimek software uses steps to describe its position, you may also want to use these units here. However, if you prefer standard units, you may want to use engineering units.
To choose diagnostics display units:
1. Open Multimek Diagnostics.
2. Click the Jog/Teach tab.
3. Select a Display option.
Setting the head speed
Optionally, change the speed the head moves by entering a different value in the Speed field.
This speed applies to all moves.
For information about... See...
Advanced settings “Using JavaScript to set task parameters” on page 22
Opening the Diagnostics “Opening diagnostics” on page 10
Chapter 10: MultimekDevice Driver User Guide
142
Homing the pipette head
Use these commands to reset the pipette head.
To home the pipettor:
1. Click Home XYZ to reset the pipette head in the X, Y, and Z axes.
2. Click Home D to reset the pipette head in the D axis.
Moving the pipette head
About moving the pipette headYou can move the head in increments relative to its current position or its zero position. Depending on circumstances, one way may be more convenient than the other.
To move the head in relative motion:
1. Enter the number of steps (or millimeters) you want to move in the appropriate fields.
Values entered are relative to the zero position at that axis.
2. Click one of the +/- X, Y, Z, Aspirate, or Dispense buttons to jog the pipette head.
The aspirate and dispense buttons correspond to +/- D axis.
To move the head in absolute motion:
1. Enter the number of steps (or millimeters) you want to move in the appropriate field.
Values entered are relative to the zero position at that axis. The range for these values is set when the device is initialized.
2. Click Move XY to move the head the specified distance in the X,Y direction.
3. Click Move Z to move the head the specified distance in the Z direction.
143Chapter 10: MultimekDevice Driver User Guide
Modifying teachpoints
The Multimek has built-in teachpoints for each frame position. These can be fine-tuned in VWorks or BenchWorks, if necessary.
To move to and modify a teachpoint:
1. Select the frame you want to move to and adjust from the list box.
2. Click Move to frame.
3. If adjustments are necessary, use the commands in the Relative Motion or Absolute Motion group boxes to move the head to a more optimal position.
4. Click Teach at current position.
Monitoring the tip loader
About the tip loader
When there is a tip loader connected to the Multimek, you can monitor the connection in the Digital I/O group box. This box displays the two input and two output channels that were assigned to it in the Multimek profile. The activity of these inputs can be monitored in Multimek Diagnostics.
To monitor the tip loader:
1. To check the status of the Ready and Halted input channels, click Update inputs.
A lit indicator means the channel is active.
2. To check the status of the output channels, click the appropriate Toggle button.
This action switches the active/inactive status of the output.
A lit indicator means the channel is active.
Chapter 10: MultimekDevice Driver User Guide
144
Monitoring the head position
To monitor the position of the pipette head:
1. In the Current Positions group box, click Update positions.
The position in steps (or millimeters) is displayed in the readouts.
Related informationFor information about... See...
Adding tasks to protocols ❑ VWorks User Guide
❑ BenchCel User Guide
Creating a Multimek profile “Creating and managing Multimek profiles” on page 115
Configuring a Sub Process task ❑ “Adding and configuring Sub Process tasks” on page 20
❑ VWorks User Guide
❑ BenchCel User Guide
Setting Multimek task parameters “Setting high-level Multimek Aspirate task parameters” on page 123
Using Multimek Diagnostics “About Multimek Diagnostics” on page 140
145Chapter 10: MultimekDevice Driver User Guide
Executing Multimek tasks
About this topic This topic describes how to execute a Multimek task using the commands on the Processes page.
Read this topic if you want to troubleshoot the device or develop task parameters.
Procedure To execute a Multimek task:
1. Open Multimek Diagnostics.
2. Click the Processes tab.
3. Select the operation you want to perform from the Available commands list box.
4. Expand the Command properties.
5. Optionally, change property values.
6. When ready, click Execute.
All task executions are recorded and shown in the log window at the bottom of the dialog box.
Chapter 10: MultimekDevice Driver User Guide
146
Making database changes
If, after performing commands, you find you need to make changes to one of the databases, you can access them from Multimek Diagnostics.
❑ Click Edit labware database to open the labware editor to make changes to or add labware definitions
❑ Click Edit liquid library to open the liquid library editor to make changes to or add liquid handling definitions
Related informationFor information about... See...
Adding tasks to protocols ❑ VWorks User Guide
❑ BenchCel User Guide
Configuring a Sub Process task ❑ “Adding and configuring Sub Process tasks” on page 20
❑ VWorks User Guide
❑ BenchCel User Guide
Setting Multimek task parameters “Setting high-level Multimek Aspirate task parameters” on page 123
Using Multimek Diagnostics “About Multimek Diagnostics” on page 140
147Chapter 11: PlateHub
Device Driver User GuideThe PlateHub is an twelve-sided plate storage carousel with each side capable of storing up to 8 microplates for a total of 96 microplates.
The PlateHub must be used with the VWorks inventory management system. For information about setting up and using the VWorks inventory, see VWorks User Guide.
This chapter describes how to:
❑ Install the PlateHub device driver plug-in
❑ Configure the PlateHub in VWorks
❑ Set the PlateHub task parameters
❑ Use PlateHub Diagnostics
PlateHub 11
Chapter 11: PlateHubDevice Driver User Guide
148
Workflow for configuring the PlateHub
About this topic Before you can add PlateHub tasks to protocols, you need to configure the device.
This topic presents the workflow for configuring the PlateHub device. Read this topic if you are an Administrator who is responsible for setting up a PlateHub in VWorks.
Workflow
Related information
Step Topic
1. “Installing device drivers” on page 13
2. “Adding devices” on page 15
3. “Creating a PlateHub profile” on page 149
4. “Setting the properties for a device” on page 17
For information about... See...
Device drivers “About device drivers” on page 11
Setting PlateHub task parameters “Setting the PlateHub task parameters” on page 151
Using PlateHub Diagnostics “Using PlateHub Diagnostics” on page 152
149Chapter 11: PlateHubDevice Driver User Guide
Creating a PlateHub profile
About this topic Profiles contain the initialization settings that enable VWorks to identify and communicate with the PlateHub. Every device within the automation system must have its own profile. Once created, you will probably not need make changes to the profile.
This topic describes how to create a profile for the PlateHub device. Read this topic if you are an Administrator who is setting up a PlateHub in VWorks.
Before you create a profile
Before you can create a profile, you must install the PlateHub device driver and add the PlateHub to the device manager.
Procedure To create a PlateHub profile:
1. Open PlateHub Diagnostics.
2. Click the Profiles tab.
3. In the Profile Settings group box, select the COM port that the PlateHub is using from the COM port list box.
4. In the Profile Management group box, click Create a new profile.
5. Enter a name and click OK.
Setting the speed In addition to defining the communication, the PlateHub profile also sets the speed at which the PlateHub turns.
There are three defined speeds:
❑ Slow
❑ Medium
❑ Fast
Chapter 11: PlateHubDevice Driver User Guide
150
These speeds are defined as a percentage of the maximum velocity and acceleration.
Optionally, you can redefine these three settings, or just use the default definitions.
To define a speed:
1. In the Speed Definitions group box, select the speed you want to define from the Speed list box.
2. Enter a value between 1 and 100% for the velocity in the Velocity field.
3. Enter a value between 1 and 100% for the acceleration in the Acceleration field.
To select a speed for the profile:
1. Select the desired speed from the Default speed list.
2. Click Update this profile to save the settings.
Related informationFor information about... See...
Adding the PlateHub to the device manager
“Adding devices” on page 15
The next step “Setting the properties for a device” on page 17
The workflow this procedure belongs to
“Workflow for configuring the PlateHub” on page 148
Using PlateHub Diagnostics “Using PlateHub Diagnostics” on page 152
Using PlateHub tasks “Setting the PlateHub task parameters” on page 151
Profiles “About profiles” on page 8
151Chapter 11: PlateHubDevice Driver User Guide
Setting the PlateHub task parameters
About this topic This topic describes how to set the Load, Unload, and Incubate at plate storage device tasks for a storage device.
Load, Unload, and Incubate at plate storage device defined
The Load task instructs a robot to move a defined set of plates into a storage device.
The Unload task instructs a robot to remove a defined set of plates from a storage device.
Using the Unload task and Load task in sequence instructs the robot to move a defined set of plates from one storage device to another.
The Incubate at plate storage device task moves a defined set of plates into a storage device, leaves them there for a specified time period and then removes them from the storage device.
These tasks are available for the following devices:
❑ PlateHub
❑ StoreX incubator
❑ Cytomat PLC
Procedures To set the Unload task parameters:
1. Confirm that the plates you want to move are in the system.
2. Add the Unload task to a protocol process.
3. In the Protocol Task Parameters toolbar, drag the groups or locations you want to unload from the Available groups/locations list to the Assigned groups/locations list.
To set the Load task parameters:
1. Add the Load task to a protocol process.
2. In the Protocol Task Parameters toolbar, drag the groups or locations you want to load into from the Available groups/locations list to the Assigned groups/locations list.
To set the Incubate at plate storage device task parameters:
1. Add the Incubate at plate storage device task to a protocol process.
Note: The Incubate at plate storage device task cannot be the last task in a process.
2. In the Task Settings page of the Protocol Task Parameters toolbar, select the devices that you don’t want to use for the incubation from the Available devices list and click Exclude.
The devices that you exclude appear in the Devices that will be excluded from this task list.
Chapter 11: PlateHubDevice Driver User Guide
152
3. Enter the length of time to incubate in the Length of incubation (sec) field.
Related information
Using PlateHub Diagnostics
About this topic You can use the PlateHub Diagnostics to:
❑ Manage profiles
❑ Set the home position
❑ Move the carousel to a specified position
❑ Change settings
Read this topic if you are:
❑ An Administrator who wants to manage PlateHub profiles
❑ A Technician or Operator who wants to troubleshoot the PlateHub or operate the PlateHub for other purposes
Managing profiles To manage PlateHub profiles, timeouts, and connection details:
1. Open the PlateHub Diagnostics.
2. Click the Profiles tab.
For information about... See...
Adding tasks to protocols VWorks User Guide
Creating plate groups and location groups (in the inventory manager)
The chapter about using the VWorks inventory in the VWorks User Guide
Setting up the PlateHub “Workflow for configuring the PlateHub” on page 148
Using PlateHub Diagnostics “Using PlateHub Diagnostics” on page 152
Adding a PlateHub to the device manager
“Adding devices” on page 15
153Chapter 11: PlateHubDevice Driver User Guide
3. Select a profile from the Profile names list.
4. Perform the desired management task.
Management tasks include the following:
Updating the profile. Use this command to save edits to an existing profile.
Copying a profile.
Renaming a profile.
Deleting a profile.
Initializing a profile. Use this command to reset the device with the selected profile.
Setting the home position
To set the home position:
1. Open the PlateHub Diagnostics.
2. Click the Control tab.
Chapter 11: PlateHubDevice Driver User Guide
154
3. Set the speed to slow by selecting it from the Speed list box.
4. Turn off the servos by clicking Servo off.
5. Manually position the carousel so that the desired home position is approximately in place.
Note: The home position is typically where the cassette lines up with the robot teachpoint.
6. Turn the servo on by clicking Servo on.
7. Click the Jog counterclockwise and Jog clockwise buttons in the Movement group box to precisely position the carousel.
To change the jog increment, click the arrow button and choose a value from the list.
8. When satisfied that the carousel is in position, click Set as home.
Moving the carousel to a specified position
To move the carousel:
1. Open the PlateHub Diagnostics.
2. Click the Control tab.
3. To move the carousel to a specific cassette, select the number of the cassette you want to move to from the list box and then click Move to cassette.
Note: The carousel moves to the position in either a clockwise or counterclockwise direction, depending on which is the shortest path.
4. To move the carousel to a specific position, enter the degree position (0–360) in the field and then click Move to degree.
Note: The carousel moves to the position in either a clockwise or counterclockwise direction, depending on which is the shortest path.
5. To move the carousel to its home position, click Go Home.
155Chapter 11: PlateHubDevice Driver User Guide
Changing the settings
!! DAMAGE HAZARD !! This diagnostics page is used to setup the PlateHub when it is manufactured. Changing these settings may adversely affect the performance of the PlateHub. If you are having problems with operating the PlateHub, please contact the Velocity11 Service Center.
Related informationFor information about... See...
Creating a PlateHub profile “Creating a PlateHub profile” on page 149
Setting PlateHub task parameters “Setting the PlateHub task parameters” on page 151
Chapter 11: PlateHubDevice Driver User Guide
156
157Chapter 12: PlateStak
Device Driver User GuideThe PerkinElmer PlateStak is a microplate handler that can be configured to work in a lab automation system using VWorks.
This chapter describes how to:
❑ Install the PlateStak device driver plug-in
❑ Configure the PlateStak device
❑ Set the PlateStak task parameters
❑ Use PlateStak Diagnostics
PlateStak 12
Chapter 12: PlateStakDevice Driver User Guide
158
Workflow for configuring the PlateStak
About this topic Before you can add PlateStak tasks to a protocol, the PlateStak needs to be configured in VWorks.
This topic presents the workflow for configuring the PlateStak device. Review this topic if you are an Administrator responsible for setting up devices in VWorks.
Workflow
Related information
Step Topic
1. “Installing device drivers” on page 13
2. “Adding devices” on page 15
3. “Creating a PlateStak profile” on page 159
4. “Setting the properties for a device” on page 17
For information about... See...
Device drivers “About device drivers” on page 11
Setting PlateStak task parameters “Setting PlateStak task parameters” on page 161
Using PlateStak Diagnostics “Using PlateStak Diagnostics” on page 163
159Chapter 12: PlateStakDevice Driver User Guide
Creating a PlateStak profile
About this topic Profiles contain the initialization settings that enable VWorks to identify and communicate with the PlateStak. Every device within the automation system must have its own profile. Once created, you will probably not need make changes to the profile.
This topic describes how to create a profile for the PlateStak device. Read this topic if you are an Administrator who is setting up a PlateStak in VWorks.
Before you start Before you create a PlateStak profile, you must install the PlateStak device driver and add the PlateStak to the device manager.
Procedure To create a profile for the PlateStak:
1. Open PlateStak Diagnostics.
2. Click the Profiles tab.
3. Click Create a new profile.
4. Enter a name for the profile and click OK.
5. Choose the Profile Settings:
a. Select the Serial port (COM port) that connects the computer to the PlateStak from the list box.
b. Select A for the Device Address from the list box.
c. If you have a bar code reader, select the side of the plate the bar code reader is on from the BCR Side list box.
6. Click Update this profile and click OK to exit the PlateStak Diagnostics dialog box.
Chapter 12: PlateStakDevice Driver User Guide
160
Related information
About PlateStak device locations
About this topic You need to know about PlateStak device locations when you set the device properties for the PlateStak.
Read this topic if you are an Administrator who wants to set up a PlateStak in VWorks.
About PlateStak device locations
The PlateStak has eight locations, labeled Position 1–6 and an input and output.
The input position is for upstacking. The output position is for downstacking.
Related information
For information about... See...
The next step “Setting the properties for a device” on page 17
The workflow this procedure belongs to
“Workflow for configuring the PlateStak” on page 158
Adding the PlateStak to the device manager
“Adding devices” on page 15
Setting PlateStak task parameters “Setting PlateStak task parameters” on page 161
Using PlateStak Diagnostics “Using PlateStak Diagnostics” on page 163
Profiles “About profiles” on page 8
For information about... See...
Setting PlateStak device properties “Setting the properties for a device” on page 17
Configuring the PlateStak “Workflow for configuring the PlateStak” on page 158
161Chapter 12: PlateStakDevice Driver User Guide
Setting PlateStak task parameters
About this topic After a task has been added to a protocol process, the parameters for it need to be set, such as where to downstack from or upstack to.
This topic describes how to set the task parameters for the PlateStak device. Read this topic if you are:
❑ An Administrator or Technician who is creating protocols
❑ An Operator who might need to make changes to task parameters to accommodate a particular protocol
PlateStak tasks defined
There are three tasks associated with the PlateStak:
❑ Downstack. Moves a plate out of the stacker.
❑ Upstack. Moves a plate into a stacker.
❑ Restack. Collects plates in a stack, moves them to another stack in a definable time, in a way that maintains the proper order of the plates, and ready to pass them to another task.
Downstacking and Upstacking tasks
To set the Downstacking and Upstacking task parameters:
1. Add the Downstack or Upstack task to a protocol.
2. In the list of available stackers in the Protocol Task Parameters toolbar, select a stacker to downstack from or upstack to and click Add.
3. To select more than one stacker, SHIFT-click or CTRL-click before clicking Add.
An asterisk next to a stacker in the list means that the stacker is currently assigned to a task that uses the same labware.
4. To remove a stacker from your list of available stacker devices, select it and click Remove.
5. If you have added more than one stacker, you can change the order in which particular stackers are used:
a. Select a stacker.
b. Click Use earlier to increase the priority of the stacker or Use later to decrease the priority of it.
Chapter 12: PlateStakDevice Driver User Guide
162
6. To specify a time interval for when plates are made available to the system, select the Release a new plate check box and type in an interval time.
You can use this feature to avoid a plate processing bottleneck that results in plates having different incubation times.
Consider a simplified example process in which plates are downstacked, labels applied, liquid dispensed into, and then incubated for 10 minutes.
Applying the label only takes a few seconds while subsequent tasks take longer. This creates a processing bottleneck.
If the dispense task takes 2 minutes, plates that are ready for the pipetting step would have to wait. In this example, the first plate would incubate for approximately 5 minutes, the second plate for approximately 7 minutes, the third plate for approximately 9 minutes, and so on. To avoid these different incubation times, you could downstack one plate every 2 minutes. The plates are then incubated sequentially and not simultaneously.
7. If you want to dynamically assign an upstacking stacker, click Add dynamically-assigned stacker.
Note: This option is only available for upstacking tasks.
With dynamic assignment you do not have to specifically assign every stacker that will receive plates because assignments are made automatically.
When stackers are dynamically assigned, the text “TBD,” meaning To Be Determined, is added to the stacker task icon.
Note: When using dynamically assigned stackers, you need to add a dynamic stacker to the device manager for each stacker you expect to require.
You can determine which stackers contain which plates at the end of the run by consulting the run log.
Restacking tasks To set the Restack task parameters:
1. Add the Restack task to a protocol.
2. In the Protocol Task Parameters toolbar, do one of the following:
Select the empty stackers that you want to use for the task and click Add
Click Add dynamically-assigned stacker
With this option, the scheduler automatically assigns stackers during a run, and there must be at least two stackers available for this operation.
3. In the Store up to text box, type a number equal to the number of plates you intend to incubate.
This value is important because it can affect the timing of the incubation. For example, if the time taken to move all plates to the
163Chapter 12: PlateStakDevice Driver User Guide
first restack stacker is greater than the time specified for the incubation, the first plate cannot be moved to the next task in time. This problem can be resolved by lowering the number of plates in a restack operation and adding more stackers.
4. In the Incubate plate for text box, type the time interval between when a plate enters the first restack stacker and leaves the second restack stacker.
!! IMPORTANT !! When you start a run that includes a Restack task, you must type in a number that is equal to the total number of plates you want to restack in the Number of Runs dialog box.
Related information
Using PlateStak Diagnostics
About this topic This topic describes how to:
❑ Jog and teach
❑ Execute specific operations
❑ Manage profiles
Read this topic if you are:
❑ A Technician or Operator who wants to operate the device for setup or troubleshooting
❑ An Administrator who wants to manage profiles
Using the jog and teach commands
Use these commands to fine-tune teachpoint positions.
To use PlateStak jog and teach commands:
1. Open PlateStak Diagnostics.
2. Click the Control tab.
For information about... See...
Adding tasks to protocols VWorks User Guide
Restacking example VWorks User Guide
Workflow for setting up the PlateStak
“Workflow for configuring the PlateStak” on page 158
Using PlateStak Diagnostics “Using PlateStak Diagnostics” on page 163
Chapter 12: PlateStakDevice Driver User Guide
164
3. Select the position you want to fine tune from the Teach Point list.
4. Click Move to to move the robot to the teachpoint.
The Position updates to display the current position.
5. Enter a value in the Increment field.
Increment numbers are in motor units or steps.
6. Click Left or Right to jog the robot by the value entered in the Increment field.
The Position updates to display the current position.
7. When you are satisfied with the position, click Teach Here.
Executing specific operations
Use these commands to move individual plates without running a protocol and to test the bar code reader.
To execute operations:
1. Open the PlateStak Diagnostics.
2. Click the Control tab.
3. From the Rack list, select the rack with which you want to perform the operation.
4. Click the desired command. Use the table below as a guide.
Item Description
Downstack Picks a plate from the selected rack.
Upstack Places a plate into the selected rack.
Test BCR Reads the bar code on the plate and displays it in the BCR field.
Note: This feature is only for PlateStak bar code readers.
165Chapter 12: PlateStakDevice Driver User Guide
Managing profiles To manage profiles:
1. Open PlateStak Diagnostics.
2. Click the Profiles tab.
3. Select a profile from the Profile names list.
4. Perform the desired management task.
Management tasks include the following:
Updating the profile. Use this command to save edits to an existing profile.
Copying a profile.
Renaming a profile.
Deleting a profile.
Initializing a profile. Use this command to reset the device with the selected profile.
Related informationFor information about... See...
Opening PlateStak Diagnostics “Opening diagnostics” on page 10
Workflow for setting up the PlateStak
“Workflow for configuring the PlateStak” on page 158
Setting PlateStak task parameters “Setting PlateStak task parameters” on page 161
Chapter 12: PlateStakDevice Driver User Guide
166
167Chapter 13: Rake
Device Driver User GuideThe Rake is a four-channel dispensing device.
The Rake works with a PlateStak and together they can be configured to work in lab automation systems using VWorks or BenchWorks.
This chapter describes how to:
❑ Install the Rake device driver
❑ Configure the Rake
❑ Set the Rake task parameters
❑ Use Rake Diagnostics
Rake 13
Chapter 13: RakeDevice Driver User Guide
168
Workflow for configuring the Rake
About this topic This topic presents the workflow for configuring the Rake device driver.
Read this topic if you are an Administrator responsible for setting up devices in VWorks or BenchWorks.
Before you start Because the Rake can only be used in conjunction with the PlateStak, before you configure the Rake, you need to configure the PlateStak.
Workflow
Related information
Step Topic
1. “Installing device drivers” on page 13
You may have already done this.
2. “Adding devices” on page 15
3. “Creating a Rake profile” on page 169
4. “Setting the properties for a device” on page 17
When setting the Location Dispense properties for the Rake, make sure a PlateStak is accessible and the teachpoint position is not an input or an output position.
When configuring the PlateStak, make sure that the teachpoint assigned to the Rake is located under the Rake’s first channel.
For information about... See...
Device drivers “About device drivers” on page 11
Configuring the PlateStak “Workflow for configuring the PlateStak” on page 158
Setting Rake task parameters “Setting Rake task parameters” on page 171
Using Rake Diagnostics “Using Rake Diagnostics” on page 172
169Chapter 13: RakeDevice Driver User Guide
Creating a Rake profile
About this topic Profiles contain the initialization settings that enable VWorks or BenchWorks to identify and communicate with the Rake. Every device within the automation system must have its own profile. Once created, you will probably not need make changes to the profile.
This topic describes how to create a profile for the Rake.
Read this topic if you are an Administrator responsible for setting up devices in VWorks or BenchWorks.
Before you start Before you create a profile, you need to have installed the Rake device driver and added the Rake to the device manager.
Procedure To create a Rake profile:
1. Open the Rake Diagnostics.
2. Click the Profiles tab.
3. Click Create a new profile.
4. Enter a name for the profile and click OK.
5. In the Profile Attributes group box, set the following:
Setting Description
Serial port The port connecting the Rake to the controlling computer.
Wells in labware Number of wells in the plate you are dispensing to.
Number of channels Number of different liquids you are dispensing, up to 4.
This value determines how many tabs are displayed on the Controls page.
Chapter 13: RakeDevice Driver User Guide
170
6. Click Update this profile.
Related information
❑ Channel 0 offset (mm)
❑ Channel 1 offset (mm)
❑ Channel 2 offset (mm)
❑ Channel 3 offset (mm)
Distance from the teachpoint to the center of the channel.
❑ Channel 0 IO
❑ Channel 1 IO
❑ Channel 2 IO
❑ Channel 3 IO
Number of the output on the Rake controller that goes to a channel solenoid.
These outputs can be remapped, if desired.
Working Directory Path to the folder that has the Rake command files and liquid database.
Setting Description
For information about... See...
Opening diagnostics “Opening diagnostics” on page 10
Adding the Rake to the device manager
“Adding devices” on page 15
The next step “Setting the properties for a device” on page 17
The workflow this procedure belongs to
“Workflow for configuring the Rake” on page 168
Using diagnostics “Using Rake Diagnostics” on page 172
Using Rake tasks “Setting Rake task parameters” on page 171
Profiles “About profiles” on page 8
171Chapter 13: RakeDevice Driver User Guide
Setting Rake task parameters
About this topic After the device has been added to the device file, the tasks associated with the Rake become available in the protocol editor. When a task is added to a protocol, you need to set the parameters for it. This includes choosing which Rake command file you want to use.
This topic describes the tasks and their parameters.
Read this topic if you are:
❑ An Administrator or Technician responsible for creating protocols
❑ An Operator who wants to make changes to the Rake task parameters in a protocol
About Rake tasks The Rake device driver adds one task to VWorks or BenchWorks software. This task is used to execute a command file, which contains dispense instructions, to the Rake during the execution of a protocol.
The Rake task is represented by this icon in the Protocol Tasks toolbar:
Setting Dispense (Rake) task parameters
To set the Dispense (Rake) task parameters:
1. Add the Dispense (Rake) task to the desired protocol process.
2. Move the Rake or Rakes that you want to use to the right field using the Add and Remove buttons.
3. Select the command file under the “Dispense” properties group heading (see “Related information” below).
Tip. To do this, click in the field to the right of the Command filename field. Then click the grey button that appears. (See figure below.)
Chapter 13: RakeDevice Driver User Guide
172
Related information
Using Rake Diagnostics
About this topic This topic describes using Rake Diagnostics to:
❑ Manage profiles
❑ Add liquids and create Rake command files
❑ Access PlateStak Diagnostics
Read this topic if you are:
❑ An Administrator who wants to manage Rake profiles
❑ A Technician or Operator who wants to use Rake Diagnostics to troubleshoot or operate the Rake without running a protocol
Managing profiles To manage Rake profiles:
1. Open the Rake Diagnostics.
2. Click the Profiles tab.
3. Select a profile from the Profile names list.
For more information about... See...
Creating a Rake command file “Using Rake Diagnostics” on page 172
Creating protocols, pre-protocols, post-protocols, and pipette processes
❑ VWorks User Guide
❑ BenchCel User Guide
Opening Rake device properties page
“Setting the properties for a device” on page 17
Using Rake Diagnostics “Using Rake Diagnostics” on page 172
173Chapter 13: RakeDevice Driver User Guide
4. Perform the desired management task.
Management tasks include the following:
Updating the profile. Use this command to save edits to an existing profile.
Copying a profile.
Renaming a profile.
Deleting a profile.
Initializing a profile. Use this command to reset the device with the selected profile.
Adding liquids to the Rake database
All liquids that the Rake dispenses must be entered into the Rake database.
To add a liquid:
1. Open Rake Diagnostics.
2. Click the Liquids tab.
3. Enter the Name of the fluid.
4. Enter a Slope and Intercept for the fluid.
These are the volume/time transfer functions for the liquid.
5. Click Add/Update.
Creating a Rake command file
Before you can create a Rake command file, you need to add the liquids you are using to Rake database (as described above).
You can use the Rake Diagnostics to create command files that can be executed by either:
❑ VWorks or BenchWorks during protocol run
❑ Directly from Rake Diagnostics.
To create a Rake command file:
1. Open Rake Diagnostics.
2. Click the Controls tab.
Chapter 13: RakeDevice Driver User Guide
174
3. Click New.
4. Optionally, change the default Command file name.
The file name must have the extension .arc.
5. Select the Labware type from the list.
The available labware reflects the attributes selected in the profile.
6. Click the Channel tab that has the liquid type you want to dispense for that channel.
7. Select the Liquid type from the list.
8. Select a Dispense Method and enter the volume or time to be dispensed.
9. Select the columns to which you want to dispense.
10. Click the arrow to record your choice.
11. Repeat step 6–step 10 for the other channels.
12. Click Save As to save the file so you can use it later or in a VWorks or BenchWorks protocol.
13. Click Run to execute the current command file.
Note: Click Abort run to interrupt the run.
175Chapter 13: RakeDevice Driver User Guide
Accessing PlateStak Diagnostics
Because the Rake can only be configured using a PlateStak, for convenience, you can access the PlateStak Diagnostics from the Rake Diagnostics dialog box.
Related informationFor more information about... See...
Opening diagnostics “Opening diagnostics” on page 10
Workflow for configuring the Rake “Workflow for configuring the Rake” on page 168
Creating a Rake profile “Creating a Rake profile” on page 169
Chapter 13: RakeDevice Driver User Guide
176
177Chapter 14: SoftMax Pro
Device Driver User GuideThe Molecular Devices family of readers that use SoftMax Pro can be configured to work in a lab automation system using VWorks or BenchWorks.
This chapter describes how to:
❑ Install the SoftMax Pro device driver plug-in
❑ Configure the SoftMax Pro device
❑ Set the SoftMax Pro task parameters
❑ Use SoftMax Pro Diagnostics
SoftMax Pro 14
Chapter 14: SoftMax ProDevice Driver User Guide
178
Workflow for configuring the SoftMax Pro
About this topic In order to use the SoftMax Pro task in protocols, the SoftMax Pro device driver needs to be configured in VWorks or BenchWorks.
This topic provides a workflow for configuring the SoftMax Pro device driver. Read this topic if you are an Administrator responsible for setting up the SoftMax Pro in VWorks or BenchWorks.
Workflow
Related information
Creating a SoftMax Pro profile
About this topic Profiles contain the initialization settings that enable VWorks or BenchWorks to identify and communicate with the SoftMax Pro. Every device within the automation system must have its own profile. Once created, you will probably not need make changes to the profile.
This topic describes how to create a profile for the SoftMax Pro device. Read this topic if you are an Administrator responsible for setting up a SoftMax Pro device in VWorks or BenchWorks.
Before you start Before you can create a profile, you must install the device driver plug-in and add the SoftMax Pro to the device manager.
Step Topic
1. “Installing device drivers” on page 13
2. “Adding devices” on page 15
3. “Creating a SoftMax Pro profile” on page 178
4. “Setting the properties for a device” on page 17
For information about... See...
Device drivers “About device drivers” on page 11
Setting SoftMax Pro task parameters
“Setting the SoftMax Pro task parameters” on page 180
Using SoftMax Pro Diagnostics “Using SoftMax Pro Diagnostics” on page 181
179Chapter 14: SoftMax ProDevice Driver User Guide
Creating a profile To create a SoftMax Pro profile:
1. Open SoftMax Reader Device Diagnostics.
2. Click the Profiles tab.
3. Click Browse and set the path to the desired directory.
4. In the Profile Management group box, click New.
5. Enter a name and click OK.
Choosing the profile settings
To choose the settings for the profile:
1. If you want the file names to be appended with the bar code, select the Generate data filename using bar code read check box and select the side of the plate the bar code is located on from the Bar code side list box.
2. Optionally, change the Read timeout time. This is the time to wait for a read to occur before displaying an error message.
3. Click Update this profile and then click OK to close the dialog box.
Chapter 14: SoftMax ProDevice Driver User Guide
180
Related information
Setting the SoftMax Pro task parameters
About this topic When you add a SoftMax Pro task to a protocol, you need to set the task parameters, that is, tell the robot which SoftMax Pro device to use. This topic describes how to set the SoftMax Pro task parameters.
Read this topic if you are:
❑ An Administrator or Technician who writes protocols for the SoftMax Pro
❑ An Operator who needs to change which SoftMax Pro is used in a protocol
SoftMax Pro task defined
The SoftMax Pro task moves a specified plate into the SoftMax Pro and waits for the plate to be read.
Procedure To set the SoftMax Pro task parameters:
1. Add the Read (SoftMax Pro reader driver) task to a protocol.
2. In the Protocol Task Parameters toolbar, select the SoftMax Pro device in the left field and click Add. The name appears in the right.
For information about... See...
The next step “Setting the properties for a device” on page 17
The workflow this procedure belongs to
“Workflow for configuring the SoftMax Pro” on page 178
Opening diagnostics “Opening diagnostics” on page 10
Setting SoftMax Pro task parameters
“Setting the SoftMax Pro task parameters” on page 180
Using SoftMax Pro Diagnostics “Using SoftMax Pro Diagnostics” on page 181
Profiles “About profiles” on page 8
181Chapter 14: SoftMax ProDevice Driver User Guide
Related information
Using SoftMax Pro Diagnostics
About this topic You can use the SoftMax Pro Diagnostics to:
❑ Manage profiles
❑ Take reads and examine results
Read this topic if you are:
❑ An Administrator who wants to manage profiles for the SoftMax Pro
❑ A Technician or Operator who wants to take readings and examine the results without running a protocol
Managing profiles To manage SoftMax Pro profiles:
1. Open SoftMax Reader Device Diagnostics.
2. Click the Profile tab.
3. Select the profile you want to modify from the Profile name list.
4. Perform the desired management task.
Management tasks include the following:
Updating the profile. Use this command to save edits to an existing profile.
Copying a profile.
Renaming a profile.
Deleting a profile.
Initializing a profile. Use this command to reset the device with the selected profile.
For information about... See...
Adding tasks to protocols ❑ VWorks User Guide
❑ BenchCel User Guide
Configuring the SoftMax Pro driver “Workflow for configuring the SoftMax Pro” on page 178
Creating a profile “Creating a SoftMax Pro profile” on page 178
Using SoftMax Pro Diagnostics “Using SoftMax Pro Diagnostics” on page 181
Chapter 14: SoftMax ProDevice Driver User Guide
182
Taking a reading To take a reading and view the results:
1. Open SoftMax Reader Device Diagnostics.
2. Click the Controls tab.
3. If not already open, open the reader drawer by clicking Open.
4. Place the plate on the reader stage and click Close to close the drawer.
5. When ready, click Read.
The results are displayed in the Result field. The numbers correspond to the columns on the plate.
183Chapter 14: SoftMax ProDevice Driver User Guide
Related informationFor information about... See...
Adding the SoftMax Pro to the device manager
“Adding devices” on page 15
The workflow for configuring the SoftMax Pro
“Workflow for configuring the SoftMax Pro” on page 178
Profile settings “Creating a SoftMax Pro profile” on page 178
Profiles “About profiles” on page 8
Setting task parameters “Setting the SoftMax Pro task parameters” on page 180
Chapter 14: SoftMax ProDevice Driver User Guide
184
185Chapter 15: StoreX/CytomatPLC
Device Driver User GuideThe LiCONiC STX-Series and STR-Series Automated Precision Incubators and the Heraeus Cytomat PLC storage device can be configured to work in lab automation systems using VWorks.
Note: Current models of the Heraeus Cytomat automated incubators are not supported by this driver.
The StoreX/CytomatPLC must be used with the VWorks inventory management system. For information about setting up and using the VWorks inventory, see the VWorks User Guide.
This chapter describes how to:
❑ Update old device and protocol files to use the current StoreX/CytomatPLC device driver
❑ Install the StoreX/CytomatPLC device driver
❑ Configure the StoreX/CytomatPLC
❑ Set the StoreX/CytomatPLC task parameters
❑ Use StoreX/CytomatPLC Diagnostics
StoreX/CytomatPLC 15
Chapter 15: StoreX/CytomatPLCDevice Driver User Guide
186
Updating device and protocol files for StoreX
About this topic Older versions of VWorks used a different driver for the StoreX device. This topic describes how to change old device and protocol files so that you can use them with this version of VWorks.
Read this topic if you want to use protocols and device files created in pre-21.x versions of VWorks.
Two procedures There are two parts to updating your device and protocol files for the new StoreX/CytomatPLC device driver:
❑ Updating device files
❑ Updating protocol files
Updating device files Follow this procedure to remove the StoreX IO Pad devices and change the StoreX Incubator device to a StoreX/CytomatPLC device.
To update the device file with the new StoreX/CytomatPLC driver:
1. Select File > Device File > Open and open the device file that contains the old StoreX devices of type:
StoreX Incubator
StoreX IO Pad
2. In the device manager, change the device type of the StoreX Incubator device to StoreX/CytomatPLC Device Driver (from Plugin).
3. Set the properties for the device.
If your device file has two StoreX IO Pads, set both locations to be accessible by the robot and select the teachpoint.
If your device file has only one StoreX IO Pad, set only the Primary location to be accessible by the robot.
4. In the device manager, delete the StoreX IO Pad devices.
These pad devices have been replaced by the Locations in the new StoreX/CytomatPLC device driver.
187Chapter 15: StoreX/CytomatPLCDevice Driver User Guide
5. Save the device file.
Updating protocol files
Follow this procedure to update protocols containing StoreX tasks (Load, Unload, and Incubate at plate storage device).
If you are not familiar with the current VWorks inventory system, you need to review the information about the inventory in the VWorks User Guide and set up plate groups or location groups for use in the tasks.
To update the protocol file with the StoreX task parameters:
1. Select File > Protocol File > Open and open a protocol file that contains the old StoreX tasks.
2. For each StoreX task (Load, Unload, and Incubate at plate storage device) in the protocol, edit the task parameters.
3. After editing the task parameters, save the protocol file.
Related informationFor information about... See...
Configuring the StoreX/CytomatPLC device
“Workflow for configuring the StoreX/CytomatPLC” on page 188
Setting device properties “Setting the properties for a device” on page 17
Editing task parameters for the StoreX
“Setting the PlateHub task parameters” on page 151
Device drivers “About device drivers” on page 11
Chapter 15: StoreX/CytomatPLCDevice Driver User Guide
188
Workflow for configuring the StoreX/CytomatPLC
About this topic This topic presents the workflow for configuring the StoreX/CytomatPLC device driver.
Read this topic if you are an Administrator responsible for setting up devices in VWorks.
Workflow
Related information
Step Topic
1. “Installing device drivers” on page 13
You may have already done this.
2. “Adding devices” on page 15
Make sure you set the Device type to StoreX/CytomatPLC Device Driver (from plugin). The StoreX Incubator and StoreX IO Pad device types are obsolete.
3. “Creating a StoreX/CytomatPLC profile” on page 189
4. “Setting the properties for a device” on page 17
For the STX and Cytomat PLC, set only the Primary location to be accessible by a robot.
For the STR, set both locations to be accessible by the robot. The Primary location is where the robot drops off plates for loading into the STR, and the Secondary location is where the robot picks up plates unloaded from the STR.
For information about... See...
Device drivers “About device drivers” on page 11
Setting StoreX/CytomatPLC task parameters
“Setting StoreX/CytomatPLC task parameters” on page 192
Using StoreX/CytomatPLC Diagnostics
“Using StoreX/CytomatPLC Diagnostics” on page 193
189Chapter 15: StoreX/CytomatPLCDevice Driver User Guide
Creating a StoreX/CytomatPLC profile
About this topic This topic describes how to create a profile for the StoreX/CytomatPLC. Creating a profile is an essential step for setting up the StoreX/CytomatPLC device driver.
Read this topic if you are an Administrator responsible for setting up devices in VWorks.
Before you start Before you create a profile, you need to have added the StoreX/CytomatPLC to the device manager.
Procedure To create a StoreX/CytomatPLC profile:
1. Open the StoreX/CytomatPLC Diagnostics.
2. Click the Profiles tab.
You may see an error related to teachpoints. If the device has not yet been initialized, it is safe to ignore the error.
3. Click Create new profile and replace the text New profile #number with the name you want to give the profile.
4. In the StoreX/Cytomat Parameters group box, set the following:
Setting Description
This device uses The port connecting the StoreX/CytomatPLC to the controlling computer.
BCR on The serial port of the VWorks computer to which an optional bar code reader is attached.
Number of carousel levels
Specify if your model of StoreX has one or two carousel levels.
Chapter 15: StoreX/CytomatPLCDevice Driver User Guide
190
Cassettes per level The number of cassettes in one carousel.
A cassette is a stacker containing plate slots. The cassettes can be removed and replaced on the carousel.
Slots per cassette on lower level
This value specifies how many plates a cassette on the lower level can hold.
If you have only one level, it is considered the lower.
Load / unload timeout [ms]
An error is generated when the StoreX/CytomatPLC does not load or unload a plate by this time period after the command was sent.
The default value is 20,000 ms. Because different incubators have different response times, this value is editable.
Lower level slot spacing [steps]
Spacing between the bottom of one plate and the bottom of the next one in the stack.
This value is constant for an incubator and in general should not be changed. If you do need to change it, you must also select the Lower slot spacing check box in step 5.
Rotate external pad for robotic access
Select this if:
❑ Your StoreX/CytomatPLC has an external pad that rotates (called a Turn Station), and
❑ You want the pad to rotate after a plate has been placed on it.
Has sensor under external pad
Select this if the external pad of the StoreX/CytomatPLC’s transfer station is equipped with a plate sensor.
If this is selected and the sensor does not detect a plate when expected, you receive an error message.
Load default values You can reset the StoreX/CytomatPLC profile to factory settings by clicking this button and turning the power to the incubator off and back on.
Remember to save the profile if you want to keep these factory settings.
Setting Description
191Chapter 15: StoreX/CytomatPLCDevice Driver User Guide
5. In the Overrides for Liconic settings group box, set the following:
6. Click Rename profile to save the new profile.
The name of the button changes to Update profile.
Teachpoints are also saved in the profile. If you need to modify teachpoints, see “Using StoreX/CytomatPLC Diagnostics” on page 193.
Related information
Setting Description
Lower slot spacing If you specified a Lower level slot spacing [steps] in step 4 above, then select this box.
❑ Output angle
❑ Output height
❑ Input height
❑ Left carousel teachpoint
❑ Right carousel teachpoint
If you want to use the teachpoints (set in the Teachpoints page), you have to select these check boxes.
For example, if you want to use the Output angle [steps] teachpoint, select the Output angle box.
For information about... See...
Opening diagnostics “Opening diagnostics” on page 10
Adding the StoreX/CytomatPLC to the device manager
“Adding devices” on page 15
The next step “Setting the properties for a device” on page 17
The workflow this procedure belongs to
“Workflow for configuring the StoreX/CytomatPLC” on page 188
Using diagnostics “Using StoreX/CytomatPLC Diagnostics” on page 193
Using StoreX/CytomatPLC tasks “Setting StoreX/CytomatPLC task parameters” on page 192
Profiles “About profiles” on page 8
Chapter 15: StoreX/CytomatPLCDevice Driver User Guide
192
Setting StoreX/CytomatPLC task parameters
About this topic After the device has been added to the device file, the tasks associated with the StoreX/CytomatPLC become available in the protocol editor. When a task is added to a protocol, you need to set the parameters for it. This includes specifying what groups of plates to store or incubate.
This topic describes the tasks and their parameters.
Read this topic if you are:
❑ An Administrator or Technician responsible for creating protocols
❑ An Operator who wants to make changes to the StoreX/CytomatPLC task parameters in a protocol
About StoreX/CytomatPLC tasks
The StoreX/CytomatPLC device driver adds three tasks to VWorks software:
❑ Load
❑ Unload
❑ Incubate at plate storage device
These are the same tasks that are used by the PlateHub device.
For information about these tasks, see “Setting the PlateHub task parameters” on page 151.
Related informationFor more information about... See...
The workflow that this procedure belongs to
“Workflow for configuring the StoreX/CytomatPLC” on page 188
Creating protocols, pre-protocols, post-protocols, and pipette processes
VWorks User Guide
Opening StoreX/CytomatPLC device properties page
“Adding devices” on page 15
Using diagnostics “Using StoreX/CytomatPLC Diagnostics” on page 193
Creating plate groups and Location groups (in the inventory manager)
The chapter about using the VWorks inventory in the VWorks User Guide
193Chapter 15: StoreX/CytomatPLCDevice Driver User Guide
Using StoreX/CytomatPLC Diagnostics
About this topic This topic describes using StoreX/CytomatPLC Diagnostics to:
❑ Manage profiles
❑ Set climate control (temperature, humidity, and gas concentration) for the StoreX/CytomatPLC
❑ Execute specific operations, such as opening and closing the gate
❑ Send direct commands to the StoreX/CytomatPLC
Read this topic if you are:
❑ An Administrator who wants to manage StoreX/CytomatPLC profiles
❑ A Technician or Operator who wants to use StoreX/CytomatPLC Diagnostics to troubleshoot or operate the StoreX/CytomatPLC without running a protocol
Managing profiles To manage StoreX/CytomatPLC profiles:
1. Open the StoreX/CytomatPLC Diagnostics.
2. Click the Profiles tab.
3. Select a profile from the Profile names list.
4. Perform the desired management task using these buttons:
Use this profile. Use this command to reset the device with the selected profile.
Create copy.
Update profile. Use this command to save edits to the current profile.
Rename profile. Use this command to save the profile after you have edited the current profile’s name.
Delete profile.
Chapter 15: StoreX/CytomatPLCDevice Driver User Guide
194
Adjusting the StoreX climate
The Climate Control diagnostics page allows you to set the temperature, humidity, carbon dioxide, and nitrogen levels for the StoreX.
(The Cytomat PLC does not support climate control.)
To adjust the StoreX/CytomatPLC climate:
1. Open the StoreX/CytomatPLC Diagnostics.
2. Click the Climate Control tab.
The current values and set points for the climate parameters are displayed.
3. Select the Auto-update sensor values check box.
The climate parameters will be updated approximately every 2 seconds.
4. Enter a value into one of the Setpoint fields and click Set.
If you enter a value that is out of range, the Setpoint resets to the closest value. For example, if you try to set the temperature to 80°C, the Setpoint reappears as 70°C (assuming 70°C is the maximum temperature for your incubator).
Operating the StoreX/CytomatPLC in manual mode
In manual mode, you can move a plate to and from the following locations:
❑ A specified slot in a cassette
❑ The external pad (such as the StoreX transfer station or a BioCel’s platepad)
❑ The lift (this is the assembly that moves plates from slots to the external pad)
To load or unload a plate in manual mode:
1. Open the StoreX/CytomatPLC Diagnostics.
2. Click the I/O tab.
3. Select the position: (This is the position in the StoreX/CytomatPLC that you want to move the plate from or to.)
a. Select the Cassette from the list.
b. Select the Slot from the list.
4. Optionally, select to Read barcode after unloading.
195Chapter 15: StoreX/CytomatPLCDevice Driver User Guide
5. Perform the desired action.
The commands you can perform in manual mode are listed in the table.
Operating the StoreX/CytomatPLC in service mode
To operate the StoreX/CytomatPLC in service mode:
1. Open the StoreX/CytomatPLC Diagnostics.
2. Click the I/O tab.
3. Select the Enable service mode to make all actions available.
4. Click the desired Action:
Open gate
Close gate
Rotate external pad to robot
Rotate external pad home
Extend shovel
Retract shovel
The command Moves the plate from the...
To the...
Unload slot –> external pad
Slot in the cassette External pad
Load external pad –> slot
External pad Slot in the cassette
Slot –> lift Slot in the cassette Lift assembly
External pad –> lift External pad Lift assembly
Lift –> external pad Lift assembly External pad
Chapter 15: StoreX/CytomatPLCDevice Driver User Guide
196
Turn to transfer station
Move lift to gate
The appropriate Sensor lights up when the mechanical action completes.
5. To send a command not available in the Actions group, type it in the Enter device command field and click Send.
See your StoreX/CytomatPLC operating manual for information about these commands.
If you often need to enter commands, consider using the Macros page of the diagnostics to enter the commands instead of typing the command in the I/O page each time.
Sending direct commands with macros
Create macros to send direct commands to the StoreX/CytomatPLC. You can also send commands by typing them in the I/O page. However, it is easier to set up frequently used commands as macros because you can:
❑ Give descriptive (friendly) names to the macros
❑ Send the command in two clicks (no typing)
To create, send, and manage macros:
1. Open the StoreX/CytomatPLC Diagnostics.
2. Click the Macros tab.
3. Perform one of the following actions:
Adding a new command. Click the button and enter values for Friendly name and Command string.
Execute selected command. Select a macro and click the button.
197Chapter 15: StoreX/CytomatPLCDevice Driver User Guide
Delete selected command. Select a macro and click the button.
See your StoreX/CytomatPLC operating manual for information about direct commands.
About managing teachpoints
Teachpoints are created and modified using the Teachpoint page of the diagnostics.
!! DAMAGE HAZARD !! Contact Velocity11 Service Center before adjusting StoreX/CytomatPLC teachpoints.
If you are using a StoreX/CytomatPLC with a simple robot such as a BenchCel, it is unlikely that you will need to change the StoreX/CytomatPLC teachpoints. It should be sufficient to adjust the teachpoints of the BenchCel’s robot to coordinate the handoff of plates between the BenchCel and the StoreX/CytomatPLC.
If you are using a StoreX/CytomatPLC with the BioCel, the teachpoints have been set for you by Velocity11, and it is unlikely that you will need to change them.
Related informationFor more information about... See...
Opening diagnostics “Opening diagnostics” on page 10
Workflow for configuring the StoreX/CytomatPLC
“Workflow for configuring the StoreX/CytomatPLC” on page 188
Creating a StoreX/CytomatPLC profile
“Creating a StoreX/CytomatPLC profile” on page 189
Chapter 15: StoreX/CytomatPLCDevice Driver User Guide
198
199Chapter 16: Symbol MiniScan BCS
Device Driver User GuideThe Symbol Technologies Symbol MiniScan BCSs are a family of desktop bar code scanners.
These bar code scanners can be configured to work in lab automation systems using VWorks or BenchWorks.
This chapter describes how to:
❑ Install the Symbol MiniScan BCS device driver
❑ Configure the Symbol MiniScan BCS
❑ Set the Symbol MiniScan BCS task parameters
❑ Use Symbol MiniScan BCS Diagnostics
Symbol MiniScan BCS 16
Chapter 16: Symbol MiniScan BCSDevice Driver User Guide
200
Workflow for configuring the Symbol MiniScan BCS
About this topic This topic presents the workflow for configuring the Symbol MiniScan BCS device driver.
Read this topic if you are an Administrator responsible for setting up devices in VWorks or BenchWorks.
Workflow
Related information
Step Topic
1. “Installing device drivers” on page 13
You may have already done this.
2. “Adding devices” on page 15
3. “Creating a Symbol MiniScan BCS profile” on page 201
4. “Setting the properties for a device” on page 17
For information about... See...
Device drivers “About device drivers” on page 11
Setting Symbol MiniScan BCS task parameters
“Setting Symbol MiniScan BCS task parameters” on page 202
Using Symbol MiniScan BCS Diagnostics
“Using Symbol MiniScan BCS Diagnostics” on page 204
201Chapter 16: Symbol MiniScan BCSDevice Driver User Guide
Creating a Symbol MiniScan BCS profile
About this topic Profiles contain the initialization settings that enable VWorks or BenchWorks to identify and communicate with the Symbol MiniScan BCS. Every device within the automation system must have its own profile. Once created, you will probably not need make changes to the profile.
This topic describes how to create a profile for the Symbol MiniScan BCS.
Read this topic if you are an Administrator responsible for setting up devices in VWorks or BenchWorks.
Before you start Before you create a profile, you need to have installed the Symbol MiniScan BCS device driver and added the Symbol MiniScan BCS to the device manager.
Procedure To create a Symbol MiniScan BCS profile:
1. Open the Symbol MiniScan BCS Diagnostics.
2. Click the Profiles tab.
3. Click Create a new profile, enter a name, and click OK.
4. In the Profile Settings group box, set the following:
5. Click Update this profile.
Setting Description
Serial port The port connecting the Symbol MiniScan BCS to the controlling computer.
Beep on decode Select to have the Symbol MiniScan BCS beep when scanned bar code is decoded.
Chapter 16: Symbol MiniScan BCSDevice Driver User Guide
202
Related information
Setting Symbol MiniScan BCS task parameters
About this topic After the device has been added to the device file, the tasks associated with the Symbol MiniScan BCS become available in the protocol editor. When a task is added to a protocol, you need to set the parameters for it. This includes choosing the Symbol MiniScan BCS to use and on which side of the labware the bar code is located.
This topic describes the task and its parameters.
Read this topic if you are:
❑ An Administrator or Technician responsible for creating protocols
❑ An Operator who wants to make changes to the Symbol MiniScan BCS task parameters in a protocol
About Symbol MiniScan BCS tasks
The Symbol MiniScan BCS device driver adds one task to VWorks or BenchWorks software. This task instructs the Symbol MiniScan BCS to perform a bar code scan.
The Symbol MiniScan BCS task is represented by this icon in the Protocol Tasks toolbar:
This task is available in the protocol editor.
For information about... See...
Opening diagnostics “Opening diagnostics” on page 10
Adding the Symbol MiniScan BCS to the device manager
“Adding devices” on page 15
The next step “Setting the properties for a device” on page 17
The workflow this procedure belongs to
“Workflow for configuring the Symbol MiniScan BCS” on page 200
Using Symbol MiniScan BCS Diagnostics
“Using Symbol MiniScan BCS Diagnostics” on page 204
Using Symbol MiniScan BCS tasks “Setting Symbol MiniScan BCS task parameters” on page 202
Profiles “About profiles” on page 8
203Chapter 16: Symbol MiniScan BCSDevice Driver User Guide
Setting the Symbol MiniScan BCS task parameters
To set the Symbol MiniScan BCS task parameters:
1. Add the Symbol MiniScan BCS task to the desired protocol process.
2. In the parameters toolbar, make sure the Task Settings tab is displayed.
3. Move the Symbol MiniScan BCS or Symbol MiniScan BCSs that you want to use to the right field using the Add and Remove buttons.
4. Set the Symbol MiniScan BCS properties.
Related information
Property Description
Side to scan Select the location of the bar code from the list.
Tip. To do this, click in the field to the right of the Side to scan field. Then click the grey arrow button that appears. (See figure below.)
For more information about... See...
The workflow for configuring the Symbol MiniScan BCS
“Workflow for configuring the Symbol MiniScan BCS” on page 200
Creating protocols, pre-protocols, post-protocols, and pipette processes
❑ VWorks User Guide
❑ BenchCel User Guide
Opening Symbol MiniScan BCS device properties page
“Setting the properties for a device” on page 17
Creating a Symbol MiniScan BCS profile
“Creating a Symbol MiniScan BCS profile” on page 201
Chapter 16: Symbol MiniScan BCSDevice Driver User Guide
204
Using Symbol MiniScan BCS Diagnostics
About this topic This topic describes using Symbol MiniScan BCS Diagnostics to:
❑ Manage profiles
❑ Scan a bar code
Read this topic if you are:
❑ An Administrator who wants to manage Symbol MiniScan BCS profiles
❑ A Technician or Operator who wants to use Symbol MiniScan BCS Diagnostics to troubleshoot or operate the Symbol MiniScan BCS without running a protocol
Managing profiles To manage Symbol MiniScan BCS profiles:
1. Open the Symbol MiniScan BCS Diagnostics.
2. Click the Profiles tab.
3. Select a profile from the Profile names list.
4. Perform the desired management task.
Management tasks include the following:
Updating the profile. Use this command to save edits to an existing profile.
Copying a profile.
Using Symbol MiniScan BCS Diagnostics
“Using Symbol MiniScan BCS Diagnostics” on page 204
For more information about... See...
205Chapter 16: Symbol MiniScan BCSDevice Driver User Guide
Renaming a profile.
Deleting a profile.
Initializing a profile. Use this command to reset the device with the selected profile.
Scanning a bar code To scan a bar code:
1. Open Symbol MiniScan BCS Diagnostics.
2. Click the Controls tab.
3. Place the labware on the device that has the Symbol MiniScan BCS.
4. Click Scan.
The decoded bar code appears in the Result field.
Related informationFor more information about... See...
Opening Symbol MiniScan BCS Diagnostics
“Opening diagnostics” on page 10
Workflow for configuring the Symbol MiniScan BCS
“Workflow for configuring the Symbol MiniScan BCS” on page 200
Creating a Symbol MiniScan BCS profile
“Creating a Symbol MiniScan BCS profile” on page 201
Chapter 16: Symbol MiniScan BCSDevice Driver User Guide
206
207Chapter 17: Translator Robot
Device Driver User GuideThe Robo Cylinder Translator Robot is a two-axis robot.
It can be configured to work in a lab automation system using VWorks or BenchWorks.
This chapter describes how to:
❑ Install the Translator Robot device driver plug-in
❑ Configure the Translator Robot device
❑ Use Translator Robot Diagnostics
Translator Robot 17
Chapter 17: Translator RobotDevice Driver User Guide
208
Workflow for configuring the Translator Robot
About this topic Before you can use the Translator Robot in a protocol, you need to configure the Translator Robot in VWorks or BenchWorks.
This topic presents the workflow for configuring the Translator Robot. Read this topic if you are an Administrator who is responsible for setting up a Translator Robot in VWorks or BenchWorks.
Workflow
Related information
Step Topic
1. “Installing device drivers” on page 13
2. “Adding devices” on page 15
3. “Creating a Translator Robot profile” on page 209
4. “Setting the properties for a device” on page 17
For information about... See...
Device drivers “About device drivers” on page 11
Using Translator Robot Diagnostics “Using Translator Robot Diagnostics” on page 211
209Chapter 17: Translator RobotDevice Driver User Guide
Creating a Translator Robot profile
About this topic Profiles contain the initialization settings that enable VWorks or BenchWorks to identify and communicate with the Translator Robot. Every device within the automation system must have its own profile. Once created, you will probably not need make changes to the profile.
This topic describes how to create a profile for the Translator Robot. Read this topic if you are an Administrator who is responsible for setting up a Translator Robot in VWorks or BenchWorks.
Before you start Before you can create a profile, you must install the Translator Robot device driver plug-in and add the Translator Robot to the device manager.
Procedure To create a Translator Robot profile:
1. Open TBot Diagnostics.
2. Click the Profiles tab.
3. Select the Translator Robot COM port and the Gripper COM port from the list boxes.
4. If different, change the default values for the X and Z axes screw pitch.
The screw pitch value is dependent on the type of motor the robot uses. See the Translator Robot documentation for the values.
5. Optionally, change the default timeouts for X and Z movements.
This is the maximum time the robot is allowed to carry out a command for that direction before sending an error message.
Chapter 17: Translator RobotDevice Driver User Guide
210
6. Optionally, select the Turn off... check box to turn off plate detection when you are using diagnostics.
7. Select a Teachpoint file. If you do not have one, create one:
a. Click Create new teachpoint file.
b. Enter a name for the file in the Create a blank TBot teachpoint file dialog box.
c. Optionally, change the directory for the teachpoint file.
d. Click Save.
8. Click Create a new profile.
9. Enter a name and click OK.
Related informationFor information about... See...
The next step “Setting the properties for a device” on page 17
The workflow that this procedure belongs to
“Workflow for configuring the Translator Robot” on page 208
Using Translator Robot Diagnostics “Using Translator Robot Diagnostics” on page 211
Opening Translator Robot Diagnostics
“Opening diagnostics” on page 10
Profiles “About profiles” on page 8
211Chapter 17: Translator RobotDevice Driver User Guide
Using Translator Robot Diagnostics
About this topic Use the Translator Robot Diagnostics to:
❑ Manage profiles
❑ Create and modify teachpoints
❑ Check robot grippers
Read this topic if you are:
❑ An Administrator who wants to manage profiles for the Translator Robot
❑ A Technician or Operator who wants to troubleshoot a problem or otherwise operate the robot without running a protocol
Managing profiles To manage Translator Robot profiles:
1. Open the TBot Diagnostics.
2. Click the Profiles tab.
3. Select a profile from the Profile name list.
4. Perform the desired management task.
Management tasks include the following:
Updating the profile. Use this command to save edits to an existing profile.
Copying a profile.
Renaming a profile.
Deleting a profile.
Chapter 17: Translator RobotDevice Driver User Guide
212
Initializing a profile. Use this command to reset the device with the selected profile.
Creating teachpoints Use the Teachpoints page of TBot Diagnostics to create, rename, and delete teachpoints. Once created, use the commands on the Control page to modify and fine tune the teachpoints.
To create a teachpoint:
1. Open TBot Diagnostics.
2. Click the Teachpoints tab.
3. Click New.
4. Enter a name for the teachpoint and click OK.
5. Optionally, choose the teachpoint’s initial coordinates.
Enter an X and Z-axis position and click Save teachpoints or,
Click Use current position and then click Save teachpoints.
Note: You can also create a new teachpoint file and its directory location from the Profiles page.
213Chapter 17: Translator RobotDevice Driver User Guide
Modifying teachpoints and checking grippers
To modify or fine-tune the Translator Robot teachpoints:
1. Open TBot Diagnostics.
2. Click the Controls tab.
3. Select the teachpoint you want to modify from Teachpoint 1 list. If you want to fine tune the robot travel between two teachpoints, select the second teachpoint from the Teachpoint 2 list.
4. Select the labware that you are using from the Labware list.
To edit or add labware, click Editor to open the Labware Editor.
5. Use the commands in the Actions group box to pick and place labware and move between teachpoints. Use the following table as a guide.
Clicking the command... Causes the robot to...
Move to Move to the selected teachpoint.
Pick Pick up the labware from the selected teachpoint.
Place Place the labware at the selected teachpoint.
Pick and Place Pick up the labware from the non-selected teachpoint and places it at the selected teachpoint. For example, if you click Pick and Place under Teachpoint 2, the robot picks the plate up from teachpoint 1 and places it at Teachpoint 2.
Teach Record the current position as the teachpoint.
Chapter 17: Translator RobotDevice Driver User Guide
214
6. Use the controls in the Robot Position group box to modify the position of the robot to fine-tune the teachpoints.
To move the robot by hand, click the Servo on button to turn off the motor and then move the robot.
To send the robot back to the zero position, click Home.
Note: If you have a problem and need to reinitialize the robot, go to the Profiles page and click Initialize this profile.
7. When you are satisfied with the teachpoints, click Save teachpoints.
8. Click OK to exit the dialog box.
To check the robot’s gripper sensors:
1. Use the commands in the Gripper group box to open and close the gripper.
2. Monitor the indicator lights to confirm the gripper action.
Related informationFor information about... See...
Opening Translator Robot Diagnostics
“Opening diagnostics” on page 10
Workflow for setting up the Translator Robot
“Workflow for configuring the Translator Robot” on page 208
Creating a Translator Robot profile “Creating a Translator Robot profile” on page 209
Changing the teachpoint file directory
“Creating a Translator Robot profile” on page 209
215Chapter 18: ViewLux
Device Driver User GuideThe PerkinElmer ViewLux ultraHTS Microplate Imager can be configured to work in lab automation systems using VWorks or BenchWorks.
The ViewLux is an ultra high throughput microplate imager for measuring light from fluorescence polarization (FP), fluorescence intensity, time-resolved fluorescence (TRF), luminescence, and absorbance.
This chapter describes how to:
❑ Install the ViewLux device driver
❑ Configure the ViewLux
❑ Set the ViewLux task parameters
❑ Use ViewLux Diagnostics
ViewLux 18
Chapter 18: ViewLuxDevice Driver User Guide
216
Workflow for configuring the ViewLux
About this topic This topic presents the workflow for configuring the ViewLux device driver.
Read this topic if you are an Administrator responsible for setting up devices in VWorks or BenchWorks.
Workflow
Related information
Step Topic
1. “Installing device drivers” on page 13
You may have already done this.
2. “Adding devices” on page 15
3. “Creating a ViewLux profile” on page 217
4. “Setting the properties for a device” on page 17
For information about... See...
Device drivers “About device drivers” on page 11
Setting ViewLux task parameters “Setting ViewLux task parameters” on page 219
Using ViewLux Diagnostics “Using ViewLux Diagnostics” on page 221
217Chapter 18: ViewLuxDevice Driver User Guide
Creating a ViewLux profile
About this topic Profiles contain the initialization settings that enable VWorks or BenchWorks to identify and communicate with the ViewLux. Every device within the automation system must have its own profile. Once created, you will probably not need make changes to the profile.
This topic describes how to create a profile for the ViewLux.
Read this topic if you are an Administrator responsible for setting up devices in VWorks or BenchWorks.
Before you start Before you create a profile, you need to have installed the ViewLux device driver and added the ViewLux to the device manager.
Procedure To create a ViewLux profile:
1. Open the ViewLux Diagnostics.
2. Click the Profiles tab.
3. Click Create a new profile, enter a name, and click OK.
4. In the Profile Settings group box, set the following:
Setting Description
Holder movement timeout Time to wait for the plate stage to complete its motion before sending an error message.
Run protocol timeout Time to wait for the protocol to complete its run before sending an error message.
Default output filename Path and name of the output file containing the data from the ViewLux reading.
The path and filename can also be changed when setting the task parameters for a ViewLux reading.
Chapter 18: ViewLuxDevice Driver User Guide
218
5. Click Update this profile.
Related information
Date / time stamp When selected, appends the output file name with the date and time of run.
❑ South bar code
❑ West bar code
❑ North bar code
❑ East bar code
When selected, appends the output file name with the selected bar code.
Setting Description
For information about... See...
Opening diagnostics “Opening diagnostics” on page 10
Adding the ViewLux to the device manager
“Adding devices” on page 15
The next step “Setting the properties for a device” on page 17
The workflow this procedure belongs to
“Workflow for configuring the ViewLux” on page 216
Using ViewLux Diagnostics “Using ViewLux Diagnostics” on page 221
Using ViewLux tasks “Setting ViewLux task parameters” on page 219
Profiles “About profiles” on page 8
219Chapter 18: ViewLuxDevice Driver User Guide
Setting ViewLux task parameters
About this topic After the device has been added to the device file, the tasks associated with the ViewLux become available in the protocol editor. When a task is added to a protocol, you need to set the parameters for it. This includes choosing which ViewLux protocol to use.
This topic describes the tasks and their parameters.
Read this topic if you are:
❑ An Administrator or Technician responsible for creating protocols
❑ An Operator who wants to make changes to the ViewLux task parameters in a protocol
About ViewLux tasks The ViewLux device driver adds one task to VWorks or BenchWorks software. This task is used to deliver the read commands to the ViewLux during the execution of a protocol.
The ViewLux task is represented by this icon in the Protocol Tasks toolbar:
This task is available in the protocol editor.
Before you begin Make sure you have specified the number of the ViewLux protocol that the Read task is going to run. This can be found (and set) in the ViewLux manager software, as shown in the figure.
Chapter 18: ViewLuxDevice Driver User Guide
220
Setting Read (PerkinElmer ViewLux Driver) task parameters
To set the Read (PerkinElmer ViewLux Driver) task parameters:
1. Add the Read (PerkinElmer ViewLux Driver) task to the desired protocol process.
2. Move the ViewLux that you want to use to the right field using the Add and Remove buttons.
3. Set the “Read” properties.
Related information
Property Description
Protocol number The number assigned to the ViewLux protocol in the ViewLux (Wallac 1430) software.
Output filename Path to the data output file of the ViewLux. Default is set in the ViewLux profile.
If you change the file name or path here, it takes precedence over the value specified in the profile.
Tip. To open the browser box, click in the field to the right of the Output name field. Then click the grey button that appears. (See figure below.)
For more information about... See...
The workflow for configuring the ViewLux
“Workflow for configuring the ViewLux” on page 216
Creating protocols, pre-protocols, post-protocols, and pipette processes
❑ VWorks User Guide
❑ BenchCel User Guide
Opening ViewLux device properties page
“Setting the properties for a device” on page 17
Creating a ViewLux profile “Creating a ViewLux profile” on page 217
221Chapter 18: ViewLuxDevice Driver User Guide
Using ViewLux Diagnostics
About this topic This topic describes using ViewLux Diagnostics to:
❑ Manage profiles
❑ Run a protocol
❑ Operate the stage
Read this topic if you are:
❑ An Administrator who wants to manage ViewLux profiles
❑ A Technician or Operator who wants to use ViewLux Diagnostics to troubleshoot or operate the ViewLux without running a protocol
Managing profiles To manage ViewLux profiles:
1. Open the ViewLux Diagnostics.
2. Click the Profiles tab.
3. Select a profile from the Profile names list.
4. Perform the desired management task.
Management tasks include the following:
Updating the profile. Use this command to save edits to an existing profile.
Copying a profile.
Using ViewLux Diagnostics “Using ViewLux Diagnostics” on page 221
For more information about... See...
Chapter 18: ViewLuxDevice Driver User Guide
222
Renaming a profile.
Deleting a profile.
Initializing a profile. Use this command to reset the device with the selected profile.
Running a ViewLux protocol
To run a ViewLux protocol:
1. Open ViewLux Diagnostics.
2. Click the Controls tab.
3. Select the Protocol number you want to run from the list.
The protocol number corresponds to the number assigned to the protocol when it was created in the Wallac software.
Note: In the Profiles page, you can specify an output folder for the data acquired by the ViewLux.
4. Click Run protocol to execute the protocol.
5. Click Stop protocol at any time to interrupt the protocol execution.
Operating the ViewLux stage
To operate the ViewLux stage:
1. Open ViewLux Diagnostics.
2. Click the Controls tab.
3. To move the stage to an accessible position, click Extend holder.
4. Click Retract holder to move the stage into the read position.
Related informationFor more information about... See...
Opening diagnostics “Opening diagnostics” on page 10
Workflow for configuring the ViewLux
“Workflow for configuring the ViewLux” on page 216
Creating a ViewLux profile “Creating a ViewLux profile” on page 217
223IndexDevice Driver User Guide
IndexNote: You can search our technical documentation on our website at www.velocity11.com/support/support.html.
Aabsolute motion, Multimek, 142Acrobat Reader, 4Acrobat viewer, 4add dynamically-assigned stacker, PlateStak, 162Amersham Biosciences IN Cell Analyzer. see IN
Cell AnalyzerAmersham Biosciences LEADseeker. see LEAD-
seeker, 105Analyst GT
about tasks, 29configuring workflow, 26creating profiles, 27Execute Method task defined, 29managing profiles, 31Set Lamp State task defined, 29setting Execute Method task parameters, 30setting Set Lamp State task parameters, 29using diagnostics, 31
Arrival height, KiNEDx Robot, 102Aspirate (simple) task
defined, Multimek, 122setting parameters, Multimek, 135
Aspirate taskdefined, Cavro Pump, 39defined, Multimek, 119setting parameters, Cavro Pump, 40setting parameters, Multimek, 123
Bbar code properties, setting for devices, 17Bar Code Scan task
defined Symbol MiniScan BCS, 202setting parameters, 203
bar code scanning, Symbol MiniScan BCS, 205Beckman Multimek Pipettor. see Multimekbits per second, Generic RS-232, 77
CCavro Pump
Aspirate task defined, 39configuring workflow, 36Dispense task defined, 39Load task defined, 39managing profiles, 43operating in real time, 44
Prime task defined, 39setting Aspirate task parameters, 40setting Dispense task parameters, 40setting Load task parameters, 41setting Prime task parameters, 42setting task parameters, 39setting Transfer task parameters, 42Transfer task defined, 39
Change Instance taskdefined, FLIPR Tetra, 65defined, Multimek, 119setting parameters, FLIPR Tetra, 66setting parameters, Multimek, 125
close pump, Cavro Pump, 44communications traffic, Cavro Pump, 45connection and instrument status, viewing FLIPR
Tetra, 71controls, PlateHub, 153current position, Multimek, 144Cytomat
setting Incubate at plate storage device task parameters, 151
setting Load task parameters, 151setting Unload task parameters, 151tasks defined, 151
Cytomat PLCcreating teachpoints, 197Incubate at plate storage device task defined,
192Load task defined, 192Unload task defined, 192see also StoreX/CytomatPLC
Ddata bits, Generic RS-232, 77Deliver Tip Tray task
defined, Multimek, 120setting parameters, Multimek, 120
Departure height, KiNEDx Robot, 101device busy, Cavro Pump, 44device driver
defined, 11installing, 13writing your own, 11
device filesadding devices to, 15saving, 15
IndexDevice Driver User Guide
224
updating for new StoreX driver, 186Device Manager page
opening, 15device properties, setting, 17devices
defined, 7diagnostics
Analyst GT, 31Cavro Pump, 44FlexDrop, 56FLIPR Tetra, 71Generic RS-232, 83IN Cell Analyzer, 92KiNEDx Robot, 101LEADseeker, 110Multimek jog/teach page, 141Multimek, about, 140opening, 10PlateHub, 152PlateStak, 163Rake, 172SoftMax Pro, 181StoreX/CytomatPLC, 193Symbol MiniScan BCS, 204Translator Robot, 211ViewLux, 221
digital I/O, Multimek, 143Dispense (simple) task
defined, Multimek, 122setting parameters, Multimek, 136
Dispense taskdefined, Cavro Pump, 39defined, FlexDrop, 52defined, Multimek, 120defined, Rake, 171setting parameters, Cavro Pump, 40setting parameters, FlexDrop, 53setting parameters, Multimek, 127setting parameters, Rake, 171
display values, Multimek, 141driver version, finding, 6
EEmpty Tips (simple) task
defined, Multimek, 122setting parameters, Multimek, 136
Empty Tips taskdefined, Multimek, 120setting parameters, Multimek, 129
enable sensors, Cavro Pump, 44Execute Method task
defined, Analyst GT, 29setting parameters, Analyst GT, 30
Extend Stage, IN Cell Analyzer, 93
FFind button, 5finding the file, 3firmware version, 6FlexDrop
about tasks, 51configuring workflow, 48creating profiles, 49Dispense task defined, 52managing profiles, 56Prime task defined, 52Purge task defined, 52Run protocol task defined, 52Set reagent task defined, 51setting Dispense task parameters, 53setting Prime task parameters, 54setting Purge task parameters, 54setting Run task parameters, 55setting Set reagent task parameters, 52using diagnostics, 56
FLIPR Tetraabout tasks, 64Change Instance task, 65configuring workflow, 60creating profiles, 61Load and Unload tasks defined, 67Loop task defined, 68managing profiles, 73operating in real time, 72profile settings, 61resetting, 72Run Protocol task defined, 69setting Change Instance task parameters, 66setting Load and Unload task parameters, 67setting Loop task parameters, 68setting Run Protocol task parameters, 69using diagnostics, 71viewing connection and instrument status, 71viewing subsystem status, 72
flow control, Generic RS-232, 78
GGeneric RS-232
configuring workflow, 76creating profiles, 77managing profiles, 83sending a command, 84setting Receive task parameters, 79setting Send and Receive task parameters,
81setting Send task parameters, 79
225IndexDevice Driver User Guide
setting Wait for Location task parameters, 82task defined, 78using diagnostics, 83
gripper sensors, Translator Robot, 214
Hhead speed, Multimek, 141Heraeus Cytomat PLC see StoreX/CytomatPLChome, Cavro Pump, 44homing Multimek pipettor, 142
IIN Cell Analyzer
about tasks, 91configuring workflow, 88creating profiles, 89extending the stage, 93managing profiles, 93running protocol from diagnostics, 94setting Run Protocol task parameters, 91using diagnostics, 92
Incubate at plate storage device tasksetting parameters, 151
Incubate at storage device taskdefined, 151
incubate plate for, PlateStak, 163IWorks, about, 11
JJavaScript, using to set task parameters, 23job roles for readers of this guide, 2jog and teach, PlateStak, 163
KKiNEDx Robot
configuring workflow, 98creating profiles, 99creating teachpoints, 103managing profiles, 100moving between teachpoints, 102simple move, 101using diagnostics, 101viewing current position, 103
Llabware editor, editing with Multimek, 146LEADseeker
about tasks, 108configuring workflow, 106creating profiles, 107managing profiles, 110Read task defined, 109setting Read task parameters, 109
using diagnostics, 110LiCONiC STR-Series incubator. see StoreXLiCONiC STX-Series incubator. see StoreXlinking a pipette process, 21linking a pipette process to a device, 21liquid library editor, editing with Multimek, 146Load device task
defined, Cytomat PLC, 192Load task
defined, 151defined, Cavro Pump, 39defined, StoreX, 192setting parameters, 151setting parameters, Cavro Pump, 41
location properties, setting for devices, 17look for delimiters, Generic RS-232, 80look for exact string, Generic RS-232, 80Loop task
defined, Multimek, 120setting parameters, Multimek, 131
MMix task
defined, Multimek, 120setting parameters, Multimek, 132
Molecular Devices Analyst GT Reader. see Analyst GT
Molecular Devices FLIPR Tetra. see FLIPR TetraMolecular Devices microplate readers. see Soft-
Max Promove to cassette, PlateHub, 154Move to Plate/Frame task
defined, Multimek, 122setting parameters, Multimek, 139
Move to, Translator Robot, 213Move X-Y Axes task
defined, Multimek, 122setting parameters, Multimek, 137
Move Z Axis (absolute) taskdefined, Multimek, 122setting parameters, Multimek, 138
Move Z Axis (relative) taskdefined, Multimek, 122setting parameters, Multimek, 138
Multimekabout diagnostics, 140about tasks, 119, 121absolute motion, 142Aspirate (simple) task defined, 122Aspirate task defined, 119Change Instance task defined, 119configuring workflow, 114creating profiles, 115
IndexDevice Driver User Guide
226
current position, 144Deliver Tip Tray task defined, 120digital I/O, 143Dispense (simple) task defined, 122Dispense task defined, 120display values, 141editing labware database, 146editing liquid library, 146Empty Tips (simple) task defined, 122Empty Tips task defined, 120executing processes, 145head speed, 141homing the pipette head, 142Loop task defined, 120managing profiles, 117modifying teachpoints, 143Move to Plate/Frame task defined, 122Move X-Y Axes task defined, 122Move Z Axis (absolute) task defined, 122Move Z Axis (relative) task defined, 122relative motion, 142Remove Tip Tray task defined, 120Run Macro task defined, 120setting Aspirate (simple) task parameters,
135setting Aspirate task parameters, 123setting Change Instance task parameters,
125setting Deliver Tip Tray task parameters, 120setting Dispense (simple) task parameters,
136setting DIspense task parameters, 127setting Empty Tips (simple) task parameters,
136setting Empty Tips task parameters, 129setting Loop task parameters, 131setting Mix task parameters, 132setting Move to Plate/Frame task parame-
ters, 139setting Move X-Y Axes task parameters, 137setting Move Z Axis (absolute) task parame-
ters, 138setting Move Z Axis (relative) task parame-
ters, 138setting Remove Tip Tray task parameters, 120setting Run Macro task parameters, 134Sub Process task defined, 120using diagnostics jog/teach page, 141
OOffset, KiNEDx Robot, 102online help, 3
Pparity, Generic RS-232, 77PDF guide, 3, 4Peak Robotics KiNEDx. see KiNEDxPerkinElmer FlexDrop. see FlexDropPerkinElmer PlateStak. see PlateStakPerkinElmer ViewLux. see ViewLuxPick and Place, Translator Robot, 213Pick, Translator Robot, 213pipette process task
adding, 20linking a pipette task to, 21linking a pipette task to a device, 21setting parameters, 20
Place, Translator Robot, 213PlateHub
changing the settings, 155configuring workflow, 148controls page, 153creating profiles, 149managing profiles, 152setting Incubate at plate storage device task
parameters, 151setting Load task parameters, 151setting speed definitions, 149setting Unload task parameters, 151tasks defined, 151using diagnostics, 152
PlateStakconfiguring workflow, 158creating a profile, 159managing profiles, 165setting Downstacking task parameters, 161setting Restacking task parameter, 162setting Upstacking task parameter, 161tasks defined, 161using diagnostics, 163
plug-in, defined, 11Prime task
defined, Cavro Pump, 39defined, FlexDrop, 52setting parameters Cavro Pump, 42setting parameters, FlexDrop, 54
processes, executing on Multimek, 145profile, defined, 8profiles
creating Analyst GT, 27creating FlexDrop, 49creating FLIPR Tetra, 61creating for Cavro Pump, 37creating Generic RS-232, 77creating IN Cell Analyzer, 89creating KiNEDx Robot, 99
227IndexDevice Driver User Guide
creating LEADseeker, 107creating Multimek, 115creating PlateHub, 149creating PlateStak, 159creating Rake, 169creating StoreX/CytomatPLC, 189creating Symbol MiniScan BCS, 201creating Translator Robot, 209creating ViewLux, 217creating, SoftMax Pro, 179managing Analyst GT, 31managing Cavro Pump, 43managing FlexDrop, 56managing FLIPR Tetra, 73managing Generic RS-232, 83managing IN Cell Analyzer, 93managing KiNEDx Robot, 100managing LEADseeker, 110managing Multimek, 117managing PlateHub, 152managing PlateStak, 165managing Rake, 172managing StoreX/CytomatPLC, 193managing Symbol MiniScan BCS, 204managing ViewLux, 221managing, SoftMax Pro, 181managing, Translator Robot, 211setting attributes Cavro Pump, 37settings FLIPR Tetra, 61settings, SoftMax Pro, 179settings, Translator Robot, 209
protocol files, updating for StoreX, 186pump action, Cavro Pump, 45Purge task
defined, FlexDrop, 52setting parameters, FlexDrop, 54
Push-down overextend, KiNEDx Robot, 102
RRake
about tasks, 171configuring workflow, 168creating profiles, 169Dispense task defined, 171managing profiles, 172setting Dispense task parameters, 171using diagnostics, 172
Read taskdefined, LEADseeker, 109defined, ViewLux, 219setting parameters, LEADseeker, 109setting parameters, ViewLux, 220
receive mode, Generic RS-232, 80
relative motion, Multimek, 142release a new plate, PlateStak, 162Remove Tip Tray task
defined, Multimek, 120setting parameters, Multimek, 120
Robo Cylinder Translator Robot. see Translator Ro-bot
Run Macro taskdefined, Multimek, 120setting parameters, Multimek, 134
Run Protocol (IN Cell Analyzer) tasksetting parameters, IN Cell Analyzer, 91
Run protocol taskdefined, FlexDrop, 52
Run tasksetting parameters, FlexDrop, 55
SSave All command, 15scripts, writing, 23Set Lamp State task
defined, Analyst GT, 29setting parameters, Analyst GT, 29
Set reagent taskdefined, FlexDrop, 51setting parameters, FlexDrop, 52
simple move, KiNEDx Robot, 101SoftMax Pro
choosing profile settings, 179configuring workflow, 178creating profiles, 179managing profiles, 181setting task parameters, 180task defined, 180using diagnostics, 181
software components, 5speed code, Cavro Pump, 44speed definitions, PlateHub, 149stop bits, Generic RS-232, 77stop, Cavro Pump, 44store up to, PlateStak, 162StoreX
creating teachpoints, 197Incubate at plate storage device task defined,
192Load task defined, 192setting Incubate at plate storage device task
parameters, 151setting Load task parameters, 151setting Unload task parameters, 151tasks defined, 151Unload task defined, 192updating old device files, 186
IndexDevice Driver User Guide
228
updating old protocol files, 187see also StoreX/CytomatPLC
StoreX/CytomatPLCabout tasks, 192configuring workflow, 188creating profiles, 189managing profiles, 193using diagnostics, 193
Sub Process taskabout, 20adding, 20
subsystem status, viewing FLIPR Tetra, 72Symbol MiniScan BCS
about tasks, 202Bar Code Scan task defined, 202configuring workflow, 200creating profiles, 201managing profiles, 204scanning a bar code, 205setting Bar Code Scan task parameters, 203using diagnostics, 204
syringe liquid volume, Cavro Pump, 44
Ttask parameters
Cavro Pump, 40, 42task parameters, setting
Analyst GT, 29Cavro Pump, 40, 41, 42Change Instance parameters, 66Downstacking, PlateStak, 161FlexDrop, 51IN Cell Analyzer, 91Incubate at plate storage device, 151LEADseeker, 108Load, 151Load and Unload FLIPR Tetra, 67Loop, 68Rake, 171Receive, Generic RS-232, 79Restacking, PlateStak, 162Run Protocol, FLIPR Tetra, 69Send and Receive, Generic RS-232, 81Send, Generic RS-232, 79SoftMax Pro, 180StoreX/CytomatPLC, 192Symbol MiniScan BCS, 202Unload, 151Upstacking, PlateStak, 161ViewLux, 219Wait for Location, Generic RS-232, 82
tasksabout Analyst GT, 29
about FlexDrop, 51about FLIPR Tetra, 64about IN Cell Analyzer, 91about LEADseeker, 108about Multimek, 119, 121about Rake, 171about StoreX/CytomatPLC, 192about Symbol MiniScan BCS, 202about ViewLux, 219Aspirate (simple), Multimek defined, 122Change Instance, Multimek, 119Deliver Tip Tray defined, 120Dispense (simple), Multimek defined, 122Dispense, Multimek defined, 120Empty Tips (simple), Multimek defined, 122Empty Tips defined, Multimek, 120Generics RS-232 defined, 78Load and Unload defined, FLIPR Tetra, 67Load, Unload, and Incubate at plate storage
device, defined, 151Loop task defined, 68Loop task, Multimek defined, 120Mix, Multimek defined, 120Move to Plate/Frame, Multimek defined, 122Move X-Y Axes, Multimek defined, 122Move Z Axis (absolute), Multimek defined,
122Move Z Axis (relative), Multimek defined, 122PlateStak defined, 161Remove Tip Tray, Multimek task defined, 120Run Macro, Multimek, 120Run Protocol defined, 69setting parameters for Cavro Pump, 39SoftMax Pro defined, 180Sub Process task defined, 120Wait for Location, 81
Teach, Translator Robot, 213teachpoints
creating Cytomat PLC, 197creating StoreX, 197creating, Translator Robot, 212modifying, Translator Robot, 213
teachpoints, creating KiNEDx Robot, 103teachpoints, modifying Multimek, 143teachpoints, setting for devices, 17Tecan Systems Cavro Pump. see Cavro PumpTransfer task
defined, Cavro Pump, 39setting parameters Cavro Pump, 42
Translator Robotchoosing profile settings, 209configuring workflow, 208creating profiles, 209
229IndexDevice Driver User Guide
creating teachpoints, 212managing profiles, 211modifying teachpoints, 213using diagnostics, 211
UUnload device task
defined, Cytomat PLC, 192Unload task
defined, 151defined, StoreX, 192setting parameters, 151
VVelocity11 PlateHub. see PlateHubViewLux
about tasks, 219configuring workflow, 216creating profiles, 217managing profiles, 221Read task defined, 219setting Read task parameters, 220using diagnostics, 221
WWait for Location task, about, 81wait for number of bytes, Generic RS-232, 80wait for timeout, Generic RS-232, 80workflow for configuring
Analyst GT, 26Cavro Pump, 36FlexDrop, 48FLIPR Tetra, 60Generic RS-232, 76IN Cell Analyzer, 88KiNEDx Robot, 98LEADseeker, 106Multimek, 114PlateHub, 148PlateStak, 158Rake, 168SoftMax Pro, 178StoreX/CytomatPLC, 188Symbol MiniScan BCS, 200Translator Robot, 208ViewLux, 216
IndexDevice Driver User Guide
230