Overview

The POS application is either a Java application or an applet that uses one or more JavaPOS devices. An application accesses the JavaPOS device through the JavaPOS Device Interface, which is specified by Java interfaces.

Each JavaPOS device is a combination of these components:

• JavaPOS Device Control is a Java class that provides the interface between the application and the device category. It contains no graphical component and is therefore invisible at runtime and conforms to the JavaBeans API. The Device Control was designed so that all implementations of a device category's control are compatible. The Device Control can be developed independently of a Device Service for the same device category. They may even be developed by different companies.
• JavaPOS Device Service is a Java class that is called by the Device Control through the JavaPOS Device Service Interface. The Device Service is used by the Device Control to implement JavaPOS-prescribed functionality for a physical device. It can also call special event methods provided by the Device Control to deliver events to the application.
• The JPOS driver included with the Zebra Scanner SDK for Windows provides JNI (Java Native Interface) mechanisms to scanner and scale devices (CSJPOSScanner.dll and CSJPOSScale.dll) for the JavaPOS Device Service layer to interface with the CoreScanner driver.

Zebra Scanner JPOS Driver Architecture

Figure 1: Zebra Scanner JPOS Driver Architecture

For more information about JavaPOS, JavaPOS architecture, terminology and programmer's guides, refer to:

• JavaPOS home page at http://www.javapos.com/
• UPOS home page at http://www.nrf-arts.org/

NOTE: The terms JavaPOS and JPOS are used interchangeably in this document.

Version History

Overview

This chapter describes installation instructions and settings to configure the Zebra Scanner JPOS Driver on a host computer.

For custom installation instructions on installing the Zebra scanner JPOS driver, refer to the Installation and Configuration of Scanner SDK for Windows.

NOTE (for Windows): JPOS components are installed by default with the standard scanner SDK installation. If a custom scanner SDK installation is performed, the JPOS option must be selected to install the JPOS components.

NOTE (for Linux): JPOS components can be installed using RPM and Debian packages separately.

Configuration

Configuration for Windows

After a successful installation of the Zebra Scanner SDK with the JPOS driver, an XML file named JPOS.xml is created in the folder C:\Program Files\Zebra Technologies\Barcode Scanners\Scanner SDK\JPOS\Sample Applications\bin.

Setting JPOS CLASSPATH for Windows

The libraries required for the JPOS to run are referenced through classpath definitions. All the required classpaths are defined in the JPOSTest.bat file.

Why .bat file?

All the classpaths are defined through the JPOSTest.bat file to demonstrate which libraries are needed and how to load them to run the JPOS. Based on that the user can set the classpaths as needed from their custom locations. Zebra packages do not set .jar and libraries entries at system level classpath by default.

CLASSPATH Definitions

set PATH=%PATH%;%ProgramFiles%\Zebra Technologies\Barcode Scanners\Scanner SDK\JPOS\bin

Defines the directory which contains the CSJPOSScanner.dll and CSJPOSScale.dll files. These two .dll files acts as a link between the CoreScanner and the JPOS

set classpath=%classpath%;%ProgramFiles%\Zebra Technologies\Barcode Scanners\Scanner SDK\JPOS\External\xerces-2_11_0\xercesImpl.jar
set classpath=%classpath%;%ProgramFiles%\Zebra Technologies\Barcode Scanners\Scanner SDK\JPOS\External\xerces-2_11_0\xml-apis.jar

Defines the path to xercesImpl.jar and xml-apis.jar files. These are third-party libraries used for XML processing.

set classpath=%classpath%;%ProgramFiles%\Zebra Technologies\Barcode Scanners\Scanner SDK\JPOS\External\JavaPOS-1.14.0-Dist\javaPOS114.jar

Defines the path to the javaPOS114.jar file. This is the JPOS 1.14 service object.

set classpath=%classpath%;%ProgramFiles%\Zebra Technologies\Barcode Scanners\Scanner SDK\JPOS\bin\JposLogger.jar

Defines the path to the JposLogger.jar file. This handles the logging operations in JPOS.

set classpath=%classpath%;%ProgramFiles%\Zebra Technologies\Barcode Scanners\Scanner SDK\JPOS\bin\JposServiceJniScale.jar
set classpath=%classpath%;%ProgramFiles%\Zebra Technologies\Barcode Scanners\Scanner SDK\JPOS\bin\JposServiceJniScanner.jar

set classpath=%classpath%;%ProgramFiles%\Zebra Technologies\Barcode Scanners\Scanner SDK\JPOS\bin\JposServiceOnScale.jar
set classpath=%classpath%;%ProgramFiles%\Zebra Technologies\Barcode Scanners\Scanner SDK\JPOS\bin\JposServiceOnScanner.jar

set classpath=%classpath%;%ProgramFiles%\Zebra Technologies\Barcode Scanners\Scanner SDK\JPOS\bin\JposServiceScale.jar
set classpath=%classpath%;%ProgramFiles%\Zebra Technologies\Barcode Scanners\Scanner SDK\JPOS\bin\JposServiceScanner.jar

These six lines define the paths to the JPOS service object related .jar files. All these jar files are required for the execution of JPOS. They are categorized based on Scale and Scanner.

set classpath=%classpath%;%ProgramFiles%\Zebra Technologies\Barcode Scanners\Scanner SDK\JPOS\Sample Applications\bin\

Defines the directory which contains the JPOS sample app executable.

Visit Configure JavaPOS Scanner and Scale Drivers for Windows on a Custom Path KB article for more details.

Configuration for Linux

Following prerequisites are needed to run JPOS in Linux distributions.

• libudev-dev
• JDK (1.6 or above)
• libgtk2.0-dev
• ant

JPOS package can be installed by executing the following command inside the folder containing the .deb/.rpm packages.

Please refer the Install 32-bit CoreScanner and JAVAPOS Packages in a 64-bit Linux Environment to see the instructions to install Zebra 32bit applications on 64bit environment.

For Debian distributions:

sudo dpkg -i zebra-scanner-javapos_X.X.X-X_amd64.deb

For RPM distributions:

rpm –ivh zebra-scanner-javapos-X.X.X-X.x86_64.rpm

Use the appropriate Package names when using the above commands. After the installation is completed, jpos.xml can be found in the location given below.

/usr/share/zebra-scanner/javapos/xml

The JPOS Sample Application can be found at:

/usr/share/zebra-scanner/samples/jpos-sample-app

Note that, this Application can only be run with JDK version 1.8 or above. In order to run the JPOS Sample Application in Linux, navigate to the location where the executable is located.

cd /usr/share/zebra-scanner/samples/jpos-sample-app

Execute the command mentioned below.

./jpos-sample-app.sh

Furthermore, a Sample Application especially catered to run with JDK 1.6 is provided to the users in the form of a zip file, 'jpos-sample-app-java1.6_vX.X.X-X.tar.gz' along with the package. In order to run the Application, extract and navigate to the below location.

cd jpos-sample-app-java1.6_vX.X.X-X/jpos-sample-app-java1.6

Please include the appropriate version in the above command. The Sample App can be run by executing the relevant '.sh' file.

./jpos-sample-app-java1.6.sh

Note that, this Sample Application has a limited set of features than what the above Sample App offers.

Setting JPOS CLASSPATH for Linux

References for the essential lib and JAR files needed for the proper execution of JPOS driver for Linux are defined as CLASSPATHs in the shell script jposampleapp.sh. These libs and JARS are loaded at runtime based on the CLASSPATH locations. In custom app development, it is possible to change the default CLASSPATHs into user appropriate locations to suit the custom requirement.

CLASSPATH Definitions

Shared object files of JPOS driver for Linux can be found in the path stated below.

LIB_PATH=$LIB_PATH:/usr/lib/zebra-scanner/javapos/jni
CLASSPATH=$CLASSPATH:$LIB_PATH

Third party JAR files responsible for XML processing are found in the path given below.

CLASSPATH=$CLASSPATH:/usr/lib/zebra-scanner/javapos/jpos/xercesImpl.jar	
CLASSPATH=$CLASSPATH:/usr/lib/zebra-scanner/javapos/jpos/xml-apis.jar

JAR file containing the path to the JPOS 1.14 service object is found in the path provided below.

CLASSPATH=$CLASSPATH:/usr/lib/zebra-scanner/javapos/jpos/javaPOS114.jar

The XML file containing the names of the logical devices and the corresponding settings is saved in the location below.

CLASSPATH=$CLASSPATH:/usr/share/zebra-scanner/javapos/xml

Logging configurations and JPOS trace properties can be done using the file available at the given location.

CLASSPATH=$CLASSPATH:/usr/share/zebra-scanner/javapos/config

Path for the JAR file managing the logging operations of JPOS is defined below.

CLASSPATH=$CLASSPATH:/usr/lib/zebra-scanner/javapos/jpos/JposLogger.jar

Paths that lead to JPOS service objects of both the scanner and the scale, that are essential for the JPOS driver execution are mentioned below.

CLASSPATH=$CLASSPATH:/usr/lib/zebra-scanner/javapos/jpos/JposServiceJniScale.jar
CLASSPATH=$CLASSPATH:/usr/lib/zebra-scanner/javapos/jpos/JposServiceJniScanner.jar

CLASSPATH=$CLASSPATH:/usr/lib/zebra-scanner/javapos/jpos/JposServiceOnScale.jar
CLASSPATH=$CLASSPATH:/usr/lib/zebra-scanner/javapos/jpos/JposServiceOnScanner.jar

CLASSPATH=$CLASSPATH:/usr/lib/zebra-scanner/javapos/jpos/JposServiceScanner.jar
CLASSPATH=$CLASSPATH:/usr/lib/zebra-scanner/javapos/jpos/JposServiceScale.jar

The path to the Jar file used by the JPOS sample application is defined below.

CLASSPATH=$CLASSPATH:/usr/share/zebra-scanner/samples/jpos-sample-app/JposSampleApp.jar

JPOS Logical Devices

The Zebra Scanner JPOS Driver reads jpos.xml to retrieve required configurations such as the baud rate for serial scanners and scanner filtering rules to form the logical scanner defined by the user. Each <JposEntry logicalName="LogicalScannerName"> tag defines a logical scanner. The following sample JPOSEntries represents serial, USB IBM Hand-held and USB SNAPI logical devices.

Wincor-Nixdorf Mode B

<JposEntry logicalName="ZebraScannerSerialNIXMODB">
    <creation factoryClass="com.zebra.jpos.service.scanner.SymScannerSvc112Factory" serviceClass="com.zebra.jpos.service.scanner.SymScannerSvc112"/>
    <vendor name="Zebra Technologies" url="https://www.zebra.com"/>
    <jpos category="Scanner" version="1.12"/>
    <product description="Zebra Serial" name="Zebra Serial NIXMODB Scanner" url="https://www.zebra.com"/>		
    <prop name="ScannerType" value="NIXMODB"/>
    <prop name="ExclusiveClaimLevel" value="0" />
</JposEntry>

SSI Serial Scanners

<JposEntry logicalName="ZebraScannerSerialSSI">
    <creation factoryClass="com.zebra.jpos.service.scanner.SymScannerSvc112Factory" serviceClass="com.zebra.jpos.service.scanner.SymScannerSvc112"/>
    <vendor name="Zebra Technologies" url="https://www.zebra.com"/>
    <jpos category="Scanner" version="1.12"/>
    <product description="Zebra Serial" name="Zebra Serial SSI Scanner" url="https://www.zebra.com"/>		
    <prop name="ScannerType" value="SSI_SERIAL"/>
    <prop name="ExclusiveClaimLevel" value="0" />
</JposEntry>

USB IBM Hand-held Scanners

<JposEntry logicalName="ZebraUSBHandHeld">
    <creation factoryClass="com.zebra.jpos.service.scanner.SymScannerSvc112Factory" serviceClass="com.zebra.jpos.service.scanner.SymScannerSvc112"/>
    <vendor name="Zebra Technologies" url="https://www.zebra.com"/>
    <jpos category="Scanner" version="1.12"/>
    <product description="Zebra USB Scanner" name="Zebra Scanner" url="https://www.zebra.com"/>
    <prop name="ScannerType" value="USBIBMHID"/>
    <prop name="ExclusiveClaimLevel" value="0" />
</JposEntry>

USB SNAPI Scanners

<JposEntry logicalName="ZebraScannerSNAPI">
    <creation factoryClass="com.zebra.jpos.service.scanner.SymScannerSvc112Factory" serviceClass="com.zebra.jpos.service.scanner.SymScannerSvc112"/>
    <vendor name="Zebra Technologies" url="https://www.zebra.com"/>
    <jpos category="Scanner" version="1.12"/>
    <product description="Zebra SNAPI Scanner" name="Zebra Scanner" url="https://www.zebra.com"/>
    <prop name="ScannerType" value="SNAPI"/>
    <prop name="ExclusiveClaimLevel" value="0" />
