CAEN RFID srl CAENRFID003 A528 - OEM UHF multiregional Compact Reader User Manual CAEN UHF RFID Readers Communication Protocol
CAEN RFID srl A528 - OEM UHF multiregional Compact Reader CAEN UHF RFID Readers Communication Protocol
Contents
- 1. User Manual 1
- 2. User Manual 2
- 3. User Manual 3
- 4. User Manual 4
User Manual 2
Technical Information Manual Revision n. 5 02 April 2008 CAEN RFID UHF READERS COMMUNICATION PROTOCOL NPO: 00117/03:PROTx.MUTx/05 Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Revision date: 02/04/2008 Revision: INDEX 1. INTRODUCTION ..................................................................................................................................................3 1.1. CAEN RFID UHF RFID READER NAMING CONVENTIONS ...............................................................................3 2. PROTOCOL SPECIFICATION ..........................................................................................................................4 3. ASYNCHRONOUS NOTIFICATION: PROTOCOL SPECIFICATION .....................................................28 4. DEFAULT CONFIGURATION .........................................................................................................................29 5. SAMPLES .............................................................................................................................................................31 6. REFERENCES .....................................................................................................................................................32 LIST OF TABLES TABLE 1.1: CAEN RFID NAME ABBREVIATION ........................................................................................................3 TABLE 2.1: ATTRIBUTE TYPES ...................................................................................................................................5 TABLE 2.2: COMMAND CODES .................................................................................................................................11 TABLE 3.1: ATTRIBUTE TYPES: NOTIFICATION AVP LIST. ......................................................................................28 TABLE 4.1: A928 AND A948 CONFIGURATION PARAMETERS DEFAULT VALUES ......................................................29 TABLE 4.2: A928 AND A948 DEFAULT COMPOSITION OF SOURCES .........................................................................29 TABLE 4.3: A828, A829, A829, A946 AND A949 CONFIGURATION PARAMETERS DEFAULT VALUES .....................30 TABLE 4.4: A828, A829, A946 AND A949 DEFAULT COMPOSITION OF SOURCES ...................................................30 NPO: 00117/03:PROTx.MUTx/05 Filename: EASY2READ_PROTOCOL_REV5.DOC Number of pages: 32 Page: Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Revision date: 02/04/2008 Revision: 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. The command set and the firmware architecture draw inspiration from the Reader Protocol 1.0 specification draft from EPCGlobal but, at now, this protocol is not fully compatible with the same last specifications. Message fields are described left to right, with the most significant byte on the left and the least on the right. 1.1. CAEN RFID UHF RFID Reader Naming conventions The following table describes CAEN RFID reader name abbreviation following paragraph used in the Table 1.1: CAEN RFID name abbreviation Name Abbreviation CAEN RFID Reader A528 A528 - OEM UHF multiregional Compact Reader A828 A828EU - OEM UHF compact reader (ETSI EN 300 220) A828US - OEM UHF compact reader (FCC Part 15) A828A A828AEU - OEM UHF enhanced compact reader (ETSI EN 300 220) A829 A829EU - Fully integrated UHF compact reader (ETSI EN 300 220) A829US - Fully integrated UHF compact reader (FCC Part 15) A941 A941MEI - IP65 UHF stand alone reader (ETSI EN 302 208) A941MEO - OEM UHF stand alone reader (ETSI EN 302 208) A941MUI - IP65 UHF stand alone reader (FCC Part 15) A941MUO - OEM UHF stand alone reader (FCC Part 15) A949 A949EU - IP65 UHF stand alone reader (ETSI EN 302 208) A946 A946EU - OEM UHF stand alone reader (ETSI EN 302 208) A928 A928EU - UHF long range reader (ETSI EN 300 220) A948 A948EU - UHF long range reader (ETSI EN 302 208) A948EU - UHF long range reader DRM (ETSI EN 302 208) A948US - UHF long range reader (FCC part 15) A948EU - UHF long range reader HS (ETSI EN 302 208) NPO: 00117/03:PROTx.MUTx/05 Filename: EASY2READ_PROTOCOL_REV5.DOC Number of pages: 32 Page: Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Revision date: 02/04/2008 Revision: 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. All the messages (commands, responses and notifications) are composed by a header and a body. In all cases the body of the message is a list of attribute-value pairs. Responses always echo the Command AVP sent by the host. All the packets for the control and notification channel share a common header format: 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-------------------------------+------------------------------+ FIXED Message ID +-------------------------------+------------------------------+ Vendor ID +-------------------------------+------------------------------+ Length +-------------------------------+ FIXED: Must be 0x8001 for commands and 0x0001 for responses. Message ID: Id of the message. It is a sequence number used to map requests to its responses: a request and its corresponding response have the same message ID (the id is local to the channel). Vendor ID: Must be 21336: the IANA “SMI Network Management Private Enterprise Code” assigned to CAEN SpA. Length: Encodes the length of the message (in bytes) including the header. The header is followed by a list of AVPs the number of which depends on the command. Each AVP have the following format: 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-------------------------------+------------------------------+ RESERVED Length +-------------------------------+------------------------------+ Attribute Type Attribute Value ……… +-------------------------------+------------------------------+ ………[ until length is reached ]……… +--------------------------------------------------------------+ RESERVED: The first 16 bits are reserved for future extensions. All reserved bits must be set to 0 on outgoing messages and ignored on incoming messages. Length: Encodes the length of the AVP packet including the length and the reserved fields. Attribute type: A 2 byte code identifying the attribute type. Attribute value: The actual attribute value according to the type. It follows immediately after the Attribute Type field and runs for the remaining bytes indicated in the Length (i.e. Length minus 6 bytes of header). NPO: 00117/03:PROTx.MUTx/05 Filename: EASY2READ_PROTOCOL_REV5.DOC Number of pages: 32 Page: Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Revision date: 02/04/2008 Revision: 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. EventType: the type of the notified event. Attribute value is 4 bytes long and can assume the following values: 0x00 = Unknown Event 0x0E 0x01 = Tag glimpsed 0x02 = Tag New 0x03 = Tag Observed 0x04 = Tag Lost 0x05 = Tag Purged 0x0F TagIDLen: the length of the tag ID. Attribute value is 2 bytes long. TimeStamp: an indication of the time. Attribute is 8 bytes long and must be interpreted as follow: 0x10 the 4 least significant bytes are the seconds elapsed from the 1 January 1970. the 4 most significant bytes are the micro-seconds. TagID: the ID read from the tag. Attribute value has a maximum length of 0x11 12 bytes. For ISO18000 tags only the first 8 bytes are significant while for EPC tags all the 12 bytes are significant. 0x1E 0x1F 0x20 0x21 NPO: 00117/03:PROTx.MUTx/05 ChannelName: the name of the notification channel. Attribute value has a maximum length of 30 bytes. ChannelAddress: the address of the notification channel. Attribute value has a maximum length of 30 bytes. TriggerName: the name of the trigger. Attribute value has a maximum length of 30 bytes. TriggerType: the type of the trigger. Attribute value has a maximum length of 30 bytes. Filename: EASY2READ_PROTOCOL_REV5.DOC Number of pages: 32 Page: Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Code Revision date: 02/04/2008 Revision: 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. TagAddress: the memory location address of the tag where read or write data (when applicable). Attribute value is 2 bytes long. RESERVED. Length: a value representing the length of a parameter. Attribute value is 2 bytes long. BitRate: a value representing the RF BitRate. Attribute value is 2 bytes long and can assume the following values: 0x51 0x0 – Transmit = 10kbit, Receive = 10kbit 0x1 – Transmit = 10kbit, Receive = 40kbit 0x2 – Transmit = 40kbit, Receive = 40kbit 0x3 – Transmit = 40kbit, Receive = 160kbit 0x52 0x53 PowerGet: a value representing the RF power. Attribute value is 4 bytes long. (used for read the current setting) RESERVED. Protocol: a value representing the air protocol. Attribute value is 4 bytes long and can assume the following values: 0x54 0x00 = ISO18000-6B 0x01 = EPCC1G1 0x02 = ISO18000-6A 0x03 = EPCC1G2 ReadPointStatus: a value representing the antenna’s status. Attribute value is 4 bytes long and can assume the following values: 0x56 0x00 = Bad: antenna is not connected or broken. 0x01 = Poor: antenna has a low quality connection. 0x02 = Good: antenna is well connected. NPO: 00117/03:PROTx.MUTx/05 Filename: EASY2READ_PROTOCOL_REV5.DOC Number of pages: 32 Page: Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Code Revision date: 02/04/2008 Revision: 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. IPNetMask: a string representing an IP netmask formatted with the 0x59 standard IP dotted decimal format. Attribute value has a maximum length of 30 bytes. IPGateway: a string representing an IP address formatted with the standard 0x5A IP dotted decimal format. Attribute value has a maximum length of 30 bytes. DESBEnable: used to enable/disable the Data Exchange Status Bit handling for ISO18000-6b and EPC 1.19 anti-collision algorithm. Attribute 0x5B value is 2 bytes long and can assume the following values: 0x00 = Disable the DESB handling. Not 0x00 = Enable the DESB handling. 0x5C FWRelease: a string representing the device’s firmware revision. Attribute value has a maximum length of 200 bytes. DESBStatus: used to check the Data Exchange Status Bit handling for ISO18000-6b and EPC 1.19 anti-collision algorithm. Attribute value is 2 0x5D bytes long and can assume the following values: 0x00 = DESB handling is not enabled. Not 0x00 = DESB handling is enabled. 0x5E EPCPWD: a value representing an EPC tag password. Attribute value is 2 bytes long. RFOnOff: used to start the generation of a continuous wave for test purposes. Attribute value is 2 bytes long and can assume the following 0x5F vaules: 0x00 = Stop the wave generation. Not 0x00 = Start the wave generation. 0x60 NPO: 00117/03:PROTx.MUTx/05 BaudRate: a value representing the baudrate setting of serial port. Attribute value is 4 bytes long. Filename: EASY2READ_PROTOCOL_REV5.DOC Number of pages: 32 Page: Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Code 0x61 0x62 Revision date: 02/04/2008 Revision: 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. Attribute value is 4 bytes long and can assume the following values: 0x63 0x00 = No parity 0x01 = Odd parity 0x02 = Even parity FlowCtrl: a value representing the flow control setting of serial port. Attribute value is 4 bytes long and can assume the following values: 0x64 0x00 = No flow control 0x01 = Hardware flow control 0x02 = Software flow control (not yet implemented) DateTime: a value representing a date and time. Attribute value has a 0x65 maximum length of 30 bytes. The data format is: YYYY–MM–DD HH:MM:SS SelUnselOp: a value representing the tag selection operation defined by the ISO18000-6B protocol. Attribute value is 2 bytes long and can assume the following values: 0x00 = select equal 0x01 = select not equal 0x66 0x02 = select greater than 0x03 = select lower than 0x04 = unselect equal 0x05 = unselect not equal 0x06 = unselect greater than 0x07 = unselect lower than Bitmask: a value representing the bitmask parameter of tag selection 0x67 operations defined by the ISO18000-6B protocol. Attribute value is 2 bytes long (only 8 least significant bits are used). 0x68 NPO: 00117/03:PROTx.MUTx/05 REESERVED. Filename: EASY2READ_PROTOCOL_REV5.DOC Number of pages: 32 Page: Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Code Revision date: 02/04/2008 Revision: 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). ConfigParameter: a value representing a configuration parameter. Attribute value is 4 bytes long and can assume the following values: 0x6A 0x00 = ReadCycle configuration 0x01 = Observed Threshold configuation 0x02 = Lost Threshold configuration 0x6B 0x6C 0x6D ConfigValue: a value for the configuration parameter. Attribute value is 4 bytes long. NoOfTriggers: a value representing the number of triggers. Attribute value is 2 bytes long. NoOfChannels: a value representing the number of channels. Attribute value is 2 bytes long. EventMode: a value representing the event handling mode. Attribute value is 2 bytes long and can assume the following values: 0x6E 0x00 = ReadCycle mode 0x01 = Time Mode 0x02 = No Event Mode UpgradeType: a value representing the type of upgrade to perform. 0x6F Attribute value is 2 bytes long and can assume the following values: 0x01 = TFTP firmware upgrade. UpgradeArgument: a value representing the argument for the requested 0x70 upgrade. Attribute value has a maximum length of 255 bytes. For TFTP upgrade (code 0x01) the string has the form: ‘: ’. NPO: 00117/03:PROTx.MUTx/05 Filename: EASY2READ_PROTOCOL_REV5.DOC Number of pages: 32 Page: Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Code Revision date: 02/04/2008 Revision: Description MemoryBank: a value representing the memory bank of a EPC Class 1 Generation 2 tag. Attribute value is 2 bytes long and can assume the following values: 0x71 0x00 = Reserved Memory Bank 0x01 = EPC Memory Bank 0x02 = TID Memory Bank 0x03 = User Memory Bank Payload: a value representing the payload parameter for the EPC Class 1 0x72 Gen 2 lock command (see the EPC Gen2 specification for details). Attribute value is 4 bytes long. G2Password: a value representing the password parameter for the EPC 0x73 Class 1 Gen 2 kill command (see the EPC Gen2 specification for details). Attribute value is 4 bytes long. G2NSI: a value representing the numbering system identifier for the EPC 0x74 Class 1 Gen 2 tags’ id (see the EPC Gen2 specification for details). Attribute value is 2 bytes long. QParameter: a value representing the initial value for the Q parameter 0x75 involved in the EPC Class 1 Gen 2 anticollision algorithm (see the EPC Gen2 specification for details). Attribute value is 2 bytes long. 0x76 ReaderInfo: a string indicating the model and the serial number of the reader. RFRegulation: a value representing the RF regulation to use. Attribute 0x77 value is 2 bytes long and can assume the following values: 0x00 = ETSI EN 302 208 0x01 = ETSI EN 300 220 RFChannel: a value representing the RF channel to use. Attribute value is 0x78 2 bytes long and can assume values in the range 0 … 9. Channels are referred to the ETSI EN 302 208 regulation. PowerSet: a value representing the RF power emitted during the 0x96 communication with tags. Attribute value is 4 bytes long. (used to set a new current value). NPO: 00117/03:PROTx.MUTx/05 Filename: EASY2READ_PROTOCOL_REV5.DOC Number of pages: 32 Page: 10 Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Code Revision date: 02/04/2008 Revision: 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. A928 Parameters: A948 SourceNameIn: [in] the name of the source to use. A528 SourceNameOut: [out] the name of the source used. A828 ReadPointName: [out] the name of the readpoint. A828A TimeStamp: [out] the time at which the tags are detected. A829 TagIDLen: [out] the ID length of the tags detected. A941 ListOfIDs: [out] the list of Ids detected from the source. A946 ResultCode: [out] the result code. A949 Note: out parameters are repeated for each readpoint in the source. AddReadTrigger: permits to add a trigger to a source. Parameters: 0x3F A928 SourceName: [in] the name of the source. A948 TriggerName: [in] the name of the trigger. ResultCode: [out] the result code. AddNotifyTrigger: permits to add a trigger to a notification channel. Parameters: 0x40 A928 ChannelName: [in] the name of the channel. A948 TriggerName: [in] the name of the trigger. ResultCode: [out] the result code. RemoveReadTrigger: permits to remove a trigger from a source. Parameters: 0x41 A928 SourceName: [in] the name of the source. A948 TriggerName: [in] the name of the trigger. ResultCode: [out] the result code. NPO: 00117/03:PROTx.MUTx/05 Filename: EASY2READ_PROTOCOL_REV5.DOC Number of pages: 32 Page: 11 Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Code Revision date: 02/04/2008 Revision: 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. A948 TriggerType: [in] the type of the trigger. ResultCode: [out] the result code. DeallocateTrigger: permits to destroy an existing trigger. 0x4A Parameters: A928 TriggerName: [in] the name of the trigger. A948 ResultCode: [out] the result code. AllocateChannel: permits to create a notification channel. Parameters: 0x53 A928 ChannelName: [in] the name of the channel. A948 ChannelAddress: [in] the address of the channel. ResultCode: [out] the result code. DeallocateChannel: permits to destroy a notification channel. 0x54 Parameters: A928 ChannelName: [in] the name of the channel. A948 ResultCode: [out] the result code. AddSourceToChannel: permits to add a source to a notification channel. 0x5D Parameters: A928 SourceName: [in] the name of the source. A948 ChannelName: [in] the name of the channel. ResultCode: [out] the result code. NPO: 00117/03:PROTx.MUTx/05 Filename: EASY2READ_PROTOCOL_REV5.DOC Number of pages: 32 Page: 12 Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Code Revision date: 02/04/2008 Revision: 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. Parameters: 0x5F A928 SourceName: [in] the name of the source. A948 ReadPointName: [in] the name of the readpoint. ResultCode: [out] the result code. RemoveReadPointFromSource: permits to remove a readpoint from a source. 0x60 Parameters: A928 SourceName: [in] the name of the source. A948 ReadPointName: [in] the name of the readpoint. ResultCode: [out] the result code. 0x64 SetPower: permits to set the RF power level. A928 Parameters: A948 PowerSet: [in] the power level to set. A941 ResultCode: [out] the result code. A946 A949 0x6E NPO: 00117/03:PROTx.MUTx/05 ReadTagData: permits to read data from 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 from which read the data. A829 Length: [in] the number of bytes to read. A941 TagValue: [out] the data read from the tag memory. A946 ResultCode: [out] the result code. A949 Filename: EASY2READ_PROTOCOL_REV5.DOC Number of pages: 32 Page: 13 Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Code 0x6F 0x70 Revision date: 02/04/2008 Revision: 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. A941 TagValue: [in] the data to write to the tag memory. A946 ResultCode: [out] the result code. A949 LockTag: permits to lock data into 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 ResultCode: [out] the result code. A941 A946 A949 0x71 RESERVED SetBitRate: permits to set the BitRate to use. A928 Parameters: A948 BitRate: [in] the BitRate to set. A528 ResultCode: [out] the result code. A828 0x72 A828A A829 A941 A946 A949 0x73 GetPower: permits to get the current RF power level. A928 Parameters: A948 PowerGet: [out] the current power level. A941 ResultCode: [out] the result code. A946 A949 NPO: 00117/03:PROTx.MUTx/05 Filename: EASY2READ_PROTOCOL_REV5.DOC Number of pages: 32 Page: 14 Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Code Revision date: 02/04/2008 Revision: 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. 0x76 A928 A948 Parameters: A941 ReadPointName: [in] the name of the readpoint. A946 ReadPointStatus: [out] the quality of the connection. A949 ResultCode: [out] the result code. CheckSourceInChannel: permits to verify if a source is assigned to a notify channel. Parameters: 0x77 A928 SourceName: [in] the name of the source. A948 ChannelName: [in] the name of the channel. Value: [out] a Boolean value meaning the belonging to the source. ResultCode: [out] the result code. CheckReadPointInSource: permits to verify if a readpoint belongs to 0x78 a givens source. A928 Parameters: A948 ReadPointName: [in] the name of the readpoint. A941 SourceName: [in] the name of the source. A946 Value: [out] a Boolean value meaning the belonging to the source. A949 ResultCode: [out] the result code. NPO: 00117/03:PROTx.MUTx/05 Filename: EASY2READ_PROTOCOL_REV5.DOC Number of pages: 32 Page: 15 Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Code Revision date: 02/04/2008 Revision: 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. A948 IPGateway: [in] the IP gateway to set. ResultCode: [out] the result code. SetDESB: permits to enable or disable the “Data Exchange Status Bit” A928 handling during the anti-collision algorithm when ISO 18000-6b air A948 0x7B protocol is in use. A528 Parameters: A828 DESBEnable: [in] enable/disable value. A828A ResultCode: [out] the result code. A829 A941 A946 A949 GetFirmwareRelease: permits to get the firmware revision. A928 Parameters: A948 FWRelease: [in] the firmware release. A528 ResultCode: [out] the result code. A828 0x7C A828A A829 A941 A946 A949 NPO: 00117/03:PROTx.MUTx/05 Filename: EASY2READ_PROTOCOL_REV5.DOC Number of pages: 32 Page: 16 Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Code Revision date: 02/04/2008 Revision: 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. 0x7E TagIDLen: [in] the ID length of the tag. A928 TagID: [in] the ID of the tag. A948 EPCPWD: [in] the EPC password to set. Lock: [in] a Boolean value; TRUE = lock the ID. FALSE = do not lock. ResultCode: [out] the result code. KillTag: permits to kill a EPC Class 1 Gen 1 tag. Parameters: SourceName: [in] the name of the source. 0x7F A928 TagIDLen: [in] the ID length of the tag. A948 TagID: [in] the ID of the tag. EPCPWD: [in] the EPC password. ResultCode: [out] the result code. RFOnOff: permits to start/stop the generation of a continuous wave. A928 0x80 Used only for test and measurements purposes. A948 Parameters: A528 RFOnOff: [in] = 0 Î stop; != 0 Î start A828 ResultCode: [out] the result code. A828A A829 A941 A946 A949 NPO: 00117/03:PROTx.MUTx/05 Filename: EASY2READ_PROTOCOL_REV5.DOC Number of pages: 32 Page: 17 Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Code Revision date: 02/04/2008 Revision: 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. This function uses the ISO18000-6b Write4Byte command to speed up the writing of A928 0x82 large amount of data at one time. A948 Parameters: A528 SourceName: [in] 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 TagAddress: [in] the address where to write the data. A941 Length: [in] the number of bytes to write. A946 TagValue: [in] the data to write to the tag memory. A949 ResultCode: [out] the result code. 0x83 SetRS232: permits to modify the settings of the serial port. A928 Parameters: A948 Baudrate: [in] the baud rate value. A528 Databits: [in] the data bits setting. A828 Stopbits: [in] the stop bits setting. A828A Parity: [in] the parity setting. A829 Flowctrl: [in] the flow control setting. A941 ResultCode: [out] the result code. A946 A949 NPO: 00117/03:PROTx.MUTx/05 Filename: EASY2READ_PROTOCOL_REV5.DOC Number of pages: 32 Page: 18 Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Code Revision date: 02/04/2008 Revision: 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. A948 Parameters: SourceName: [in, optional] the name of the source to use. 0x85 A928 Operation: [in] the tag selection operation. Bytemask: [in] the byte mask as defined by the protocol. TagAddress: [in] the address where to compare the data. TagValue: [in] the data to compare with the tag memory. TagID: [out] the ID of the tag. A528 A828 A828A A829 A941 A946 A949 ResultCode: [out] the result code. GetIO: permits to read the current status of the I/O lines. A928 Parameters: A948 IORegister: [out] the status of the I/O lines. A528 ResultCode: [out] the result code. A828 0x86 A828A A829 A941 A946 A949 NPO: 00117/03:PROTx.MUTx/05 Filename: EASY2READ_PROTOCOL_REV5.DOC Number of pages: 32 Page: 19 Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Code Revision date: 02/04/2008 Revision: 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. A528 (0 = input; 1 = output) A828 Parameters: A828A IORegister: [in] the direction to set to the I/O lines. A829 ResultCode: [out] the result code. A941 A946 A949 GetIODirection: permits to read the current status of the I/O lines. (0 = A528 0x89 input; 1 = output) A828 Parameters: A828A IORegister: [out] the direction of the I/O lines. A829 ResultCode: [out] the result code. A941 A946 A949 SetSourceConfig: permits to set a configure parameter for a logical source. Parameters: 0x8A SourceName: [in] the name of the source to configure. ConfigParameter: [in] the code of the parameter. A928 A948 ConfigValue: [in] the value for the parameter. ResultCode: [out] the result code. NPO: 00117/03:PROTx.MUTx/05 Filename: EASY2READ_PROTOCOL_REV5.DOC Number of pages: 32 Page: 20 Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Code Revision date: 02/04/2008 Revision: 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. GetTriggers: permits to read the names of the allocated triggers. Parameters: 0x8C NoOfTriggers: [out] the number of allocated triggers. A928 ListOfTriggerNames: [in] a list containing the names of the allocated A948 triggers. ResultCode: [out] the result code. 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 A928 A948 channels. ResultCode: [out] the result code. CheckSourceInTrigger: permits to verify if the specified logical source is associated to the specified trigger. Parameters: 0x8E A928 SourceName: [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. CheckTriggerInChannel: permits to verify if the specified trigger is associated to the specified channel. Parameters: 0x8F 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. NPO: 00117/03:PROTx.MUTx/05 Filename: EASY2READ_PROTOCOL_REV5.DOC Number of pages: 32 Page: 21 Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Code Revision date: 02/04/2008 Revision: 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. SetEventMode: permits to set the event generation mode for the reader notification channels. 0x91 A928 Parameters: A948 EventMode: [in] the event mode. ResultCode: [out] the result code. GetEventMode: permits to read the event generation mode for the reader notification channels. 0x92 A928 Parameters: A948 EventMode: [out] the event mode. ResultCode: [out] the result code. FirmwareUpgrade: permits to upgrade the reader firmware. Parameters: 0x93 A928 UpgradeType: [in] the type of the upgrade. UpgradeArg: [in] the argument needed by the upgrade procedure. A948 ResultCode: [out] the result code. 0x94 E119ProgramID: permits to write the EPC into a EPC1.19 tag. A928 Parameters: A948 SourceName: [in] the name of the source to use. A528 TagID: [in] the old EPC of the tag. A828 TagValue: [in] the EPC to write into the tag memory. A828A ResultCode: [out] the result code. A829 A941 A946 A949 NPO: 00117/03:PROTx.MUTx/05 Filename: EASY2READ_PROTOCOL_REV5.DOC Number of pages: 32 Page: 22 Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Code 0x95 Revision date: 02/04/2008 Revision: 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. A829 ResultCode: [out] the result code. A941 A946 A949 G2Read: permits to read data from anyone of the Gen2 tag memory 0x96 banks. A928 Parameters: A948 SourceName: [in, optional] 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 MemoryBank: [in] the memory bank. A829 TagAddress: [in] the address where to read the data. A941 Length: [in] the number of bytes to read (must be an even number). A946 TagValue: [out] the data read from the tag memory. A949 ResultCode: [out] the result code. G2Write: permits to write data into anyone of the Gen2 tag memory 0x97 banks. A928 Parameters: A948 SourceName: [in, optional] 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 MemoryBank: [in] the memory bank. A829 TagAddress: [in] the address where to write the data. A941 Length: [in] the number of bytes to write (must be an even number). A946 TagValue: [in] the data to write to the tag memory. A949 ResultCode: [out] the result code. NPO: 00117/03:PROTx.MUTx/05 Filename: EASY2READ_PROTOCOL_REV5.DOC Number of pages: 32 Page: 23 Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Code Revision date: 02/04/2008 Revision: 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. A946 A949 G2Kill: permits to execute the tag kill command defined by the EPC A928 0x99 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 G2Password: [in] the kill password. A941 ResultCode: [out] the result code. A946 A949 G2Query: permits to execute the tag query command defined by the A928 EPC Class 1 Gen 2 protocol. If a tag is in the field result code is A948 ERROR_SUCCESS 0x9A (0x00) else result code is A528 ERROR_TAGNOTPRESENT (0xCA). A828 Parameters: A828A SourceName: [in] the name of the source to use. A829 ResultCode: [out] the result code. A941 A946 A949 NPO: 00117/03:PROTx.MUTx/05 Filename: EASY2READ_PROTOCOL_REV5.DOC Number of pages: 32 Page: 24 Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Code Revision date: 02/04/2008 Revision: 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. A828A A829 A941 A946 A949 G2GetQ: permits to read the initial value of the Q parameter used in A928 0x9C the Gen2 anticollision algorithm. A948 Parameters: A528 QParameter: [out] the value of the Q parameter. A828 ResultCode: [out] the result code. A828A A829 A941 A946 A949 G2QueryAck: permits to execute the tag query and ack command A928 defined by the EPC Class 1 Gen 2 protocol. If a tag is in the field result A948 code is ERROR_SUCCESS (0x00) and the command returns the EPC A528 code 0x9D NPO: 00117/03:PROTx.MUTx/05 stored in the tag else the result code is A828 ERROR_TAGNOTPRESENT (0xCA). A828A Parameters: A829 SourceName: [in] the name of the source to use. A941 TagID: [out] the ID of the tag. A946 ResultCode: [out] the result code. A949 Filename: EASY2READ_PROTOCOL_REV5.DOC Number of pages: 32 Page: 25 Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Code Revision date: 02/04/2008 Revision: 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. 0x9F A946 Parameters: Boolean: [in] 0 to disable LBT and ≠0 to enable LBT. ResultCode: [out] the result code. GetLBTMode: permits to read the current setting for the Listen Before Talk capability on ETSI EN 302 208 compatible readers. 0xA0 A941 Parameters: Boolean: [out] 0 if LBT is disabled, ≠0 if LBT is enabled. ResultCode: [out] the result code. A948 A949 A941 A946 A948 A949 SetRFRegulation: permits to change the RF regulation used by the A941 0xA1 reader. A946 Parameters: A948 RFRegulation: [in] the desired RF regulation. A949 ResultCode: [out] the result code. GetRFRegulation: permits to read the RF regulation used by the A941 0xA2 reader. A946 Parameters: A948 RFRegulation: [out] the desired RF regulation. A949 ResultCode: [out] the result code. SetRFChannel: permits to set the RF channel where the reader emits A941 0xA3 the RF field. A946 Parameters: A948 RFChannel: [in] the RF channel. A949 ResultCode: [out] the result code. NPO: 00117/03:PROTx.MUTx/05 Filename: EASY2READ_PROTOCOL_REV5.DOC Number of pages: 32 Page: 26 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: 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.DOC Number of pages: 32 Page: 27 Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Revision date: 02/04/2008 Revision: 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. All the packets for notification channel share the same header format of other packet as described at § 3. The first AVP (NotifyMessage) is followed by a list of AVPs, the number of which depends on how many tags should be notified. Each AVP has the same format of the AVP described in § 3. The NotifyMessage has the following fixed format: 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-------------------------------+------------------------------+ RESERVED +-------------------------------+------------------------------+ CommandName ReportBuffer +-------------------------------+------------------------------+ After the NotifyMessage AVP we can receive: a) a list of AVPs (as described in table 3) followed by an AVP with ‘Attribute Type’ ResultCode b) a single AVP called KillMessage with the following fixed format: 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-------------------------------+------------------------------+ RESERVED +-------------------------------+------------------------------+ KillCommand KillCommand +-------------------------------+------------------------------+ Table 3.1: Attribute types: Notification AVP List. Description TimeStamp: the timestamp of the notification TagIDLen: the ID length of the tag. TagID: the ID of the tag. SourceName: the name of the source to use. EventType: the type of the notified event NPO: 00117/03:PROTx.MUTx/05 Filename: EASY2READ_PROTOCOL_REV5.DOC Number of pages: 32 Page: 28 Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Revision date: 02/04/2008 Revision: 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.1 Sources “Source_0”, “Source_1”, “Source_2”, “Source_3” Readpoints “Ant0”, “Ant1”, “Ant2”, “Ant3” Baud Rate 115200 Data Bits Stop Bits Parity None Flow Control None The default composition of sources for A928E and A948 reader is the following: Table 4.2: A928 and A948 Default composition of sources Source Readpoints Source_0 Ant0 Source_1 Ant1 Source_2 Ant2 Source_3 Ant3 CAEN A828, A829, A946 and A949 UHF RFID Reader protocol has various configuration parameters; in the following table are summarized the default values. NPO: 00117/03:PROTx.MUTx/05 Filename: EASY2READ_PROTOCOL_REV5.DOC Number of pages: 32 Page: 29 Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Revision date: 02/04/2008 Revision: 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 Stop Bits Parity None Flow Control None The default composition of sources for the A828, A829, A946 and A949 reader is the following: Table 4.4: A828, A829, A946 and A949 Default composition of sources Source Source_0 NPO: 00117/03:PROTx.MUTx/05 Readpoints Ant0 Filename: EASY2READ_PROTOCOL_REV5.DOC Number of pages: 32 Page: 30 Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Revision date: 02/04/2008 Revision: 5. Samples In the following sample a RawReadIDs command is examined together with the response coming from the reader. Command sent: 0x8001 0x0000 0x00005358 0x0021 0x0000 0x0008 0x0001 0x0012 0x0000 0x000F 0x00FB “Source_0” (Fixed) (Message ID) (Vendor ID = CAEN SpA) (Message Length) (Reserved) (AVP Length) (AVP Type = CommandName) (AVP Value = RawReadIDs) (Reserved) (AVP Length) (AVP Type = SourceName) (AVP Value) Response received: 0x0001 0x0000 0x00005358 0x0066 0x0000 0x0008 0x0001 0x0012 0x0000 0x000F 0x00FB “Source_0” 0x0000 0x000B 0x0022 “Ant0” 0x0000 0x000E 0x0010 0x00000578 0x00000000 0x0000 0x0008 0x000F 0x0008 0x0000 0x000E 0x0011 0x05629FFF 0xC0113001 (Fixed) (Message ID) (Vendor ID = CAEN SpA) (Message Length) (Reserved) (AVP Length) (AVP Type = CommandName) (AVP Value = RawReadIDs) (Reserved) (AVP Length) (AVP Type = SourceName) (AVP Value) (Reserved) (AVP Length) (AVP Type = ReadPointName) (AVP Value) (Reserved) (AVP Length) (AVP Type = TimeStamp) (AVP Value = Thu Jan (AVP Value) (Reserved) (AVP Length) (AVP Type = TagIDLen) (AVP Value) (Reserved) (AVP Length) (AVP Type = TagID) (AVP Value) (AVP Value) 0x0000 0x000E 0x0011 0xE0040F0E 0x06010000 0x0000 0x0008 0x0002 0x0000 (Reserved) (AVP Length) (AVP Type = TagID) (AVP Value) (AVP Value) (Reserved) (AVP Length) (AVP Type = ResultCode) (AVP Value = Success) NPO: 00117/03:PROTx.MUTx/05 Filename: EASY2READ_PROTOCOL_REV5.DOC 1 01:23:20 1970) Number of pages: 32 Page: 31 Document type: User's Manual (MUT) Title: CAEN UHF RFID Readers Communication Protocol Revision date: 02/04/2008 Revision: 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.9 – EPCGlobal ISO/IEC FDIS 18000-6:2003(E) – Information technology automatic identification and data capture techniques – Radio frequency identification for item management air interface – Part 6: Parameters for air interface communication at 860-960 MHz NPO: 00117/03:PROTx.MUTx/05 Filename: EASY2READ_PROTOCOL_REV5.DOC Number of pages: 32 Page: 32
Source Exif Data:
File Type : PDF File Type Extension : pdf MIME Type : application/pdf PDF Version : 1.4 Linearized : No Encryption : Standard V2.3 (128-bit) User Access : Print, Extract, Print high-res XMP Toolkit : 3.1-701 Producer : Acrobat Distiller 7.0.5 (Windows) Creator Tool : Acrobat PDFMaker 7.0.7 per Word Modify Date : 2008:04:15 17:15:09+02:00 Create Date : 2008:04:15 17:15:03+02:00 Metadata Date : 2008:04:15 17:15:09+02:00 Format : application/pdf Title : CAEN UHF RFID Readers Communication Protocol Creator : Guido Esposito Maurizio Lippi Description : 00117/03:PROTx.MUTx/05 Document ID : uuid:2c516b81-5ea9-4394-affd-d58fbbde0a7c Instance ID : uuid:018db1bd-3def-44ad-9fce-5845c98ded4c Sbc : A928 A948 RF prg : A941 A946 A949 Data 0020registrazione : 02 April 2008 Mic : A528 A828 A828A A829 A941 A946 A949 Comments : data Lbt : A941 A946 A948 A949 Category : User's manual (MUT) Data 0020rev : D:20080402 Page Count : 32 Page Layout : OneColumn Subject : 00117/03:PROTx.MUTx/05 Author : Guido Esposito Maurizio Lippi Keywords : 5 RF Prg : A941 A946 A949 Data Registrazione : 02 April 2008 LBT : A941 A946 A948 A949 Data Rev : D:20080402EXIF Metadata provided by EXIF.tools