ATID UHF RFID READER Protocol. July 2009 ATID900F - V0.0.3

Transcription

1 Specification for RFID Reader Host Interface ATID UHF RFID READER Protocol July 2009 ATID900F - V0.0.3 Copyright c 2009, ATID Inc. All rights reserved 1-28

2 Document Version Ø Ver The protocol draft written. Model applied: ATID900F F/W applied: root.v002 Ø Ver Reader command, Set/Get control added. - The overall document s content updated. Model applied: ATID900F F/W applied: root.v006~7 Ø Ver The checksum method changed. - The overall document s content updated. Model applied: ATID900F F/W applied: root.v

3 List I. OVERVIEW... 4 II. SIGNAL... 5 III. PACKET... 6 IV. DATA... 7 V. ANNEX

4 I. OVERVIEW This document defines the communication method and messages between the two processors for the reader controller that interlocks with the reader. 4-28

5 II. SIGNAL The terminal unit connected with the reader uses signal of RS-232 level and transmits from the MSB. ( bps, Async, Full duplex, 8bits, No parity) The state of physical connection, equipped with RX, TX lines sharing with the ground, uses an independent communication line. 5-28

6 III. PACKET STX DATA ETX The packet is composed of STX, DATA and ETX. Following below shows each content of the composition. Code Length STX > (0x3E) 1byte DATA reader Data More than 1byte ETX \r\n (0x0D0A) 1byte Each unit consists of 8bit(octet) and their formation is network byte order. 6-28

7 IV. DATA Host Reader Tag START (SET/GET CONTROL) (REPLY) REQ TAG READ RF RES TAG READ (STOP) <Fig. 1 - Data Flow> 7-28

8 A. START The reader is power on and when the booting is complete it transmits START. - Reader -> Host(PC) - Function: Informs the PC of booting completion. - Command : STX Start Code ETX Length(byte) HEX 3Eh 73h 74h 61h 72h 74h 0D0Ah ASCII > start \r\n Ex ) 3Eh 73h 74h 61h 72h 74h 0D 0A( >start\r\n ) B. SET CONTROL Command for changing the control values of reader. - Host(PC) -> Reader - Function: Changes main control values of reader. - Command : 8-28

9 STX Command SP Control SP Value ETX Code Code Length(byte) variable 2 HEX 3Eh 78h 20h 20h 0D0Ah ASCII > x \r\n <Table 1> Control Code/Value No. CODE (char) CODE (HEX) CONTROL VALUE DEFAULT 1 b 0x62 Buzzer 0(0x30), 1(0x31) 1(ON) 2 c 0x63 Continuous Mode 0(0x30), 1(0x31) 1(ON) 3 d 0x64 All Default Set X X 4 e 0x65 ANT Status 0~15(0x30~0x3135 ) 1 5 j 0x6A ANT Switching Time 1~10000(ms) 500(ms) 6 p 0x70 Power Gain 0~300 (0x30~0x333030) q 0x71 Start Q Value 0~15 7 IP Address Value 8 r 0x72 Reader IP Address ex) (0x312e32 2E332E34) x 0x78 Reader Mode 0~MAX 0 IP Address Value 10 z 0x7A Server IP Address ex) (0x312e32 2E332E34) x30 Power Idle Time 0~10000(ms) 100(ms) x31 Baud Rate 0(0x30), 1(0x31) 0(115200bps) x x33 Ethernet Port Number Repeat Tag Report Time 1024~ ~ (Sec) x34 GPIO Delay 0~ (ms) x35 GPIO Out Port 0~

