Zebra DS9908R General Purpose Scanner Host API for Barcode Scanners with RFID Programming Interface (en)

HOST API FOR
BARCODE
SCANNERS
WITH RFID

Programming Interface

72E-154791-05EN Rev. A

ZEBRA and the stylized Zebra head are trademarks of Zebra Technologies Corporation, registered in
many jurisdictions worldwide. All other trademarks are the property of their respective owners. ©2021
Zebra Technologies Corporation and/or its affiliates. All rights reserved.

Information in this document is subject to change without notice. The software described in this document
is furnished under a license agreement or nondisclosure agreement. The software may be used or copied
only in accordance with the terms of those agreements.

For further information regarding legal and proprietary statements, please go to:

SOFTWARE:www.zebra.com/linkoslegal
COPYRIGHTS:www.zebra.com/copyright
WARRANTY:www.zebra.com/warranty
END USER LICENSE AGREEMENT: www.zebra.com/eula

Terms of Use

Proprietary Statement

This manual contains proprietary information of Zebra Technologies Corporation and its subsidiaries
(“Zebra Technologies”). It is intended solely for the information and use of parties operating and
maintaining the equipment described herein. Such proprietary information may not be used, reproduced,
or disclosed to any other parties for any other purpose without the express, written permission of Zebra
Technologies.

Product Improvements

Continuous improvement of products is a policy of Zebra Technologies. All specifications and designs are
subject to change without notice.

Liability Disclaimer

Zebra Technologies takes steps to ensure that its published Engineering specifications and manuals are
correct; however, errors do occur. Zebra Technologies reserves the right to correct any such errors and
disclaims liability resulting therefrom.

Limitation of Liability

In no event shall Zebra Technologies or anyone else involved in the creation, production, or delivery of the
accompanying product (including hardware and software) be liable for any damages whatsoever
(including, without limitation, consequential damages including loss of business profits, business
interruption, or loss of business information) arising out of the use of, the results of use of, or inability to
use such product, even if Zebra Technologies has been advised of the possibility of such damages. Some
jurisdictions do not allow the exclusion or limitation of incidental or consequential damages, so the above
limitation or exclusion may not apply to you.

2

Revision History

Changes to the original guide are listed below:

Change Date Description

-01 Rev A 9/21/11 Initial release.

-02 Rev A 1/18/12 Update tables on pages 8, 9, 11, 13, and 14.

-03 Rev A 3/31/2015 Zebra rebranding.

-04 Rev A 2/27/2019 Add DS9908R.

-05 Rev A 8/23/2021 Remove patent-pending wording on page 8.

3

Contents

Terms of Use ................................................................................................................... 2

Proprietary Statement .............................................................................................. 2

Product Improvements ............................................................................................ 2

Liability Disclaimer ................................................................................................... 2

Limitation of Liability ................................................................................................ 2

Revision History .............................................................................................................. 3

About This Document ....................................................................................................................... 6

Introduction ..................................................................................................................... 6

Notational Conventions ................................................................................................... 6

Related Documents and Software .................................................................................. 7

Service Information ......................................................................................................... 7

Provide Documentation Feedback .................................................................................. 7

Host API for RFID ............................................................................................................................... 8

Overview ......................................................................................................................... 8

DS9808R Corded Hybrid Imager with RFID ............................................................ 8

DS9908R Next Generation Corded Hybrid Imager with RFID ................................. 8

Setup ............................................................................................................................... 9

Using with USB OPOS ............................................................................................ 9

RSM Attributes for RFID ................................................................................................. 9

RFID_LAST_TAG_ID – Last Reported Tag ........................................................... 10

RFID_CMD_STATUS - Common Operation Response ........................................ 11

RFID_COMMAND ................................................................................................. 11

Tag Read Operation ........................................................................................ 11

Tag Write Operation ........................................................................................ 16

Example Write ................................................................................................. 17

Tag Lock Operation ......................................................................................... 18

Tag Kill Operation ........................................................................................... 21

RFID_TAG_CACHE – Tag Cache Operations ....................................................... 23

Example Read Cache Size ............................................................................. 23

Example Clear Tag Cache .............................................................................. 23

4

List of Tables

About This Document ........................................................................................................................ 6

Host API for RFID ................................................................................................................................ 8

RSM Attributes ................................................................................................................ 9

Example Read - Read Entire EPC Bank ....................................................................... 12