</JposEntry>

All Scanners

<JposEntry logicalName="ZebraAllScanners">
    <creation factoryClass="com.zebra.jpos.service.scanner.SymScannerSvc112Factory" serviceClass="com.zebra.jpos.service.scanner.SymScannerSvc112"/>
    <vendor name="Zebra Technologies" url="https://www.zebra.com"/>
    <jpos category="Scanner" version="1.12"/>
    <product description="Zebra Serial/USB Scanner" name="Zebra Scanner" url="https://www.zebra.com"/>
    <prop name="ScannerType" value="ALL"/>
    <prop name="ExclusiveClaimLevel" value="0" />
    <prop name="NcrScanNOFPattern" type="String" value="12"/>
    <prop name="NcrScanTonePattern" type="String" value="4"/>
    <prop name="DioScannerNotOnFile" type="String" value="12"/>
    <prop name="DioScannerDioNof" type="String" value="12"/>
</JposEntry>

Scale Devices

<JposEntry logicalName="ZebraScale">
    <creation factoryClass="com.zebra.jpos.service.SvcServiceInstanceFactoryImpl" serviceClass="com.zebra.jpos.service.scale.ScaleService113Impl"/>
    <vendor name="Zebra Technologies" url="https://www.zebra.com"/>
    <jpos	category="Scale" version="1.13"/>
    <product description="Zebra Scale" name="Zebra Scale" url="https://www.zebra.com"/>
    <prop name="ErrorOnSameWeight" value="1"/>
</JposEntry>

NOTE When a scale device (such as MP6200) is connected to a host PC via an RSM-supported host mode, scale functionality is available. The scale is accessible using the JPOS Open and Claim methods. RSM-supported host modes include SNAPI, IBM HH, IBM TT and SSI.

Scanner Configuration Bar Codes

Scan the Set All Defaults bar code below to return all parameters to the scanner's default values. Refer to the scanner's Product Reference Guide for default values.

Scan the appropriate bar code below to configure the scanner for either USB or RS-232 communication protocols.

USB Communication Protocol

RS-232 Communication Protocol

Logging

Logging for Windows

To configure logging for Scanner JPOS and Scale JPOS, use the jpos_trace.properties file located at C:\Program Files\Zebra Technologies\Barcode Scanners\Scanner SDK\JPOS\bin.

Following is a sample log section of this file.

###############################################################################
#################### JPOS Configurations Zebra Scanners #######################
# ZEBRA, ZEBRA TECHNOLOGIES, and the Zebra Logo are trademarks or registered  #
# trademarks of Zebra Technologies International, LLC, © 2022 Zebra           #
# Technologies International, LLC. All Rights Reserved.                       #
###############################################################################

###############################################################################
# logFileName:
# File name or lable for the log file
###############################################################################
logFileName=jpos.log

###############################################################################
# logFilePath:
# log file storing location default location is /var/log/corescanner/jpos
###############################################################################
logFilePath=C:\\Program Files\\Zebra Technologies\\Barcode Scanners\\Scanner SDK\\JPOS\\bin\\Logs

###############################################################################
# logFileSize:
# size of a single log file, this can be changed
###############################################################################
logFileSize=1048576

###############################################################################
# logFileCount:
# Maximum number of log files created by JPOS, new log file will be created once
# the current log file archive "logFileSize" in byte
###############################################################################
logFileCount=2

###############################################################################
# logLevel:
# Currently support only 2 values
# 0 - Disable logging
# 1 - Enable logging
###############################################################################
logLevel=1

Logging for Linux

The file jpos_trace.properties in Linux platform can be found in the location /usr/share/zebra-scanner/javapos/config

The following is the content present in the file jpos_trace.properties

###############################################################################
#################### JPOS Configurations Zebra Scanners #######################
# ZEBRA, ZEBRA TECHNOLOGIES, and the Zebra Logo are trademarks or registered  #
# trademarks of Zebra Technologies International, LLC, © 2022 Zebra           #
# Technologies International, LLC. All Rights Reserved.                       #
###############################################################################

###############################################################################
# logFileName:
# File name or lable for the log file
###############################################################################
logFileName=jpos.log

###############################################################################
# logFilePath:
# log file storing location default location is /var/log/zebra-scanner/jpos
###############################################################################
logFilePath=/var/log/zebra-scanner/jpos

###############################################################################
# logFileSize:
# size of a single log file, this can be changed
###############################################################################
logFileSize=1048576

###############################################################################
# logFileCount:
# Maximum number of log files created by JPOS, new log file will be created once
# the current log file archive "logFileSize" in byte
###############################################################################
logFileCount=2

###############################################################################
# logLevel:
# Currently support only 2 values
# 0 - Disable logging
# 1 - Enable logging with input output values for functions
# 2 - Enable logging with input output values for functions along with function names
###############################################################################
logLevel=1

###############################################################################
# ShowSensitiveInfo:
# Log sensitive information (Scan Data, Read Weight Values)
# 0 - Disable logging
# 1 - Enable logging
###############################################################################
showSensitiveInfo=1

###############################################################################
# enableCimPropertyFile:
# Log CIM properties related log file. Applicable for Linux only
# 0 - Disable creation of CIM property log file
# 1 - Enable creation of CIM property log file
###############################################################################
enableCimPropertyFile=1

JPOS Scanner and Scale related logs get created in the folder /var/log/zebra-scanner/jpos

Overview

The following steps depict the behavioral model of the JPOS driver and scanner.

1. The scanner reads encoded data from a label.
2. When the Control receives input, it queues a DataEvent.
3. If the AutoDisable property is TRUE, the Control is disabled when a DataEvent is queued.
4. The Control can deliver a queued DataEvent to the application when the DataEventEnabled property is TRUE. Just before delivering this event, the Control copies the data into properties and disables further data events by setting the DataEventEnabled property to FALSE. This causes the Control to queue subsequent input data while the application processes the current input and associated properties. When the application finishes the current input and is ready for more data, it re-enables events by setting DataEventEnabled to TRUE.
5. The Control queues an ErrorEvent (or events) if it encounters an error while gathering or processing input and delivers this to the application when the DataEventEnabled property is TRUE.
6. The DataCount property contains the number of DataEvents queued by the Control.
7. Call the ClearInput method to delete all input that the Control queued.

Scanned data is placed into the property ScanData. If the application sets the property DecodeData to TRUE, the data is decoded into ScanDataLabel and ScanDataType.

Deviations from JPOS Specifications

• When there is no scanner connected to a cordless base, the Zebra Scanner JPOS Driver considers the cordless base a scanner. Therefore, a claim succeeds with a cordless base.
• In serial mode, a claim succeeds even when no scanner is connected to the port. In this case, it indicates the success of the port opening.

The following steps depict the behavioral model of the JPOS driver and scale:

1. The POS application calls the ReadWeight method in JPOS control.
2. When JPOS control receives the method call, it passes the request to the JPOS scale service and JPOS scale service passes that request to CoreScanner service.
3. The CoreScanner Service requests the weight data from the scale and reports it back up through the JPOS scale service to the JPOS control.
4. JPOS control returns the ReadWeight method with the weight data retrieved to the POS application.

JPOS Configurable Properties

Configurable JPOS properties are defined in the JPOS XML and a separate configuration set can be maintained per each host name as given in the sample xml below.

<JposEntries>
    <JposEntry logicalName="LogicalName1">
        <prop name="Property1" value="Value1"/>
        <prop name="Property2" value="Value2"/>
        <prop name="Property3" value="Value3"/>
        ... 
    </JposEntry>
    <JposEntry logicalName="LogicalName2">
        <prop name="Property1" value="Value1"/>
        <prop name="Property2" value="Value2"/>
        <prop name="Property3" value="Value3"/>
        ...
    </JposEntry>
<JposEntries>

JPOS Configurable Properties

Scanner Profile Properties

<prop name="ExclusiveClaimLevel" type="String" value="0"/>

The ExclusiveClaimLevel property controls the ability to claim the same device from multiple applications. When this value = 0, multiple apps can claim the same device. When this value = 1, once a device is claimed, other apps cannot claim the same device.

<prop name="ScannerType" type="String" value="ALL"/>

The ScannerType property identifies the Host communication mode of the Open device. The value ALL means all host modes are associated with the device. Individual mode values are USBIBMTT, USBIBMHID, SNAPI, SSI_SERIAL, USBOPOS, NIXMODB and SSI_BT.

<prop name="NcrBeepOnceScanTonePattern" type="String" value="10"/>

The NcrBeepOnceScanTonePattern property defines the NCR single beep tone pattern. The value represents the id of the tone pattern defined in the Beep Tone Value section.

<prop name="NcrEnableBeepScanTonePattern" type="String" value="10"/>

                                                    

The NcrEnableBeepScanTonePattern property defines the NCR Enable Scan beep tone pattern. The value represents the id of the tone pattern defined in the Beep Tone Value section.

<prop name="NcrDisableBeepScanTonePattern" type="String" value="10"/>

The NcrDisableBeepScanTonePattern property defines the NCR Disable Scan beep tone pattern. The value represents the id of the tone pattern defined in the Beep Tone Value section.

<prop name="DioScannerNotOnFile" type="String" value="12"/>

The DioScannerNotOnFile property defines the Direct IO Not on File beep tone pattern. The value represents the id of the tone pattern defined in the Beep Tone Value section.

<prop name="DioScannerDioNof" type="String" value="12"/>

The DioScannerDioNof property defines the Direct IO NoF beep tone pattern. The value represents the id of the tone pattern defined in the Beep Tone Value section.

<prop name="ScanDataLabelId" type="String" value="9999"/>

The ScanDataLabelId property will append/prepend data based on the label ID. Supported values:

• IBM_LABEL = 0 (Leave IBM Label ID)
• NCR_LABEL = 1 (Convert to NCR Label ID)
• NO_LABEL = 2 (Remove Label ID)
• NCR_1D_ONLY = 3 (Convert to NCR Label ID for 1D barcode only)
• NCR_2D_ONLY = 4 (Convert to NCR Label ID for 2D barcode only)
• ZEBRA_LABEL = 9999 (Zebra default behavior)

<prop name="ReportMissingScannersOnEnable" type="String" value="0"/>

The ReportMissingScannersOnEnable property controls whether an exception is generated when a scanner that was connected during the Open command execution becomes unavailable during the Device Enable command execution. When this value is set to 0 (default), no exception will be raised if a scanner becomes unavailable. When this value is set to 1, an exception will be raised if a scanner becomes unavailable.

<prop name="ScannerHotSwap" type="String" value="0"/>

The ScannerHotSwap property controls whether JPOS accepts a scanner that is plugged in after the Open → Claim → Device Enable (hereafter referred to as OCE) process. When this value = 0 (default), only scanners that have completed OCE are accepted. When this value = 1, scanners that have not followed OCE are also accepted, if its host mode matches a logical device that has already completed OCE.

NOTE: This property is supported from Zebra Scanner SDK v3.07.0012 onwards.

NOTE: Remember to disable the ReportMissingScannersOnEnable property when enabling ScannerHotSwap.

Scale Profile Settings

<prop name="LiveWeightFrequency" type="String" value="500"/>

The LiveWeightFrequency property defines the live weight reporting rate in milliseconds.

<prop name="SyncReadWeightOnZeroTimeout" type="String" value="False"/>

The SyncReadWeightOnZeroTimeout property enable/disable the ReadWeight timeout value.

<prop name="NcrScaleReadWeightTimeout" type="String" value="300"/>

The NcrScaleReadWeightTimeout property defines the read weight timeout for the NCR ReadWeight Direct IO command in milliseconds.

<prop name="ErrorCode" type="String" value="114"/>

The ErrorCode property defines the error code value for the ReadWeight command.

The following entries define the string return values for NCR ResultCodeExtended (JPOS_E_EXTENDED) responses:

<prop name="ExtErrorOverWeight" type="String" value="201"/>

JPOS_ESCAL_OVERWEIGHT—the weight was over MaximumWeight.

<prop name="ExtErrorUnderZero" type="String" value="202"/>

NCR_ESCAL_UNDERZERO—the scale is reading less than zero weight.

<prop name="ExtErrorNonStableWeight" type="String" value="203"/>

NCR_ESCAL_UNSTABLE—the scale reading is not stable.

<prop name="ExtErrorStableZeroWeight" type="String" value="204"/>