10 17 6 0x36 Status Server Access Time 0~ (Sec) 18 [ 0x5b Mini Q Value 0~ ] 0x5d Max Q Value 0~ All numeric value correspond to the ASCII codes. Ex) 0 -> 0x30, 1 -> 0x31 As the exceeded value is not filtered through the reader, When applying a wrong value, the reader may malfunction. (it is recommended restoring to the initial state using the default code d(0x64) ) 1. Buzzer Switch: Sets buzzer On/Off. VALUE 0 1 Buzzer Switch Off On 2. Continuous Mode: If the reader performs Inventory and the continuous mode is off, the reader becomes off automatically when after Tag is read once, and the continuous mode is on it continuously performs until it receives a Stop command. VALUE 0 1 Continue Mode Off On 3. All Default set: Set all the control values to those of default. 4. ANT Status: Sets the antenna port. ANT 4 ANT 3 ANT 2 ANT 1 VALUE OFF OFF OFF ON 1 OFF OFF ON OFF 2 OFF OFF ON ON 3 OFF ON OFF OFF

11 OFF ON OFF ON 5 OFF ON ON OFF 6 OFF ON ON ON 7 ON OFF OFF OFF 8 ON OFF OFF ON 9 ON OFF ON OFF 10 ON OFF ON ON 11 ON ON OFF OFF 12 ON ON OFF ON 13 ON ON ON OFF 14 ON ON ON ON ANT Switching Time: In case that the reader uses over two antenna ports, it uses the other antenna successively during the time of ANT Switching at the one port. Ex) In case of ANT Status 3, ANT Switching Time 500: (a) ANT1 operates during 500ms and ANT2 operates during 500ms. (b) Repeats process (a) until STOP command executed 6. Power Gain: Changes the power level of the reader s transmission. Table recommended for power level Power Level (Parameter) dbm Start Q Value: Nominates Q algorithm Start Q value for the Multi Tag Read. If not a single TAG environment, using the default value(7) recommended. 8. Reader IP Address: Used for changing Ethernet IP Address of the reader that is set currently

12 IP Address X.(0x2E) X. X. X ex) 3Eh 78h 20h 72h 20h 31h 39h 32h 2Eh 31h 36h 38h 2Eh 31h 30h 2Eh 39h 31h ( >x r \r\n ) 9. Reader Mode: Changes the reader s mode. Value Mode Description 0 Normal Mode Basic motion mode 1 Inventory Auto Mode When booted, it performs the Inventory Command( f ) automatically. X reserved Added upon user s request. 10. Server IP Address: If the reader operates with TPC/IP Client, nominates the IP server to access. IP Address X.(0x2E) X. X. X ex) 3Eh 78h 20h 72h 20h 31h 39h 32h 2Eh 31h 36h 38h 2Eh 31h 30h 2Eh 39h 31h ( >x r \r\n ) 11. Power Idle Time: Changes the Idle Time of the Inventory Idle Command (It is recommended to use Inventory Command in an actual environment in order to minimize the interference between readers in multi environments and prevent the reader s overheat due to the full time work for a long time). Ex) In case of ANT Switching Time 500, Power Idle Time 100: When performing Inventory Idle Command, the reader maintains an idle state (Power Gain Off) during 100ms every 500ms and then does Inventory again. 12. Baud Rate : Changes the reader s UART Baud Rate. Value Baud Rate 12-28

13 0 (default) bps bps 13. Ethernet Port Number: Changes the port number of Ethernet (It is recommended to use number from 1024 except the well-known numbers. Default: 5578). 14. Repeat Tag Report Time : When using User Option Command it set the report time about repeatedly read TAG 15. GPIO Delay : Tag 인식시 GPIO Status 에설정된 GPIO 값의유지시간을 설정한다. 16. GPIO Out Port Status : When recognizing Tag it sets the signal level of the GPIO Out Port Value GPIO Out 1 GPIO Out 2 GPIO Out 3 0 Low Low Low 1 Low Low High 2 Low High Low 3 Low High High 4 High Low Low 5 High Low High 6 High High Low 7 High High High 17. Server Access Time: If the reader operates with TCP/IP Client, it sets the time interval to attempt to connect the server 13-28

