Atid AT870 User manual

SDK Reference Guide (Rev1.7)
AT870
Windows CE ® .NET Ruggedized PDA
ATID Co., Ltd.

2AT870 SDK UHF 900MHz Reference
ATID Co., Ltd.
#1210, Byuksan/Gyungln Digital Valley II, #481-10,
Gasan-Dong, Gumchon-Gu, Seoul, Korea
Telephone: [phone]
Fax: [phone]
www.atid1.com
Copyright ○
c2006 ATID Co., Ltd. An Unpublished
Work –All right reserved. No part of the contents of this documentation or the
procedures described there in may be reproduced or transmitted in any form or by any
means without prior written permission of ATID Co., Ltd.. or its wholly owned
subsidiaries ("ATID "). Owners of ATID products are hereby granted
a non-exclusive, revocable license to reproduce and transmit
this documentation for the purchaser's own internal business purposes.
Purchaser shall not remove or alter any proprietary notices, including copyright notices,
contained in this documentation and shall ensure that all notices appear on any
reproductions of the documentation.
Should futruerevisions of this manual be published, you can acquire printed versions by
contacting
ATID Customer Administration. Electronic versions may either be downloadable from the
ATID web site (www.atid1.com) or provided on appropriate media. If you visit our web
site and would like to make comments or suggestions about this or other ATID
publications, please let us know via the “Contact ATID ”page.
Disclaimer
Reasonable measures have been taken to ensure that the information included in this
manual is complete and accurate. However, ATID reserves the right to change any
specification at anytime without prior notice.
ATID is a registered trademark of ATID Co., Ltd..
The ATID logo is a trademark of ATID . All other trademarks and trade names referred to
herein are property of their respective owners.
AT870 is a registered trademark of ATID Co., Ltd.. and of its wholly owned subsidiaries.
Microsoft Windows®, Windows® 2000, Windows® CE .NET, Windows® NT, and Windows® XP are
registered
trademarks of Microsoft Corporation.

3
AT870 SDK UHF 900MHz Reference
AT870 SDK RFID 900MHz Reference
1. UHF 900MHZ .NET SDK API REFERENCE GUIDE.....................5
1.1. CONSTRUCTOR ............................................................................................... 5
1.1.1. CUHFHost()....................................................................................................................... 5
1.2. PROPERTIES................................................................................................... 5
1.2.1. ActivatedForm.................................................................................................................. 5
1.2.2. FirmwareVersion.............................................................................................................. 5
1.2.3. LibVersion......................................................................................................................... 5
1.3. INTERFACE ..................................................................................................... 5
1.3.1. GetAccessEPC()............................................................................................................... 5
1.3.2. GetMemoryData()............................................................................................................. 5
1.3.3. GetReply()......................................................................................................................... 5
1.4. METHODS....................................................................................................... 6
1.4.1. PowerON() ........................................................................................................................ 6
1.4.2. PowerOFF()....................................................................................................................... 6
1.4.3. PowerOnInit() ................................................................................................................... 6
1.4.4. Open()................................................................................................................................ 6
1.4.5. IsOpen()............................................................................................................................. 7
1.4.6. Close()............................................................................................................................... 7
1.4.7. Stop()................................................................................................................................. 7
1.4.8. ReadUID().......................................................................................................................... 7
1.4.9. ReadUID_TagSelect()....................................................................................................... 7
1.4.10. ReadEPC_Continuous() .................................................................................................. 8
1.4.11. InventoryOnce_Done() .................................................................................................... 8
1.4.12. InventoryOnce_TagSelect_Done().................................................................................. 8
1.4.13. InventoryOnce_BankSelect_Done()............................................................................... 8
1.4.14. BankSelectRead() ............................................................................................................ 9
1.4.15. BankSelectRead_TagSelect().......................................................................................... 9
1.4.16. BankSelectRead_BankSelect()....................................................................................... 9
1.4.17. BankSelectRead_Done() ............................................................................................... 10
1.4.18. BankSelectRead_TagSelect_Done() ............................................................................ 10
1.4.19. BankSelectRead_BankSelect_Done()...........................................................................11
1.4.20. BankSelectWrite() ...........................................................................................................11
1.4.21. BankSelectWrite_TagSelect() ....................................................................................... 12
1.4.22. BankSelectWrite_BankSelect()..................................................................................... 12
1.4.23. BankSelectWrite_Done() ............................................................................................... 13
1.4.24. BankSelectWrite_TagSelect_Done() ............................................................................ 13
1.4.25. BankSelectWrite_BankSelect_Done().......................................................................... 13
1.4.26. Lock() .............................................................................................................................. 14
1.4.27. Lock_TagSelect() ........................................................................................................... 14
1.4.28. Lock_BankSelect()......................................................................................................... 15
1.4.29. Lock_Done() ................................................................................................................... 15
1.4.30. Lock_Done_TagSelect() ................................................................................................ 15
1.4.31. Lock_BankSelect_Done().............................................................................................. 16
1.4.32. UnLock().......................................................................................................................... 16
1.4.33. UnLock_TagSelect()....................................................................................................... 17
1.4.34. UnLock_BankSelect().................................................................................................... 17
1.4.35. UnLock_Done() .............................................................................................................. 17
1.4.36. UnLock_TagSelect_Done()............................................................................................ 18
1.4.37. UnLock_BankSelect_Done()......................................................................................... 18
1.4.38. Permalock() .................................................................................................................... 19
1.4.39. Permalock_TagSelect().................................................................................................. 19
1.4.40. Permalock_BankSelect()............................................................................................... 19
1.4.41. Permalock_Done() ......................................................................................................... 20
1.4.42. Permalock_TagSelect_Done()....................................................................................... 20
1.4.43. Permalock_BankSelect_Done().................................................................................... 20