NCR_ESCAL_ZEROWEIGHT—the scale is not registering a weight.

Supported Feature Set

Properties

Table 1: Common Properties

Table 2: Scanner Specific Properties

Table 3: Scale Specific Properties

Methods

Table 4: Common Methods

Table 5: Scale Specific Methods

Zero Scale Operation

The weight reading of the scale can be set to zero by performing the Zero Scale operation. Once performed, the reading is set to Zero.

• The range of values is 0-60 (default is 60)
• In Lbs mode: 0 = 0.00 lb - 60 = 0.60 lb (increments of 0.01 lbs)
• In Kgs mode: 0 = 0.00 kg - 60 = 0.300 kg (increments of 0.005 kg)

Events

Table 6: Events

Overview

The Zebra Scanner JPOS Driver suite ships with a sample application that demonstrates all the JPOS operations on connected Zebra scanner and scale devices.

JPOS Sample Application (JPOS Test Utility)

The JPOS Test Utility allows you to simulate an application communicating with the Zebra Scanner JPOS Driver. This utility displays scanner and scale data received from the devices through the Zebra Scanner SDK. Zebra Scanner SDK includes source code for this Java test utility.

Multi-instance Support through JPOS

Multiple instances of the scanners can be maintained with JPOS driver for Windows/Linux. The instances can be of the same logical name or different logical names. The JPOS commands can be executed on selected scanners based on the configuration set in the JPOS xml. Details on setting the configuration is explained in the table given below. Addition of a new instance is performed by clicking on the 'Add Scanner' button. Currently, support is given to maintain only one instance of Scale through the utility.

Figure 2: Design Architecture of JPOS Multi-instance Support

Table 7: Specific Scanner selection to initiate Communication in JPOS

For better clarity, an excerpt of the JPOS xml is provided below.

<JposEntry logicalName="ZebraAllScanners">
    <creation factoryClass="com.zebra.jpos.service.scanner.SymScannerSvc112Factory" serviceClass="com.zebra.jpos.service.scanner.SymScannerSvc112"/>
    <vendor name="Zebra Technologies" url=https://www.zebra.com/>
    <jpos category="Scanner" version="1.12"/>
    <product description="Zebra Serial/USB Scanner" name="Zebra Scanner" url=https://www.zebra.com/>
    <prop name="ScannerType" value="ALL"/>
    <prop name="ScannerModel" value=""/>
    <prop name="SerialNumber" value=""/>
    <prop name="ExclusiveClaimLevel" value="0" />
    <prop name="NcrBeepOnceScanTonePattern" type="String" value="10"/>
    <prop name="NcrEnableBeepScanTonePattern" type="String" value="10"/>
    <prop name="NcrDisableBeepScanTonePattern" type="String" value="10"/>
    <prop name="DioScannerNotOnFile" type="String" value="7"/>
    <prop name="DioScannerDioNof" type="String" value="7"/>
    <prop name="ScanDataLabelId" type="String" value="9999"/>
    <prop name="ResetTimeout" type="String" value="30000"/>
</JposEntry>

JPOS Test Utility Scanner Functionality

Figure 3: Scanner JPOS Test Window

Table 8: Scanner JPOS Test Utility Button/Field/Checkbox Functionality

Viewing Bar Code Data

To view bar code data using the Scanner JPOS Test Utility:

1. Scan the USB (IBM Hand-held) bar code, SNAPI bar code or Wincor-Nixdorf RS-232 Mode B bar code on Scanner Configuration Bar Codes to configure the scanner for the correct communication protocol.
2. Launching the sample application.
   1. Windows - run C:\Program Files\Zebra Technologies\Barcode Scanners\Scanner SDK\JPOS\Sample Applications\bin\JPOSTest.bat to launch the Scanner JPOS Test Utility.

   2. Linux - execute the following commands to launch the JPOS Sample Application in Linux.

      
      cd /usr/share/zebra-scanner/samples/jpos-sample-app
      ./jpos-sample-app.sh
      
      

3. Select Open after entering the logical name.
4. Select Claim.
5. Select Device Enable.
6. Select Data Events.
7. Select Decode Data.

8. Scan the following sample bar code:

   
   

9. The bar code data the driver processed appears in the Scan Data Type and Scan Data Label boxes.

   Figure 4: Scanner JPOS Test Window - Scan Data
   
   
10. Select Clear Input to clear the data from the Scan Data Type and Scan Data Label boxes.
11. To perform a second test, scan another bar code.

Return Value

When calling any method, check whether the return value is 0 (=JPOS_SUCCESS) to ensure the method is successful. Otherwise it returns an error code, which indicates the reason for the error.

JPOS Test Utility Scale Functionality

Figure 5: Scale JPOS Test Scale Window

Table 9: Scale JPOS Test Utility Button/Field/Checkbox Functionality

Read Weight Error and Status Codes

Error Codes and Extended Error Codes

JPOS reports scale statuses as JposException Error code and the default values for each states are as follows.

Table 10: Scale Read Weight Error Codes

Both the Error Code and the Extended Error Code are reported in the same exception. Error Code value is common and the Extended Error Code is unique for each scenario.

The values of the ErrorCode and the Extended Error Codes can be changed from the JPOS.xml by updating the following property values.

<prop name="ErrorCode" type="String" value="114"/>
<prop name="ExtErrorOverWeight" type="String" value="201"/>
<prop name="ExtErrorUnderZero" type="String" value="202"/>
<prop name="ExtErrorNonStableWeight" type="String" value="203"/>
<prop name="ExtErrorStableZeroWeight" type="String" value="204"/>

Status Update Events

If the property StatusNotify is true when the scale is enabled, the following StatusUpdateEvent will be generated. Each event is denoted by the tag given in the tag column.

Table 11: Status Update Events

Measuring the Weight of an Item

To view the weight of an item using the JPOS Test utility:

Figure 6: JPOS Test Window - Scale Read Weight

1. Scan an IBM Hand-held, IBM Table-top, SNAPI, or SSI bar code to configure the device for the correct communication protocol.
2. Launching the sample application.
   1. Windows - run C:\Program Files\Zebra Technologies\Barcode Scanners\Scanner SDK\JPOS\Sample Applications\bin\JPOSTest.bat to launch the Scanner JPOS Test Utility.

   2. Linux - execute the following commands to launch the JPOS Sample Application in Linux.

      
      cd /usr/share/zebra-scanner/samples/jpos-sample-app
      ./jpos-sample-app.sh
      
      

3. Enter the scale's logical name, and select Open.
4. Select Claim.
5. Select Device Enable.
6. Place an item on the scale platter.
7. Select the ReadWeight button. The item's weight appears on the adjoining text box.
8. To measure the weight of another item, remove any items on the platter and place the new item on the scale; select the ReadWeight button.
9. Select Release to release the claimed device.
10. Select Close to close the logical device.

How to Create a Sample Application Using NetBeans and Eclipse

Create a Sample Application Using NetBeans

Pre-requisites

• Java 8 (JDK 1.8.0_202) to Java 21.
• NetBeans IDE which corresponds to the installed Java version. (ex: NetBeans IDE 8.2 for Java 8)
• Latest versions of Zebra Scanner SDK and JPOS for Linux.
• Latest versions of Zebra Scanner SDK and JPOS for Windows.

NOTE: The JPOS driver for Linux or Windows supports Java versions starting from Java 1.6 onwards. Therefore, use a suitable version that fits the overall requirements and compatibility needs. At present it supports up to Java 21.

Setting up the Project

1. Make sure the preferred Java version is installed on the system.
2. Open NetBeans and click 'File' → 'New Project'.
3. Select 'Java with Ant' from 'Categories'.

4. Select 'Java Application' from 'Projects' and click 'Next'.

   Figure 7: Create a New Project
   
   

5. Enter ‘Project Name’ and ‘Project Location’ (If required, click ‘Create Main Class’) and click ‘Finish’.

   Figure 8: Select the Application Type
   
   

6. Right click on the created project in the ‘Projects’ pallet and select ‘Properties’.

   Figure 9: Project Properties
   
   
7. Select ‘Libraries’ from ‘Categories’ and navigate to the ‘Compile’ tab.
8. Select ‘Classpath’ in ‘Compile-time Libraries’.

9. Click ‘+’ button and select ‘Add JAR/Folder’.

   Figure 10: Project Dependencies
   
   

   NOTE: Make sure to select the correct Java Platform.

10. Navigate to the location where JPOS binaries are located.

    • Linux- ‘/usr/share/zebra-scanner/javapos/’
    • Windows- ‘C:\Program Files\Zebra Technologies\Barcode Scanners\Scanner SDK\JPOS’

11. Add the JAR files listed below from the specified locations in Table 1 at the Appendix section.

    • JposLogger.jar
    • JposServiceJniScale.jar
    • JposServiceJniScanner.jar
    • JposServiceOnScale.jar
    • JposServiceOnScanner.jar
    • JposServiceScale.jar
    • JposServiceScanner.jar
    • javaPOS114.jar
    • xercesImpl.jar
    • xml-apis.jar
    Figure 11: Project Dependencies Added
    
    
12. Then click ‘Run’ option from ‘Categories palette.
13. If the ‘Main Class’ is not selected, then browse and select ‘Main class’ of the project.

14. Make sure to add’ DJava’ path inside the ‘VM Options’ box to specify the path to native libraries.

    For Linux:

    
    -Djava.library.path="/usr/lib/zebra-scanner/javapos/jni "
    -Djava.library.path="/usr/lib/zebra-scanner/javapos/jni:/usr/lib/jni "
    
    

    Figure 12: Project Properties on Linux
    
    

    For Windows:

    
    -Djava.library.path="C:\Program Files\Zebra Technologies\Barcode Scanners\Scanner SDK\JPOS\bin"
    
    

    Figure 13: Project Properties on Windows
    
    
15. Click ‘OK’ button.

16. Select ‘Source Packages’ in the ‘Projects’ pallet and paste below files under the ‘Source Packages’ from the given location.

    For Linux

    • jpos_trace.properties (/usr/share/zebra-scanner/javapos/config)
    • jpos.xml (/usr/share/zebra-scanner/javapos/xml)
    
    

    For Windows

    • jpos_trace.properties (C:\Program Files\Zebra Technologies\Barcode Scanners\Scanner SDK\JPOS\bin\jpos_trace.properties)
    • jpos.xml (C:\Program Files\Zebra Technologies\Barcode Scanners\Scanner SDK\JPOS\Sample Applications\bin\jpos.xml)
    
    

17. Click on the ‘Run Project’ button and run the application.

    Figure 14: Project Execution
    
    

Create a Sample Application Using Eclipse

Pre-requisites

• Java 8 (JDK 1.8.0_202) to Java 21.
• Eclipse IDE which corresponds to the installed Java version . (ex: Eclipse 2024-12 (4.34))
• Latest versions of Zebra Scanner SDK and JPOS for Linux.
• Latest versions of Zebra Scanner SDK and JPOS for Windows.

NOTE: The JPOS driver for Linux or Windows supports Java versions starting from Java 1.6 onwards. Therefore, use a suitable version that fits the overall requirements and compatibility needs. At present it supports up to Java 21.

Setting up the Project

1. Make sure the preferred Java version is installed on the system.
2. Open Eclipse and click ‘File’ -> ‘New’ -> ‘Java Project’.

3. Enter ‘Project Name’ and ‘Project Location’ (or the default location).

   Figure 15: Create a new Project in Eclipse
   
   

   NOTE: Make sure to select the correct Java Platform in ‘Use and execution environment JRE’.

4. Click 'Finish'.

5. Right click on the created project in the ‘Projects Explorer’ and select ‘Properties’.

   Figure 16: Project Properties
   
   
6. Select ‘Libraries’ tab from ‘Java Build Path’,

7. Select ‘Classpath’ and click ‘Add External JARs’ button.

   Figure 17: Project Dependencies
   
   

8. Navigate to the location where JPOS binaries are located.

   • Linux- ‘/usr/share/zebra-scanner/javapos/’
   • Windows- ‘C:\Program Files\Zebra Technologies\Barcode Scanners\Scanner SDK\JPOS’

9. Add each of the JAR files below from the specific location.

   • JposLogger.jar
   • JposServiceJniScale.jar
   • JposServiceJniScanner.jar
   • JposServiceOnScale.jar
   • JposServiceOnScanner.jar
   • JposServiceScale.jar
   • JposServiceScanner.jar
   • javaPOS114.jar
   • xercesImpl.jar
   • xml-apis.jar
   Figure 18: Project Properties
   
   
10. Click ‘Apply and Close’.
11. Right click on the project from ‘Project Explorer’ palette.

