HOST API FOR RFID MODULE
OF THE DS9808-R SCANNER
WHITE PAPER
HOST API FOR RFID MODULE
OF THE DS9808-R SCANNER
WHITE PAPER
March 2015 – Revision A
Revisions
Rev Description Date
A Release Document 9/21/11
A Update tables on pages 8, 9, 11, 13, and 14. 1/18/12
A Zebra Rebranding 3/31/2015
HOST API FOR RFID MODULE OF THE DS9808-R SCANNER WHITE PAPER Page 2/16
Table of Contents
1 Introduction .................................................................................................... 4
1.1 Purpose .............................................................................................................................. 4
1.2 Terms and Definitions ......................................................................................................... 4
1.3 References ......................................................................................................................... 4
2 Description ..................................................................................................... 4
2.1 System Overview ................................................................................................................ 4
3 Setup .............................................................................................................. 5
3.1 Using with USB OPOS ....................................................................................................... 5
4 RSM Attributes for RFID ............................................................................... 5
4.1 RFID_LAST_TAG_ID – Last Reported Tag ....................................................................... 6
4.2 RFID_CMD_STATUS - Common Operation Response ..................................................... 7
4.3 RFID_COMMAND .............................................................................................................. 7
4.3.1 T ag Read Operation ........................................................................................................... 7
4.3.2 T ag Write Operation ......................................................................................................... 10
4.3.3 T ag Lock Operati on .......................................................................................................... 12
4.3.4 T ag Kill Operation ............................................................................................................. 14
4.4 RFID_TAG_CACHE – Tag Cache Operations ................................................................. 15
4.4.1 Example Read Cache Size ............................................................................................... 15
4.4.2 Example Clear Tag Cache ............................................................................................... 15
HOST API FOR RFID MODULE OF THE DS9808-R SCANNER WHITE PAPER Page 3/16
1 Introduction
1.1 Purpose
The purpose of this document is to describe the host Application Program
Interface (API) for the advanced reading and writing of RFID tags using the
Durango RFID Module with the DS9808 Sierra Digital Scanner.
1.2 Terms and Definitions
• EPC Electronic Product Code
• RFID Radio-frequency identification
1.3 References
[ref 1] DS9808 Digital Scanner Product Ref Guide,
part number 72E-112999-xx
[ref 2] Zebra Scanner SDK v1.0, SCANNERSDK100.0043
http://www.zebra.com/scannersdkforwindows
[ref 3] [ref 3] EPCglobal-uhfc1g, Tag Protocol – UHF Class-1 Gen-2
http://www.epcglobalinc.org
2 Description
2.1 System Overview
The DS9808 scanner provides imager based scanning for hands-free operation
(presentation) and both imager and laser based scanning for hand-held
operation.
The D9808 may optionally be equipped with the D9808-R RFID Module (based
on the Sailfish Module), an RFID radio engine intended to enable mobile
computers and bar code scanners to read and modify Electronic Product Code
(EPC) Gen2 UHF RFID tags.
The DS9808 offers several host interfaces; some which behave like sim ple input
devices, some which offer intelligent control to the connected host.
The host control of the advanced RFID capabilities of the D9808 with RFID
makes use of the existing RSM protocol by adding new attributes for the setup
and execution of RFID functions.
HOST API FOR RFID MODULE OF THE DS9808-R SCANNER WHITE PAPER Page 4/16
RSM
Type
Size
(bytes)
The EPC Tag ID of the last tag reported. (sizeencoded binary)
The EPC Tag ID of the tag to be operated
upon. (size-encoded binary)
Desired Tag Bank:
3 = User
Buffer for read, write, and lock (size-encoded
binary)
35005
RFID_OFFSET
‘W’ 2 W
Word offset into tag buffer
Words of data to read from tag buffer. 0 means
entire bank
35007
RFID_PASSWORD
‘A’ 4 W
Binary password for privileged operations
Execute command:
4 = Kill
35009
RFID_CMD_STATUS
‘W’ 2 R
Resulting status from executing a command
Internal Tag Cache Size:
Write 0 to clear the cache
3 Setup
3.1 Using with USB OPOS
To use the RFID control with the Zebra Scanner SDK (see [ref 2])
you may use the Scanner WMI Sample Application (Scanner_WMI_test.exe).
This program offers the “SetAttributes” and “GetAttributes” methods which are
needed to access the RFID attributes. All examples in this document assume you
are using this sample application.
The DS9808-R scanner must have a USB cable connection and should be
configured with the USB Device Type set to one of the following:
• USB OPOS Handheld
• IBM Handheld USB
• IBM Table Top USB
Refer to the DS9808 Product Reference Guide (see [ref 1]) for details and
configuration bar codes.
4 RSM Attributes for RFID
The RFID API is expressed in a series of RSM attributes.
Attribute Number Attribute Name
35001 RFID_LAST_TAG_ID ‘A’ 34 R
35002 RFID_TAG_ID ‘A’ 34 W
35003 RFID_BANK ‘B’ 1 W
35004 RFID_DATA ‘A’ 66 RW
35006 RFID_LENGTH ‘W’ 2 W
35008 RFID_COMMAND ‘B’ 1 W
35010 RFID_TAG_CACHE ‘W’ 2 RW
Access Description
0 = reserved,
1 = EPC,
2 = TID,
1 = Read
2 = Write
3 = Lock
Read for current cache size
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).
HOST API FOR RFID MODULE OF THE DS9808-R SCANNER WHITE PAPER Page 5/16
Loading...