Velocity Micro MS-3 User Manual

Microscan MS-3 Laser Scanner
Device Driver User Guide
July 2007
VWorks3 and BenchWorks
Copyright 2007 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, VCode, 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.
Velocity11 3565 Haven Avenue Menlo Park, CA 94025 USA
Table of Contents
Microscan MS-3 Laser Scanner Device Driver User Guide

Contents

Chapter 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Who should read this guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
About Velocity11 user guides . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
What this guide covers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
About devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
About device drivers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Installing device drivers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Adding devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
About diagnostics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Opening diagnostics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
About profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Setting the properties for a device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Adding and linking Sub Process tasks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Using JavaScript to set task parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
About reader output files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
About device initialization. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
i
Chapter 2. Microscan MS-3 Laser Scanner. . . . . . . . . . . . . . 27
Workflow for configuring the Microscan MS-3 Laser . . . . . . . . . . . . . . . . . . . . . . . . 28
Creating a Microscan MS-3 Laser profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Setting Microscan MS-3 Laser task parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Operating the Microscan MS-3 Laser with diagnostics . . . . . . . . . . . . . . . . . . . . . . 32
Managing Microscan MS-3 Laser profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Table of Contents
ii
Microscan M S-3 Laser Scanner Device Driver User Guide

Introduction

This 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 software to allow them to control a specific device.
Before reading this guide, you should be familiar with the VWorks or BenchWorks software user interface. Information about using VWorks or BenchWorks software can be found in the VWorks Version 3 Automation Control User Guide or BenchWorks Automation Control 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 devices that use VWorks or BenchWorks software.
This chapter contains the following topics:
Chapter 1: Introduction
Microscan MS-3 Laser Scanner Device Dr iver User Guide
1
1
“Who should read this guide” on page 2
“About Velocity11 user guides” on page 3
“What this guide covers” on page 5
“About devices” on page 6
“About device drivers” on page 7
“Installing device drivers” on page 9
“A dd i ng d ev i ce s ” o n pa g e 10
“About diagnostics” on page 11
“Opening diagnostics” on page 12
“About profiles” on page 15
“Setting the properties for a device” on page 16
“Adding and linking Sub Process tasks” on page 19
“Using JavaScript to set task parameters” on page 21
“About reader output files” on page 22
“About device initialization” on page 25
2
Chapter 1: Introduction
Microscan M S-3 Laser Scanner Device Driver User Guide

Who should read this guide

Job roles This user guide is for people with the following job roles:
Job role Responsibilities
Integrator Someone who writes software and
configures hardware controlled by device drivers.
Related topics
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 might arise
Developing training materials and
standard operating procedures for operators
Operator Someone who performs the daily
production work using the device driver and solves routine problems.
Your organization may choose to create its own procedures for operators including the procedures 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
Device drivers “About device drivers” on page 7
Chapter 1: Introduction
Microscan MS-3 Laser Scanner Device Dr iver User Guide

About Velocity11 user guides

About this topic This topic describes the different formats of Velocity11 user information
and explains how to access the user information.
Formats available Velocity11 user information is provided 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.
3
Where to find user information
Online help
The online help is added to your computer with the Velocity11 lab automation system software installation.
PDF file
The PDF file of the user guide is on the software CD that is supplied with the product.
Velocity11 website
You can search the online help or download the latest version of any PDF file from the Velocity11 website at
Note: All Velocity11 user information can be searched from the website at
www.velocity11.com.
www.velocity11.com.
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.
To open the online help:
1. In the Velocity11 lab automation software, press F1. The online help window opens.
Main features
The online help window contains the following:
Navigation pane. Consists of four tabs. The Contents, Index, and
Search tabs provide different ways to locate information. The Using tab contains information about using the help system.
Content pane. Displays the online help topics.
Navigation buttons. Enables you to navigate through the pages.The
online help includes a navigation pane, content pane, and navigation buttons.
4
Chapter 1: Introduction
Microscan M S-3 Laser Scanner Device Driver User Guide
Navigation pane Content pane Navigation buttons
PDF user guides Computer requirements
To open a user guide in PDF format, you need a PDF viewer. You can download a free PDF viewer from the internet.
Printing and searching
The user guides in PDF format are mainly for printing additional copies. You can perform simple searches in the PDF file, although these searches are much slower than online help searches.
More information
For more information about using PDF documents, see the user documentation for the PDF viewer.
Related topics
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 7
Chapter 1: Introduction
Microscan MS-3 Laser Scanner Device Dr iver User Guide

