Datalogic QuickScan L QD2300 manual

Datalogic™ OPOS Service Objects User Manual[...]

Datalogic ADC, Inc. 959 Terry Street Eugene, OR 97402 USA Telephone: (541) 683-5700 Fax: (541) 345-7140 ©2008-2014 Datalogic ADC, Inc. An Unpublished Work - All rights reserved. No part of the contents of this documentation or the procedures described therein may be reproduced or transmitted in any form or by any means with out prior written permi[...]

User Manual i Table of Contents DATA LOGIC™ O POS S ERVIC E OBJECTS ........................ ..................... ..................... .................... .......... ................ ................. 1 Introduction ................................................... ........................... ................................. ... ...........[...]

Contents ii Datalogic™ OPOS Service Ob jects NOTES[...]

User Manual 1 Datalogic™ OPOS Service Objects Introduction Document Con v entions Formatting conventions are used throughout this guide to provide a consis - tent method for representing sc reen shots and command entries. CA UTI ON Keys t ro ke s: Filenames, paths, field selections , and data or keystrokes entered by the user are shown in this mo[...]

Introduction 2 Datalogic™ OPOS Service Objects Datalogic Pr oduc ts Suppor ted . Device Type Scanner Scale RS232 Std RS232 SC USB-COM OEM USB RS232 Std RS232 SC OEM USB Ta b l e To p S c a n n e r / S c a l e s Mage llan 3200     Mage llan 3300     Magellan 220 0VS    Magellan 2300HS    Magellan 800i  [...]

Insta llati on User Manual 3 Installation Running the Install Installation can be performed in either of two ways: using a standard GUI installation, or as a silent install from the Command Prompt. GUI Installation To install, please perf orm the following st eps: 1. Download the most current install file for the DATALOGIC OPOS service objects from[...]

Insta llati on 4 Datalogic™ OPOS Service Objects 2. Double-click DatalogicOPOS.msi to run the install program. 3. Follow the on-screen in structions to complete the installation. Silent Install from C ommand Pr ompt To perform a “silent install,” open a command window and cd to the direc - tory containing the DatalogicOPOS.msi file. Type the [...]

Utilit ies User Manual 5 Utilities DualT est Utility The Datalogic OPOS package contains a ut ility called DualTe st that provides customers with the ability to quickly connect and test the operation of a Datalogic scanner/scale with the Datalogic servi ce objects. Simple OPOS operations such as Open, Claim, Enable, Read Weights, bar code scanning,[...]

Utilit ies 6 Datalogic™ OPOS Service Objects 2. Open Scanner: 3. Claim:[...]

Utilit ies User Manual 7 4. Select Power Notify: 5. Enable:[...]

Utilit ies 8 Datalogic™ OPOS Service Objects 6. Click the “ DataEventEnable ” button and check the “ AutoDa - taEventEnable ” box, and scan a bar code. The bar code data and type will be displayed as shown here: 7. Unplug the Scanner from the syst em. Power Status will show the new scanner power state.[...]

Utilit ies User Manual 9 8. Plug the scanner back into the syst em. Power Status will update again with the new scanner power state. F irmwar e Update with DualT est The Datalogic OPOS Scanner Service Ob ject supports the ability to update firmware on select scanners in accord ance with the UPOS Specification (ver - sion 1.9 and above). The user’[...]

Utilit ies 10 Datalogic™ OPOS Service Objects 1. OpenFile : Locate the firmware file on your machine or network. 2. Confirm Update Firmware: Firmware files are interface and scanne r specific a nd may be obtained from Datalogic Tech Suppor t.[...]

Utilit ies User Manual 11 Firmware Update Started The Status field will update at every 1% of the upload. Depending on the scanner interface and parameters such as baud rate, the update may take from approximately 7 minutes to 40 minutes. DO NOT disconnect the interface cabl e or power cable from the scanner during the update! Update in progress, a[...]

Utilit ies 12 Datalogic™ OPOS Service Objects Firmware Update Finished NOTE that the service will stop at 99% complete until the scanner reboots and comes on line, which may take several seconds. Finalized: The scanner is now back on line and ful ly operational.[...]

Utilit ies User Manual 13 F irmwar e Update from the C ommand Line 1. Navigate to the install directory. 2. Execute the update program: CFirmwareUpdate <ScannerName> <FirmwareFileName.ext> 3. Wait until the program finishes: 4. After program exits, update is complete.[...]

Utilit ies 14 Datalogic™ OPOS Service Objects Scale with D ualT est To connect to a Scale, follow these steps after installing the OPOS package from Datalogic: 1. Select Device: 2. Open Scale:[...]

Utilit ies User Manual 15 3. Claim: 4. Enable:[...]

Utilit ies 16 Datalogic™ OPOS Service Objects 5. Read a weight:[...]