12. Navigate to ‘Run As’ and select ‘Run Configuration’ from the drop-down list.

    Figure 20: Project Workspace
    
    
13. Double click on ‘Java Application’ to create a new configuration.

14. Select ‘Main’ tab and browse for the project.

    Figure 19: Project Configuration
    
    

15. If ‘Main class’ is not selected, browse and select main class of the project.

    Figure 21: Project Type Selection
    
    

16. Tick the check boxes as shown in the figure below if required.

    Figure 22: Project Configuration Execution
    
    

17. Select ‘Arguments’ tab and inside the VM arguments box, add ‘DJava’ path to specify the path to native libraries.

    For Linux:

    
    -Djava.library.path="/usr/lib/zebra-scanner/javapos/jni "
    -Djava.library.path="/usr/lib/zebra-scanner/javapos/jni:/usr/lib/jni "
    
    

    Figure 23: Project Configuration on Linux
    
    

    For Windows:

    
    -Djava.library.path="C:\Program Files\Zebra Technologies\Barcode Scanners\Scanner SDK\JPOS\bin"
    
    

    Figure 24: Project Configuration on Windows
    
    
18. Apply the changes and close the window.
19. Select ‘Src’ of the project from the ‘Package Explorer’.

20. Locate the following configuration files from the given locations and copy and paste the files under the Source Packages.

    For Linux:

    • jpos_trace.properties (/usr/share/zebra-scanner/javapos/config)
    • jpos.xml (/usr/share/zebra-scanner/javapos/xml)

    For windows:

    • jpos_trace.properties (C:\Program Files\Zebra Technologies\Barcode Scanners\Scanner SDK\JPOS\bin\jpos_trace.properties)
    • jpos.xml (C:\Program Files\Zebra Technologies\Barcode Scanners\Scanner SDK\JPOS\Sample Applications\bin\jpos.xml)
    Figure 25: Source Packages
    
    

21. Click on the ‘Run’ button and run the application.

    Figure 26: Sample Application Execution
    
    

Overview

Through the DirectIO feature a POS application communicates directly with the underlying CoreScanner Service.

This method provides a means for a UnifiedPOS Service to provide functionality to the application that is not otherwise supported by UnifiedPOS control for its device category.

Information in this chapter is applicable to both scanner and scale devices.

DirectIO Java Package

The necessary classes to perform DirectIO are contained in the JposService.jar file under the two namespaces:

• com.zebra.jpos.service
• com.zebra.jpos.service.directio

The package com.zebra.jpos.service contains the DirectIO method, while the package com.zebra.jpos.service.directio contains the supporting classes to leverage the DirectIO method.

Zebra JPOS Direct IO implementation is similar to the Scanner SDK.

The directio package contains the following supporting class:

• DirectIOCommand

DirectIO Command

public class DirectIOCommand {

    // Common for Scanner and Scale
    public static final int DIO_GET_SCANNERS = 1;
    @Deprecated
    public static final int GET_SCANNERS = DIO_GET_SCANNERS;
    public static final int DIO_RSM_ATTR_GETALL = 0x1388;                       // 5000
    @Deprecated
    public static final int RSM_ATTR_GETALL = DIO_RSM_ATTR_GETALL;
    public static final int DIO_RSM_ATTR_GET = 0x1389;                          // 5001
    @Deprecated
    public static final int RSM_ATTR_GET = DIO_RSM_ATTR_GET;
    public static final int DIO_RSM_ATTR_GETNEXT = 0x138A;                      // 5002
    @Deprecated
    public static final int RSM_ATTR_GETNEXT = DIO_RSM_ATTR_GETNEXT;
    public static final int DIO_RSM_ATTR_SET = 0x138C;                          // 5004
    @Deprecated
    public static final int RSM_ATTR_SET = DIO_RSM_ATTR_SET;
    public static final int DIO_RSM_ATTR_STORE = 0x138D;                        // 5005
    @Deprecated
    public static final int RSM_ATTR_STORE = DIO_RSM_ATTR_STORE;
    public static final int DIO_RTA_GET_SUPPORTED = 0x157C;                     // 5500
    @Deprecated
    public static final int CMD_RTA_SUPPORTED_GET = DIO_RTA_GET_SUPPORTED;
    public static final int DIO_RTA_UNREGISTER = 0x157E;                        // 5502
    @Deprecated
    public static final int CMD_RTA_UNREGISTER = DIO_RTA_UNREGISTER;
    public static final int DIO_RTA_GET_EVENT_STATUS = 0x157F;                  // 5503
    @Deprecated
    public static final int CMD_RTA_ALERT_STATUS_GET = DIO_RTA_GET_EVENT_STATUS;
    public static final int DIO_RTA_SET_EVENT_STATUS = 0x1580;                  // 5504
    @Deprecated
    public static final int CMD_RTA_ALERT_STATUS_SET = DIO_RTA_SET_EVENT_STATUS;
    public static final int DIO_RTA_SUSPEND = 0x1581;                           // 5505
    @Deprecated
    public static final int CMD_RTA_SUSPEND = DIO_RTA_SUSPEND;
    public static final int DIO_RTA_GETSTATE = 0x1582;                          // 5506
    @Deprecated
    public static final int CMD_RTA_STATE = DIO_RTA_GETSTATE;
    public static final int DIO_SCANNER_LOAD_CONFIG = 0x139C;                   // 5020
    @Deprecated
    public static final int CMD_LOAD_CONFIGURATION = DIO_SCANNER_LOAD_CONFIG;

    // Scanner Specific
    public static final int DIO_SCANNER_UPDATE_FW_DAT = 0x1398;                 // 5016
    @Deprecated
    public static final int CMD_DEVICE_UPDATE_FIRMWARE_DAT = DIO_SCANNER_UPDATE_FW_DAT;
    public static final int DIO_SCANNER_UPDATE_FW_PLUGIN = 0x1399;              // 5017
    @Deprecated
    public static final int CMD_DEVICE_UPDATE_FIRMWARE_FROM_PLUGIN = DIO_SCANNER_UPDATE_FW_PLUGIN;

    // NCR Scanner
    public static final int NCR_DIO_SCANNER_TONE = 0x01F5;                      // 501
    @Deprecated
    public static final int DIO_NCR_SCAN_TONE = NCR_DIO_SCANNER_TONE;
    public static final int NCR_DIO_SCANNER_RESET = 0x1F6;                      // 502
    @Deprecated
    public static final int NCRDIO_SCAN_RESET = NCR_DIO_SCANNER_RESET;
    public static final int NCR_DIO_SCANNER_STATUS = 0x1F7;                     // 503
    @Deprecated
    public static final int NCRDIO_SCAN_STATUS = NCR_DIO_SCANNER_STATUS;
    public static final int NCR_DIO_SCANNER_DIRECT = 0x1FB;                     // 507
    @Deprecated
    public static final int NCRDIO_SCAN_DIRECT = NCR_DIO_SCANNER_DIRECT;
    public static final int NCR_DIO_SCANNER_NOT_ON_FILE = 0x01FC;               // 508
    @Deprecated
    public static final int DIO_NCR_SCANNER_NOF = NCR_DIO_SCANNER_NOT_ON_FILE;

    // NCR Scale
    public static final int NCR_DIO_SCALE_STATUS = 0x259;                       // 601
    @Deprecated
    public static final int NCRDIO_SCAL_STATUS = NCR_DIO_SCALE_STATUS;
    public static final int NCR_DIO_SCALE_LIVE_WEIGHT = 0x25C;                  // 604
    @Deprecated
    public static final int NCR_DIO_SCAL_LIVE_WEIGHT = NCR_DIO_SCALE_LIVE_WEIGHT;
    public static final int NCR_DIO_SCALE_DIRECT = 0x25D;                       // 605
    @Deprecated
    public static final int NCRDIO_SCAL_DIRECT = NCR_DIO_SCALE_DIRECT;
}

DIO_GET_SCANNERS (GET_SCANNERS)

This command must be used first when setting up DirectIO. It updates the OutXml parameter with information for available scanners, and returns ScannerIDs used in all other DirectIO calls.

InOutXml: This contains the raw XML string of all of the connected scanners in the format:

<scanners>
    <scanner type="mode">
        <scannerID>id1</scannerID>
        <serialnumber>serial_number</serialnumber>
        <GUID>S_N:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX</GUID>
        <VID>vendor_id</VID>
        <PID>product_id</PID>
        <modelnumber>model_number</modelnumber>
        <DoM>date_of_manufacture</DoM>
        <firmware>firmare_revision</firmware>
    </scanner>
    <scanner type="mode">
        <scannerID>id2</scannerID>
        <serialnumber>serial_number</serialnumber>
        <GUID>S_N:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX</GUID>
        <VID>vendor_id</VID>
        <PID>product_id</PID>
        <modelnumber>model_number</modelnumber>
        <DoM>date_of_manufacture</DoM>
        <firmware>firmare_revision</firmware>
    </scanner>
    ....
    ....
    <scanner type="mode">
        <scannerID>idN</scannerID>
        <serialnumber>serial_number</serialnumber>
        <GUID>S_N:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX</GUID>
        <VID>vendor_id</VID>
        <PID>product_id</PID>
        <modelnumber>model_number</modelnumber>
        <DoM>date_of_manufacture</DoM>
        <firmware>firmware_revision</firmware>
    </scanner>
</scanners>

DIO_RSM_ATTR_GETALL (RSM_ATTR_GETALL)

This command returns a list in XML format via the object argument, defined above, of all possible attributes that can be set. This list and what it contains is dependent on the scanning device. The scanner specific Product Reference Guide contains the definitions of all of these attributes. The XML string returned in the obj argument has the following format:

InOutXml: This contains the raw XML string of all the supported RSM attributes:

<?xml version="1.0" encoding="UTF-8"?>
<outArgs>
    <scannerID>1</scannerID>
    <arg-xml>
        <modelnumber>DS4801-XXXXXXXXXXX</modelnumber>
        <serialnumber>S/N:B1353E3FBA73C94DB3449420F6F3B3FD</serialnumber>
        <GUID>B1353E3FBA73C94DB3449420F6F3B3FD</GUID>
        <response>
            <opcode>5000</opcode>
            <attrib_list>
                <attribute name="">0</attribute>
                <attribute name="">1</attribute>
                <attribute name="">2</attribute>
                <attribute name="">3</attribute>
                <attribute name="">4</attribute>
                ....
                ....
                <attribute name="">25011</attribute>
                <attribute name="">25012</attribute>
            </attrib_list>
        </response>
    </arg-xml>
</outArgs>

The value of each attribute in the returned XML list can be accessed using the DIO_RSM_ATTR_GET (RSM_ATTR_GET) command.

NOTE: Calling this is not necessary if the attributes you wish to SET, or GET are known ahead of time.

DIO_RSM_ATTR_GET (RSM_ATTR_GET)

This command can be used to retrieve scanner attribute information including value, data type, and permission. For more information, refer to the Zebra Scanner SDK for Windows Developer's Guide.

InOutXml: For this command InOutXml argument is used to provide input and retrieve the output of the command.

InXML:

<inArgs>
    <scannerID>scannerID</scannerID>
    <!-- ScannerID of one of the scanners which could be retrieved by executing DIO_GET_SCANNERS (GET_SCANNERS) Direct IO command -->
    <cmdArgs>
        <arg-xml>
            <attrib_list> attribute1[,attribute2…attributeN]</attrib_list>
            <!-- A comma separated list of scanner attribute numbers -->
        </arg-xml>
    </cmdArgs>
</inArgs>

OutXML:

<outArgs>
    <scannerID>1</scannerID>
    <arg-xml>
        <modelnumber>DS4801-XXXXXXXXXXX</modelnumber>
        <serialnumber>S/N:B1353E3FBA73C94DB3449420F6F3B3FD</serialnumber>
        <GUID>B1353E3FBA73C94DB3449420F6F3B3FD</GUID>
        <response>
            <opcode>5001</opcode>
            <attrib_list>
                <attribute>
                    <id> attribute1</id>
                    <name></name>
                    <datatype>F</datatype>
                    <permission>RWP</permission>
                    <value>True</value>
                </attribute>
                ....
                ....
                <attribute>
                    <id> attributeN</id>
                    <name></name>
                    <datatype>F</datatype>
                    <permission>RWP</permission>
                    <value>True</value>
                </attribute>
            </attrib_list>
        </response>
    </arg-xml>
</outArgs>

DIO_RSM_ATTR_GETNEXT (RSM_ATTR_GETNEXT)

This will retrieve the value of the next available attribute of the given attribute number.