14 18. Mini Q Value : Nominates the Q algorithm Minimum Q value for the Multi Tag Read. 19. Max Q Value : Nominates the Q algorithm Minimum Q value for the Multi Tag Read. B. GET CONTROL Command used for fetching control values of reader from terminal. - Host(PC) <-> Reader - Function: Reads the control values which is currently set in the reader. - Command : STX Command SP Control ETX Code Code Length(byte) HEX 3Eh 79h 20h 0D0Ah ASCII > y \r\n For Control Code, refer to the Table1 Control Code/Value Ex) 3Eh 79h 20h 65h 0Dh 0Ah ( >x e\r\n ) - Reply : Replies to the Control Value which is currently set. STX Command Control ETX Code Value Length(byte) 1 1 Variable 2 HEX 3Eh 79h 0D0Ah ASCII > Y \r\n 14-28

15 Ex) 3Eh 65h 31h 35h 0Dh 0Ah ( >e15\r\n ) D. READER COMMAMD The reader provides commands used for controlling commands and reader itself accessing TAG. Following shows REQ TAG READ packet formation. Commands without parameter transmits only the Command Code between STX and ETX, and Those unnecessary for parameter are divided in (0x20) between Command Code and each parameter, transmitting as many as the numbers of parameters. - Host(PC) <-> Reader - Function: Main commands of reader -Command: The main commands of the reader are shown below. <Table 2> Reader Command No. CODE CODE COMMAND PROTOCOL PARA (char) (HEX) TYPE METER 1 f 0x66 Inventory (EPC Read) C X 2 d 0x64 Inventory_Idle C X 3 R 0x72 Memory READ C 1, 2, 3, (4) 4 W 0x77 Memory WRITE C 1, 2, 3, (4) 5 ㅣ 0x6C Memory LOCK C 1, 2, (3) 6 K 0x6B TAG KILL (Reserved) C 1 7 G 0x67 GPIO Control

16 8 Q 0x71 Reader Reset (soft) X 9 S 0x73 Reader Reboot (hard) X - Reply : Reply: Replies either to the case in which when it receives the data of Tag or to that in which it receives a response code from Tag. If the Tag Data is received Check sum is added for the Tag reply 1) TAG Data Reply STX ANT No. REPLY Tag CheckSum ETX CODE Reply Length(byte) Variable 2 2 HEX 3Eh 31~34h 54h 0D0Ah ASCII > 1~4 T \r\n The checksum is the changed value of Ascii of that in which the Tag Reply is Exclusive OR(^) by 1byte. Ex) Tag Reply: > checksum: Being 0x34, it becomes when changed to ASCII. 2) Tag-Replycode Reply STX ANT No. REPLY CODE Tag- Replycode ETX Length(byte) HEX 3Eh 31~34h 43h 0D0Ah ASCII > 1~4 C \r\n <Table 3> Tag-ReplyCode Ascii Hex Tag Reply h Success h Other error h Memory overrun 16-28

17 h Memory locked 0B 3042h Insufficient power 0F 3046h Non-specific error 1. Inventory: It is the most basic command that fetches EPC(Tag ID) of Tag. The reader responds in formation of PC+EPC only when Tag is detected - Command STX COMMAND CODE ETX Length(byte) HEX 3Eh 66h 0D0Ah ASCII > f \r\n Ex) 3Eh 66h 0Dh 0Ah ( >f\r\n ) - Reply STX ANT No. REPLY PC EPC CheckSum ETX CODE Length(byte) Variable 2 2 HEX 3Eh 31~34h 54h 0D0Ah ASCII > 1~4 T \r\n Ex) 3Eh 31h 54h 30h 31h 30h 0Dh 0Ah 3Eh 33h 54h 30h 32h 33h 0Dh 0Ah.. As TAG that has EPC of a different length respectively is capable of responding the data length is variable.. 2. Inventory_Idle : As a command that has a extended function it performs the inventory for certain time and performs it again after stops during the idle time