4AT870 SDK UHF 900MHz Reference
1.4.44. TagKill()........................................................................................................................... 21
1.4.45. TagKill_TagSelect()........................................................................................................ 21
1.4.46. TagKill_BankSelect() ..................................................................................................... 21
1.4.47. TagKill_Done()................................................................................................................ 22
1.4.48. TagKill_TagSelect_Done()............................................................................................. 22
1.4.49. TagKill_BankSelect_Done() .......................................................................................... 22
1.4.50. GET_EPC()...................................................................................................................... 23
1.4.51. GET_LAST_ERROR()..................................................................................................... 23
1.4.52. GET_ControlValue()....................................................................................................... 23
1.4.53. bool SET_QValue()......................................................................................................... 24
1.4.54. bool SET_TimeOut() ...................................................................................................... 24
1.4.55. bool SET_PowerControl() ............................................................................................. 24
1.4.56. bool SET_ContinueModeONOff() ................................................................................. 24
1.4.57. SET_Session()................................................................................................................ 25
1.4.58. SET_InventoryTarget()................................................................................................... 25
1.4.59. GET_InventoryTarget() .................................................................................................. 25
1.4.60. GET_MaxPwr()................................................................................................................ 25
1.4.61. SET_LBT_CHState()....................................................................................................... 26
1.4.62. SET_LBT_Time() ............................................................................................................ 26
1.4.63. SET_Default() ................................................................................................................. 26
1.4.64. SET_ReportMode()......................................................................................................... 26
1.5. ENUMERATION ...............................................................................................27
1.5.1. AccessResult ................................................................................................................. 27
1.5.2. ActField........................................................................................................................... 27
1.5.3. CONTROL_CODE........................................................................................................... 27
1.5.4. HOPPING_CODE............................................................................................................ 27
1.5.5. MEMBANK_CODE.......................................................................................................... 27
1.5.6. ReportMode.................................................................................................................... 28
1.5.7. UIDREAD_CODE ............................................................................................................ 28
1.5.8. InventoryFlagMode........................................................................................................ 28
1.6. STRUCTURE...................................................................................................28
1.6.1. CH_STATE....................................................................................................................... 28
1.6.2. CONTROL_VALUE ......................................................................................................... 28

5
AT870 SDK UHF 900MHz Reference
1. UHF 900Mhz .NET SDK API Reference Guide
1.1. Constructor
1.1.1. CUHFHost()
CUHFHost(Objcect Form)
Description :
Initialize a new CUHFHost object
Parameters :
Objcect Form : Application Window Form.
Return Values :
None
Protocol Type :
EPC Gen2
1.2. Properties
1.2.1. ActivatedForm
Description :
Change Activated Application Window Form
1.2.2. FirmwareVersion
Description :
Get Firmware Version
1.2.3. LibVersion
Description :
Get Library Version
1.3. Interface
1.3.1. GetAccessEPC(string EPC)
Description :
Get accessed EPC of tag.
1.3.2. GetMemoryData(string MemoryData)
Description :
Get MemoryBank Value. (Result of access’operation)
1.3.3. GetReply(string Reply)