InOutXml: For this command InOutXml argument is used to provide input and retrieve the output of the command.

InXML:

<inArgs>
    <scannerID>1</scannerID>
    <cmdArgs>
        <arg-xml>
            <attrib_list>1</attrib_list>
        </arg-xml>
    </cmdArgs>
</inArgs>

OutXML:

<?xml version="1.0" encoding="UTF-8"?>
<outArgs>
    <scannerID>1</scannerID>
    <arg-xml>
        <modelnumber>MP7001-LNS0C00AU</modelnumber>
        <serialnumber>22351010553559</serialnumber>
        <GUID>22351010553559</GUID>
        <configname>Modified</configname>
        <response>
            <opcode>5002</opcode>
            <attrib_list>
                <attribute>
                    <id>2</id>
                    <name></name>
                    <datatype>F</datatype>
                    <permission>RWP</permission>
                    <value>True</value>
                </attribute>
            </attrib_list>
        </response>
    </arg-xml>
</outArgs>

DIO_RSM_ATTR_SET (RSM_ATTR_SET) / DIO_RSM_ATTR_STORE (RSM_ATTR_STORE)

Sets (volatile, cleared after device reboot) or stores (non-volatile, retained after device reboot) attributes respectively, specified in the XML string given in the obj argument. The XML string takes the following format.

InOutXml: For this command using InOutXml argument we could provide the information for the attribute to set in XML format

NOTE: The tabbed formatting is for brevity only, and the actual XML string has no end-line or carriage-return characters required.

<inArgs>
    <scannerID>1</scannerID>
    <cmdArgs>
        <arg-xml>
            <attrib_list>
                <attribute>
                    <id>rsm_attribute_number</id>
                    <!-- 7 -->
                    <datatype>valid_datatype</datatype>
                    <!-- F -->
                    <value>value_matching_datatype</value>
                    <!-- True -->
                </attribute>
            </attrib_list>
        </arg-xml>
    </cmdArgs>
</inArgs>

The following are the valid values:

• rsm_attribute_number: One of the scanners accepted, writeable attributes numbers.
• valid_datatype: A valid datatype character: F, B, W, D, A, S
• value_matching_datatype: A value that is consistent with the datatype and the datatypes range. For example, 'F' is a 'Boolean' value that may be either 'false' or 'true'. A 'B' datatype is 'Byte' which ranges from 0-255.

For example, to disable UPC Code 128, the actual XML string passed into the obj argument would look this:

<inArgs>
    <scannerID>1</scannerID>
    <cmdArgs>
        <arg-xml>
            <attrib_list>
                <attribute>
                    <id>7</id>
                    <datatype>F</datatype>
                    <value>False</value>
                </attribute>
            </attrib_list>
        </arg-xml>
    </cmdArgs>
</inArgs>

DIO_SCANNER_LOAD_CONFIG (CMD_LOAD_CONFIGURATION)

This command can be used to update the scanner configuration by specifying the relevant scannerID and the absolute file path, including the filename, created using 123Scan (.scncfg).

InXML:

<inArgs> 
    <scannerID>1</scannerID> 
    <cmdArgs> 
        <arg-string>C:\DS8108 Config.scncfg</arg-string> 
    </cmdArgs> 
</inArgs>

OutXML: None. Instead of OutXml, DirectIO events with the following event types will be received.

• CONFIG_LOAD_START = 17
• CONFIG_LOAD_PROGRESS = 18
• CONFIG_LOAD_END = 19

Possible error scenarios are outlined below.

DIO_SCANNER_UPDATE_FW_PLUGIN (CMD_DEVICE_UPDATE_FIRMWARE_FROM_PLUGIN) / DIO_SCANNER_UPDATE_FW_DAT (CMD_DEVICE_UPDATE_FIRMWARE_DAT)

This command can be used to update the scanner firmware by specifying the relevant scannerID and the absolute path of the firmware file (PLUGIN or DAT), including the filename.

InXML:

<inArgs> 
    <scannerID>1</scannerID> 
    <cmdArgs> 
        <arg-string>C:\DS3678-STANDARD.SCNPLG</arg-string> 
    <arg-int>2</arg-int> 
    </cmdArgs> 
</inArgs>

OutXML: None. Instead of OutXml, DirectIO events with the following event types will be received.

• SCANNER_UF_SESS_START = 11
• SCANNER_UF_DL_START = 12
• SCANNER_UF_DL_PROGRESS= 13
• SCANNER_UF_DL_END= 14
• SCANNER_UF_SESS_END= 15
• SCANNER_UF_STATUS= 16

Possible error scenarios are outlined below.

NCR_DIO_SCANNER_TONE (DIO_NCR_SCAN_TONE)

This command is used to execute the NCR tone pattern configured in the JPOS.xml. Tone pattern can be set for any logical device by setting the following configuration.

<prop name="NcrScanTonePattern" type="String" value="<TonePatternID>"/>

InOutXml: No need of providing an InOutXml argument.

NCR_DIO_SCANNER_NOT_ON_FILE (DIO_NCR_SCANNER_NOF)

This command is used to execute the NCR “Not on File” tone pattern configured in the JPOS.xml. Tone pattern can be set for any logical device by setting the following configuration.

<prop name="NcrScanNOFPattern" type="String" value="<TonePatternID>"/>

InOutXml: No need of providing an InOutXml argument.

NCR_DIO_SCANNER_RESET (NCRDIO_SCAN_RESET)

This command is used to reset the device. Executing this command is not doing any change to the device now. Once executed it always returns success.

InOutXml: No need of providing an InOutXml argument.

NCR_DIO_SCANNER_STATUS (NCRDIO_SCAN_STATUS)

This command is used to get the IBM USB status bytes of the scanner. Status bytes are given as a string.

InOutXml: No need of providing an InOutXml argument.

NCR_DIO_SCANNER_DIRECT (NCRDIO_SCAN_DIRECT)

This command is used to execute direct IO commands GetAll, Get, GetNext, Set and Store attributes directly without the corresponding direct IO commands for these operations. Direct IO OpCode for these operations are passed as an attribute in the InXml.

InOutXml: This contains the raw XML string of direct access in xml with the opcode tag.

<inArgs>
    <scannerID>1</scannerID>
    <opcode>5000</opcode>
    <cmdArgs>
        <arg-xml>
            <attrib_list>
                <attribute>
                    <id>6000</id>
                    <datatype>X</datatype>
                    <value>2</value>
                </attribute>
            </attrib_list>
        </arg-xml>
    </cmdArgs>
</inArgs>

NCR_DIO_SCALE_LIVE_WEIGHT (NCR_DIO_SCAL_LIVE_WEIGHT)

This command is used to get the live weight value of the scale.

InOutXml: No need of providing an InOutXml argument.

NCR_DIO_SCALE_STATUS (NCRDIO_SCAL_STATUS)

This command is used to get the IBM USB status bytes of the scale. Status bytes are given as a string.

InOutXml: No need of providing an InOutXml argument.

NCR_DIO_SCALE_DIRECT (NCRDIO_SCAL_DIRECT)

This command is used to execute direct IO commands GetAll, Get, GetNext, Set and Store attributes directly without the corresponding direct IO commands for these operations. Direct IO OpCode for these operations are passed as an attribute in the InXml.

InOutXml: This contains the raw XML string of direct access in xml with the opcode tag.

<inArgs>
    <scannerID>1</scannerID>
    <opcode>5000</opcode>
    <cmdArgs>
        <arg-xml>
            <attrib_list>
                <attribute>
                    <id>6000</id>
                    <datatype>X</datatype>
                    <value>2</value>
                </attribute>
            </attrib_list>
        </arg-xml>
    </cmdArgs>
</inArgs>

Real Time Alerts (RTA)

Real Time Alerts (RTA) are preselected events that are monitored by a scanner device. When a selected statistic has reached a specified value or when a selected event occurs, it is then reported by the scanner device to the host as an alert.

For more information, see Real Time Alerts (RTA) User Guide

The JPOS driver uses DirectIO commands to invoke Real-Time Alerts (RTA) methods on the scanner or cradle device and utilizes DirectIO events to receive notifications when an RTA event is triggered by the scanner. Because the Zebra JPOS Service Object automatically registers for CoreScanner notification events during the initial Open call, the host application does not need to perform manual registration to receive RTA events.

DIO_RTA_GET_SUPPORTED (OPCODE - 5500)

Gets RTA events supported by the device.

InXML:

<inArgs>
    <scannerID>1</scannerID>
</inArgs>

OutXML:

Supported RTA events (ID and Stat type) along with on-limit and off-limit.

NOTE: On-limit/ Off-limit with "Not set" requires the value to be set when registering, and "Not applicable" doesn't require a value to be set.

<?xml version="1.0" encoding="UTF-8"?>
<outArgs>
    <scannerID>1</scannerID>
    <arg-xml>
        <modelnumber>CR8178-PCM00FBWW</modelnumber>
        <serialnumber>23117010558099</serialnumber>
        <GUID>B2887932D8F09D40880BFAE7AD61A8BA</GUID>
        <configname>Modified</configname>
        <response>
            <opcode>5500</opcode>
            <rtaevent_list>
                <rtaevent>
                    <id>38004</id>
                    <stat>7</stat>
                    <onlimit>Not set</onlimit>
                    <offlimit>Not applicable</offlimit>
                </rtaevent>
                <rtaevent>
                    <id>38001</id>
                    <stat>7</stat>
                    <onlimit>Not set</onlimit>
                    <offlimit>Not applicable</offlimit>
                </rtaevent>
                <rtaevent>
                    <id>38003</id>
                    <stat>13</stat>
                    <onlimit>Not applicable</onlimit>
                    <offlimit>Not applicable</offlimit>
                </rtaevent>
                <rtaevent>
                    <id>616</id>
                    <stat>2</stat>
                    <onlimit>Not applicable</onlimit>
                    <offlimit>Not applicable</offlimit>
                </rtaevent>
            </rtaevent_list>
        </response>
    </arg-xml>
</outArgs>

DIO_RTA_UNREGISTER (OPCODE - 5502)

Unregister for selected RTA events using RTA event ID and type.

InXML:

<inArgs>
    <scannerID>1</scannerID>
    <cmdArgs>
        <arg-xml>
            <rtaevent_list>
                <rtaevent>
                    <id>38004</id>
                    <stat>7</stat>
                </rtaevent>
                <rtaevent>
                    <id>38001</id>
                    <stat>7</stat>
                </rtaevent>
            </rtaevent_list>
        </arg-xml>
    </cmdArgs>
</inArgs>

OutXML:

Null

DIO_RTA_GET_EVENT_STATUS (OPCODE - 5503)

Retrieve the RTA event's alert status. The RTA alert status contains information on the following four statuses:

• Registered: Whether the event is registered or not.
• Reported: An alert associated with the event has been reported.
• Measuring: Device has started measurement of the event.
• Initialized: Device has initialized the event.

InXML:

<inArgs>
    <scannerID>1</scannerID>
</inArgs>

OutXML:

<outArgs>
    <scannerID>1</scannerID>
    <arg-xml>
        <modelnumber>CR8178-PC100F4WW  </modelnumber>
        <serialnumber>17034010506402  </serialnumber>
        <GUID>8835E76BE40A6C49B458BEEA0065F60E</GUID>
        <configname>Factory Default </configname>
        <response>
            <opcode>5503</opcode>
            <suspend>FALSE</suspend>
            <rtaevent_list>
                <rtaevent>
                    <id>38004</id>
                    <stat>7</stat>
                    <scope>0</scope>
                    <registered>TRUE</registered>
                    <reported>FALSE</reported>
                    <initialized>TRUE</initialized>
                    <measuring>FALSE</measuring>
                </rtaevent>
                <rtaevent>
                    <id>38001</id>
                    <stat>7</stat>
                    <scope>0</scope>
                    <registered>TRUE</registered>
                    <reported>TRUE</reported>
                    <initialized>TRUE</initialized>
                    <measuring>TRUE</measuring>
                </rtaevent>
            </rtaevent_list>
        </response>
    </arg-xml>
</outArgs>

DIO_RTA_SET_EVENT_STATUS (OPCODE - 5504)

Set RTA event's reported state.

NOTE: Only the <reported> alert status can be modified, and it can only be transitioned from true (1) to false (0). If set to any other value, the system will automatically overwrite it with 0.

InXML:

<inArgs>
    <scannerID>1</scannerID>
    <cmdArgs>
        <arg-xml>
            <rtaevent_list>
                <rtaevent>
                    <id>38004</id>
                    <stat>7</stat>
                    <reported>0</reported>
                </rtaevent>
                <rtaevent>
                    <id>616</id>
                    <stat>2</stat>
                    <reported>0</reported>
                </rtaevent>
            </rtaevent_list>
        </arg-xml>
    </cmdArgs>
