IBM Anyplace Kiosk Omni Scanner Configuration Guide

Version: 3.9 July 24, 2006

TERMS & CONDITIONS: AS A PRECONDITION TO DOWNLOADING AND USE OF THE FOLLOWING DOCUMENTATION, PROGRAM CODE, SAMPLES, UPDATES, AND FIXES ("CODE"), YOU MUST AGREE THAT (1) THE CODE IS SUBJECT TO THE TERMS OF THE LICENSE AGREEMENT WHICH ACCOMPANIED, OR IS CONTAINED IN, THE PROGRAM FOR WHICH YOU ARE OBTAINING THE CODE AND (2) YOU READ AND ACCEPTED THOSE TERMS WHEN YOU OBTAINED THE PROGRAM. YOU ARE NOT AUTHORIZED TO INSTALL OR USE THE CODE, EXCEPT AS PART OF A PROGRAM FOR WHICH YOU HAVE A VALID PROOF OF ENTITLEMENT. SUBJECT TO ANY STATUTORY WARRANTIES THAT CANNOT BY LAW BE EXCLUDED, IBM MAKES NO WARRANTIES OR CONDITIONS EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OR CONDITIONS OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT, REGARDING THE CODE OR TECHNICAL SUPPORT PROVIDED IN CONNECTION WITH THE CODE, IF ANY.

Table of Contents
Section 1 Document Objectives..............................................................................................................................................3 Section 2 Scanner Introduction .............................................................................................................................................4 Three Scan Pattern Options.....................................................................................................................................................5 Installing the Scanner & MSR Drivers................................................................................................................................6 Default Scanner Configuration Settings..................................................................................................................................7 Section 3 Using IBM UPOS Package ....................................................................................................................................9 Scanner Initialization ..............................................................................................................................................................9 Testing Basic Functionality ....................................................................................................................................................9 UPOS Installation Procedure ................................................................................................................................................10 Customizing the JPOS.XML.................................................................................................................................................12 Section 4 Using Direct Communication via COM Port .....................................................................................................14 Scanner Initialization ............................................................................................................................................................14 Testing Basic Functionality ..................................................................................................................................................14 Available Programming References .....................................................................................................................................14 Section 5 Keyboard Wedge Mode .......................................................................................................................................15 Scanner Initialization & Testing ...........................................................................................................................................15 Enabling Serial Keys.............................................................................................................................................................15 Disabling Serial Keys............................................................................................................................................................15 Section 6 Frequently Asked Questions................................................................................................................................16
Does the scanner support 2D / PDF / RSS barcode formats? .............................................................................................................................16 The system and/or application are not recognizing the Omni scanner. ................................................................................................................16 How do I know that the hardware and drivers are working properly? .................................................................................................................16 How can the scanner send data to a web based application? ..............................................................................................................................16 What support is provided under Linux for this scanner?....................................................................................................................................16 Where can I find additional programming information and supported parameter barcodes for this scanner? ..........................................................16

Section 7 Troubleshooting & Support Options ..................................................................................................................17 Appendix A: Parameter Barcodes.........................................................................................................................................18

Section 1 Document Objectives

This document describes how to configure the IBM Anyplace Kiosk (4836, 4838) integrated omni scanner through various methods. The following communication methods will be discussed: IBM Unified Point Of Sale (UPOS) (v1.90 or higher required) Direct serial communication Keyboard Wedge

Section 2 Scanner Introduction