6AT870 SDK UHF 900MHz Reference
Description :
Get Reply. (Result of operation)
1.4. Methods
1.4.1. void PowerON()
Description :
This function turns on UHF module.
Parameters :
None
Return Values :
None
Protocol Type : EPC Gen2
Note :
You use this function just one time when you initialize your program.
1.4.2. void PowerOFF()
Description :
This function turns off UHF module.
Parameters :
None
Return Values :
None
Protocol Type : EPC Gen2
Note :
You use this function just one time when you close your program.
1.4.3. bool PowerOnInit()
Description :
This function initialize UHF module when PDA turns on.
Parameters :
None
Return Values :
True or false
Protocol Type : EPC Gen2
Note :
You must use this function every time when your PDA turns on.
1.4.4. bool Open()
Description :
This function opens the communication port of UHF module.
Parameters :
None
Return Values :
TRUE : If it was successful to open the communication port of UHF module
FALSE : If this function failed in opening the communication port of UHF module.
The cause of FALSE : Another program is using the UHF900Mhz reader, you need to
close the program to use yours.

7
AT870 SDK UHF 900MHz Reference
Protocol Type : EPC Gen2
Note :
You use this Open function just one time when you initialize your program.
1.4.5. bool IsOpen()
Description :
Use this function to check the communication port is open or not.
Parameters :
None
Return Values :
TRUE or FALSE
Protocol Type : EPC Gen2
1.4.6. void Close()
Description :
This function closes the communication port.
Parameters :
None
Return Values :
None
Protocol Type : EPC Gen2
Note : You use this Close function just one time when you close your program.
1.4.7. void Stop()
Description :
This function stops the current task.
Parameters :
None
Return Values :
None
Protocol Type : EPC Gen2
1.4.8. void ReadUID(UIDREAD_CODE code)
Description :
This function executes the 900MHz reader to read UID according as the value of
UIDREAD_Code. If the function succeeds in reading, it calls GetAccessEPC(string
EPC)function in user’s application.
If the value of Code is set by EPC_GEN2_MULTI_TAG, the reader reads tag
continuously till it receives the stop command.
Parameters :
UIDREAD_CODE code
Return Values :
None
Protocol Type : EPC Gen2
1.4.9. void ReadUID_TagSelect(UIDREAD_CODE code, string EPC)

8AT870 SDK UHF 900MHz Reference
Description :
This function works as like as API ReadUID(UIDREAD_CODE code) function, but
this function only access the tag which is masked.
Parameters :
UIDREAD_CODE code –Read Type
string EPC –the value of EPC to access
Return Values :
None
Protocol Type : EPC Gen2
1.4.10. void ReadEPC_Continuous()
Description :
The reader reads multi-tag continuously till it receives the stop command.
If the function succeeds in reading UID, it calls GetAccessEPC(string EPC)function in
user’s application..
Parameters :
None
Return Values :
None
Protocol Type :
EPC Gen2
1.4.11. AccessResult InventoryOnce_Done(string Result)
Description :
SET_ReportMode(ReportMode.WAIT_DONE, true) should be set in order to use this
function.
Get EPC value through ‘Result’variable is entered as a parameter.
Refer to ‘Access Result’for result.
Parameters :
string Result - variable to get data.
Return Values :
AccessResult
Protocol Type : EPC Gen2
1.4.12. AccessResult InventoryOnce_TagSelect_Done(string Result, string EPC)
Description :
SET_ReportMode(ReportMode.WAIT_DONE, true) should be set in order to use this
function.
This function read EPC same as second parameter EPC.
Parameters :
string Result –variable to get data.
string EPC - the value of EPC to access.
Return Values :
AccessResult
Protocol Type : EPC Gen2
1.4.13. AccessResult InventoryOnce_BankSelect_Done(string Result, MEMBANK_CODE
MemBank_s, uint Offset_s, string Pattern_s)