Example Read - Read PC Word ................................................................................... 14

Example Write ............................................................................................................... 17

Example Tag Lock Operation ........................................................................................ 20

Example - Tag Kill Operation ........................................................................................ 22

Example - Read Cache Size ......................................................................................... 23

Example - Clear Tag Cache .......................................................................................... 23

5

About This Document

Introduction

This document describes the host Application Program Interface (API) for the advanced reading and
writing of Radio Frequency Identification (RFID) tags using the Durango RFID Module with the DS9808
Sierra digital scanner and the DS9908R (DS9908 with RFID) imager.

Notational Conventions

The following conventions are used in this document:

• The

• Bold text is used to highlight the following:

• Bullets (•) indicate:

Consolas font is used to denote code.

• Dialog box, window and screen names

• Drop-down list and list box names

• Check box and radio button names

• Icons on a screen

• Key names on a keypad

• Button names on a screen.

• Action items

• Lists of alternatives

• Lists of required steps that are not necessarily sequential.

• Sequential lists (e.g., those that describe step-by-step procedures) appear as numbered lists.

6

About This Document

Related Documents and Software

The following documents provide more information about the DS9X08 scanners.

• DS9808 Digital Scanner Product Reference Guide, part number 72E-112999-xx

• DS9808R Digital Scanner Product Reference Guide Supplement, part number 72E-132822-xx

• DS9908 Hands-Free Imaging Scanner Product Reference Guide, part number MN-003185--xx.

• DS9908R Hands-Free Imaging Scanner Product Reference Guide Supplement, part number

MN-003377-xx.

• Zebra Scanner SDK

www.zebra.com/us/en/products/software/scanning-systems/scanner-drivers-and-utilities.html

• EPC Tag Data Standard Standard version 1.11

www.gs1.org/standards/epcrfid-epcis-id-keys/epc-rfid-tds/1-11

For the latest version of this guide and all guides, go to: zebra.com/support.

Service Information

If you have a problem with your equipment, contact Zebra Global Customer Support for your region.
Contact information is available at: zebra.com/support

When contacting support, please have the following information available:

• Serial number of the unit

• Model number or product name

• Software type and version number.

Zebra responds to calls by email, telephone or fax within the time limits set forth in support agreements.

If your problem cannot be solved by Zebra Customer Support, you may need to return your equipment for
servicing and will be given specific directions. Zebra is not responsible for any damages incurred during
shipment if the approved shipping container is not used. Shipping the units improperly can possibly void
the warranty.

If you purchased your Zebra business product from a Zebra business partner, contact that business
partner for support.

Provide Documentation Feedback

If you have comments, questions, or suggestions about this guide, send an email to

[e-mail]

.

.

7

Host API for RFID

Overview

DS9808R Corded Hybrid Imager with RFID

The DS9808R is the first combination 1D/2D barcode scanner and RFID reader and the first combination
hand-held/hands-free UHF RFID reader. The DS9808R offers the flexibility to accommodate virtually any
type of data capture application, including support for: 1D and 2D paper and mobile barcodes, mobile
coupons, mobile loyalty cards, mobile boarding passes, PDF417 barcodes, and reading/writing RFID tags.

The read range for the RFID antenna can be adjusted to suit the environment. For example, the RFID read
range in presentation mode can be decreased to prevent inadvertent reading of RFID tags in a nearby
cash-wrap, while the range in hand-held (triggered) mode can be increased to read RFID tags that are
further away.

DS9908R Next Generation Corded Hybrid Imager with RFID

The DS9908R replaces the DS9808R. The DS9908R offers several enhanced features that includes the
following.

• A capacitive touch sensor and accelerometer that work together to instantly switch to hand-held mode
as soon as an associate picks up the scanner. There are no mechanical components to wear out,
providing fail-proof switching throughout the scanner’s life.

• The reader operates with just 5 VDC and does not require an external power supply.

• Built-in RFID data conversion software reports the tags EPC data as:

• Raw - the EPC buffer transmits as 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.

• EPC URI - the EPC data is represented as a Universal Resource Identifier (URI) as defined in the

EPC Tag Data Standard version 1.11.

• Zebra’s ScanSpeed Analytics provides detailed performance metrics on each barcode captured ­enabling you to identify and eliminate poor performing barcodes that slow down the checkout process.
You can also view the number of decodes performed in hand-held and hands-free modes to better
understand how associates are using the scanner.

8