ClarIDy Solutions UEE006 UHF USB READER MODULE User Manual Linux A1

ClarIDy Solutions, Inc. UHF USB READER MODULE Users Manual Linux A1

Users Manual Linux A1

ClarIDy UHF USB Reader Demo Program for Linux 1/28 © Copyright 2008 ClarIDy Solutions, Inc. All rights reserved. ClarIDy UHF USB Reader Demo Program User’s Manual for Linux Version: A.1-01 2008-12-09 ClarIDy Solutions, Inc. Product Name: UHF USB Reader ModuleModel No.: UEE006Applicant: ClarIDy Solutions, Inc.
ClarIDy UHF USB Reader Demo Program for Linux 2/28 © Copyright 2008 ClarIDy Solutions, Inc. All rights reserved. Copyright Notice © Copyright 2008 ClarIDy Solutions, Inc. All rights reserved. No part of this document may be reproduced without the prior written permission of ClarIDy Solutions, Inc. Disclaimer The information of this document is subject to change without notice and does not represent a commitment on any part of ClarIDy Solutions, Inc. Trademarks Intel is a registered trademark of Intel Corporation. AMD is a registered trademark of Advanced Micro Devices, Inc. Linux is a registered trademark of Linus Torvalds. RED HAT is a registered trademark of Red Hat, Inc. All other product names are trademarks or registered trademarks of their respective owners.
ClarIDy UHF USB Reader Demo Program for Linux 3/28 © Copyright 2008 ClarIDy Solutions, Inc. All rights reserved. Change Log Revision Date Author Description A.1 2008.11.07. Jun-Rong Chang Create the ClarIDy UHF SDK Demo Program User’s Manual for Linux A.1-01 2008.12.09 Jun-Rong Chang Added the application of Lock Tag and Kill Tag
ClarIDy UHF USB Reader Demo Program for Linux 4/28 © Copyright 2008 ClarIDy Solutions, Inc. All rights reserved. Table of Contents 1. Introduction..................................................................................................................5 2. Installation ...................................................................................................................6 2.0 Prerequisites to Installation ................................................................................6 2.0.1 Hardware Platform Requirements ............................................................6 2.0.2 Operating System Requirements .............................................................6 2.0.3 Other Software Requirements ..................................................................6 2.1 Setup the USB Driver .........................................................................................6 2.3 Install ClarIDy UHF Demo ..................................................................................6 3. Demo Program Operation Guide .................................................................................8 3.1 Setting ................................................................................................................8 2.2.1 Reader Current Configure ........................................................................8 2.2.2 Algorithm Configure................................................................................12 3.2 Operation..........................................................................................................16 3.2.1 Inventory ................................................................................................17 3.2.2 Read.......................................................................................................17 3.2.3 Write.......................................................................................................18 3.2.4 Filter Inventory........................................................................................20 3.2.5 Filter Read..............................................................................................21 3.2.6 Filter Write ..............................................................................................22 3.2.7 Lock Tag.................................................................................................23 3.2.8 Kill Tag....................................................................................................25 4. Error Code.................................................................................................................27
ClarIDy UHF USB Reader Demo Program for Linux 5/28 © Copyright 2008 ClarIDy Solutions, Inc. All rights reserved. 1. Introduction This document describes the demo program for ClarIDy UHF RFID Reader. The demo program provides “Setting”, “Algorithm”, “Inventory”, “Read/Write”, “Filter Inventory”, “Filter Read/Write” and “Lock/Kill” functions. Users can use those applications to control the ClarIDy UHF RFID Reader to communicate with EPC RFID tags. The operational procedures are described as the following chapters.
ClarIDy UHF USB Reader Demo Program for Linux 6/28 © Copyright 2008 ClarIDy Solutions, Inc. All rights reserved. 2. Installation Before Installing the USB Driver and ClarIDy UHF Demo program, please see prerequisites first. 2.0 Prerequisites to Installation In order to run ClarIDy UHF Demo program as smoothly as possible, we recommend some conditions as following. 2.0.1 Hardware Platform Requirements The following hardware Platforms are supported by ClarIDy UHF RFID Reader  CPU: Intel® Pentium® 4 or AMD® Athlon™ processor, 1.4 GHz or above  RAM: 512MB or above 2.0.2 Operating System Requirements The following host operating systems are supported by ClarIDy UHF RFID SDK:  Red Hat* Enterprise Linux*4 or other binary-compatible Linux kernel 2.6 distribution for the IA-32 platform. 2.0.3 Other Software Requirements The following other systems are supported by ClarIDy UHF RFID Reader:  GCC 3.4.6 and above. 2.1 Setup the USB Driver The ClarIDy UHF Reader is support on Linux using user-level libraries that communicate with the standard Linux USB drivers. No driver installation is necessary. 2.3 Install ClarIDy UHF Demo We only provide a command line application “ClarIDy_UHF_Demo” for demonstration. 1. Copy “ClarIDy_UHF_Demo_Linux.tar.gz” to Linux PC, as figure 1. 2. Extract the “ClarIDy_UHF_Demo_Linux.tar.gz” from tarball, as figure 2. 3. Run the “source setup.sh”, as Figure 3. Figure 1 Copy “ClarIDy_UHF_SDK_Linux.tar.gz” to Linux PC
ClarIDy UHF USB Reader Demo Program for Linux 7/28 © Copyright 2008 ClarIDy Solutions, Inc. All rights reserved. Figure 2 extract the “ClarIDy_UHF_SDK_Linux.tar.gz” from tarball Figure 3 Run “source setup.sh”
ClarIDy UHF USB Reader Demo Program for Linux 8/28 © Copyright 2008 ClarIDy Solutions, Inc. All rights reserved. 3. Demo Program Operation Guide The following sections will describe the usage of the ClarIDy UHF Demo application.First run the "ClarIDy_UHF_Demo". The application is include two Controls, “Setting” and “Operation”, as Figure 4. Figure 4 Run “ClarIDy_UHF_Demo” 3.1 Setting The ClarIDy UHF Demo Program support two configure (as Figure 5) as follows: 1. Set Reader Current Configure 2. Set Algorithm Configure Figure 5 Setting 2.2.1 Reader Current Configure When the user select "1: Set Reader Current Configure" then show Configure page. This page allows the user to configure the following items:
ClarIDy UHF USB Reader Demo Program for Linux 9/28 © Copyright 2008 ClarIDy Solutions, Inc. All rights reserved. 1. Link Profile: Sets the current link profile for the reader module, as figure 6. The option is as follows: 0: DSB ASK / MO / 40 khz 1: DSB_ASK / M1 / 160 khz 2: PR_ASK / M2 / 25U khz 3: PR_ASK / M2 / 300 khz 4: DSB_ASK / MO / 400 khz 5: PR_ASK / M1 / 250 khz Figure 6 Set to Link Profile 2. Data Format: Sets the operation response data reporting mode for tag-protocol operations, as figure 7. The option is as follows: 1: COMPACT: The response data is limited to provide the application with the pertinent tag-access operation data, but minimize the amount of MAC-to-host communication overhead. 3: NORMAL: The response data builds on the compact mode to provide the application with status and contextual information to give additional finer-grained feedback such as the beginning of inventory cycles, etc. 7: EXTENDED: The response data builds on the normal mode by providing additional diagnostics and statistical information.
ClarIDy UHF USB Reader Demo Program for Linux 10/28 © Copyright 2008 ClarIDy Solutions, Inc. All rights reserved. Figure 7 Set to Data Format 3. Operation Mode: Sets the reader's operation mode, as figure 8. The option is as follows: 0: CONTINUOUS: In continuous mode, when a tag-protocol-operation cycle (i.e., one iteration through all enabled antenna ports) has completed, the reader module will begin a new tag-protocol-operation cycle with the first enabled antenna port and will continue to do so until the operation is explicitly cancelled by the application. 1: NONCONTINUOUS: In non-continuous mode, only a single tag-protocol-operation cycle is executed upon the reader module.
ClarIDy UHF USB Reader Demo Program for Linux 11/28 © Copyright 2008 ClarIDy Solutions, Inc. All rights reserved. Figure 8 Operation Mode 4. Inventory Algorithm: Allows the application to set the currently-active singulation algorithm, as figure 9. The option is as follows: 0: ALGORITHM_FIXEDQ 1: DYNAMICQ 2: DYNAMICQ_ADJUST 3: DYNAMICQ_THRESHOLD Figure 9 Set to Inventory Algorithm
ClarIDy UHF USB Reader Demo Program for Linux 12/28 © Copyright 2008 ClarIDy Solutions, Inc. All rights reserved. 2.2.2 Algorithm Configure The Algorithm Configure page allows the user to configure the following items (as figure 10): Figure 10 Algorithm Configure 1. FixedQ (as figure 11): Fixed Q algorithm. The items as follows: 1: qValue: The Q value to use. Valid values are 0 to 15, inclusive. 2: retryCount: Specifies the number of times to try another execution of the singulation algorithm for the specified session/target before either toggling the target (if toggleTarget is non-zero) or terminating the inventory/tag access operation. Valid values are 0-255, inclusive. 3: toggleTarget: A flag that indicates if, after performing the inventory cycle for the specified target (i.e., A or B), if the target should be toggled (i.e., A to B or B to A) and another inventory cycle run. A non-zero value indicates that the target should be toggled. A zero value indicates that the target should not be toggled. Note that if the target is toggled, retryCount and repeatUntilNoTags will also apply to the new target. 4: repeatUntilNoTags: A flag that indicates whether or not the singulation algorithm should continue performing inventory rounds until no tags are singulated. A non-zero value indicates that, for each execution of the singulation algorithm, inventory rounds should be performed until no tags are singulated. A zero value indicates that a single inventory round should be performed for each execution of the singulation algorithm.
ClarIDy UHF USB Reader Demo Program for Linux 13/28 © Copyright 2008 ClarIDy Solutions, Inc. All rights reserved. Figure 11 Set to FixedQ 2. DynamicQ (as figure 12): Adjusts the Q value based on the presence or absence of tags. The items as follows: 1: startQValue: The starting Q value to use. Valid values are 0 to 15, inclusive. minQValue <= startQValue <= maxQValue 2: minQValue: The minimum Q value to use. Valid values are 0 to 15, inclusive. minQValue <= startQValue <= maxQValue 3: maxQValue: The maximum Q value to use. Valid values are 0 to 15, inclusive. minQValue <= startQValue <= maxQValue 4: retryCount: Specifies the number of times to try another execution of the singulation algorithm for the specified session/target before either toggling the target (if toggleTarget is non-zero) or terminating the inventory/tag access operation. Valid values are 0-255, inclusive. 5: maxQueryRepCount: The maximum number of ISO 18000-6C QueryRep commands that will follow the ISO 18000-6C Query command during a single inventory round. Valid values are 0-255, inclusive. 6: toggleTarget: A flag that indicates if, after performing the inventory cycle for the specified target (i.e., A or B), if the target should be toggled (i.e., A to B or B to A) and another inventory cycle run. A non-zero value indicates that the target should be toggled. A zero value indicates that the target should not be toggled. Note that if the target is toggled, retryCount and repeatUntilNoTags will also apply to the new target.
ClarIDy UHF USB Reader Demo Program for Linux 14/28 © Copyright 2008 ClarIDy Solutions, Inc. All rights reserved. Figure 12 Set to DynamicQ 3. DynamicQAdjust (as figure 13): This algorithm modifies the previous dynamic Q algorithm by issuing ISO 18000-6C Query Adjust commands instead of ISO 18000-6C Query commands when adjusting the Q value. The items as follows: 1: startQValue: The starting Q value to use. Valid values are 0 to 15, inclusive. minQValue <= startQValue <= maxQValue 2: minQValue: The minimum Q value to use. Valid values are 0 to 15, inclusive. minQValue <= startQValue <= maxQValue 3: maxQValue: The maximum Q value to use. Valid values are 0 to 15, inclusive. minQValue <= startQValue <= maxQValue 4: retryCount: Specifies the number of times to try another execution of the singulation algorithm for the specified session/target before either toggling the target (if toggleTarget is non-zero) or terminating the inventory/tag access operation. Valid values are 0-255, inclusive. 5: maxQueryRepCount: The maximum number of ISO 18000-6C QueryRep commands that will follow the ISO 18000-6C Query command during a single inventory round. Valid values are 0-255, inclusive. 6: toggleTarget: A flag that indicates if, after performing the inventory cycle for the specified target (i.e., A or B), if the target should be toggled (i.e., A to B or B to A) and another inventory cycle run. A non-zero value indicates that the target should be toggled. A zero value indicates that the target should not be toggled. Note that if the target is toggled, retryCount and repeatUntilNoTags will also apply to the new target.
ClarIDy UHF USB Reader Demo Program for Linux 15/28 © Copyright 2008 ClarIDy Solutions, Inc. All rights reserved. Figure 13 Set to DynamicQAdjust 4. DynamicQThreshold (as figure 14): This algorithm uses a Q-modification algorithm that allows the application to control the change of the Q-adjustment-threshold value. The items as follows: 1: startQValue: The starting Q value to use. Valid values are 0 to 15, inclusive. minQValue <= startQValue <= maxQValue 2: minQValue: The minimum Q value to use. Valid values are 0 to 15, inclusive. minQValue <= startQValue <= maxQValue 3: maxQValue: The maximum Q value to use. Valid values are 0 to 15, inclusive. minQValue <= startQValue <= maxQValue 4:retryCount: Specifies the number of times to try another execution of the singulation algorithm for the specified session/target before either toggling the target (if toggleTarget is non-zero) or terminating the inventory/tag access operation. Valid values are 0-255, inclusive. 5: toggleTarget: A flag that indicates if, after performing the inventory cycle for the specified target (i.e., A or B), if the target should be toggled (i.e., A to B or B to A) and another inventory cycle run. A non-zero value indicates that the target should be toggled. A zero value indicates that the target should not be toggled. Note that if the target is toggled, retryCount and repeatUntilNoTags will also apply to the new target. 6: thresholdMultiplier: The multiplier, specified in units of fourths (i.e., 0.25), that will be applied to the Q-adjustment threshold as part of the dynamic-Q algorithm. Valid values are 0-255, inclusive.
ClarIDy UHF USB Reader Demo Program for Linux 16/28 © Copyright 2008 ClarIDy Solutions, Inc. All rights reserved. Figure 14 Set to DynamicQThreshold 3.2 Operation The ClarIDy UHF Demo Program supports six Operations as follows (as figure 15): 1. Inventory 2. Read 3. Write 4. Filter Inventory 5. Filter Read 6. Filter Write Figure 15 Operation
ClarIDy UHF USB Reader Demo Program for Linux 17/28 © Copyright 2008 ClarIDy Solutions, Inc. All rights reserved. 3.2.1 Inventory Inventory step by step as the following instructions: 1. When the user select "1: Inventory" then showed the "Input interval time (second)", as figure 16. 2. Input interval time. 3. Place the RFID tag in the RF field of the ClarIDy UHF RFID Reader. 4. The PC (“PC”), EPC (EPC), CRC16 (CRC), number of reads (“Count”), and Receive Signal Strength Indicator (“RSSI”) will be shown on the table, as figure 16. Note : interval time: Runs out the Inventory total time. Figure 16 Inventory 3.2.2 Read The Read page allows the user to configure the following items: 1. Read EPC (as figure 17): Read Tag EPC Data.
ClarIDy UHF USB Reader Demo Program for Linux 18/28 © Copyright 2008 ClarIDy Solutions, Inc. All rights reserved. Figure 17 Read EPC 2. Read User Memory (as figure 18): Input “StartOffset” and “Count” then showed the user memory data. Figure 18 Read User Memory Note : StartOffset: The offset of the first 16-bit word to read. Count: The nubmer of 16-bit words to read. 3.2.3 Write The Write page allows the user to configure the following items: 1. Write EPC (as figure 19): input 24 nibble to Write Tag EPC Data.
ClarIDy UHF USB Reader Demo Program for Linux 19/28 © Copyright 2008 ClarIDy Solutions, Inc. All rights reserved. Figure 19 Write EPC 2. Write User Memory (as figure 20): Input “StartOffset”, “Count” and “WriteData” then write the data to user memory. Figure 20 Write User Memory Note : StartOffset: The offset of the first 16-bit word to write. Count: The nubmer of 16-bit words to write. WriteData: The Write data length is Count * 4 nibble.
ClarIDy UHF USB Reader Demo Program for Linux 20/28 © Copyright 2008 ClarIDy Solutions, Inc. All rights reserved. 3.2.4 Filter Inventory Follow the instructions step by step as following: 1. When the user select "4: Filter Inventory", the system shows the input dialogs: “Mask bank”, “Mask start”, “Mask Length”, “Mask data”, “match or unmatched” and “interval time”, as figure 21. 2. Place the RFID tag in the RF field of the ClarIDy UHF RFID Reader. 3. The PC (“PC”), EPC (EPC), CRC16 (CRC), number of reads (“Count”), and Receive Signal Strength Indicator (“RSSI”) will be shown on the table, as Figure 21. Figure 21 Filter Inventory Note : Mask bank: The memory bank to match against ( 0: Reserved, 1: EPC, 2: TID, 3: USER Memory). Mask start offset: The offset of the first byte to match. Mask Length: The number of bits in the mask. Mask data: The byte pattern to match. Match or unmatched: selected to match or unmatched (0: none 2: unmatched, 3: match ).
ClarIDy UHF USB Reader Demo Program for Linux 21/28 © Copyright 2008 ClarIDy Solutions, Inc. All rights reserved. Interval time: Runs out the FlterInventory total time 3.2.5 Filter Read Follow the instructions step by step as following: 1. Place the RFID tag in the RF field of the ClarIDy UHF RFID Reader. 2. Selects "5: Filter Read" , the system shows the input dialogs: “Mask bank”, “Mask start”, “Mask Length”, “Mask data”, “match or unmatched”, “Start offset” and “Count”, as figure 22. 3. The system will show the filtered tag’s memory data, as figure 20. Note : Mask bank: The memory bank to match against ( 0: Reserved, 1: EPC, 2: TID, 3: USER Memory). Mask start offset: The offset of the first byte to match. Mask Length: The number of bits in the mask. Mask data: The byte pattern to match. Match or unmatched: selected to match or unmatched ( 0: none 2: unmatched, 3: match ). Memory bank: The RFID tag's memory bank ( 0: Reserved, 1: EPC, 2: TID, 3: USER Memory). Start offset: The offset of the first 16-bit word to read. Count: The nubmer of 16-bit words to read.
ClarIDy UHF USB Reader Demo Program for Linux 22/28 © Copyright 2008 ClarIDy Solutions, Inc. All rights reserved. Figure 22 Filter Read 3.2.6 Filter Write Follow the instructions step by step as following: 1. Place the RFID tag in the RF field of the ClarIDy UHF RFID Reader. 2. Selects "6: Filter Write" , the system shows the input dialogs: “Mask bank”, “Mask start”, “Mask Length”, “Mask data”, “match or unmatched”, “Start offset”, “Count” and “WriteData”, as figure 23. 3. The system will show the write OK or failed, as figure 23. Note : Mask bank: The memory bank to match against ( 0: Reserved, 1: EPC, 2: TID, 3: USER Memory). Mask start offset: The offset of the first byte to match. Mask Length: The number of bits in the mask. Mask data: The byte pattern to match. Match or unmatched: selected to match or unmatched ( 0: none 2: unmatched, 3: match ). Memory bank: The RFID tag's memory bank ( 0: Reserved, 1: EPC, 2: TID, 3: USER Memory). Start offset: The offset of the first 16-bit word to Write. Count: The number of 16-bit words to write. WriteData: The Write data length is Count * 4 nibble.
ClarIDy UHF USB Reader Demo Program for Linux 23/28 © Copyright 2008 ClarIDy Solutions, Inc. All rights reserved. Figure 23 Filter Write 3.2.7 Lock Tag Follow the instructions step by step as following: 1. Place the RFID tag in the RF field of the ClarIDy UHF RFID Reader. 2. Selects "7: Lock Tag" , the system shows the input dialogs: “Mask bank”, “Mask start”, “Mask Length”, “Mask data” and “match or unmatched”. 3. Select “KillPassword”,” AccessPassword”, “EPC Memory Bank”, “TID Memory Bank” and “User Memory Bank” state. 4. Input the AccessPassword. 5. The system will show the success or failed. Figure 24 Set Filter Mask
ClarIDy UHF USB Reader Demo Program for Linux 24/28 © Copyright 2008 ClarIDy Solutions, Inc. All rights reserved. Figure 25 Set Lock Tag State Note : Mask bank: The memory bank to match against ( 0: Reserved, 1: EPC, 2: TID, 3: USER Memory). Mask start offset: The offset of the first byte to match. Mask Length: The number of bits in the mask. Mask data: The byte pattern to match. Match or unmatched: selected to match or unmatched (0: none 2: unmatched, 3: match ).
ClarIDy UHF USB Reader Demo Program for Linux 25/28 © Copyright 2008 ClarIDy Solutions, Inc. All rights reserved. AccessPassword: The access password for the tags. A value of zero indicates no access password. The state of “KillPassword” and “AccessPassword” as follows: Accessible: The password may be read and written when the tag is in either the open or secured states. Accessible Permanently: The password may be read and written when the tag is in either the open or secured states and this access permission should be set permanently. Secured Accessible: The password may be read or written only when the tag is in the secured state. Not Accessible Permanently: The password may not be read or written and this access permission should be set permanently. No Change: The password’s access permission should remain unchanged. The state of “EPC Memory Bank”, “TID Memory Bank” and “User Memory Bank”as follows: Writeable: The memory bank is writeable when the tag is in either the open or secured states. Writeable Permanently: The memory bank is writeable when the tag is in either the open or secured states and this access permission should be set permanently. Secured Writeable: The memory bank is writeable only when the tag is in the secured state. Not Writeable Permanently: The memory bank is not writeable and this access permission should be set permanently. No Change: The memory bank’s access permission should remain unchanged. 3.2.8 Kill Tag Follow the instructions step by step as following: 1. Place the RFID tag in the RF field of the ClarIDy UHF RFID Reader. 2. Selects "8: Kill Tag" , the system shows the input dialogs: “Mask bank”, “Mask start”, “Mask Length”, “Mask data” and “match or unmatched”. 3. Input the AccessPassword and KillPassword. 4. The system will show the success or failed. Note : Mask bank: The memory bank to match against ( 0: Reserved, 1: EPC, 2: TID, 3: USER Memory).
ClarIDy UHF USB Reader Demo Program for Linux 26/28 © Copyright 2008 ClarIDy Solutions, Inc. All rights reserved. Mask start offset: The offset of the first byte to match. Mask Length: The number of bits in the mask. Mask data: The byte pattern to match. Match or unmatched: selected to match or unmatched (0: none 2: unmatched, 3: match ). AccessPassword: The access password for the tags. A value of zero indicates no access password. KillPassword: The kill password for the tags. Figure 26 Kill Tag
ClarIDy UHF USB Reader Demo Program for Linux 27/28 © Copyright 2008 ClarIDy Solutions, Inc. All rights reserved. 4. Error Code The following lists provide error codes of demo program. These values are defined in the description. Code (dec) Description 0 Success -9999 Attempted to open a reader that is already open -9998 Buffer supplied is too small -9997 General failure -9996 Failed to load reader bus driver -9995 Library cannot use version of reader bus driver present on system -9994 Operation cannot be performed while library is in emulation mode -9993 Antenna number is invalid -9992 Reader handle provided is invalid -9991 One of the parameters to the function is invalid -9990 Attempted to open a non-existent reader -9989 Library has not been successfully initialized -9988 Function not supported -9987 Operation was cancelled by call to cancel operation, close reader, or shut down the library -9986 Library encountered an error allocating memory -9985 The operation cannot be performed because the reader is currently busy -9984 The underlying reader module encountered an error -9983 The reader has been detached from the system -9982 The RFID library function is not allowed at this time. -9981 The reader module's MAC firmware is not responding to requests. -9980 The MAC firmware encountered an error while initiating the nonvolatile memory update. The MAC firmware will return to its normal idle state without resetting the reader module. -9979 An attempt was made to write data to an address that is not in the valid range of reader module nonvolatile memory addresses. -9978 The MAC firmware encountered an error while trying to write to the reader module's nonvolatile memory region. -9977 The underlying transport layer detected that there was an overflow error resulting in one or more bytes of the incoming data being dropped. The operation was aborted and all data in the pipeline was flushed.
ClarIDy UHF USB Reader Demo Program for Linux 28/28 © Copyright 2008 ClarIDy Solutions, Inc. All rights reserved. -7999 Fail to find reader -7998 Fail to allocate memory -7997 Write Data failure -7996 Read Data failure -7995 Lock Tag failure -7994 Kill Tag failure

Navigation menu