Technical Information Manual Revision n. 5 02 April 2008 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: 02/04/2008 Revision: 5 INDEX 1. INTRODUCTION ..................................................................................................................................................3 1.1. CAEN RFID UHF RFID READER NAMING CONVENTIONS ...............................................................................3 2. PROTOCOL SPECIFICATION ....................................................
Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Revision date: 02/04/2008 Revision: 5 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: 02/04/2008 Revision: 5 2. Protocol specification CAEN RFID 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: 02/04/2008 Revision: 5 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: 02/04/2008 Revision: 5 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: 02/04/2008 Revision: 5 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: 02/04/2008 Revision: 5 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: 02/04/2008 Revision: 5 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: 02/04/2008 Revision: 5 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: 02/04/2008 Revision: 5 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 0x12 field of the selected source.
Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Code Revision date: 02/04/2008 Revision: 5 Description Comp. RemoveNotifyTrigger: permits to remove a trigger from a notification channel. 0x42 Parameters: A928 ChannelName: [in] the name of the channel. A948 TriggerName: [in] the name of the trigger. ResultCode: [out] the result code. AllocateTrigger: permits to create a new trigger. Parameters: 0x49 A928 TriggerName: [in] the name of the trigger.
Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Code Revision date: 02/04/2008 Revision: 5 Description Comp. RemoveSourceFromChannel: permits to remove a source from a notification channel. 0x5E Parameters: A928 SourceName: [in] the name of the source. A948 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 0x6F 0x70 Revision date: 02/04/2008 Revision: 5 Description Comp. WriteTagData: permits to write data to the tag memory. A928 Parameters: A948 SourceName: [in] the name of the source to use. A528 TagIDLen: [in] the ID length of the tag. A828 TagID: [in] the ID of the tag. A828A TagAddress: [in] the address where to write the data. A829 Length: [in] the number of bytes to write.
Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Code Revision date: 02/04/2008 Revision: 5 Description Comp. SetProtocol: permits to set the protocol to use. A928 Parameters: A948 Protocol: [in] the protocol to use. A528 ResultCode: [out] the result code. A828 0x74 A828A A829 A941 A946 A949 0x75 RESERVED CheckReadPointStatus: permits to check the quality of the antenna connection.
Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Code Revision date: 02/04/2008 Revision: 5 Description Comp. GetProtocol: permits to get the protocol in use. A928 Parameters: A948 Protocol: [out] the protocol in use. A528 ResultCode: [out] the result code. A828 0x79 A828A A829 A941 A946 A949 SetNetwork: permits to set up the network configuration. Parameters: 0x7A IPAddress: [in] the IP address to set. A928 IPNetMask: [in] the IP netmask to set.
Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Code Revision date: 02/04/2008 Revision: 5 Description Comp. GetDESB: permits to get the current setting of the “Data Exchange A928 0x7D Status Bit” handling. A948 Parameters: A528 DESBStatus: [in] enabled/disabled value. A828 ResultCode: [out] the result code. A828A A829 A941 A946 A949 ProgramID: permits to program the ID in the EPC Class 1 Gen 1 tags. Parameters: SourceName: [in] the name of the source.
Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Code Revision date: 02/04/2008 Revision: 5 Description Comp. GetBitRate: permits to get the BitRate in use. A928 Parameters: A948 BitRate: [out] the BitRate in. A528 ResultCode: [out] the result code. A828 0x81 A828A A829 A941 A946 A949 BlockWriteTag: permits to write data to the tag memory.
Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Code Revision date: 02/04/2008 Revision: 5 Description Comp. SetDateTime: permits to modify date and time. A928 Parameters: A948 Datetime: [in] the date and time to set up. A528 ResultCode: [out] the result code. A828 0x84 A828A A829 A941 A946 A949 GroupSelectUnselect: permits to execute the tag selection commands defined by the ISO18000-6B protocol.
Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Code Revision date: 02/04/2008 Revision: 5 Description Comp. SetIO: permits to set the level of the output lines. A928 Parameters: A948 IORegister: [in] the value to set to the output lines. A528 ResultCode: [out] the result code. A828 0x87 A828A A829 A941 A946 A949 0x88 SetIODirection: permits to define the direction of the I/O lines.
Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Code Revision date: 02/04/2008 Revision: 5 Description Comp. GetSourceConfig: permits to read a configure parameter for a logical source. 0x8B Parameters: A928 SourceName: [in] the name of the source to configure. A948 ConfigParameter: [in] the code of the parameter. ConfigValue: [out] the value for the parameter. ResultCode: [out] the result code.
Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Code Revision date: 02/04/2008 Revision: 5 Description Comp. CheckChannelInTrigger: permits to verify if the specified channel is associated to the specified trigger. Parameters: 0x90 A928 ChannelName: [in] the name of the source. A948 TriggerName: [in] the name of the trigger. Boolean: [out] 0 if they are associated, ≠0 if not. ResultCode: [out] the result code.
Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Code 0x95 Revision date: 02/04/2008 Revision: 5 Description Comp. G2ProgramID: permits to write the EPC in a Class 1 Gen 2 tag. A928 Parameters: A948 SourceName: [in] the name of the source to use. A528 TagIDLen: [in] the ID length of the tag (must be an even number). A828 TagID: [in] the EPC to write into the tag memory. A828A G2NSI: [in] the EPC numbering system.
Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Code Revision date: 02/04/2008 Revision: 5 Description Comp. G2Lock: permits to execute the tag lock command defined by the EPC A928 0x98 Class 1 Gen 2 protocol. A948 Parameters: A528 SourceName: [in, optional] the name of the source to use. A828 TagIDLen: [in] the ID length of the tag. A828A TagID: [in] the ID of the tag. A829 G2Payload: [in] the lock payload. A941 ResultCode: [out] the result code.
Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Code Revision date: 02/04/2008 Revision: 5 Description Comp. G2SetQ: permits to change the initial value of the Q parameter used in A928 0x9B the Gen2 anticollision algorithm. A948 Parameters: A528 QParameter: [in] the value of the Q parameter. A828 ResultCode: [out] the result code.
Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Code Revision date: 02/04/2008 Revision: 5 Description Comp. GetReaderInfo: permits to read some information about the reader A928 0x9E itself. A948 Parameters: A528 ReaderInfo: [out] a string with information about the reader. A828 ResultCode: [out] the result code. A828A A829 A941 A946 A949 SetLBTMode: permits to enable or disable the Listen Before Talk capability on ETSI EN 302 208 compatible readers.
Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Code 0xA4 0xFFFF NPO: 00117/03:PROTx.MUTx/05 Revision date: 02/04/2008 Revision: 5 Description Comp. GetRFChannel: permits to read the RF channel currently in use. A941 Parameters: A946 RFChannel: [out] the RF channel. A948 ResultCode: [out] the result code. A949 RESERVED Filename: EASY2READ_PROTOCOL_REV5.
Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Revision date: 02/04/2008 Revision: 5 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: 02/04/2008 Revision: 5 4. Default configuration CAEN A928 and A948E UHF RFID Reader protocol has various configuration parameters; in the following table are summarized the default values. Table 4.1: A928 and A948 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 Revision date: 02/04/2008 Revision: 5 Table 4.3: A828, A829, A829, A946 and A949 Configuration parameters default values Parameter Sources Default value “Source_0” Readpoints “Ant0” Baud Rate 115200 Data Bits 8 Stop Bits 1 Parity None Flow Control None The default composition of sources for the A828, A829, A946 and A949 reader is the following: Table 4.
Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Revision date: 02/04/2008 Revision: 5 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: 02/04/2008 Revision: 5 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.