</inArgs>

OutXML:

Null

DIO_RTA_SUSPEND (OPCODE - 5505)

Toggle RTA alert notification reporting to the host.

InXML:

<inArgs>
    <scannerID>1</scannerID>
    <cmdArgs>
        <arg-bool>false</arg-bool> <!--"true" will enable RTA to suspend, "false" will disable RTA suspend -->
    </cmdArgs>
</inArgs>

OutXML:

Null

DIO_RTA_GETSTATE (OPCODE - 5506)

Retrieve the current operational state of RTAs. State will have 4 values as follows.

InXML:

<inArgs>
    <scannerID>1</scannerID>
</inArgs>

OutXML:

<outArgs>
    <scannerID>1</scannerID>
    <arg-xml>
        <modelnumber>CR8178-PC100F4WW  </modelnumber>
        <serialnumber>17034010506402  </serialnumber>
        <GUID>8835E76BE40A6C49B458BEEA0065F60E</GUID>
        <configname>Factory Default </configname>
        <response>
            <opcode>5506</opcode>
            <state>0</state>
        </response>
    </arg-xml>
</outArgs>

DirectIO Status

public class DirectIOStatus {
    public static final int STATUS_SUCCESS = 0;
}

Currently only STATUS_SUCCESS is defined. Any other value should be indicated as an error. The DirectIO method itself is an exception based method (see The DirectIO Method for more information). As a result, use a try-catch statement when calling it. The JposException class contains most of the error information.

The DirectIO Methods

The Zebra JPOS driver allows direct RSM attribute GET/SET access in order to leverage features not otherwise able to be exposed through the JPOS API Specification.

The JPOS DirectIO method has the following prototype (as of Zebra JPOS driver 1.0):

directIO ( command: int32, inout data: int32, inout obj: object ): void { raises-exception }

DirectIO Method Arguments

For the purposes of the Zebra scanner device class, the DirectIO method arguments are defined as:

command: int32: The command is passed to the CoreScanner service which is responsible for communicating with the scanner. This command is defined in the JposService.jar.

inout data: int32: For Zebra devices, this is used to return the status of the executed op-code.

inout obj: object: This is an object type. In Zebra JPOS Direct IO implementation, Java StringBuffer type is used to provide input and get output of the argument in XML format. See DirectIO Command.

Using the JPOS Sample Application to Send Direct I/O Commands

DirectIO operations can be done using the panel highlighted in red, as shown in the screenshot given below. The required DirectIO command can be selected from the drop-down list named as the Command. Upon selecting, the InXML relevant to the chosen command will be displayed on the left side of the panel.

Figure 27: JPOS Sample Application - Direct IO Commands

The OutXML: corresponding to the selected DirectIO command can be retrieved by clicking on the Execute button.

Figure 28: JPOS Sample Application - Direct IO Commands Output

To send Direct I/O commands using the JPOS sample application:

1. Connect a Zebra scanner and switch to a management enabled host mode such as IBM OPOS, IBM Hand-held, IBM Table-top, or SNAPI.
2. Open the JPOS sample application and select the Scanner tab.
3. Enter ZebraAllScanners as the logical name and click Open.
4. Click Claim.

To retrieve a list of all the scanners connected to the PC:

• Select DIO_GET_SCANNERS (GET_SCANNERS) as DIO Op-Code from the Direct I/O section.
• Click Execute. The Direct I/O OutXml text box populates with XML with all the attached scanners.

To retrieve all attributes available in the scanner:

1. Select DIO_RSM_ATTR_GETALL (RSM_ATTR_GETALL) as DIO Op-Code from Direct I/O section.
2. In the Direct I/O InXml text box, change the value of the ScannerID XML element to the scannerID from which you want to retrieve attributes. Use the DIO_GET_SCANNERS (GET_SCANNERS) command to find available ScannerIDs.
3. Click Execute. The Direct I/O OutXml text box populates with XML with attribute numbers of all supported attributes.

To retrieve more information for an attribute:

1. Select DIO_RSM_ATTR_GET (RSM_ATTR_GET) as DIO Op-Code from the Direct I/O section.
2. In the Direct I/O InXml text box, change the value of the ScannerID XML element to the required scanner ID, and enter a comma-separated list of attribute numbers as the value of attrib_list.
3. Click Execute. The Direct I/O OutXml text box populates with XML containing a list of attributes with values and other attribute related details.

To temporarily set or permanently store the value of an attribute:

1. Select DIO_RSM_ATTR_SET (RSM_ATTR_SET) or DIO_RSM_ATTR_STORE (RSM_ATTR_STORE) as DIO Op-Code from the Direct I/O section.
2. In the Direct I/O InXml text box, change the value of the ScannerID XML element to the required scanner ID and change the values of data_type and the value XML elements accordingly as obtained by executing the command DIO_RSM_ATTR_GET (RSM_ATTR_GET).
3. Click Execute. For these Direct I/O op-codes, an OutXml does not populate.

Upon executing each Op-Code, the CoreScanner Status field populates with the status of the underlying CoreScanner driver. Any value other than 0 indicates an error.

Using DirectIO

Following is an example of how to use DirectIO when attached to a single device, assuming a returned scanner/scale ID of '1'.

NOTE: The following code demonstrates how to use DirectIO with scanner JPOS control. The same pattern is applicable to scale JPOS control by declaring and instantiating JPOS scale class, and scale object instead of scanner class in the code.

package dio;

import jpos.*;
import com.zebra.jpos.service.directio.DirectIOCommand; 
import com.zebra.jpos.service.directio.DirectIOStatus; 
import java.io.ByteArrayInputStream;
import java.io.IOException; 
import java.util.logging.Level; 
import java.util.logging.Logger;
import javax.xml.parsers.DocumentBuilderFactory; 
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.ParserConfigurationException; 
import org.w3c.dom.Document;
import org.xml.sax.SAXException;

/**
*
* @author Zebra Technologies
*/
public class DirectIODemo {
    // As defined in JPOS v1.13

    public static Scanner scannerObj = new Scanner();
    // Interfacing with a single scanner connection 
    static int scannerID;

    // main function
    public static void main(String[] args) {
        // Open scanner API, claim, enable and perform get scanners 
        try {
            // open with 'ZebraAllScanners' as logical device name 
            scannerObj.open("ZebraAllScanners");
            
            // standard claim with 5000ms timeout 
            scannerObj.claim(5000); 
            
            // enable device
            scannerObj.setDeviceEnabled(true);

            // object to store DirectIO data
            StringBuffer deviceParams = new StringBuffer();

            // get scanners - this acquires the scanner ID needed to perform directIO on a specific device
            int opCode = DirectIOCommand.DIO_GET_SCANNERS; int[] csStatus = new int[1];
            // OR int opCode = DirectIOCommand.GET_SCANNERS; int[] csStatus = new int[1];

            scannerObj.directIO(opCode, csStatus, (Object) deviceParams); 
            if (csStatus[0] != DirectIOStatus.STATUS_SUCCESS) {
                    System.out.println("Error connecting to device"); return;
            }

            // retrieve ID number of scanner for this example, we assume at least 1 scanner is found
            DocumentBuilderFactory dbFactory = DocumentBuilderFactory.newInstance(); 
            DocumentBuilder dBuilder;
            try {
                dBuilder = dbFactory.newDocumentBuilder();
                Document doc;
                ByteArrayInputStream inIs = new ByteArrayInputStream(deviceParams.toString().getBytes());
                doc = dBuilder.parse(inIs);

                int scannerCount = doc.getElementsByTagName("scannerID").getLength();
                if (scannerCount <= 0) {
                    System.out.println("No scanner found attatched"); return;
                }

                for (int n = 0; n < scannerCount; n++) {
                    System.out.println("Scanner ID : " + doc.getElementsByTagName("scannerID").item(n).getTextContent());
                }

                System.out.println("Selected scanner ID : " + doc.getElementsByTagName("scannerID").item(0).getTextContent()); 
                scannerID = Integer.parseInt(doc.getElementsByTagName("scannerID").item(0). getTextContent());
            } 
            catch (SAXException ex) { 
                Logger.getLogger(DirectIODemo.class.getName()).log(Level.SEVERE, null, ex);
            } 
            catch (IOException ex) { 
                Logger.getLogger(DirectIODemo.class.getName()).log(Level.SEVERE, null, ex);
            } 
            catch (ParserConfigurationException ex) { 
                Logger.getLogger(DirectIODemo.class.getName()).log(Level.SEVERE, null, ex);
            }

            // retrieve model number of device

            // Setup DirectIO to do a GET Attribute setup DirectIO XML string
            String sGetAttribInXML = "<inArgs>\n"
                                    + " <scannerID>" + scannerID + "</scannerID>\n"
                                    + " <cmdArgs>\n"
                                    + " <arg-xml>\n"
                                    + " <attrib_list>535</attrib_list>\n"
                                    + " </arg-xml>\n"
                                    + " </cmdArgs>\n"
                                    + "</inArgs>";

            // create new DirectIO data structure see DirectIO data definition for more information 
            StringBuffer oGETparams = new StringBuffer();

            // copy XML string into DirectIO inXML member 
            oGETparams.append(sGetAttribInXML);

            // set opcode for Atrribute GET
            opCode = DirectIOCommand.DIO_RSM_ATTR_GET;
            // OR opCode = DirectIOCommand.RSM_ATTR_GET;

            // set scanner ID
            int[] csSataus = new int[1];

            // make directIO call to JPOS driver 
            scannerObj.directIO(opCode, csSataus, (Object) oGETparams);

            // check status from DirectIO status member
            if (csSataus[0] != DirectIOStatus.STATUS_SUCCESS) { 
                System.out.println("Error performing DirectIO"); return;
            }

            // output XML string returned. Not that the actual model number will be contained within the <value> XML tag.
            System.out.println("XML string returned: " + oGETparams.toString());

            // disable UPC-A barcode on scanner

            // Setup DirectIO to do a SET Attribute 
            String sSetAttribInXML = "<inArgs>\n"
                                    + " <scannerID>" + scannerID + "</scannerID>\n"
                                    + " <cmdArgs>\n"
                                    + " <arg-xml>\n"
                                    + " <attrib_list>\n"
                                    + " <attribute>\n"
                                    + " <id>6000</id>\n"
                                    + " <datatype>X</datatype>\n"
                                    + " <value>2</value>\n"
                                    + " </attribute>\n"
                                    + " </attrib_list>\n"
                                    + " </arg-xml>\n"
                                    + " </cmdArgs>\n"
                                    + "</inArgs>";

            // create new DirectIO data structure
            // see DirectIO data definition for more information 
            StringBuffer oSETparams = new StringBuffer();

            // copy XML string into DirectIO inXML member 
            oSETparams.append(sSetAttribInXML);

            // set opcode for Atrribute SET
            opCode = DirectIOCommand.DIO_RSM_ATTR_SET;
            // OR opCode = DirectIOCommand.RSM_ATTR_SET;

            // set scanner ID
            csSataus[0] = scannerID;

            // make directIO call to JPOS driver 
            scannerObj.directIO(opCode, csSataus, (Object) oSETparams);

            // check status from DirectIO status member
            if (csSataus[0] != DirectIOStatus.STATUS_SUCCESS) { 
                System.out.println("Error performing DirectIO");
            }
        } 
        catch (JposException ex) { 
            System.out.println("Exception: " + ex.getMessage());
        }
    }
}

Overview

Zebra RFID scanners provide flexible data transmission options, allowing you to seamlessly integrate RFID into your existing workflows and easily distinguish between standard barcode scans and RFID tag reads.

RFID Data Transmission Format

Zebra RFID scanners offer built-in RFID data conversion software that reports the tag's EPC data.

• Raw: The EPC buffer transmits a hexadecimal string. This format can include the protocol control bytes.
• GS1-128: For GS1-encoded tags, this option converts EPC data to a GS1-128 barcode (as per the GS1 EPC Tag Data Standard available at gs1.org). Otherwise, the tag optionally transmits in Raw format or is ignored.
• EPC URI: The EPC data is represented as a Universal Resource Identifier (URI) as defined in the EPC Tag Data Standard.

The above format options can be selected using Parameter # 643 (SSI # F1h 83h):

Refer to: https://docs.zebra.com/us/en/scanners/general/ds8-series/ds82-prg/c-rfid-scanning/r-rfid-preferences-parameter-defaults/r-param-desc-rfid-data-transmission-format.html

