IDENTIVE TECHNOLOGIES AUDR User Manual

Device command description & firmware update procedure
Dagobertstrasse 9 D - 55116 Mainz Germany Phone +49 (0) 61 31-30476-0 Fax +49 (0) 61 31-30 476-20 Email. info@arygon.com
UHF Desktop Reader / Module - AUxx series
ARYGON TECHNOLOGIES AG
A p p l i c a t i o n N o t e
AUxx UHF reader AN © All rights reserved. Copyright by Arygon Technologies AG - 2011 Page 2 of 28
Revision
Date
Description
1.0
01.03.2011
Initial version
1.1
07.04.2011
Added Error code Information and state charts, command frame review with firmware
1.2
27.05.2011
Channel selection and switching (frequency hopping) description added
Document: Application Note
Author: ARYGON Technologies AG
Version: 1.2
Document History
Table 1 - Dokument History
Contact Information
For additional information and sales office addresses visit: http://www.arygon.com or http://www.nfc-global.com
ARYGON TECHNOLOGIES AG
A p p l i c a t i o n N o t e
AUxx UHF reader AN © All rights reserved. Copyright by Arygon Technologies AG - 2011 Page 3 of 28
FCC NOTICE
Note: This equipment has been tested and found to comply with the limits for a Class B digital device, pursuant to part 15 of the FCC Rules. These limits are designed to provide reasonable protection against harmful interference in a residential installation. This equipment generates, uses and can radiate radio frequency energy and, if not installed and used in accordance with the instructions, may cause harmful interference to radio communication. However, there is no guarantee that interference will not occur in a particular installation. If this equipment does cause harmful interference to radio or television reception, which can be determined by turning the equipment off and on, the user is encouraged to try to correct the interference by one or more of the following measures:
Reorient or relocate the receiving antenna Increase the separation between the equipment and receiver Connect the equipment into an outlet on a circuit different from that to which the receiver
is connected
Consult the dealer or an experienced radio/TV technician for help
THIS DEVICE COMPLIES WITH PART 15 OF FCC RULES. OPERATION IS SUBJECT TO THE FOLLOWING WO CONDITIONS:
1) THIS DEVICE MAY NOT CAUSE HARMFUL INTERFERENCE AND
2) THIS DEVICE MUST ACCEPT ANY INTERFERENCE RECEIVED, INCLUDING INTERFERENCE
THAT MAY CAUSE UNDESIRED OPERATION
WARNING: CHANGES OR MODIFICATIONS NOT EXPRESSLY APPROVED BY THE PARTY RESPONSIBLE FOR COMPLIANCE COULD VOID THE USER’S AUTHORITY TO OPERATE THE
1. Disclaimer
Products sold by ARYGON Technologies AG are covered by the ARYGONSs Term and Conditions of Sale. ARYGON Technologies AG makes no warranty, express, statutory, implied, or by description regarding the information set forth herein or regarding the freedom of the described devices from patent infringement. ARYGON Technologies AG reserves the right to change specifications and prices at any time and without notice. Therefore, please check with ARYGON Technologies AG for current information. This product is intended for use in normal commercial applications. Applications requiring extended temperature range, unusual environmental requirements, or high reliability applications, such as for military, medical life-support or life-sustaining equipment are specifically not recommended without additional consultation of ARYGON Technologies AG. The information provided in this document by ARYGON Technologies AG is believed to be correct and accurate. However, ARYGON Technologies AG shall not be liable to recipient or any third party for any damages, including but not limited to personal injury, property damage, loss of profits, loss of use, interruption of business or indirect, special, incidental or consequential damages, of any kind, in connection with or arising out of the furnishing, performance or use of the technical data herein. No obligation or liability to recipient or any third party shall arise or flow out of ARYGON Technologies AG rendering of technical or other services.
ARYGON TECHNOLOGIES AG
A p p l i c a t i o n N o t e
AUxx UHF reader AN © All rights reserved. Copyright by Arygon Technologies AG - 2011 Page 4 of 28
Table of Contents:
1. Disclaimer ........................................................................................................... 3
2. Introduction ........................................................................................................ 7
Application Layer ................................................................................................................. 7
USB Report-Frame................................................................................................................. 7
USB Reports.......................................................................................................................... 7
Reader Related USB Reports ................................ ................................................................ .. 8
callSendFirmwareHardwareID .................................................................................................................... 8
callAntennaPower ....................................................................................................................................... 8
writeRegister ............................................................................................................................................... 9
callReadRegister .......................................................................................................................................... 9
callReadRegisters ........................................................................................................................................ 9
callChangeFreq .......................................................................................................................................... 10
configGen2 ................................................................................................................................................ 12
callEnableBootloader ................................................................................................................................ 13
callStartStop .............................................................................................................................................. 13
Tag Related USB Reports ......................................................................................................14
callInventory.............................................................................................................................................. 14
callInventoryRSSIInternal .......................................................................................................................... 14
callInventory6B ......................................................................................................................................... 15
callSelectTag .............................................................................................................................................. 15
callWriteToTag .......................................................................................................................................... 16
writeToTag6B ............................................................................................................................................ 17
callReadFromTag ....................................................................................................................................... 17
readFromTag6B ......................................................................................................................................... 17
callLockUnlock ........................................................................................................................................... 18
callKillTag ................................................................................................................................................... 18
callNXPCommands .................................................................................................................................... 19
Error Byte ............................................................................................................................20
Protocol Layer - Gen2 ..........................................................................................................21
Protocol Layer - ISO6B ................................................................ .........................................25
Device Specific Functions .....................................................................................................26
Firmware functionality regarding frequency hopping .............................................................26
3. Firmware update of the ADRU reader ................................................................. 28
ARYGON TECHNOLOGIES AG
A p p l i c a t i o n N o t e
AUxx UHF reader AN © All rights reserved. Copyright by Arygon Technologies AG - 2011 Page 5 of 28
List of Tables:
Table 1 - Dokument History ....................................................................................................... 2
Table 2 Report Frame .............................................................................................................. 7
Table 3 USB Reports Overview .................................................................................................. 7
Table 4- callSendFirmwareHardwareID - outgoing ....................................................................... 8
Table 5- callSendFirmwareHardwareID - incoming ....................................................................... 8
Table 6 –callAntennaPower - outgoing ....................................................................................... 8
Table 7 - callAntennaPower - incoming ....................................................................................... 8
Table 8 - writeRegister – outgoing ............................................................................................. 9
Table 9 - writeRegister – incoming ............................................................................................. 9
Table 10 - callReadRegister - outgoing ........................................................................................ 9
Table 11 - callReadRegister - incoming ....................................................................................... 9
Table 12 - callReadRegisters - outgoing ...................................................................................... 9
Table 13 - callReadRegisters - incoming ...................................................................................... 9
Table 14 - callChangeFreq - Get RSSI Level - outgoing ..................................................................10
Table 15 - callChangeFreq - Get RSSI Level - incoming .................................................................10
Table 16 - callChangeFreq - Get Reflected Power Level - outgoing ................................................10
Table 17 - callChangeFreq - Get Reflected Power Level - incoming ................................................10
Table 18 - callChangeFreq – Add frequency to hopping list - outgoing ...........................................10
Table 19 - callChangeFreq – Add frequency to hopping list - incoming ..........................................10
Table 20 –Clear frequency hopping list - outgoing.......................................................................10
Table 21 - Clear frequency hopping list – incoming .....................................................................10
Table 22 – Set frequency hopping parameters - outgoing ............................................................11
Table 23 - Set frequency hopping parameters - incoming ............................................................11
Table 24 - Get frequency hopping parameters – outgoing ............................................................11
Table 25 - Get frequency hopping parameters – incoming ...........................................................11
Table 26 - Continuous modulation test – outgoing ......................................................................11
Table 27 - Continuous modulation test – incoming .....................................................................11
Table 28 – configGen2 - outgoing .............................................................................................12
Table 29 – configGen2 - incoming ................................ ............................................................. 12
Table 30 - configGen2 - parameter settings ................................................................................12
Table 31 - callEnableBootloader – outgoing ...............................................................................13
Table 32 - callEnableBootloader – incoming ...............................................................................13
Table 33 - callStartStop - outgoing ............................................................................................13
Table 34 - callStartStop - incoming ............................................................................................13
Table 35 - callInventory - outgoing ............................................................................................14
Table 36 - callInventory - incoming ...........................................................................................14
Table 37 - callInventoryRSSIInternal - outgoing ...........................................................................14
Table 38 - callInventoryRSSIInternal – incoming..........................................................................14
Table 39 - callInventory6B – outgoing ........................................................................................15
Table 40 - callInventory6B – incoming .......................................................................................15
Table 41 - callSelectTag - outgoing ............................................................................................16
Table 42 - callSelectTag - incoming ............................................................................................16
Table 43 - callWriteToTag - outgoing .........................................................................................16
Table 44 - callWriteToTag – incoming ........................................................................................16
Table 45 - writeToTag6B - outgoing ...........................................................................................17
Table 46 - writeToTag6B – incoming ..........................................................................................17
Table 47 - callReadFromTag - outgoing ......................................................................................17
Table 48 - callReadFromTag - incoming .....................................................................................17
Table 49 - readFromTag6B - outgoing ........................................................................................17
Table 50 - readFromTag6B - outgoing ........................................................................................17
Table 51 - callLockUnlock - outgoing .........................................................................................18
ARYGON TECHNOLOGIES AG
A p p l i c a t i o n N o t e
AUxx UHF reader AN © All rights reserved. Copyright by Arygon Technologies AG - 2011 Page 6 of 28
Table 52 - callLockUnlock - incoming .........................................................................................18
Table 53 - callKillTag - outgoing ................................................................................................18
Table 54 - callKillTag - incoming ................................................................................................18
Table 55 - callNXPCommands - EAS command - outgoing ............................................................19
Table 56 - callNXPCommands - Set / Reset Protect - outgoing ......................................................19
Table 57 - callNXPCommands - Calibrate - outgoing ....................................................................19
Table 58 - callNXPCommands - Change Config - outgoing ............................................................19
Table 59 - callNXPCommands - incoming ...................................................................................19
Table 60 - Error Byte ...............................................................................................................20
Table 61 - Gen2 Functions ........................................................................................................21
Table 62 - AS399x_public Functions ..........................................................................................25
Table 63 - AS399x - Functions ...................................................................................................26
List of Figures:
Picture 1 - Gen2 Tag Singulation ...............................................................................................15
Picture 2 - Gen2 - State Diagram ................................ ............................................................... 22
Picture 3 - Gen2 - State Diagram (no password set).....................................................................22
Picture 4 - Gen2 Anti Collision – State Diagram ...........................................................................24
Picture 5 - ISO6B - State Diagram ..............................................................................................25
Picture 6 - Parameters .............................................................................................................25
Picture 7 - Firmeware updating response ...................................................................................28
ARYGON TECHNOLOGIES AG
A p p l i c a t i o n N o t e
AUxx UHF reader AN © All rights reserved. Copyright by Arygon Technologies AG - 2011 Page 7 of 28
2. Introduction
Byte 1
Byte 2
Variable length
Report ID
Frame Length
Payload
USB Report Name
Report ID outgoing
Report ID incoming
callSendFirmwareHardwareID
0x10
0x11
callAntennaPower
0x18
0x19
writeRegister
0x1A
0x1B
callReadRegister
0x1C
0x1D
callReadRegisters
0x57
0x58
callChangeFreq
0x41
0x42
configGen2
0x59
0x5A
callEnableBootloader
0x55
0x56
callStartStop
0x5D
0x5E
callInventory
0x31
0x32
callInventoryRSSIInternal
0x43
0x44
callInventory6B
0x3F
0x40
callSelectTag
0x33
0x34
callWriteToTag
0x35
0x36
writeToTag6B
0x47
0x48
callReadFromTag
0x37
0x38
readFromTag6B
0x49
0x50
callLockUnlock
0x3B
0x3c
callKillTag
0x3D
0x3E
callNXPCommands
0x45
0x46
This document describes the architecture important functions. For a complete reference of implemented functions please refer to the Doxygen documentation.
Application Layer
After connecting the reader to the computer the reader is automatically installed as a HID (Human Interface Device). The USB HID protocol defines different reports. Every report starts with its own report ID defining the length and if it is an incoming or an outgoing report.
USB Report-Frame
Each report frame starts with a Report ID byte. The second byte defines the length of the frame (the ID and the length bytes are included in the length).
Table 2 Report Frame
USB Reports
The following table gives an overview of the implemented USB reports. Each USB report causes the device to reply with a response frame (incoming report).
Table 3 USB Reports Overview
ARYGON TECHNOLOGIES AG
A p p l i c a t i o n N o t e
AUxx UHF reader AN © All rights reserved. Copyright by Arygon Technologies AG - 2011 Page 8 of 28
It is recommended to send the reports always with the maximal report length of 64 bytes. Most reports are
Byte 0 1
2
Content
0x10(ID)
3(length)
Payload
Byte 0 1
2 .. 47
Content
0x11(ID)
length
Zero terminated string
Byte 0 1
2
Content
0x18(ID)
3(length)
Payload
Byte 0 1
2
Content
0x19(ID)
3(length)
0 on success
already defined in the descriptor with the maximal length. The others may change in future. Windows truncates longer reports and discards shorter reports!
Reader Related USB Reports
These commands are intended to configure the AUDR UHF reader and for obtaining information about the firmware.
callSendFirmwareHardwareID
This report sends the firmware or the hardware ID to the host computer.
Table 4- callSendFirmwareHardwareID - outgoing
Payload:
0x00…Firmware 0x01…Hardware
Table 5- callSendFirmwareHardwareID - incoming
callAntennaPower
This report enables or disables the RF power on the RF-output ports.
Table 6 –callAntennaPower - outgoing
Payload:
0x00…RF-Power OFF 0x01…RF-Power ON
Table 7 - callAntennaPower - incoming
ARYGON TECHNOLOGIES AG
A p p l i c a t i o n N o t e
AUxx UHF reader AN © All rights reserved. Copyright by Arygon Technologies AG - 2011 Page 9 of 28
writeRegister
Byte 0 1 2 3 4 5
Content
0x1A(ID)
5(length)
reg_number
val_0
val_1
val_2
Byte 0 1
2
Content
0x1B(ID)
3(length)
0 on success
Byte 0 1
2
Content
0x1C(ID)
2(length)
reg_number
Byte 0 1 2 3 4 5
Content
0x1D(ID)
6(length)
0x00 on success
val0
val1
val2
Byte 0 1
Content
0x57(ID)
1(length)
Byte 0 1 2 …
44
Content
0x58(ID)
45(length)
reg 0x00
reg 0x1F
This function writes one register of the AUDR UHF reader.
Table 8 - writeRegister – outgoing
val_1 and val_2 are used only if reg_number is a deep register (e.g.: Modulator Control Register).
If reg_number ≥ 0x80 a direct command is executed.
Table 9 - writeRegister – incoming
callReadRegister
This function reads one register from the AUDR UHF reader
Table 10 - callReadRegister - outgoing
If a 3-bytes deep register is selected the controller sends back 3 data bytes.
Table 11 - callReadRegister - incoming
callReadRegisters
This function reads all register in one bulk from AUDR UHF reader.
Table 12 - callReadRegisters - outgoing
Table 13 - callReadRegisters - incoming
Loading...
+ 19 hidden pages