The Omni Scanner is an RS232 device which uses a USB to Serial virtual COM port architecture. The scanner can be accessed through a standard RS-232 COM port. The default COM port used for the scanner is COM4. This is accomplished through a device installed on the scanner working in conjunction with the Scanner & MSR Drivers which must be installed in order to communicate with the scanner using any of the method described in this document. Since the scanner is on a standard RS-232 COM device in Windows, standard RS-232 communication functions can be used to configure and read data from the scanner. This scanner is optimized for aggressive reading on 1-D symbols, and also features a Smart Raster scan pattern for 2-D symbols including PDF417. For reference purposes only, the engine used in the Omni Scanner is the Symbol SE3223. Additional information is available from Symbol (http://www.symbol.com). Symbol does not provide any support for, nor warrant in any way, the Omni Scanner.

Three Scan Pattern Options

The Integrated Omni Scanner has the capability of 3 different scan patterns 1-D linear, 2-D raster, and omnidirectional "Cyclone". This allows you to select the best scan pattern for your particular application. Scan Pattern Definitions Omnidirectional Scan Pattern The scan pattern is a high speed rotating omnidirectional scan pattern that provides very aggressive performance on 1-D bar codes because there are virtually no "holes" in the pattern. This ensures fast throughput at the point of activity and the ability to read 1-D symbols in 360 of rotation, eliminating the need to orient the bar code in the field of View. Smart Raster Scan Pattern Creates a single line which opens vertically to read PDF417 symbols using the Smart raster feature. This feature auto detects the type of bar code being scanned and adjusts its pattern accordingly. This provides optimal performance on 1-D, PDF417, RSS, and Composite codes. Always Raster Pattern Creates an adjustable raster pattern of a programmed height. This pattern is best for PDF417 environments. Typical Barcode Types 1D UPC-A Omnidirectional Scan Pattern 1D Code 39 Omnidirectional Scan Pattern 2D PDF-417 Smart Raster Scan Pattern or Always Raster Pattern

Installing the Scanner & MSR Drivers

The installation process will prompt you with a message regarding Digital Signatures, for each of these messages, simply click YES. During the installation, the following messages should appear:

When the Scanner & MSR Drivers are properly installed, you should see the following items in Device Manager:

Default Scanner Configuration Settings

Listed below are the default settings for the scanner. These settings are the same on a new system, and after scanning the Reset Factory Defaults parameter barcode. Parameter
Beeper Volume Beeper Tone Laser On Time Trigger Mode Scanning Mode Aiming Mode Beep After Good Decode Transmit .No Read. Message Parameter Scanning Bi-directional Redundancy UPC-A UPC-E UPC-E1 EAN-8 EAN-13 Bookland EAN UPC/EAN Coupon Code Decode UPC/EAN Supplementals Transmit UPC-A Check Digit Transmit UPC-E Check Digit Transmit UPC-E1 Check Digit UPC-A Preamble UPC-E Preamble UPC-E1 Preamble Convert UPC-E to A Convert UPC-E1 to A EAN-8 Zero Extend Linear UPC/EAN Decode Code 128 UCC/EAN-128 Code 39 Trioptic Code 39 Transmit Code 39 Check Digit Code 93 Code 11 Interleaved 2 of 5 Discrete 2 of 5 Codabar MSI Plessey PDF417 MicroPDF417 MicroPDF Performance Code 128 Emulation RSS-14 RSS-Limited RSS-Expanded

Parameter Number Operating Modes

8Ch 91h 88h 8Ah 8Dh F0h 7Eh 38h 5Eh ECh 43h

Default
High Volume High Frequency 5.0 sec Level Smart Raster Disabled Enable Disable Enable Disable Enable Enable Disable Enable Enable Disable Disable Ignore Enable Enable Enable System Character System Character System Character Disable Disable Disable Disable Enable Enable Enable Disable Disable Disable Disable Disable Disable Disable Disable Disable Disable Standard Disable Disable Disable Disable

Supported Symbologies
01h 02h 0Ch 04h 03h 53h 55h 10h 28h 29h 2Ah 22h 23h 24h 25h 26h 27h 44h 08h 0Eh 00h 0Dh 2Bh 09h 0Ah 06h 05h 07h 0Bh 0Fh E3h F0h 65h 7Bh F0h 52h F0h 53h F0h 54h

Communication Settings
Scan Data Transmission Format Baud Rate Parity Check Parity Software Handshaking Host RTS Line State Decode Data Packet Format Stop Bit Select Intercharacter Delay EBh 9Ch 9Eh 97h 9Fh 9Ah EEh 9Dh 6Eh Data as is 9600 None Enable ACK/NAK Low Unpacketed 1 0

NOTE: Host RTS Line State must be changed to HIGH for certain applications, as directed in the steps below. Do not set RTS Line State to HIGH unless directed to do so in this document. The parameter barcode to make this change is included in Appendix A.

Section 3 Using IBM UPOS Package

This section describes the steps necessary to properly configure the scanner, install the IBM Unified Point of Sale (UPOS) driver package, and test for proper functionality. For more information on POS Driver standards visit the Monroe Consulting Services website at http://www.monroecs.com/posstandards.htm. NOTE: IBM UPOS v1.90 or higher is required to support the OMNI Scanner.

Scanner Initialization
You must first enable the scanner for serial based communications. To do so, scan all of the BASE barcodes and the RTS Line State = LOW barcode provided in Appendix A. Additional parameters will be configured as needed automatically by the UPOS installation package. Any specific configuration changes which your application requires can be setup within the JPOS.XML file (see below).

Testing Basic Functionality

Before proceeding, we recommend that you first test the scanner to ensure that the hardware and drivers are working properly. The simplest test for this is to use HyperTerminal to display the scanned data upon reading a barcode. 1. Ensure that the Scanner and MSR Drivers are properly installed. Refer to the Scanner Introduction section above. 2. Initialize the scanner using the steps above. 3. Launch HyperTerminal and create a new connection using COM4. Configure this connection to use 9600, 8, N, 1, XON/XOFF. 4. When you scan a bar code the scanner should beep for a good decode and the data should appear in the terminal window. Note that unless you configure the scanner otherwise, with additional Parameter Barcodes, the scanner will transmit all digits scanned including any prefixes and/or check digits. A full listing of the parameter barcodes is available in the Integration Reference Guide.

UPOS Installation Procedure

The steps listed below are a brief overview of the procedures to setup basic OPOS and/or JavaPOS support. Please refer to the UPOS Users Guide for detailed installation and usage instructions. The latest publications are available on our IBM Retail Store Solutions Support site at: http://www-1.ibm.com/support/search.wss?rs=219&q=PUBUPOS Current Package Levels As of the date on this document, the current releases of the packages required for this installation are: IBM UPOS Package v1.90 (or higher) OPOS Common Controls v1.9.000 (or higher) The current level of UPOS is based on the Point of Sale device standards available from the Monroe Consulting Services (MCS) website (http://www.monroecs.com/unifiedpos.htm). Additional information and downloads are available directly from this site. 1. If you already have the OPOS Common Controls version 1.9.000 or higher installed, continue to the next step. Otherwise, remove any previous versions then download and install the latest OPOS Common Controls (CCOs) from the MCS website (http://www.monroecs.com/oposccos_current.htm). The CCOs are packaged in both ZIP and WISE install versions. We recommend that you use the WISE install method. Download and install the latest IBM UPOS Package from the IBM Support website http://www.ibm.com/solutions/retail/store/support/html/driverss.html. The IBM UPOS package supports communication with the Line Scanner, Omni Scanner, MSR and Presence Sensor. Install the UPOS package following the steps provided in the UPOS documentation. NOTE: It is critical that you select the proper options on the Custom Install panel (see below). You must first select either JavaPOS or OPOS support. Then select Anyplace Kiosk 4836/4838. Finally, you must install the Java JRE/JCOMM components. These components are included in the installation package, but will not be installed unless you check this box. JavaPOS and OPOS will not function if a JRE/JCOMM has not been installed.

2. 3.

4.

Installation of the IBM UPOS package also requires the Microsoft .NET Framework. The Microsoft .NET Framework installation source is not included with the UPOS distribution files. This can be downloaded directly from the Microsoft website.

5.

6. 7.

After installation of the Microsoft .NET Framework, the system will no longer be configured to automatically logon. If you are using this feature, and would like to re-enable it, use the following procedure: Run the following command: CONTROL USERPASSWORDS2 Select the user you want to logon automatically Uncheck Users must enter a Username and password. Click OK Enter the password (blank for none) Click OK Run the OPOS Configuration Utility to configure the peripheral(s) you are using. Click on XML File Location Output Location.

8.

Browse to and select c:\pos\ibmjpos\jpos.xml.

9. Click Save 10. Select the SurePOS 300/500/600, Kiosk tab 11. Locate the device you wish to configure in the list. You may need to expand the Description column to see the full description. 12. Each device to be used must be configured. Only use/configure those devices which indicate in the description that they are specifically for the IBM Anyplace, 4836 or 4838 systems.

13. The recommended device configurations are shown below:

NOTE: Device Name can be any value you select, however it MUST match exactly with the Device Name used in your application. It is case sensitive as well. 14. Once the packages have been installed and the devices configured, you can test the installation simply using our online OPOS Checkup. This is a set of online tests which use standard HTML, VBScript and JavaScript to communicate with the devices, using UPOS calls. In addition to being a very good test resource, the source code from these tests can assist you with understanding the basic methods of using OPOS from web applications. The OPOS Checkup is available at http://www.ibm.com/solutions/retail/store/support/html/oposcheckup.html

Customizing the JPOS.XML

Additional scanner configuration settings can be made by manually editing the jpos.xml file and inserting the required values. "Scanner Parameter Barcodes Enabled" This setting is recommended for diagnostic purposes only. When used on a deployed Kiosk, we recommend that these values be set to "false". With these set to "true", the Parameter barcodes (i.e. "Set all Defaults") will be permitted to modify the operating of the scanner directly. With these set to "false", the scanner will ignore any Parameter barcodes. changes are required, they can be made using the JPOS.XML. If configuration

For example: <prop name="enableProgrammingViaBarcodes" type="Boolean" value="true"/> For more information on these and other properties available under UPOS refer to the UPOS publications on our support site.

Below is an example JPOS.XML file, based on default provided with the UPOS installation.
<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE JposEntries PUBLIC "-//JavaPOS//DTD//EN" "jpos/res/jcl.dtd"> <JposEntries> <JposEntry logicalName="Scanner1"> <creation factoryClass="com.ibm.jpos.services.IBMJposServiceInstanceFactory" serviceClass="com.ibm.jpos.services.IntegratedOmniScanner"/> <vendor name="IBM" url="http://www.ibm.com"/> <jpos category="Scanner" version="1.9"/> <product description="IBM JavaPOS(TM) RS232 Omni Scanner Service for IBM Anyplace Kiosk" name="IBM JavaPOS for Linux/Windows Version 1.9" url="http://www.pc.ibm.com/store/"/> <prop name="deviceBus" type="String" value="RS232"/> <prop name="baudRate" type="String" value="9600"/> <prop name="portName" type="String" value="COM4"/> <prop name="abstractionClass" type="String" value="com.ibm.jpos.services.IntegratedOmniScanner"/> <prop name="impClass" type="String" value="com.ibm.jpos.services.sdi.ScannerServiceImp"/> <prop name="com.ibm.posj.bus.rs232.scannerId" type="String" value="OmniScanner"/> <prop name="com.ibm.posj.bus.deviceNumber" type="String" value="0"/> <prop name="setEnableUPCAE_EANJAN813" type="Boolean" value="true"/> <prop name="setSupplementals" type="Boolean" value="true"/> <prop name="setEnableCODE39" type="Boolean" value="true"/> <prop name="setEnableCode128" type="Boolean" value="true"/> <prop name="setEnableCodabar" type="Boolean" value="true"/> <prop name="setEnableCode93" type="Boolean" value="true"/> <prop name="setEnableRSS14" type="Boolean" value="true"/> <prop name="setEnablePDF417" type="Boolean" value="false"/> <prop name="setEnableStandard2of5" type="Boolean" value="true"/> <prop name="setSTFLengths" type="Boolean" value="true"/> <prop name="setSTFLength1" type="Byte" value="8"/> <prop name="setSTFLength2" type="Byte" value="100"/> <prop name="setEnableInterleaved2of5" type="Boolean" value="true"/> <prop name="setITFLengths" type="Boolean" value="true"/> <prop name="setITFLength1" type="Byte" value="8"/> <prop name="setITFLength2" type="Byte" value="100"/> <prop name="setBeeperFrequency" type="Byte" value="0"/> <prop name="enableProgrammingViaBarcodes" type="Boolean" value="false"/> </JposEntry> </JposEntries>

Section 4 Using Direct Communication via COM Port

This section describes the steps necessary to properly configure the scanner for direct communication via the COM Port (COM4), and test for proper functionality.

Scanner Initialization
To communicate with the scanner directly via the COM port, you must first enable the scanner for this method. To do so, scan all of the BASE barcodes, and the RTS Line State = High barcode provided in Appendix A.

Testing Basic Functionality

Before proceeding to coding your application, we recommend that you first test the scanner to ensure that the hardware and drivers are working properly. The simplest test for this is to use HyperTerminal to display the scanned data upon reading a barcode. 1. 2. 3. 4. Ensure that the Scanner and MSR Drivers are properly installed. Refer to the Scanner Introduction section above. Initialize the scanner using the steps above. Launch HyperTerminal and create a new connection using COM4. Configure this connection to use 9600, 8, N, 1, XON/XOFF. When you scan a bar code the scanner should beep for a good decode and the data should appear in the terminal window. Note that unless you configure the scanner otherwise, with additional Parameter Barcodes, the scanner will transmit all digits scanned including any prefixes and/or check digits. A full listing of the parameter barcodes are available in the Integration Reference Guide

Available Programming References

The Symbol Simple Serial Interface (SSI) protocol is used for communication with the Scanner. The SSI interface uses nonstandard handshaking that requires that RTS be inactive before the scanner will send data. The SSI Software Development Kit (SDK) for this protocol can be downloaded from the Symbol web site (www.symbol.com). The development kit is owned, licensed and supported by Symbol Technologies.

Section 5 Keyboard Wedge Mode

The IBM Anyplace Kiosk scanner(s) are not designed to operate as a keyboard wedge device. However, there are some third party applications which allow you to configure serial devices to send data through the keyboard buffer. Microsoft Windows XP has a built in feature called Serial Keys which is one such application. Microsoft Windows Embedded for Point of Service (WEPOS) does not include this feature. Use of third party applications, including Serial Keys is not supported by IBM Retail Store Solutions. The information below is provided for reference only.

Scanner Initialization & Testing

Configure and test the scanner for Direct I/O use following the steps provided in Section 4 above.

Enabling Serial Keys

The Serial Keys feature is configurable through Accessibility Options in Control Panel.

Ensure that the Use Serial Keys checkbox is checked and that the correct COM port is selected by clicking the Settings button. To save the settings between reboots, check both checkboxes under Administrative Options.

Disabling Serial Keys

When disabling the Serial Keys functionality, removing the check for Use Serial Keys under Accessibility Options is not sufficient. Even when this check is removed, the Serial Keys service (SKEYS.EXE) will still be running and will interfere with other applications ability to access the COM port configured in Serial Keys Settings. If not using the Serial Keys feature, we recommend that you set the Serial Keys service to Disabled under Windows Services. This service will not be listed under Windows Services until it has been configured and enabled the first time. One enabled, the Service is persistent. NOTE: The Serial Keys feature will only monitor a single COM port. If multiple COM ports are required, there are many third party solutions available (not supported).

Section 6 Frequently Asked Questions

The list below includes some of the most frequently asked questions regarding the use of the scanner. Additional information is available on our IBM Retail Store Solutions Knowledge Base, online at (http://www.ibm.com/solutions/retail/store/support). Does the scanner support 2D / PDF / RSS barcode formats? This scanner is optimized for aggressive reading on 1-D symbols, and also features a Smart Raster scan pattern for 2-D symbols including PDF417.

The system and/or application are not recognizing the Omni scanner. The Anyplace Kiosk must be using the latest level of Scanner & MSR Drivers. Please ensure you are using v1.2.11.04 or higher to support either the Linear or Omni scanners. Ensure that the scanner is connected securely. The scanner should automatically power on when the system is turned on. How do I know that the hardware and drivers are working properly? Please refer to the Scanner Introduction section in this document.

How can the scanner send data to a web based application? This depends primarily on the application. Any of the communication methods discussed in this document could be used to send data to a web application.

What support is provided under Linux for this scanner? The Anyplace Kiosk supports the IBM Retail Environment for SuSE Linux (IRES). Support for the Integrated Omni Scanner under IRES will be available at a later date.

Where can I find additional programming information and supported parameter barcodes for this scanner? The Omni scanner is uses the Symbol SE-3223 OEM scan engine. Additional information for this scanner can be found on the Symbol website. Parameter barcodes can be found in the Integration Reference Guide for the MiniScan MS-XX04. (The MS-XX04 uses the same SE-3223 scan engine)

Section 7 Troubleshooting & Support Options

In addition to the information provided in this documentation, we also have drivers, utilities, etc available on our support site. If you would like to contact us for assistance, or need additional information, please refer to our online support page at: http://www.ibm.com/solutions/retail/store/support

Appendix A: Parameter Barcodes

Below are the most commonly used parameter barcodes (BASE Barcodes) as well as those barcodes (RTS Line State Barcodes) required for special communication methods as described earlier in this document.

BASE Barcodes

RTS Line State Barcodes