18 It is a recommended command to be used in an actual environment in order to minimize the interference between readers in multi environments and prevent the reader s overheats due to the full time work for a long time. The Inventory time is set as the ANT Switching Time(ms) of the Set Control, and the Idle time is set as Power Idle Time(ms). - Command STX COMMAND CODE ETX Length(byte) HEX 3Eh 64h 0D0Ah ASCII > d \r\n Ex) 3Eh 64h 0Dh 0Ah ( >d\r\n ) - Reply STX ANT No. REPLY PC EPC CheckSum ETX CODE Length(byte) Variable 2 2 HEX 3Eh 31~34h 54h 0D0Ah ASCII > 1~4 T \r\n Ex) 3Eh 31h 54h 30h 31h 30h 0Dh 0Ah 3Eh 33h 54h 30h 32h 33h 0Dh 0Ah.. As TAG that has EPC of a different length respectively is capable of responding the data length is variable. 3. Memory Read : 3 or 4 parameters are required as it is command for reading when accessing directly the memory of Tag. - Parameter 1: Nominates the Memory Bank of tag

19 - Parameter 2: Nominates the start address of the nominated Memory Bank. The PC of EPC Bank is the 1st address, 2nd from EPC. - Parameter 3: Nominates word lengths (16 bits unit in standard of Tag Memory) to read. - Parameter 4: As the access password for accessing the Tag in which a password is set, it omits Tags in which a password is not set. - Command STX Command SP Bank SP Addr SP Leng (SP) (Pass ETX Code ess th word) Length variab 1 varia (byte) le ble HEX 3Eh 72h 20h 30h~33h 20h 20h 20h 0D0Ah ASCII > r 0~3 \r\n Password can be omitted and at this time the last SP should be omitted as well. The PC of EPC Bank is the 1st address, 2nd from EPC. Length 1 is 2byte in standard of the TAG memory(4byte in standard of ASCII). Ex) 3Eh 72h 20h 31h 20h 32h 20h 31h 0Dh 0Ah ( >r 1 2 1\r\n ) <Table 4> BANK BANK Hex Ascii RESERVED 30h 0 EPC 31h 1 TID 32h 2 USER 33h 3 - Reply 19-28

20 STX ANT No. Reply Code Data CheckSum ETX Length(byte) Variable 2 2 HEX 3Eh 31~34h 54h 0D0Ah ASCII > 1~4 T \r\n STX ANT No. Reply Code Tag-Code ETX Length(byte) HEX 3Eh 31~34h 43h 0D0Ah ASCII > 1~4 C \r\n For Tag-Code, refer to the table3 Tag-Reply codes. Ex) 3Eh 31h 54h 30h 31h 30h 0Dh 0Ah 4. Memory Write: 3 or 4 parameters are required as it is command for reading when accessing directly the memory of Tag - Parameter 1: Nominates the Memory Bank of tag. - Parameter 2: Nominates the start address of the nominated Memory Bank. - Parameter 3: As the Write Data it can nominate up to 100 bytes(standard of ASCII code) of the word(16bits in standard of Tag Memory, 4byte in standard of ASCII code) unit data. - Parameter 4: As the access password for accessing the Tag in which a password is set, it omits Tags in which a password is not set - Command STX Command SP Bank SP Addr SP Data (SP) (Pass ETX Code ess word) Length variab 1 4~ (byte) le 0 HEX 3Eh 77h 20h 30h~33h 20h 20h 20h 0D0Ah ASCII > w 0~3 \r\n 20-28

21 Password can be omitted and at this time the last SP should be omitted as well. The PC of EPC Bank is the 1st address, and 2nd from EPC. Length 1 is 2byte in standard of the TAG memory(4byte in standard of Ascii). For Bank, refer to the table4 Bank Ex 1) 3Eh 77h 20h 31h 20h 34h 20h 31h 31h 31h 31h 32h 32h 32h 32h 33h 33h 33h 33h 34h 34h 34h 34h 0Dh 0Ah ( >w \r\n ) Ex 2) Memory Write+ Access Password 3Eh 77h 20h 31h 20h 34h 20h 31h 31h 31h 31h 20h 31h 32h 33h 34h 35h 36h 37h 38h 0Dh 0Ah ( >w \r\n ) - Reply STX ANT No. Reply Code Tag-Code ETX Length(byte) HEX 3Eh 31~34h 43h 0D0Ah ASCII > 1~4 C \r\n For Tag-Code, refer to the table1 tag-reply Code. Ex) 3Eh 31h 43h 30h 31h 0Dh 0Ah (Success) 5. Memory Lock : Sets the access password in Tag, sets password in Tag using Lock command. 2 or 3 parameters are necessary, and for detail of Lock, refer to the supplement - Parameter 1: As the Memory Mask the action of the parameter 2 is valid for the memory whose Mask bit is 1(refer to the supplement)

