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.
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 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ii Table of Contents Microscan MS-3 Laser Scanner Device Driver User Guide
Chapter 1: Introduction Microscan MS-3 Laser Scanner Device Driver User Guide Introduction 1 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.
2 Chapter 1: Introduction Microscan MS-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.
Chapter 1: Introduction Microscan MS-3 Laser Scanner Device Driver 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.
4 Chapter 1: Introduction Microscan MS-3 Laser Scanner Device Driver User Guide Navigation pane PDF user guides Content pane Navigation buttons 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.
Chapter 1: Introduction Microscan MS-3 Laser Scanner Device Driver 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.
6 Chapter 1: Introduction Microscan MS-3 Laser Scanner Device Driver User Guide VWorks or BenchWorks compatibility 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.
Chapter 1: Introduction Microscan MS-3 Laser Scanner Device Driver 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...
8 Chapter 1: Introduction Microscan MS-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.
Chapter 1: Introduction Microscan MS-3 Laser Scanner Device Driver User Guide Installing device drivers About this topic Devices are integrated into VWorks or BenchWorks software 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.
10 Chapter 1: Introduction Microscan MS-3 Laser Scanner Device Driver User Guide Adding devices About this topic To configure your lab automation system to use a device, you need to add it to a device file in VWorks or BenchWorks software. The VWorks or BenchWorks software device manager uses the information in the device file to communicate and operate the device within the automation system.
Chapter 1: Introduction Microscan MS-3 Laser Scanner Device Driver User Guide 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. Related topics For information about... See...
12 Chapter 1: Introduction Microscan MS-3 Laser Scanner Device Driver User Guide Related topics For information about... See... Opening diagnostics “Opening diagnostics” on page 12 Adding a device to the device manager “Adding devices” on page 10 Device drivers “About device drivers” on page 7 The definition of devices “About devices” on page 6 Opening diagnostics About this topic Every device has diagnostics software to assist you with troubleshooting and setting up the device.
Chapter 1: Introduction Microscan MS-3 Laser Scanner Device Driver User Guide 2. In the Diagnostics window, select thedevice. Expand the general name of the device, if necessary. 3. Click Device diagnostics. The device’s diagnostics dialog box opens. Procedure 2 If you are using VWorks4 software To open Diagnostics: 1. Click the Device File tab. 2. Select the device from the Devices toolbar. Expand the general name of the device, if necessary. 3.
14 Chapter 1: Introduction Microscan MS-3 Laser Scanner Device Driver User Guide 3. Click Device diagnostics located at the bottom of the Device List toolbar. The device’s diagnostics dialog box opens. Related topics For information about... See...
Chapter 1: Introduction Microscan MS-3 Laser Scanner Device Driver User Guide 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 software to identify each device on the network.
16 Chapter 1: Introduction Microscan MS-3 Laser Scanner Device Driver User Guide Setting the properties for a device About this topic The device properties provide VWorks or BenchWorks software 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.
Chapter 1: Introduction Microscan MS-3 Laser Scanner Device Driver User Guide 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.
18 Chapter 1: Introduction Microscan MS-3 Laser Scanner Device Driver User Guide 3. Some software device drivers only. Set the Approach height and Allowed/prohibited labware. Follow the procedure in “Setting general properties” on page 16. 4. Set the Barcode Readers location. Follow the procedure in “Setting barcode location” on page 17. 5. Assign the Labware used by the location by selecting the correct labware type from the list. 6.
Chapter 1: Introduction Microscan MS-3 Laser Scanner Device Driver User Guide Adding and linking 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 software.
20 Chapter 1: Introduction Microscan MS-3 Laser Scanner Device Driver User Guide 3. If there is only one sub-process and you need to create a second one, click Add New. Associating the subprocess 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.
Chapter 1: Introduction Microscan MS-3 Laser Scanner Device Driver User Guide Related topics For information about... See...
22 Chapter 1: Introduction Microscan MS-3 Laser Scanner Device Driver User Guide For more information about using JavaScript, refer to the VWorks Version 3 Automation Control User Guide or the BenchWorks Automation Control User Guide. Related topics For information about... See...
Chapter 1: Introduction Microscan MS-3 Laser Scanner Device Driver User Guide The exact name of the file is specific to the device. For example, the RVSI VR4000 device driver creates a file with the name vialreaderresults.txt. This file can only store data for one read, which means that the set of data for each read overwrites the last set in the file. To avoid this problem you must set up an output file naming convention.
24 Chapter 1: Introduction Microscan MS-3 Laser Scanner Device Driver User Guide Overriding output file names with tasks You can override the default output file name that is set in the profile using the Output filename property of the Read task parameters. This allows you to use different output file names for every task. The suffix used for the file name that you set in the task parameters is taken from the suffix specified in the device diagnostics profile.
Chapter 1: Introduction Microscan MS-3 Laser Scanner Device Driver User Guide About device initialization About this topic When working in device diagnostics software, you are often required to initialize the device. This topic explains why device initialization is necessary. Opening communications Initializing a device opens communications with it.
26 Chapter 1: Introduction Microscan MS-3 Laser Scanner Device Driver User Guide
Chapter 2: Microscan MS-3 Laser Scanner Microscan MS-3 Laser Scanner Device Driver User Guide Microscan MS-3 Laser Scanner 2 The Microscan MS-3 Laser is a barcode scanner that can be configured to work in lab automation systems running VWorks or BenchWorks software.
28 Chapter 2: Microscan MS-3 Laser Scanner Microscan MS-3 Laser Scanner Device Driver User Guide Workflow for configuring the Microscan MS-3 Laser About this topic This topic presents the workflow for configuring the Microscan MS-3 Laser device driver. Read this topic if you are an administrator responsible for setting up devices in VWorks or BenchWorks software. Before you start Before you can configure the Microscan MS-3 Laser device driver, you must have installed it.
Chapter 2: Microscan MS-3 Laser Scanner Microscan MS-3 Laser Scanner Device Driver User Guide Creating a Microscan MS-3 Laser profile About this topic This topic describes how to create a profile for the Microscan MS-3 Laser. Read this topic if you are an administrator responsible for setting up devices in VWorks or BenchWorks software. Before you start Before you create a profile, you need to have installed the device driver and added the Microscan MS-3 Laser to the device manager.
30 Chapter 2: Microscan MS-3 Laser Scanner Microscan MS-3 Laser Scanner Device Driver User Guide Related topics For information about... See...
Chapter 2: Microscan MS-3 Laser Scanner Microscan MS-3 Laser Scanner Device Driver User Guide This task is available in the protocol editor. Setting the Microscan MS-3 Laser task parameters To set the Scan bar code task parameters: 1. Add the Scan bar code task to the protocol process. 2. In the Protocol Task Parameters toolbar, click the Task Settings tab. 3. Select the Microscan MS-3 Laser you want to use from the left side and click Add. The device name moves to the right. 4.
32 Chapter 2: Microscan MS-3 Laser Scanner Microscan MS-3 Laser Scanner Device Driver User Guide Operating the Microscan MS-3 Laser with diagnostics About this topic This topic describes how to: ❑ Initialize the Microscan MS-3 Laser ❑ Scan a barcode Read this topic if you are an operator who wants to troubleshoot or operate the Microscan MS-3 Laser using direct commands.
Chapter 2: Microscan MS-3 Laser Scanner Microscan MS-3 Laser Scanner Device Driver User Guide 3. Click Scan. The decoded barcode appears in the Result box and results are saved in the protocol log. 4. Click Calibrate to optimize the Microscan MS-3 Laser scanner settings. Note: During the calibration process, the scanner attempts various settings to determine the optimum decode rate for the given conditions. Related topics For more information about... See...
34 Chapter 2: Microscan MS-3 Laser Scanner Microscan MS-3 Laser Scanner Device Driver User Guide 3. Select a profile from the Profile name list. 4. Perform the management task. Management tasks include the following: Updating the profile Copying a profile Renaming a profile Deleting a profile Saving changes to a profile Note: Click Update this profile to save edits. Related topics For more information about... See...