What this guide covers

About this topic This topic presents 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 software can be found in the VWorks Version 3 Automation Control User Guide or the BenchWorks Automation Control User Guide.
Driver version To find version information for a driver in VWorks:
5
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 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 software
Velocity11 devices, such as the PlateLoc Sealer, VCode Microplate
Labeler, and VPrep Pipettor when used in stand-alone mode
6
Chapter 1: Introduction
Microscan M S-3 Laser Scanner Device Driver User Guide
VWorks or BenchWorks compatibility
BenchWorks versions
If you have purchased a device driver plug-in and are installing it yourself, check with the Velocity11 Technical Support to be sure your version of VWorks or BenchWorks software and the device driver plug-in are using the same version of IWorks software.
Device driver plug-ins used with BenchWorks software may not include some newer features that were specifically added for use with VWorks software and that are described in this manual.
Related topics
For information about... See...
Who this guide is for “Who should read this guide” on page 2
User documentation “About Velocity11 user guides” on
Device driver plug-ins “About device drivers” on page 7

About devices

page 3
About this topic This topic presents a definition of a Velocity11 device and the device
file.
Read this topic if you are unfamiliar with Velocity11 devices and VWorks or BenchWorks software.
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:
Ve l o c i t y 1 1 r o b o t
Human robot
PlateLoc Thermal Plate Sealer
Labcyte Echo550
Platepad
VPrep shelf
Wa st e
Device file defined The data entered into the device manager and saved as a device file
contains the configuration information for your devices.
Chapter 1: Introduction
Microscan MS-3 Laser Scanner Device Dr iver User Guide
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 topics
For information about... See...
Device diagnostics “About diagnostics” on page 11
Device profiles “About profiles” on page 15
7
Adding a device to the device manager
“Adding devices” on page 10

About device drivers

About this topic This topic describes what device drivers are and what they do.
Velocity11 device drivers enable mechanical devices or software programs to work with VWorks or BenchWorks software.
Read this topic if you are:
An administrator in charge of installing device drivers and managing
Ve l o c i t y 1 1 d ev i c es
A lab automation system integrator who writes software and
configures hardware controlled by VWorks or BenchWorks software
Device driver defined
A Velocity11 device driver enables VWorks or BenchWorks software to control and communicate with the specific type of device. Each type of device that you operate with VWorks or BenchWorks software requires a device driver.
For example, VWorks software uses the:
VPrep Pipettor device driver to communicate with the Velocity11
VPrep Pipettor device
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 software application. Other device drivers are distributed as plug-ins. All the device drivers covered in this guide are the plug-in type.
8
Chapter 1: Introduction
Microscan M S-3 Laser Scanner Device Driver User Guide
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.
There is no need to re-install the VWorks or BenchWorks software application
IWorks interface The device driver plug-ins and VWorks or BenchWorks software use
IWorks software 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 software and the
device driver must be using the same version of IWorks to work properly.
Writing your own device driver
What functions do the device drivers provide?
Related topics
If you are a lab automation system integrator who writes software and configures hardware controlled by VWorks or BenchWorks software, you can write your own driver plug-in for a new device. Contact the Velocity11 Technical Support for information about how to do this.
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.
For information about... See...
Adding a device to the device manager
Opening diagnostics “Opening diagnostics” on page 12
Installing a device driver “Installing device drivers” on page 9
Devices “About devices” on page 6
“Adding devices” on page 10
Loading...
+ 26 hidden pages