22 - Parameter 2: Nominates Memory Action(refer to the supplement). - Parameter 3: As the access password for accessing the Tag in which a password is set, it omits Tags in which a password is not set. - Command - STX Command SP Mask SP Action (SP) (Pass ETX Code word) Length (byte) HEX 3Eh 6Ch 20h 20h 20h 0D0Ah ASCII > l \r\n Password can be omitted and at this time the last SP should be omitted as well. For Mask and Action, refer to the supplement. Ex) 3Eh 6Ch 20h 30h 30h 33h 30h 20h 30h 30h 32h 30h 0Dh 0Ah ( >l \r\n ) - Reply STX ANT No. Reply Code Tag-Code ETX Length(byte) HEX 3Eh 31~34h 43h 0D0Ah ASCII > 1~4 C \r\n For Tag-Code, refer to the table3 Tag-Reply Codes. Ex) 3Eh 31h 43h 30h 31h 0Dh 0Ah (Success) 6. TAG KILL : Available to support upon request. 7. GPIO Control : A command to be used for controlling the external IO port of reader. Reader provides two of input ports and 3 of output ports. In special circumstances the auto control can be provided, and general control method is 22-28

23 as follow.. - Parameter 1: Sets command modes Parameter value Mode Select Description 0 Get Gets Input/Out port. 1 Set Sets Output Port - Parameter 2: Uses value 00~07, nominating set value of the output port. <Table 5> GPIO Status Value GPIO In 1 GPIO 2 GPIO Out 1 GPIO Out 2 GPIO Out 3 00 Low Low Low Low Low 01 Low Low Low Low High 02 Low Low Low High Low 03 Low Low Low High High 04 Low Low High Low Low 05 Low Low High Low High 06 Low Low High High Low 07 Low Low High High High 08 Low High Low Low Low 17 High High High High Low 1F High High High High High 23-28

24 - Command STX Command SP Select Mode (SP) (Set ETX Code Value) Length(byte) HEX 3Eh 67h 20h 30h or 31h 20h 0D0Ah ASCII > g 0 or 1 \r\n In case that the Select mode is 0, the set value should be omitted, and at this moment the last SP should be omitted as well. - Reply : For part Status, refer to the table5 GPIO Status STX Reply Code Port Status ETX Length(byte) HEX 3Eh 43h 0D0Ah ASCII > g \r\n 8. Reader Reset : Soft Reset except OS(Quick reset) - Command STX Command Code ETX Length(byte) HEX 3Eh 71h 0D0Ah ASCII > q \r\n Ex) 3E 71 0D 0A ( >q\r\n ) 9. Reader Reboot : OS 를포함한 All Reboot. ( 재부팅시간이소요됨.) - Command STX Command Code ETX Length(byte) HEX 3Eh 73h 0D0Ah ASCII > s \r\n 24-28

25 - Ex) 3E 73 0D 0A ( >s\r\n ) E. READER STOP A command that finishes the performance immediately while the reader performs the TAG command. - Host(PC) -> Reader - Function: A massage that finishes the TAG command forcibly - Command : STX Command Code ETX Length(byte) HEX 3Eh 33h 0D0Ah ASCII > 3 \r\n Ex) 3Eh 33h 0Dh 0Ah ( >3\r\n ) 25-28

