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 OEM USB, RS232 Standard RS232 Single Cable OPOS Service Objects ........................................................................................ 1 Datalogic™ OEM USB, RS232 Standard RS232 Single Cable OPOS Service Objects .................................................................... 1 Introduction ....................................................................................................................................................................................
Table of Contents NOTES ii Datalogic™ OEM/IBM USB 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 .
Installation 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.
Utilities 2. Open Scanner: 3.
Utilities 4. Enable: 5. Now click the “DataEventEnable” button and check the “AutoDataEventEnable” box, and scan a bar code.
Utilities 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.
Utilities Update in progress, at 55% 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.
Utilities 2. Open Scale: 3.
Utilities 4. Enable: 5.
Utilities 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.
Utilities 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.
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.
Developers Guide 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.
Developers Guide 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_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.
Developers Guide 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.
Developers Guide 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.
Developers Guide 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.
Developers Guide 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: Not supported Device Specific Events: None 28 Datalogic™ OPOS Service Object
Developers Guide Appendix A: DirectIO Command Support.
Developers Guide IO number SCALE_MONITOR 7 DISPLAY_DATA 8 DISPLAY_STATUS 9 ENABLE_TONE 10 BEEP_GOOD_TONE 11 SOFT_POWER_DOWN 12 DISABLE_TONE 13 ENTER_TOAD_MODE 14 READ_PACESETTER 15 RESET_PACESETTER 16 ENABLE_PACESETTER 17 DISABLE_PACESETTER 18 SOFT_RESET 19 RETRIEVE_DEVICE_IDENTIFIER_RECORD 20 RETRIEVE_DEVICE_EXTENDED_STATUS_RECORD 21 RETRIEVE_DEVICE_HEALTH_RECORD 22 OEM USB RS232 Std Scale OEM
Developers Guide IO number SCANNER_STATUS 502 SCANNER_READROM 503 SCANNER_ROM_VERSION 504 SCANNER_PACESETTER 505 SCANNER_DIRECT 506 SCANNER_NOT_ON_FILE 507 OEM USB RS232 Std Scale OEM USB RS232 SC Interface RS232 Std Scanner RS232 SC DirectIO name NCR Scale DirectIO for compatibility SCALE_STATUS 600 SCALE_READROM 601 SCALE_ROM_VERSION 602 SCALE_LIVE_WEIGHT 603 SCALE_DIRECT 604 SCALE_WEIGHT_DELAY 605 Note: Some DirectIo calls may not be supported by the
Developers Guide NOTES 32 Datalogic™ OPOS Service Object
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 Sarl 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.