For more information about additional RFID user preferences parameters, refer to your scanner Product Reference Guide. For example, DS8288 RFID scanner: https://docs.zebra.com/us/en/scanners/general/ds8-series/ds82-prg/c-rfid-scanning/r-rfid-preferences-parameter-defaults.html

JPOS Default RFID Data Code Type

Choose the right communication interface for your environment.

** Utilize simple ADF2 Prefix/Suffix for immediate POS compatibility.

The following tables list the expected JPOS RFID symbology types based on the communication interface selected for the scanner.

RFID Data Transmission Format set to Raw

RFID Data Transmission Format set to EPC URI

RFID Data Transmission Format set to GS1-128

How to Enable JPOS RFID Zebra Code Type Configuration

To enable this feature, add the following property to your logical device's JposEntry block in the jpos.xml configuration file:

<!-- 0 (Default): Disable Zebra-specific symbologies; 1: Enable Zebra-specific symbologies; -->
<prop name="EnableZebraCustomSymbologies" value="0"/>

• When set to 0 (Default): All custom symbologies report as SCAN_SDT_OTHER (501).
• When set to 1: The driver assigns default Zebra values (ranging from 601 to 705) to distinguish between RFID Raw and RFID URI.

Resolving JPOS Zebra Custom Symbology Types in Code

Once EnableZebraCustomSymbologies is enabled through jpos.xml, the user can identify the specific custom symbology type returned by scanner.getScanDataType().

Below are the ways a user can implement this in the dataOccurred listener:

Option 1: Using the Scan Data Type Default String Output Values (Recommended)

This method requires JposServiceScanner.jar on your classpath. It ensures your application automatically matches whatever is configured in the XML, including any future Zebra default changes. This is the exact pattern used in the Zebra JPOS sample application.

import com.zebra.jpos.service.scanner.ZebraCustomScanDataType;

// ... inside your data listener ...
int scanDataType = scanner.getScanDataType();
String val = "Unknown"; // Your default/fallback

String customName = ZebraCustomScanDataType.getDisplayName(scanDataType);
if (customName != null) {
    val = customName;
}

Option 2: Assigning the Scan Data Type String Output Values Manually

If you prefer not to add the JAR dependency, you can map the known Zebra default values directly in your code using a switch statement:

// ... inside your data listener ...
int scanDataType = scanner.getScanDataType();
String name = "Unknown";

switch (scanDataType) {
    case 601:
        name = "ZEBRA_RFID_RAW";
        break;
    case 602:
        name = "ZEBRA_RFID_URI";
        break;
}

Obtaining and Filtering RFID Data via JPOS Payload

If you are not using the Custom Zebra Symbologies feature, or if your communication interface does not support the feature (like the IBM interface), you can configure the Zebra RFID scanner using an ADF2 rule (via 123Scan) to automatically wrap or frame RFID data transmissions with a unique custom prefix and/or suffix (see the 123Scan configuration illustration in Figure 29).

The modification to filter RFID data should be within the data receiving layer of the JPOS application, inside the dataListener.

Figure 29: 123Scan ADF Rule for RFID Data

The following tables detail the expected JPOS symbology types, sample data outputs, and corresponding datatypes for each configuration.

Sample Application for Prefix/Suffix Payload Filtering

The following sample application demonstrates how to build logic inside your data listener to filter RFID data based on these Prefix/Suffix tags.

package sampleapp;

import static java.lang.System.out;

import java.io.FileWriter;
import java.io.IOException;
import java.io.PrintWriter;
import java.nio.charset.Charset;
import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;
import java.util.concurrent.CountDownLatch;
import jpos.JposException;
import jpos.Scanner;
import jpos.events.DataEvent;
import jpos.events.DataListener;

/**
* Filters RFID data from standard barcode data using scanner-configured custom prefix and suffix framing.
*
* Set LOGICAL_NAME below to match the logical device name configured in jpos.xml (typically under /usr/share/zebra-scanner/javapos/config/jpos.xml).
*
* RFID_PREFIX and RFID_SUFFIX must match the custom prefix and suffix programmed on the scanner for RFID reads through 123Scan.
*/
public class SampleApp {

    private static final String LOGICAL_NAME = "ZebraAllScanners";
    private static final DateTimeFormatter TS_FMT = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss.SSS");

    // Custom framing delimiters configured on the scanner
    private static final String RFID_PREFIX = "<RFID>";
    private static final String RFID_SUFFIX = "</RFID>";

    private final CountDownLatch shutdownLatch = new CountDownLatch(1);
    private PrintWriter logWriter;
    private Scanner scanner;

    private synchronized void log(String msg) {
        String line = LocalDateTime.now().format(TS_FMT) + " [" + Thread.currentThread().getName() + "] " + msg;
        out.println(line);
        if (logWriter != null) {
            logWriter.println(line);
            logWriter.flush();
        }
    }

    /**
     * Checks if the scanned data is wrapped in the RFID framing delimiters.
     */
    private static boolean isRfidData(String scanData) {
        if (scanData == null || scanData.isEmpty()) {
            return false;
        }
        return scanData.startsWith(RFID_PREFIX) && scanData.endsWith(RFID_SUFFIX);
    }

    /**
     * Extracts the raw RFID payload by stripping the framing prefix and suffix.
     */
    private static String extractRfidPayload(String scanData) {
        if (isRfidData(scanData)) {
            return scanData.substring(RFID_PREFIX.length(), scanData.length() - RFID_SUFFIX.length());
        }
        return scanData;
    }

    public void scannerInit() throws JposException {
        scanner = new Scanner();

        log("Opening " + LOGICAL_NAME);
        scanner.open(LOGICAL_NAME);
        log("Open " + LOGICAL_NAME + " successful");

        scanner.claim(1000);
        log("Claim " + LOGICAL_NAME + " successful");

        // Register the listener before enabling data events, so a scan arriving during initialisation cannot be missed.
        scanner.addDataListener(new DataListener() {
            @Override
            public void dataOccurred(DataEvent de) {
                long t0 = System.nanoTime();
                log(LOGICAL_NAME + " dataOccurred received");

                try {
                    String scanLabel = new String(scanner.getScanDataLabel(), Charset.defaultCharset());
                    int scanType = scanner.getScanDataType();
                    String rawScanData = new String(scanner.getScanData(), Charset.defaultCharset());
                    long elapsedMs = (System.nanoTime() - t0) / 1_000_000;

                    boolean rfid = isRfidData(rawScanData);
                    String processedData = rfid ? extractRfidPayload(rawScanData) : rawScanData;

                    log(LOGICAL_NAME + " retrieval complete in " + elapsedMs + "ms - label=" + scanLabel
                            + " JPOS type=" + scanType
                            + " rawData=" + rawScanData
                            + (rfid ? " [RFID DETECTED - Extracted Payload: " + processedData + "]" : " [STANDARD BARCODE]"));

                    // Re-enable data events for subsequent reads
                    if (!scanner.getDataEventEnabled()) {
                        scanner.setDataEventEnabled(true);
                    }
                } catch (JposException jposException) {
                    log(LOGICAL_NAME + " exception in dataOccurred: " + jposException);
                    jposException.printStackTrace();
                }
            }
        });

        scanner.setDecodeData(true);
        scanner.setDeviceEnabled(true);
        scanner.setDataEventEnabled(true);
        log(LOGICAL_NAME + " ready, waiting for scans");
    }

    /**
     * Releases and closes the device. Invoked from a shutdown hook so the scanner is always released, including on Ctrl+C.
     */
    private void shutdown() {
        if (scanner != null) {
            try {
                scanner.setDataEventEnabled(false);
                scanner.setDeviceEnabled(false);
                scanner.release();
                scanner.close();
                log("Closed " + LOGICAL_NAME);
            } catch (JposException ex) {
                log("Exception while closing " + LOGICAL_NAME + ": " + ex.getMessage());
            }
        }
        if (logWriter != null) {
            logWriter.close();
        }
        shutdownLatch.countDown();
    }

    public static void main(String[] args) throws InterruptedException {
        final SampleApp scannerTest = new SampleApp();

        String logFileName = "scanner-latency-"
                + LocalDateTime.now().format(DateTimeFormatter.ofPattern("yyyyMMdd-HHmmss")) + ".log";
        try {
            scannerTest.logWriter = new PrintWriter(new FileWriter(logFileName, true), true);
        } catch (IOException e) {
            out.println("Could not open log file " + logFileName + ": " + e.getMessage());
        }

        Runtime.getRuntime().addShutdownHook(new Thread(new Runnable() {
            @Override
            public void run() {
                scannerTest.shutdown();
            }
        }, "SampleApp-shutdown"));

        scannerTest.log("Starting application, logging to " + logFileName);
        try {
            scannerTest.scannerInit();
        } catch (JposException ex) {
            scannerTest.log("Exception in accessing " + LOGICAL_NAME + ": " + ex.getMessage());
            ex.printStackTrace();
            return;
        }

        // Keep the application alive to receive scans until interrupted.
        scannerTest.shutdownLatch.await();
    }
}

Host RFID Control over JPOS DirectIO

The Zebra JPOS driver offers JPOS Direct IO SetAttributes and GetAttributes methods to access the RFID attributes.

The Zebra RFID scanner must have a USB/Direct Bluetooth connection and should be configured with Device Type set to one of the following:

• USB IBM Handheld
• USB IBM TableTop
• USB OPOS Handheld
• SSI over Bluetooth

RSM Attributes for RFID

The RFID API is expressed in a series of RSM attributes.

Table 12: RSM Attributes

For size-encoded binary data, the first two bytes contain the length (MSB, LSB) for the data to be considered (needed because the RSM attributes are fixed size).

RFID_LAST_TAG_ID - Last Reported Tag

As a convenience, the RFID_LAST_TAG_ID may be used to get the raw EPC of the last tag reported by normal tag reading operation of the D9x08R (normally for an RFID_READ event, the scanner issues a 2-tone beep).

As an example, to get the RFID_LAST_TAG_ID attribute after the scanner reports the tag 3005FB63AC1F3681EC880469:

<attrib_list>35001</attrib_list>

<attrib_list>
  <attribute>
    <id>35001</id>
    <datatype>A</datatype>
    <permission>R</permission>
    <value>0x00 0x0c 0x30 0x05 0xfb 0x63 0xac 0x1f 0x36 0x81 0xec 0x88 0x04 0x69 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00
  </value>
</attribute>
</attrib_list>

RFID_CMD_STATUS - Common Operation Response

All operations (read, write, kill, lock) return a status in the RFID_CMD_STATUS attribute:

RFID_COMMAND

The RFID_COMMAND attribute is used to execute the various tag operations. Each operation has parameter attributes that should be set up prior to executing the command.

Tag Read Operation

The Tag Read operation requires the following attributes to be set using RSM SetAttributes:

The Tag Read operation is activated by the SetAttribute of the RFID_COMMAND attribute.

The result of the operation may be retrieved by the RSM GetAttributes of the following attributes. If the RFID_CMD_STATUS attribute indicates success, then the RFID_DATA attribute will have the requested data.

Example Read

Table 13 is an example to read the entire EPC bank of the tag with an EPC of 3005FB63AC1F3681EC880469.

Table 13: Example Read - Read Entire EPC Bank

<attrib_list>
  <attribute>
    <!--RFIDTagID-->
    <id>35002</id>
    <datatype>A</datatype>
    <value>0x00 0x0c 0x30 0x05 0xFB 0x63 0xAC 0x1F 0x36 0x81 0xEC 0x88 0x04 0x69 </value>
  </attribute>
  <attribute>
    <!--RFIDBank-->
    <id>35003</id>
    <datatype>B</datatype>
    <value>1</value>
  </attribute>
  <attribute>
    <!--RFIDOffset-->
    <id>35005</id>
    <datatype>W</datatype>
    <value>0</value>
  </attribute>
  <attribute>
    <!--RFIDLength-->
    <id>35006</id>
    <datatype>W</datatype>
    <value>0</value>
  </attribute>
  <attribute>
    <!--RFIDCommand-->
    <id>35008</id>
    <datatype>B</datatype>
    <value>1</value>
  </attribute>
</attrib_list>

<attrib_list>35009,35004</attrib_list>

<attrib_list>
  <attribute>
    <id>35009</id>
    <name>"RFIDCmdStatus"</name>
    <datatype>W</datatype>
    <permission>R</permission>
    <value>0</value>
  </attribute>
  <attribute>
    <id>35004</id>
    <name>"RFIDData"</name>
    <datatype>A</datatype>
    <permission>R W P</permission>
    <value>0x00 0x10 0xA0 0x4B 0x30 0x00 0x30 0x05 0xFB 0x63 0xAC 0x1F 0x36 0x81 0xEC 0x88 0x04 0x69 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 </value>
  </attribute>