Utilit ies User Manual 17 Live W eight Display The Datalogic OPOS Scale Service Object supports the ability to provide Live Weight Display functionality in accord ance with the UPOS Specification (ver - sion 1.9 and above). The user’s applic ation may be written to take advan - tage of this capability in the service (see the UPOS specification fo[...]

Utilit ies 18 Datalogic™ OPOS Service Objects 2. Enable: (Live Weight Begins immediately / Zero Weight) 3. Underweight: An under zero condition has occurred.[...]

Utilit ies User Manual 19 4. In motion: The scale is in motion and has not stabilized. 5. Overweight: The scale’s weight capacity has been exceeded.[...]

Utilit ies 20 Datalogic™ OPOS Service Objects 6. Stable Large Weight: 7. Stable Small Weight:[...]

Registry User Manual 21 Registr y W indow s Management Instrumentation (WMI) Compatible Datalogic OPOS Service Objects prov ide WMI compatible Remote Manage - ment for certain scanners when proper ly configured. For scanners that sup - port this data gathering capability, th e Serv ice Objects must be configured via registry settings to provide sca[...]

Registry 22 Datalogic™ OPOS Service Objects Scanner Under SCANNER in the registry, there are a number of named entities: HandScanner , MagellanSC , QS6000 , and so forth. Note that some of these are duplicates that have been maint ained for legacy pur poses: f or example, “ HandScanner ” and “ USBHHScanner ” refer to the same device (a ha[...]

Registry User Manual 23 • UPCEANCheckDigitCalc – defaulted to active, the service will calcu - late the check digit for a UPC/EAN labe l if it is not present on the scan - ner interface, and append this to the data in the ScanDataLab el property. • Usage – this is the USB “usage” for the s canner device. (The USB spec defines this in he[...]

Registry 24 Datalogic™ OPOS Service Objects • RTSControl – defaulted to active. Service will set CTS line active at the host port and leave it set high. • StopBits – defaulted to 1, same caveat as for baud rate. RS232Scanner = QS6000 Common fields as above; in addition the following field is: • IncludeCR – This will add a {0x0D} to th[...]

Registry User Manual 25 There are no unique fields for this scanner, but some of the settings default to different values because of limited capabilities: • FirmwareUpdate – defaults to 0; this device cannot be updated by the service. • CheckIHSOnClaim – defaults to 0; this device does not support com - mands needed to determine scanner hea[...]

Registry 26 Datalogic™ OPOS Service Objects Scale Under the SCALE in the registry, there are five named entities. Some are redundant and have been maintained for legacy applications. The following screen shots cover the important user -configurable settings for each cate - gory of scale. MagellanSC = SCRS232Scale • CapStatusUpdate – defaulted[...]

Registry User Manual 27 • Metric – defaulted to 0. This settin g controls the type o f Weight Request sent to the scale by the serv ice; the default is English Weight Request. The user can set thi s to 1 to obtain Metric weights. CA UTI ON • ZeroValid – defaulted to Active. When active, the service will deliver a stable zero weight as a val[...]

Registry 28 Datalogic™ OPOS Service Objects TableScale = USBScale Log gin g The DLS Service Objects have the ability to log various data items to a file for reporting, troubleshooting, and monitoring. The logging level is con - trolled by registry setting s under the location: HKEY_LOCAL_MA - CHINESOFTWAREDATALOGICDL_OPOS_SERVICE . By default,[...]

Registry User Manual 29 Registr y Ser vice Pr oper ties • CompanyName: Value is the name displayed in the Service Object. This value should not be changed. • DeviceName: Value is the name displaye d in the Service Object. This value should not be changed. • LogFile: Contains the location where the log files are written. Changing this value ma[...]

Registry 30 Datalogic™ OPOS Service Objects Additional L o gging The DLS OPOS Servic e Object can also create two additional logs. A “ Stats - File ” is created every time the scanner is “ claimed ”, provided the “ CheckIHSOnClaim ” control is set to active in the scanner registry. This file holds the result of the latest “ info-hea[...]

Developers Guide User Manual 31 Dev elopers Guide OPOS service objects expor t a unifor m interface; however there may be slight differences between the same types of devices from different vendors and models. Queries of OPOS properti es reveal these differences. Below listed properties, methods, and events are DATALOGIC device specific return valu[...]

Developers G uide 32 Datalogic™ OPOS Service Objects DataCount: Returns the number of Data Events Queued. DataEventEnabled: Returns TRUE or FALSE depending on the previous SetProperty call. DeviceEnabled: Returns TRUE or FALSE depending on the previous SetProperty call. FreezeEvents: Returns TRUE or FALSE depending on the previous SetProperty cal[...]

Developers Guide User Manual 33 PhysicalDeviceDescription: Returns a descriptive string dependin g on the interface and device type. PhysicalDeviceName: Returns a descriptive string dependin g on the interface and device type. Device Specific P roperties DecodeData: Returns TRUE or FALSE depending on the previous SetProperty call. ScanData: Holds t[...]

Developers G uide 34 Datalogic™ OPOS Service Objects Scanner Methods Co m m on M e t h o d s Open: Returns OPOS_SUCCESS OPOS_E_NOSERVICE OPOS_E_NOEXIST OPOS_E_ILLEGAL Close: Returns OPOS_SUCCESS ClaimDevice: Returns OPOS_SUCCESS OPOS_E_NOSERVICE OPOS_E_ILLEGAL OPOS_E_CLAIMED This call will activate the communication with the device. DATALOGIC dev[...]

Developers Guide User Manual 35 DirectIO: (continued) OPOS_E_OFFLINE OPOS_E_ILLEGAL ReleaseDevice: Returns OPOS_SUCCESS , OPOS_E_ILLEGAL , or OPOS_E_NOTCLAIMED . This call will deactivate the communication with the device. ResetStati stics: Returns OPOS_E_ILLEGAL DATALOGIC service objects do no t support reset statistic s . RetrieveStatistics: Retu[...]

Developers G uide 36 Datalogic™ OPOS Service Objects Scanner Events Co m m on E ve nt DataEvent: This event fires when a label is forwarded from scanner. DirectIOEvent: Not supported. ErrorEvent: Not used. StatusUpdateEvent: During the Firmware Update Process th e following Status Update Events will be delivered: OPOS_SUE_UF_PROGRESS OPOS_SUE_UF_[...]

Developers Guide User Manual 37 CapPowerReporting: Returns OPOS_PR_STANDARD . CapStatisticsReporting: Returns FALSE . CapUpdateStatistics: Returns FALSE . CapUpdateFirmware: Returns FALSE . CheckHealthText: Internal HCheck : not supported, will return OPOS_E_ILLEGAL . External HCheck : not supported. Interactive HCheck : not supported. Claimed: Ret[...]

Developers G uide 38 Datalogic™ OPOS Service Objects If PowerNotify is set to "OPOS_PN_ENABLED", then: • If the Scanner is Plugged and Enabled: OPOS_PS_ONLINE •o t h e r w i s e : OPOS_PS_OFF_OFFLINE ResultCode: Returns result of last operation. ResultCodeExtended : Returns extended result if th e last operation produced an OPOS_E_E[...]

Developers Guide User Manual 39 CapStatusUpdate: Returns TRUE . CapTareWeight: Returns FALSE . CapZeroScale: Returns TRUE . AsyncMode: Returns TRUE or FALSE depending on the previous SetProperty call. MaxDisplayTextChars: Returns 0 . MaximumWeight: Returns 15000 in metric mode. Returns 30000 in pound mode. ScaleLiveWeight: Updated if LiveWeight is [...]

Developers G uide 40 Datalogic™ OPOS Service Objects Scale Methods Co m m on M e t h o d s Open: Returns OPOS_SUCCESS OPOS_E_NOSERVICE OPOS_E_ILLEGAL Close: Returns OPOS_SUCCESS . ClaimDevice: Returns OPOS_SUCCESS OPOS_E_NOSERVICE OPOS_E_ILLEGAL OPOS_E_CLAIMED This call will activate the communication with the device. DATALOGIC devices are exclus[...]

Developers Guide User Manual 41 DirectIO: Returns OPOS_E_NOTCLAIMED OPOS_E_OFFLINE OPOS_E_ILLEGAL ReleaseDevice: Returns OPOS_SUCCESS . OPOS_E_ILLEGAL if the device has not been claimed. This call will deactivate the communication with the device. It is recom - mended that a program keep the devi ce Claimed until an application quits. ResetStati st[...]

Developers G uide 42 Datalogic™ OPOS Service Objects Device Specific Methods GetSalesPrice: Returns 0 Not implemented GetUnitPrice: Returns 0 Not implemented SetUnitPrice: Returns OPOS_E_ILLEGAL Not implemented DisplayText: Returns OPOS_E_ILLEGAL ReadWeight: Returns OPOS_SUCCESS OPOS_E_EXTENDED OPOS_E_TIMEOUT CANCELLED OPOS_E_NOTCLAIMED OPOS_E_DI[...]

Developers Guide User Manual 43 Scale Ev ents Co m m on E ve nt DataEvent: Used for asynchronous weight requests DirectIOEvent: Not supported ErrorEvent: Used if a cancel weight is called du ring an asynchronous weight request StatusUpdateEvent: Supported as per LiveWeightDisplay as documented in the UPOS speci - fication. If PowerNotify is set to [...]

Developers G uide 44 Datalogic™ OPOS Service Objects NOTES[...]

[...]

Datalogic ADC, In c. 959 Terry Street | Eugene | OR 97402 | USA Telephone: (1) 541-68 3-5700 | Fax: (1) 541-34 5-7140 ©2008-2014 Datal ogic ADC, I nc. All rights reserved. Datalogic and the Datalogi c logo are regi stered trademarks of Datalogic S.p.A. in many countries, including the U .S.A. and the E.U. www.datalogic.com 820025614 (Rev J) April [...]