OEM USB, RS232 Standard RS232 Single Cable OPOS Service Objects Quick Reference Guide
Datalogic Scanning, Inc. 959 Terry Street Eugene, Oregon 97402 Telephone: (541) 683-5700 Fax: (541) 345-7140 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 without prior written permission of Datalogic Scanning, Inc. or its subsidiaries or affiliates ("Datalogic" or “Datalogic Scanning”).
Table of Contents Datalogic™ OEM USB, RS232 Standard RS232 Single Cable OPOS Service Objects ................................. 1 Introduction .............................................................................................................................................................................. 1 Document Conventions ...........................................................................................................................................................................
Table of Contents NOTES ii Datalogic™ OPOS Service Object
Datalogic™ OEM USB, RS232 Standard RS232 Single Cable OPOS Service Objects Introduction Document Conventions Formatting conventions are used throughout this guide to provide a consistent method for representing screen shots and command entries. Notes contain additional information of interest to the user. The CAUTION symbol advises you of actions that could damage equipment or property. CAUTION Keystrokes.
Introduction Datalogic Products Supported .
Running the Install Installation Running the Install Uninstall any previous DATALOGIC or PSC OPOS scanner/scale service objects before proceeding with the installation of the DATALOGIC OPOS Service Objects. DATALOGIC Service Objects are compatible with OPOS Common Control Objects version 1.12.000 included in this package. Installation can be performed in either of two ways: using a standard GUI installation, or as a silent install from the Command Prompt.
Utilities Utilities DualTest Utility The Datalogic 1.12 OPOS package contains a utility called DualTest that provides customers with the ability to quickly connect and test the operation of a Datalogic scanner/scale with the Datalogic service objects. Simple OPOS operations such as Open, Claim, Enable, Read Weights, bar code scanning, bar code type, Release, and Close can be exercised with this utility.
DualTest Utility 2. Open Scanner: 3.
Utilities 4. Enable: 5. Now click the “DataEventEnable” button and check the “AutoDataEventEnable” box, and scan a bar code.
DualTest Utility Firmware Update with DualTest The Datalogic 1.12 OPOS Scanner Service Object supports the ability to update firmware on select scanners in accordance with the UPOS Specification (version 1.9 and above). The user’s application may be written to take advantage of this capability in the service (see the UPOS specification for details). In addition, the DualTest application bundled with Datalogic’s services supports this capability and may be used to upgrade firmware on select scanners.
Utilities 2. Confirm Update Firmware: 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.
DualTest Utility Update in progress, at 68% complete: 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.
Utilities Finalized: The scanner is now back on line and fully operational. Scale with DualTest To connect to a Scale, follow these steps after installing the 1.12 OPOS package from Datalogic: 1.
DualTest Utility 2. Open Scale: 3.
Utilities 4. Enable: 5.
DualTest Utility Live Weight Display The Datalogic 1.12 OPOS Scale Service Object supports the ability to provide Live Weight Display functionality in accordance with the UPOS Specification (version 1.9 and above). The user’s application may be written to take advantage of this capability in the service (see the UPOS specification for details).
Utilities 2. Enable: (Live Weight Begins immediately / Zero Weight) 3. Underweight: An under zero condition has occurred.
DualTest Utility 4. In motion: The scale is in motion and has not stabilized. 5. Overweight: The scale’s weight capacity has been exceeded.
Utilities 6. Stable Large Weight: 7.
Windows Management Instrumentation (WMI) Com- Registry Windows Management Instrumentation (WMI) Compatible Datalogic OPOS Service Objects provide WMI-compatible Remote Management for certain scanners when properly configured. For those scanners that support this data gathering capability, the Service Objects must be configured via registry settings to provide scanner data to the WMI data store.
Registry HandScanner = USBHHScanner: • • • • • • • • • • • • • 18 (Default) = DLOPOS.DLScanner – this is the default name used by the service. The user should not edit this entry. AbstractDevice – this represents the GUID and should not be edited by the user. Add01ToRSS – defaulted to active (1), if the scanner does not return a “01” at the start of a Databar label, the service will add the “01” if this item is active. CheckIHSOnClaim – defaulted to active (1).
OPOS Registry MagellanSC = SCRS232Scanner Common fields as per Handheld scanner above; in addition the following fields are: • BaudRate – default to 9600. Changing this value REQUIRES changing the scanner to a matching value – failure to do so will result in failure to communicate! CAUTION • • • • • • • • • • • DataBits – default to 7, same caveat as for baud rate. OverrideUPCASuplimental – default not active; can be used in certain cir- cumstances to differentiate label+addon from label only packet.
Registry RS232Scanner = QS6000 Common fields as above; in addition the following field is: • WarholParsing – defaults to not active. When using a QD21xx, QD23xx, PD71xx, or GD41xx handheld scanner, the user should set this to active and select the “RS232 OPOS” interface in the scanner programming guide. This setting enables correct identification of Label Ids from the scanner through the Service Object.
OPOS Registry TableScanner = USBScanner Settings are identical to USBHHScanner/HandScanner, except that Usage = 18944 (4A00 hex), and DeviceNameOverride = “…USB Scanner” 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 category of scale.
Registry • CapStatusUpdate – defaulted to 1, this indicates that the scale service is capable of supplying Status Update events as per the UPOS Live Weight Display description in the scale section of the UPOS spec. • CapZeroScale – defaulted to not active. The Single Cable scale does not sup- • port host zeroing of the scale. LiveWeightInterval – default to 500; this is the poll rate in milliseconds that the scale service polls the scale for weight in the case of Live Weight Display enabled.
OPOS Registry • Port – defaulted to COM2. The user can select the desired COM port for their system. This MUST be a different COM port than the associated Scanner port. • • • • BaudRate – defaulted to 9600. The user should not change this setting, as the scale baud rate is NOT configurable. DataBits – set to 7. The user should not change this setting, as the scale data bits are NOT configurable. Parity – set to Even. The user should not change this setting, as the scale parity is NOT configurable.
Registry Logging The DLS Service Objects have the ability to log various data items to a file for reporting, troubleshooting, and monitoring. The logging level is controlled by registry settings under the location HKEY_LOCAL_MACHINE\SOFTWARE\DATALOGIC\DL_OPOS_SERVICE. By default, only Error logging is turned on upon installation. If desired, the user can log various reporting levels by turning on settings. The location of log files is shown under the LogFile name; the default path is as shown above.
OPOS Registry Some DLS scanners can report additional Value Added Features, provided that 1) this feature is turned on in the scanner, 2) the scanner interface is OEM USB, 3) the “ValueLogging” registry entry is set to 1 (active). When all of the above are true, additional information related to bar code scanning performance and scanner usage is logged to the file listed under the “ValueAddedFeaturesFile” registry entry. For more information on this feature, contact DLS Tech Support.
Developers Guide Developers Guide OPOS service objects export a uniform interface; however there may be slight differences between the same types of devices from different vendors and models. Queries of OPOS properties reveal these differences. Below listed properties, methods, and events are DATALOGIC device specific return values. Other DATALOGIC service objects with different interfaces may produce slightly different results.
Scanner Properties: 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 call. OpenResult: Returns 0. PowerNotify: Returns OPOS_PN_DISABLED or OPOS_PN_ENABLED. PowerState: Returns OPOS_PS_ONLINE.
Developers Guide Device Specific Properties: DecodeData: Returns TRUE or FALSE depending on the previous SetProperty call. ScanData: Holds the raw scanned data received from the scanner. ScanData property always has bar code data when a DataEvent is fired. For Tabletop scanners, the bar code data may be sent across the USB interface as uncompressed Binary Coded Decimal (BCD), depending upon scanner configuration and bar code type.
Scanner Methods: Scanner Methods: Common Methods: 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 devices are exclusive. It is recommended that a program keep the device Claimed as long as the application is running. CheckHealth: OPOS_CH_INTERNAL is supported. OPOS_CH_EXTERNAL is not supported.
Developers Guide OPOS_E_NOTCLAIMED OPOS_E_OFFLINE OPOS_E_ILLEGAL Please refer to Appendix A for supported DirectIO functions. ReleaseDevice: Returns OPOS_SUCCESS, OPOS_E_ILLEGAL, or OPOS_E_NOTCLAIMED. This call will deactivate the communication with the device. ResetStatistics: Returns OPOS_E_ILLEGAL DATALOGIC service objects do not support reset statistics.
Scanner Events: Scanner Events: Common Event: DataEvent: This event fires when a label is forwarded from scanner. DirectIOEvent: Not supported. ErrorEvent: Not used. StatusUpdateEvent: Not implemented. Device Specific Events: None. Scale Properties: Common Properties: AutoDisable: Returns TRUE or FALSE depending on the previous SetProperty call. BinaryConversion: Returns TRUE or FALSE depending on the previous SetProperty call. CapCompareFirmwareVersion: Returns FALSE.
Developers Guide External HCheck: not supported. Interactive HCheck: not supported. Claimed: Returns TRUE after Claim method has been called. FALSE otherwise. DATALOGIC devices are exclusive. It is recommended that the device be claimed and continue to be claimed thru-out a session. DataCount: Returns 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.
Scale Properties: DeviceServiceVersion: Returns 10120XXX where XXX is the minor version. PhysicalDeviceDescription: Returns a descriptive string depending on the interface and device type. PhysicalDeviceName: Returns a descriptive string depending on the interface and device type. Device Specific Properties: CapDisplay: Returns TRUE. TRUE is returned regardless of a remote display being connected to the scanner/scale or not. CapDisplayText: Returns FALSE.
Developers Guide StatusNotify: If CapStatusUpdate is TRUE, the application can set StatusNotify to either SCAL_SN_DISABLED or SCAL_SN_ENABLED. SalesPrice: Returns 0 currency. TareWeight: Returns 0. UnitPrice: Returns 0 currency. WeightUnit: Returns SCAL_WU_KILOGRAM in metric mode. Returns SCAL_WU_POUND in pound mode. Scale Methods: Common Methods: Open: Returns OPOS_SUCCESS OPOS_E_NOSERVICE OPOS_E_ILLEGAL Close: Returns OPOS_SUCCESS.
Scale Methods: OPOS_CH_INTERACTIVE is supported. Returns OPOS_SUCCESS OPOS_E_NOTCLAIMED OPOS_E_DISABLED OPOS_E_ILLEGAL CheckHealthText property will hold the text result of this method call. ClearInput: Returns OPOS_SUCCESS OPOS_E_DISABLED OPOS_E_NOTCLAIMED DirectIO: Returns OPOS_E_NOTCLAIMED OPOS_E_OFFLINE OPOS_E_ILLEGAL Please refer to Appendix A for supported DirectIO functions. ReleaseDevice: Returns OPOS_SUCCESS. OPOS_E_ILLEGAL if the device has not been claimed.
Developers Guide 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_DISABLED OPOS_E_OFFLINE OPOS_E_ILLEGAL OPOS_E_FAILURE OPOS_E_BUSY OPOS_E_NOHARDWARE If the result is OPOS_SUCCESS valid weight is returned.
Scale Events: ZeroScale: Returns OPOS_SUCCESS OPOS_E_NOHARDWARE OPOS_E_OFFLINE OPOS_E_DISABLED OPOS_E_NOTCLAIMED Scale Events: Common Event: DataEvent: Used for asynchronous weight requests DirectIOEvent: Not supported ErrorEvent: Used if a cancel weight is called during an asynchronous weight request StatusUpdateEvent: Supported as per LiveWeightDisplay as documented in the UPOS specification.
Developers Guide Appendix A: DirectIO Command Support OEM USB RS232 SC Interface RS232 Std DirectIO name OEM USB Scale RS232 Std Scanner RS232 SC IO number LEGACY SCANNER for backwards compatibility SCANNER_RESET 1 SCANNER_BEEP 2 SCANNER_NOT_ON_FILE 3 LEGACY SCANNER DirectIO for backwards compatibility SCALE_STATUS 1 SCALE_SELFTEST 2 RS232 SC, OEM USB, RS232 Std SCANNER/SCALE 38 HARD_RESET 1 SCANNER_STATUS 2 SWITCH_READ 3 NOT_ON_FILE 4 DISABLE_WITH_RED_LIGHT
Scale Events: OEM USB RS232 SC Interface RS232 Std DirectIO name OEM USB Scale RS232 Std Scanner RS232 SC IO number RS232 SC, OEM USB, RS232 Std SCANNER/SCALE (cont.
Developers Guide OEM USB RS232 SC Interface RS232 Std DirectIO name OEM USB Scale RS232 Std Scanner RS232 SC IO number NCR Scanner DirectIO for compatibility SCANNER_TONE 500 SCANNER_RESET 501 SCANNER_STATUS 502 SCANNER_READROM 503 SCANNER_ROM_VERSION 504 SCANNER_PACESETTER 505 SCANNER_DIRECT 506 SCANNER_NOT_ON_FILE 507 NCR Scale DirectIO for compatibility SCALE_STATUS 600 SCALE_READROM 601 SCALE_ROM_VERSION 602 SCALE_LIVE_WEIGHT 603 SCALE_DIRECT 60
Australia Datalogic Scanning Pty Ltd Telephone: [61] (2) 9870 3200 australia.scanning@datalogic.com Japan Datalogic Scanning KK Telephone: 81 (0)3 3491 6761 japan.scanning@datalogic.com France and Benelux Datalogic Scanning SAS Telephone: [33].01.64.86.71.00 france.scanning@datalogic.com Latin America Datalogic Scanning, Inc Telephone: (305) 591-3222 latinamerica.scanning@datalogic.com Germany Datalogic Scanning GmbH Telephone: 49 (0) 61 51/93 58-0 germany.scanning@datalogic.