</attrib_list>

Table 14 is a second example to read the PC word (second word, whose value is 0x3000) from the EPC buffer of the same tag:

Table 14: Example Read - Read PC Word

<attrib_list>
  <attribute>
    <!--RFIDTagID-->
    <id>35002</id>
    <datatype>A</datatype>
    <value>0x00 0x0c 0x30 0x05 0xFB 0x63 0xAC 0x1F 0x36 0x81 0xEC 0x88 0x04 0x69 </value>
  </attribute>
  <attribute>
    <!--RFIDBank-->
    <id>35003</id>
    <datatype>B</datatype>
    <value>1</value>
  </attribute>
  <attribute>
    <!--RFIDOffset-->
    <id>35005</id>
    <datatype>W</datatype>
    <value>1</value>
  </attribute>
  <attribute>
    <!--RFIDLength-->
    <id>35006</id>
    <datatype>W</datatype>
    <value>1</value>
  </attribute>
  <attribute>
    <!--RFIDCommand-->
    <id>35008</id>
    <datatype>B</datatype>
    <value>1</value>
  </attribute>
</attrib_list>

<attrib_list>35009,35004</attrib_list>

<attrib_list>
  <attribute>
    <id>35009</id>
    <name>"RFIDCmdStatus"</name>
    <datatype>W</datatype>
    <permission>R</permission>
    <value>0</value>
  </attribute>
  <attribute>
    <id>35004</id>
    <name>"RFIDData"</name>
    <datatype>A</datatype>
    <permission>R W P</permission>
    <value>0x00 0x02 0x30 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 </value>
  </attribute>
</attrib_list>

Tag Write Operation

The Tag Write operation requires the following attributes to be set using RSM SetAttributes:

The Tag Write operation is activated by the SetAttribute of the RFID_COMMAND attribute.

The result of the operation may be retrieved by the RSM GetAttributes of the RFID_CMD_STATUS attribute.

Example Write

Table 15 is an example to write 0x1234 into the second word of the user bank of the tag with an EPC of 3005FB63AC1F3681EC880469.

Table 15: Example Write

<attrib_list>
  <attribute>
    <!--RFIDTagID-->
    <id>35002</id>
    <datatype>A</datatype>
    <value>0x00 0x0c 0x30 0x05 0xFB 0x63 0xAC 0x1F 0x36 0x81 0xEC 0x88 0x04 0x69 </value>
  </attribute>
  <attribute>
    <!--RFIDBank-->
    <id>35003</id>
    <datatype>B</datatype>
    <value>3</value>
  </attribute>
  <attribute>
    <!--RFIDOffset-->
    <id>35005</id>
    <datatype>W</datatype>
    <value>1</value>
  </attribute>
  <attribute>
    <!--RFIDData-->
    <id>35004</id>
    <datatype>A</datatype>
    <value>0x00 0x02 0x12 0x34
  </value>
</attribute>
<attribute>
  <!--RFIDCommand-->
  <id>35008</id>
  <datatype>B</datatype>
  <value>2</value>
</attribute>
</attrib_list>

<attrib_list>35009</attrib_list>

<attrib_list>
  <attribute>
    <id>35009</id>
    <name>"RFIDCmdStatus"</name>
    <datatype>W</datatype>
    <permission>R</permission>
    <value>0</value>
  </attribute>
</attrib_list>

Tag Lock Operation

The Tag Lock operation requires the following attributes to be set using RSM SetAttributes:

The Lock Configuration is 4 bytes, defined in the EPC Protocol Spec as:

The password is required for the Tag Lock operation and must match the access password of the tag (bytes 4-7 of the reserved bank).

The Tag Lock operation is activated by the SetAttribute of the RFID_COMMAND attribute.

The result of the operation may be retrieved by the RSM GetAttributes of the RFID_CMD_STATUS attribute.

Example Tag Lock Operation

Table 16 is an example to hide the kill password (bytes 0-3 of the reserved bank) of the tag with an EPC of 3005FB63AC1F3681EC880469, assuming the access password (bytes 4-7 of the reserved bank) is 0x87654321.

To set up the lock configuration, set:

• “kill pwd” mask = 11
• “kill pwd” action = 10

Therefore, the lock configuration is 0x000c0200.

Table 16: Example Tag Lock Operation

<attrib_list>
  <attribute>
    <!--RFIDTagID-->
    <id>35002</id>
    <datatype>A</datatype>
    <value>0x00 0x0c 0x30 0x05 0xFB 0x63 0xAC 0x1F 0x36 0x81 0xEC 0x88 0x04 0x69
  </value>
</attribute>
<attribute>
  <!--RFIDData-->
  <id>35004</id>
  <datatype>A</datatype>
  <value>0x00 0x04 0x00 0x0c 0x02 0x00
</value>
</attribute>
<attribute>
  <!--RFIDPassword-->
  <id>35007</id>
  <datatype>A</datatype>
  <value>0x87 0x65 0x43 0x21</value>
</attribute>
<attribute>
  <!--RFIDCommand-->
  <id>35008</id>
  <datatype>B</datatype>
  <value>3</value>
</attribute>
</attrib_list>

<attrib_list>35009</attrib_list>

<attrib_list>
  <attribute>
    <id>35009</id>
    <name>"RFIDCmdStatus"</name>
    <datatype>W</datatype>
    <permission>R</permission>
    <value>0</value>
  </attribute>
</attrib_list>

Tag Kill Operation

The Tag Kill operation requires the following attributes to be set using RSM SetAttributes:

The password is required for the Tag Kill operation and must match the kill password of the tag (bytes 0-3 of the reserved bank). Note that, as per the EPC protocol spec, if the kill password is zero the tag cannot be killed.

The Tag Kill operation is activated by the SetAttribute of the RFID_COMMAND attribute.

The result of the operation may be retrieved by the RSM GetAttributes of the RFID_CMD_STATUS attribute.

Example Tag Kill Operation

Table 17 is an example to kill the tag with EPC of 3005FB63AC1F3681EC880469, assuming the kill password (bytes 0-3 of the reserved bank) is 0x12345678.

Table 17: Example - Tag Kill Operation

<attrib_list>
  <attribute>
    <!--RFIDTagID-->
    <id>35002</id>
    <datatype>A</datatype>
    <value>0x00 0x0c 0x30 0x05 0xFB 0x63 0xAC 0x1F 0x36 0x81 0xEC 0x88 0x04 0x69 </value>
  </attribute>
  <attribute>
    <!--RFIDData-->
    <id>35004</id>
    <datatype>A</datatype>
    <value>0x00 0x04 0x00 0x0c 0x02 0x00 </value>
  </attribute>
  <attribute>
    <!--RFIDPassword-->
    <id>35007</id>
    <datatype>A</datatype>
    <value>0x12 0x34 0x56 0x78</value>
  </attribute>
  <attribute>
    <!--RFIDCommand-->
    <id>35008</id>
    <datatype>B</datatype>
    <value>4</value>
  </attribute>
</attrib_list>

<attrib_list>35009</attrib_list>

<attrib_list>
  <attribute>
    <id>35009</id>
    <name>"RFIDCmdStatus"</name>
    <datatype>W</datatype>
    <permission>R</permission>
    <value>0</value>
  </attribute>
</attrib_list>

RFID_TAG_CACHE - Tag Cache Operations

As a diagnostic tool, the RFID_TAG_CACHE may be used to read the current tag cache size or to flush the tag cache. Reading this attribute returns the current number of unique RFID tags in the cache. Writing any value to this attribute causes the cache to be cleared (flushed).

Example Read Cache Size

Table 18: Example - Read Cache Size

<attrib_list>35010</attrib_list>

<attrib_list>
  <attribute>
    <id>35010</id>
    <name>""</name>
    <datatype>W</datatype>
    <permission>R W</permission>
    <value>2</value>
  </attribute>
</attrib_list>

Example Clear Tag Cache

Table 19: Example - Clear Tag Cache

<attrib_list>
  <attribute>
    <id>35010</id>
    <datatype>W</datatype>
    <value>0</value>
  </attribute>
</attrib_list>

Overview

Zebra JPOS Remote Management Tool is an application which can deliver information related to current operation such as operative status, health and statistics of Zebra barcode scanners. Zebra JPOS Remote Management Tool is bundled with Zebra Barcode Scanner SDK for Linux that supports many Linux distributions such as Ubuntu 16.04, SUSE12, Debian 9 and operates with Zebra's Native and JAVAPOS libraries.

Following are some of the basic information that can be obtained using the tool:

• Scanner model
• Serial number
• Duration of operation from the last "Power-ON"
• Good decode count related to barcode scanning
• Scale calibration event count
• "Zero Scale" button pushed count
• Display error count

Many other scanner information can be retrieved on a plain text log file by configuring the tool through its XML configuration file.

Installation and Configuration

JPOS Remote Management Tool uses the Zebra Native and JAVAPOS libraries that are installed along with CoreScanner and JPOS drivers for Zebra scanners.

Quick Setup Guide

"remote-management.xml" config file which is located in /usr/share/zebra-scanner/javapos/xml is used to configure Zebra Remote Management Tool to retrieve required scanner information in a log file.

"remote-management.xml" configuration file has following format:

<remote-management-configuration>
    <user-log>
        <file-path> path-of-log-file </file-path>
        <file-hostname>name-of-log-file</file-host-name>
        <file-serial-number>scanner-serial-number</file-serial-number>
        <file-model-number>scanner-model-number</file-model-number>
    </user-log>
    <scanner-configuration>
        <logical-name>scanner-management-interface</logical-name>
        <query-scanner-attributes>
            <attribute>
                <id> attribute-id-1 </id>
                <name> attribute-name-1 </name>
            <attribute>
            <attribute>
                <id> attribute-id-2 </id>
                <name> attribute-name-2 </name>
            <attribute>
        <query-scanner-attributes>
    <scanner-configuration>
</remote-management-configuration>

NOTE: Each attribute has an ID (unique number) given by Zebra. A list of IDs of the most commonly used attributes is given at the end of this section.

If any information that is not included in the list is needed, Zebra can evaluate the possibility of providing it based on scanner capability.

Sample remote-management.xml is given below.

Figure 30: Sample remote-management.xml

Most Commonly Used Attributes

Table 20: Most Commonly Used Attributes

How to run JPOS Remote Management Tool

1. Log into your Linux system and open a terminal/console.

2. Change directory to /user/share/zebra-scanner/remote-management.

   

3. Execute remote-management.sh script.

   

Statistics Log File

After the successful execution of the script, a plain text file with the expected statistics data is generated. The file will have the .log extension and will be in the path that has been configured in the configuration XML. By default, the log file will be generated in /var/log/zebra-scanner/jpos-remote-management directory.

Information in the log file are delimited by "pipe" ( | ) separator, each field contains information about a single attribute specified via the configuration XML file. String “null” will be printed if a specified attribute is not supported by the scanner. Sample entry from the log file is as below. A separate log file will be created for each scanner.

Overview

This section provides a matrix of scanner modes and supported symbology types in each mode.

Supported Symbology Types vs. Scanner Mode

Table 21: Supported Symbology Types vs. Scanner Modes

When the scanner is in Wincor-Nixdorf RS232 Mode B, the Zebra JPOS return value for the ScanDataType property differs from the expected value for the bar code types listed below.

Table 22: Bar Code Types Not Accurately Identified in Wincor-Nixdorf RS232 Mode B

Error Codes

Error Codes - JPOS Scanner

Table 23: Error Codes for JPOS Scanner

Error Codes - JPOS Scale

Table 24: Error Codes for JPOS Scale

Installation Components for Windows and Linux

Table 25: Installation Components for Windows and Linux

Download JPOS Drivers for Scanner and Scale

NOTE: Zebra JPOS Drivers for Scanner and Scale bundled with the Barcode Scanner SDK for Windows InstallShield and Barcode Scanner SDK for Linux distribution package.

To Download Barcode Scanner SDK for Windows:

1. Visit the Zebra Barcode Scanner SDK for Windows download page and select the desired download(s).
2. Proceed to the Barcode Scanner SDK for Windows release notes for the version details.
3. Proceed to JPOS Drivers for Scanner and Scale setup page for installation instructions.

To Download Barcode Scanner SDK for Linux:

1. Visit the Zebra Barcode Scanner SDK for Linux download page and select the desired download(s).
2. Proceed to the Barcode Scanner SDK for Linux release notes for the version details.