Technical Information Manual Revision n. 4 17 January 2007 CAEN RFID UHF READERS COMMUNICATION PROTOCOL NPO: 00117/03:PROTx.
Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Revision date: 17/01/2007 Revision: 4 INDEX 1. INTRODUCTION ................................................................................................................................................3 2. PROTOCOL SPECIFICATION ........................................................................................................................4 3. ASYNCHRONOUS NOTIFICATION: PROTOCOL SPECIFICATION .........
Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Revision date: 17/01/2007 Revision: 4 1. Introduction This document describes the message format of the communication protocol used by the host and the reader in order to issuing commands and reply with responses. The protocol is based on the Attribute Value Pair (AVP) schema and foresees a message header in order to identify the message scope.
Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Revision date: 17/01/2007 Revision: 4 2. Protocol specification CAEN UHF RFID Reader protocol uses two logical communication channels: one for synchronous commands and one for asynchronous notifications. Command channel is mandatory and, at now, it is implemented on top of a TCP/IP socket (port 1000) and on RS232 while notification channels are implemented only with sockets.
Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Revision date: 17/01/2007 Revision: 4 Table 2.1: Attribute types Code 0x01 Description CommandName: the command to be executed. All the commands are specified in the relevant table. Attribute value is 2 bytes long. ResultCode: a code representing an indication on the result of the 0x02 command. All the commands are specified in the relevant table. Attribute value is 2 bytes long.
Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Code Revision date: 17/01/2007 Revision: 4 Description ReadPointName: a string representing the name of the read point. 0x22 Attribute value has a maximum length of 5 bytes and can assume the following values: “Ant0”, “Ant1”, “Ant2”, “Ant3” 0x4D 0x4E 0x4F 0x50 TagValue: data read from the tag memory (when applicable). Attribute value has a maximum length of 128 bytes.
Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Code Revision date: 17/01/2007 Revision: 4 Description Boolean: a value representing a boolean data. Attribute value is 2 bytes 0x57 long and can assume the following values: 0x00 = FALSE. Not 0x00 = TRUE. IPAddress: a string representing an IP address formatted with the standard 0x58 IP dotted decimal format. Attribute value has a maximum length of 30 bytes.
Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Code 0x61 0x62 Revision date: 17/01/2007 Revision: 4 Description DataBits: a value representing the databits setting of serial port. Attribute value is 4 bytes long. StopBits: a value representing the stopbits setting of serial port. Attribute value is 4 bytes long. Parity: a value representing the parity setting of serial port.
Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Code Revision date: 17/01/2007 Revision: 4 Description IORegister: a value representing the status of the I/O lines of the reader. Where input lines are separated from output ones, input lines are mapped 0x69 on the less significant bits while outputs are mapped on the most significant. Attribute value is 4 bytes long (effective used bits depend on the reader model).
Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Code Revision date: 17/01/2007 Revision: 4 Description MemoryBank: a value representing the memory bank of a EPC Class 1 Generation 2 tag.
Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Code Revision date: 17/01/2007 Revision: 4 Description SourceName: a string representing the name of the data source. Attribute 0xFB value has a maximum length of 30 bytes and can assume the following values: “Source_0”, “Source_1”, “Source_2”, “Source_3” Table 2.2: Command codes Code Description Comp. RawReadIDs: permits to get all the tag’s Ids that are under the RF field of the selected source.
Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Code Revision date: 17/01/2007 Revision: 4 Description Comp. RemoveNotifyTrigger: permits to remove a trigger from a notification channel. 0x42 Parameters: A928EU ChannelName: [in] the name of the channel. A948EU TriggerName: [in] the name of the trigger. ResultCode: [out] the result code. AllocateTrigger: permits to create a new trigger. Parameters: 0x49 A928EU TriggerName: [in] the name of the trigger.
Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Code Revision date: 17/01/2007 Revision: 4 Description Comp. RemoveSourceFromChannel: permits to remove a source from a notification channel. 0x5E Parameters: A928EU SourceName: [in] the name of the source. A948EU ChannelName: [in] the name of the channel. ResultCode: [out] the result code. AddReadPointToSource: permits to add a readpoint to a source.
Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Code Revision date: 17/01/2007 Revision: 4 Description Comp. WriteTagData: permits to write data to the tag memory. A928EU Parameters: A948EU SourceName: [in] the name of the source to use. A828EU TagIDLen: [in] the ID length of the tag. 0x6F A828US TagID: [in] the ID of the tag. A829EU TagAddress: [in] the address where to write the data. A829US Length: [in] the number of bytes to write.
Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Code 0x74 Revision date: 17/01/2007 Revision: 4 Description Comp. SetProtocol: permits to set the protocol to use. A928EU Parameters: A948EU Protocol: [in] the protocol to use. A828EU ResultCode: [out] the result code. A828US A829EU A829US A946EU A949EU 0x75 RESERVED CheckReadPointStatus: permits to check the quality of the antenna 0x76 connection.
Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Code 0x79 Revision date: 17/01/2007 Revision: 4 Description Comp. GetProtocol: permits to get the protocol in use. A928EU Parameters: A948EU Protocol: [out] the protocol in use. A828EU ResultCode: [out] the result code. A828US A829EU A829US A946EU A949EU SetNetwork: permits to set up the network configuration. Parameters: 0x7A IPAddress: [in] the IP address to set.
Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Code Revision date: 17/01/2007 Revision: 4 Description Comp. GetDESB: permits to get the current setting of the “Data Exchange A928EU 0x7D Status Bit” handling. A948EU Parameters: A828EU DESBStatus: [in] enabled/disabled value. A828US ResultCode: [out] the result code. A829EU A829US A946EU A949EU ProgramID: permits to program the ID in the EPC Class 1 Gen 1 tags.
Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Code 0x81 Revision date: 17/01/2007 Revision: 4 Description Comp. GetBitRate: permits to get the BitRate in use. A928EU Parameters: A948EU BitRate: [out] the BitRate in. A828EU ResultCode: [out] the result code. A828US A829EU A829US A946EU A949EU BlockWriteTag: permits to write data to the tag memory.
Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Code 0x84 Revision date: 17/01/2007 Revision: 4 Description Comp. SetDateTime: permits to modify date and time. A928EU Parameters: A948EU Datetime: [in] the date and time to set up. A828EU ResultCode: [out] the result code. A828US A829EU A829US A946EU A949EU GroupSelectUnselect: permits to execute the tag selection commands 0x85 defined by the ISO18000-6B protocol.
Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Code 0x88 Revision date: 17/01/2007 Revision: 4 Description Comp. SetIODirection: permits to define the direction of the I/O lines. A828EU (0 = input; 1 = output) A828US Parameters: A829EU IORegister: [in] the direction to set to the I/O lines. A829US ResultCode: [out] the result code. A946EU A949EU GetIODirection: permits to read the current status of the I/O lines.
Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Code Revision date: 17/01/2007 Revision: 4 Description Comp. GetChannels: permits to read the names of the allocated notification channels. Parameters: 0x8D NoOfChannels: [out] the number of allocated channels. ListOfChannelNames: [in] a list containing the names of the allocated A928EU A948EU channels. ResultCode: [out] the result code.
Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Code Revision date: 17/01/2007 Revision: 4 Description Comp. GetEventMode: permits to read the event generation mode for the reader notification channels. 0x92 A928EU Parameters: A948EU EventMode: [out] the event mode. ResultCode: [out] the result code. FirmwareUpgrade: permits to upgrade the reader firmware. Parameters: 0x93 A928EU UpgradeType: [in] the type of the upgrade.
Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Code Revision date: 17/01/2007 Revision: 4 Description Comp. G2Read: permits to read data from anyone of the Gen2 tag memory banks. A928EU Parameters: SourceName: [in, optional] the name of the source to use. A828EU TagIDLen: [in] the ID length of the tag. 0x96 A948EU A828US TagID: [in] the ID of the tag. A829EU MemoryBank: [in] the memory bank. A829US TagAddress: [in] the address where to read the data.
Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Code Revision date: 17/01/2007 Revision: 4 Description Comp. G2Kill: permits to execute the tag kill command defined by the EPC A928EU 0x99 Class 1 Gen 2 protocol. A948EU Parameters: A828EU SourceName: [in, optional] the name of the source to use. A828US TagIDLen: [in] the ID length of the tag. A829EU TagID: [in] the ID of the tag. A829US G2Password: [in] the kill password.
Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Code Revision date: 17/01/2007 Revision: 4 Description Comp. G2QueryAck: permits to execute the tag query and ack command defined by the EPC Class 1 Gen 2 protocol. If a tag is in the field result code is ERROR_SUCCESS (0x00) and the command returns the EPC code 0x9D stored in the tag else the result code is A928EU A948EU A828EU A828US ERROR_TAGNOTPRESENT (0xCA).
Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Code Revision date: 17/01/2007 Revision: 4 Description Comp. GetRFRegulation: permits to read the RF regulation used by the 0xA2 reader. A948EU Parameters: A949EU RFRegulation: [out] the desired RF regulation. A946EU ResultCode: [out] the result code. SetRFChannel: permits to set the RF channel where the reader emits 0xA3 the RF field. A948EU Parameters: A949EU RFChannel: [in] the RF channel.
Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Revision date: 17/01/2007 Revision: 4 3. Asynchronous Notification: Protocol specification The notification channels are implemented only with sockets. All the messages notifications are composed by a header and a body. In all cases the body of the message is a list of attribute-value pairs. The first AVP of the body is fixed and called NotifyMessage.
Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Revision date: 17/01/2007 Revision: 4 4. Default configuration CAEN A928EUEU and A948EUEU UHF RFID Reader protocol has various configuration parameters; in the following table are summarized the default values. Table 4.1: A928EU and A948EU Configuration parameters default values Parameter Default value IP Address 192.168.0.125 IP Netmask 255.255.255.0 IP Gateway 192.168.0.
Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Parameter Revision date: 17/01/2007 Revision: 4 Default value Parity None Flow Control None The default composition of sources for the A828EUEU, A829EUEU, A946EUEU and A949EUEU reader is the following: Table 4.4: A928EU,A948EU, A828EU, A828US, A829EU, A829US, A946EU and A949EU Default composition of sources Source Source_0 NPO: 00117/03:PROTx.MUTx/04 Readpoints Ant0 Filename: EASY2READ_PROTOCOL_REV4.
Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Revision date: 17/01/2007 Revision: 4 5. Samples In the following sample a RawReadIDs command is examined together with the response coming from the reader.
Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Revision date: 17/01/2007 Revision: 4 6. References − − − Reader Protocol 1.0 – Working Draft Version of 25 August 2004 – Document revision 33 - EPCGlobal EPC Radio Frequency Identity Protocols Class-1 Generation-2 UHF RFID Protocol for Communications at 860MHz – 960MHz – Version 1.0.