9
AT870 SDK UHF 900MHz Reference
Description :
SET_ReportMode(ReportMode.WAIT_DONE, true) should be set in order to use this
function. This function can read UID of target tag that is found by pattern of target tag.
Any memory bank data can be used as pattern for example epc, tid, user, reserved
area. This function read EPC same as second parameter EPC.
Parameters :
string Result –variable to get data.
MEMBANK_CODE MemBank_s –memory bank of target tag
uint Offset_s –the memory address of pattern (one bit per a unit)
string Pattern_s –the pattern of memory bank
Return Values :
AccessResult
Protocol Type : EPC Gen2
1.4.14. void BankSelectRead(MEMBANK_CODE MemBank, uint start, uint length)
void BankSelectRead(MEMBANK_CODE MemBank, uint start, uint length , string
AccessPWD)
Description :
This function reads the Memory Bank and Block Data of tag.
If the function succeeds in reading, it calls GetMemoryData(string MemoryData)
function in user’s application.
Parameters :
MEMBANK_Code MemBank –selects the type of Memory Bank
uint start (Min:0 ~ Max:422820625) –the memory address to read.
uint length(Min:1 ~ Max:255) –the length of memory to read. (It reads data by 2Byte)
string AccessPWD(can be omitted) –using password, if Membank is locked.
Return Values :
None
Protocol Type : EPC Gen2
1.4.15. void BankSelectRead_TagSelect(MEMBANK_CODE MemBank, uint start, uint length,
string EPC)
void BankSelectRead_TagSelect(MEMBANK_CODE MemBank, uint start, uint length,
string EPC, string AccessPWD)
Description :
This function works as like as BankSelectRead(MEMBANK_CODE MemBank, uint start,
uint length) function, but this function only access the tag which is masked.
Parameters :
MEMBANK_CODE MemBank –selects the type of Memory Bank
uint start (Min:0 ~ Max:422820625) –the memory address to read.
uint length(Min:1 ~ Max: 255) –the length of memory to read. (It reads data by 2Byte)
string EPC –the value of EPC to access.
string AccessPWD(can be omitted) - using password, if Membank is locked.
Return Values :
None
Protocol Type : EPC Gen2
1.4.16. void BankSelectRead_BankSelect(MEMBANK_CODE MemBank, uint start, uint length,

10 AT870 SDK UHF 900MHz Reference
bool multi, MEMBANK_CODE MemBank_s, uint Offset_s, string Pattern_s, string
strAccessPWD)
void BankSelectRead_BankSelect(MEMBANK_CODE MemBank, uint start, uint length,
bool multi, MEMBANK_CODE MemBank_s, uint Offset_s, string Pattern_s)
Description :
This function works as like as BankSelectRead(MEMBANK_CODE MemBank, uint start,
uint length) function, but this function can access the tag with other memory bank as
EPC, TID, USER, Reserve. And also this function can access tag continuously to set
parameter “multi”to true.
Parameters :
MEMBANK_CODE MemBank –selects the type of Memory Bank
uint start (Min:0 ~ Max:422820625) –the memory address to read.
uint length(Min:1 ~ Max: 255) –the length of memory to read. (It reads data by 2Byte)
bool multi –flag for continuous mode
MEMBANK_CODE MemBank_s –memory bank of target tag
uint Offset_s –the memory address of pattern (one bit per a unit)
string Pattern_s –the pattern of memory bank
string AccessPWD(can be omitted) –using password, if Memory bank is locked.
Return Values :
None
Protocol Type : EPC Gen2
1.4.17. AccessResult BankSelectRead_Done(string Result, MEMBANK_CODE MemBank, uint
start, uint length)
AccessResult BankSelectRead_Done(string Result, MEMBANK_CODE MemBank, uint
start, uint length , string AccessPWD)
Description :
This function works as like as BankSelectRead(MEMBANK_CODE MemBank, uint
start, uint length) function, but result is read through parameter ‘Result’.
SET_ReportMode(ReportMode.WAIT_DONE) should be set for use this function. Refer
to ‘AccessResult’for getting result.
Parameters :
string Result - variable to get data.
MEMBANK_Code MemBank –selects the type of Memory Bank
uint start (Min:0 ~ Max:422820625) –the memory address to read.
uint length(Min:1 ~ Max:255) –the length of memory to read. (It reads data by 2Byte)
string AccessPWD(can be omitted) –using password, if Membank is locked..
Return Values :
AccessResult
Protocol Type : EPC Gen2
1.4.18. AccessResult BankSelectRead_TagSelect_Done(string Result, MEMBANK_CODE
MemBank, uint start, uint length, string EPC)
AccessResult BankSelectRead_TagSelect_Done(string Result, MEMBANK_CODE
MemBank, uint start, uint length, string EPC, string AccessPWD)
Description :
This function works as like as BankSelectRead(MEMBANK_CODE MemBank, uint