26 V. ANNEX Memory Lock - Using the memory lock command: 'l [Mask(4byte)] [Action(4byte)]'(6Ch 20h XXh XXh XXh XXh 20h XXh XXh XXh XXh) * Mask : Kill Pwd AccessPwd EPC TID User pwd lock pwd lock pwd lock pwd lock pwd Lock Bit 0: Do not change the lock bit. Bit 1: Change the lock bit. * Action : Kill Pwd AccessPwd EPC TID User pwd lock pwd lock pwd lock pwd lock pwd Lock Pwd Bit 0: Password is unnecessary when reading or writing. Pwd Bit 1: Password is necessary when reading or writing. Lock Bit 0: Password Bit can be changed only when the user knows the access password or it is set in 0. Lock Bit 1: Reading or writing is not available and the password bit and lock bit can not be changed. The lock commend is performable only when the access password is 0, or the user knows it. If the password bit of the kill password and access password is 1, in case that the user doesn t know the access password, reading/writing is impossible leaving the rest accessible only to reading. If the lock bit is set in 1, writing/reading is not available even in case the user knows the password. Once the lock bit is changed to 1, never can it be changed. When transmitting the Mask or Action to the reader, they are subject to being encoded with the ASCII code as same with other commands and being transmitted. Ex) When the Mask is 0030, it should be changed to 0x Lock scenario 1: Password Bit: 1, Access password:

27 Although it is impossible to read or write a password in the memory, it is possible to change password bit to 0 and read or write it again. In other words, at first the user can set the password impossible for it to be read or written, but if the or she changes it to 0 the password can be read or written. Lock scenario 2: Password Bit: 1, Access password: value except 0 In order to write/read the pass word in the memory, the user is required to know his access password. It is possible if an access password(8 byte in standard of ASCII code) of TAG is included in the last parameter of each command(memory read/write/lock). - Fetching the lock bit set in TAG using the Memory Read Command. : In order to fetching the lock bit in from TAG, simply use the command Memory Read Command >r 0 4 1, to which 10 bits of the 16 bits responded belong Kill Pwd AccessPwd EPC TID User Pwd lock pwd lock pwd lock pwd lock pwd Lock Ex) Reader Reply : >1T0300 -> TID Pwd, Lock Enable - Fetching the access password in from TAG using Memory Read Command : Simply use the command >r (XXXXXXXX). The password enabled TAG should include the access password 8 byte(xxxxxxxx). Ex) Reader reply: (0x ) -> As the access password is 0, lock command is performable without any password. - Changing the access password using the Memory Write Command : Simply use >w 0 2 XXXXXXXX (XXXXXXXX). In case the password of the lock bits of the access password is enabled, the user can change it to a new password including it to parameter 4 of the memory Write Command, but at this time the work should be processed by 2 bytes once in all, and the response is not guaranteed depending on the communication environment. Therefore this method is not recommended. In this case it is recommended the user disable a password of the lock bits of the access password and perform it. - An example of restricting the TAG Access using the access password

28 1. Enter the data into the memory writing. Ex)>w Enter the Access Password into the memory writing. Ex)>w Have the access password, EPC Bank password enabled to the memory lock that includes access passwords. Ex)>l 00a0 00a Data can be changed to the memory write that includes the access password. Ex)>w aaaa TAG KILL(Reserved) - Using the TAG Kill Command: '>k [password(8byte)]'(6bh XXh XXh XXh XXh XXh XXh XXh XXh) * Password: All the kill passwords are saved in the 0 position(upper part) and 1 position(lower part) of the Reserved memory(membank 0). In case that all the kill passwords are 0, it is not possible to kill them, so, in order to kill them, not 0, but a kill password should necessarily be saved. The kill password can be saved using memory write and can be read using memory read. Ex1) Fetching kill password: >r (XXXXXXXX) -> Reader s response: Ex2) Saving kill password: : >w (XXXXXXXX) -> Reader s response: 01 Ex3) Killing: >k (0x6B ) -> Reader s response: 01 The response to the kill command is depending on whether 01 is entered or not, but despite being killed the response may not come up depending on the communication environment. In this case it is recommended checking the result instead consistently waiting the response. Bear in mind that once TAG is killed, it cannot be changed