A P P E N D I X  A

 


RFID Device Adapter Reference

This appendix describes the supported RFID device profiles (also known as adapters) and their properties. This information can be seen and modified using the RFID Configuration Manager. See Managing Device Profiles for procedures.

The following tables list the properties (also known as attributes), a description and the valid values. Additional descriptive information for some properties follows the table where necessary to expand on the property usage. The properties that are common to all device profiles are described in detail in the section Device Profiles for Supported RFID Devices. The complete list of supported readers and other devices described in TABLE 2-3 found in Chapter 2


Adapter for AWID Readers

This adapter is used to communicate with the AWID MPR-2010 reader. The adapter properties are defined in the following table.


TABLE A-1 Adapter Properties for the AWID MPR-2010 Reader

Property Name

Description

Values

Name

Unique name identifying this adapter

Sample value = AWIDAdapter

classname

Java class name.

com.sun.autoid.adapter.awid.AWID2010Adapter

Common Properties

See TABLE 2-4 for general description and values.

 

LogLevel

hostname

port

readerepc

autoread

communicationTimeout

scanDuration

 

hostname - Must be a static IP address or specified to boot from DHCP and obtain the IP address specified by the value of this property

 

port - default value = 4000

Additional Properties

 

 

readCommandType

The AWID reader can read tags in multiple modes.

The values are:

  • PORTAL_IDs
  • IDs
  • IDs_WITH_SELECT
  • SINGLE_TAG_METER
  • READ_SINGLE_TAGID
  • READ_SINGLE_TAGID_TIMEOUT

tagType

The reader can read different type of tags. Specifying more than one property would set it to Multi-Protocol mode

A comma-separated list of one or more of the following values:

  • EPC_CLASS_0
  • EPC_CLASS_1
  • INTERMEC
  • EM
  • EPC_CLASS_1.19
  • MULTI_PROTOCOL

EM_Version

Required when reading in IDs mode for tagType set to EM

  • EM_4022 (default)
  • EM_4222

writeEPCRetry

Number of tries to write before returning.

1 - Default = 1

0 - Write until complete

sleeptime

The sleep time between reads in milliseconds.

Default = 250 msec

gatherUserData

If true, reads the user data in the transponder (RFID tag) and associates it with the identifier during the inventory round. This information is then passed along the processing chain to filters and connectors, which in turn interpret the user data appropriately.

false (default)

true



Adapter for Feig LRU1000 Readers

This adapter is used to communicate with the Feig LRU1000 reader. The adapter properties are shown in the following table.


TABLE A-2 Adapter Properties for the Feig LRU1000 Readers

Property Name

Description

Values

Name

Unique name identifying this adapter.

Sample value = FeigLRU1000Adapter

classname

Java class name..

com.sun.autoid.adapter.feig.lru1000.LRU1000Adapter

Common Properties

See TABLE 2-4 for general description and values

LogLevel

hostname

port

readerepc

autoread

communicationTimeout

scanDuration

 

 

Additional Properties

.

antennaSequence

A list of which antenna ports have antennas connected.

One or more comma-separated port numbers. For example, 1,2,4

tagIdRepresentation

Specifies the encoding to use for interpreting the ID on the tag.

Values are:

  • ISO
  • EPC

Default value is EPC.

protocolType

Specifies which air interface protocol to activate. Only tags of the specified typ are reported.

Values are:

  • ISO
  • EPC1G1
  • EPC1G2


Adapter for Feig ISCMR100/PR100 Readers

This adapter is used to communicate with the Feig Electronic ID ISC MR.100 and Feig Electronic ID ISC PR.100 readers. The adapter properties are shown in the following table.


TABLE A-3 Adapter Properties for the Feig ISCMR100/PR100 Readers

Property Name

Description

Values

Name

Unique name identifying this adapter.

Sample value = ISCMR100FeigReader

classname

Java class name.

com.sun.autoid.adapter.feig.obidiscan.ISCMR100Adapter

Common Properties

See TABLE 2-4 for general description and values

LogLevel

 

 

hostname

 

Must be configured with a static IP address, or to boot from DHCP and obtain the IP address specified in this property.

port

 

 

readerepc

 

 

autoread

 

 

communicationTimeout

 

 

scanDuration

 

 



Adapter for Intermec IF5 Readers

This adapter is used to communicate with Intermec Intellitag IF5 readers. The adapter properties are shown in the following table.


TABLE A-4 Adapter Properties for the Intermec Intelligtag IF5 Reader

Property Name

Description

Values

Name

Unique name identifying this adapter.

Sample value = IntermecIF5_Adapter

classname

Java class name.

com.sun.autoid.adapter.intermec.IntermecIF5_Adapter

Common Properties

See TABLE 2-4 for general description and values

LogLevel

hostname

port

readerepc

 

 

autoread

 

Default value = false

communicationTimeout

 

Default value = 10000 msec

scanDuration

 

Default value is 500 msec

Additional Properties

 

 

tagType

The type of transponder (RFID tag) the reader expects.

Only one value is valid at a time.

The valid types are the following:

  • MIXED - ISO G1, G2, AND V1.19
  • ISO6BG1 - ISO6B G1
  • ISO6BG2 - ISO6B G2
  • ISO6C - The ISO equivalent to EPCglobal UHF Gen 2
  • ICODE119 - Phillips v1.19 tags (ISO6B emulating EPC tag IDs)
  • EPCC1G2 - EPCglobal UHF Gen2


PML Adapter

The PML Adapter is used to communicate with the software utility PML core reader. The PMLReader typically listens for connection on one or multiple ports. The adapter properties are shown in the following table.


TABLE A-5 Adapter Properties for the PMLReader

Name

Description

Values

Name

Unique name identifying this adapter.

Sample value = PMLReader

classname

Java class name.

com.sun.autoid.adapter.pml.PMLAdapter

Common Properties

See TABLE 2-4 for general description and values

LogLevel

 

 

hostname

IP address or host name of the reader where the PMLReader is executing.

 

port

 

Must match the corresponding entry in the Simulator.properties of the PMLReader.

readerepc

 

Must match the corresponding entry in the Simulator.properties of the PMLReader.

autoread

PMLReader supports autoread mode.

Setting this property to true causes the PMLReader to begin generating simulated RFID events.

scanDuration

 

 



Adapter for Alien Readers

This adapter communicates with the Alien ALR-9780 or Alien NanoScanner 915 RFID readers. The adapter properties are shown in the following table.


TABLE A-6 Adapter Properties for the Alien Reader

Property Name

Description

Values

Name

Unique name identifying this adapter.

Sample value = AlienReader

classname

Java class name.

com.sun.autoid.adapter.alien.NanoScannerAdapter

Common Properties

See TABLE 2-4 for general description and values

LogLevel

 

 

hostname

 

Must be configured with a static IP address, or to boot from DHCP and obtain the IP address specified in this property.

port

 

Default = 23

readerepc

autoread

communicationTimeout

scanDuration

 

 

Additional Properties

Also see Additional Properties Information for Alien Reader.

readerepcANT0, readerepcANT1, and so on.

The EPC identifier associated with antenna 0, 1, 2 or 3 of the reader.

 

antennaSequence

Specifies the order in which antennae are read. This property must be set to enable the various antennae.

A comma-separated list of antenna identifiers: 0, 1, 2, 3, that depends on the number of antennae supported by the reader.

An example value = 0,1 - The reader would pulse antenna 0, followed by antenna 1. Also see the Alien Reader documentation.

username

Specifies the user name that the RFID Event Manager uses to communicate with the reader.

Sample value = alien

password

Specifies the password that the RFID Event Manager uses to communicate with the Alien reader.

Sample value = password

persisttime

Specifies the number of seconds the reader should persist the tag list in its internal tag list buffer.

Sample value = 2, which tells the reader to remember tags for up to 2 seconds before it stops reporting them.

AcquireMode

Specifies the mode to be used for collection of tags. Refer to the Alien Reader documentation.

Values are:

  • Inventory
  • GlobalScroll

Inventory mode is recommended for applications that expect multiple tags to be detected by the reader at once.


Additional Properties Information for Alien Reader


Adapter for ThingMagic Mercury 3 and Sensormatic SensorID Agile 1 Readers

This adapter communicates with the ThingMagic Mercury 3 and the Sensormatic SensorID Agile 1 RFID Reader. The adapter properties are shown in the following table.


TABLE A-7 Adapter Properties for the Mercury 3 and Agile 1 Readers

Name

Description

Values

Name

Unique name identifying this adapter.

Sample value = ThingMagicReader

classname

Java class name.

com.sun.autoid.adapter.tyco.Mercury3Adapter

Common Properties

See TABLE 2-4 for general description and values

LogLevel

 

 

hostname

 

Must be configured with a static IP address, or to boot from DHCP and obtain the IP address specified in this property.

port

 

default = port 80

readerepc

autoread

communicationTimeout

scanDuration

 

Additional Properties

Also see Additional Properties Information for Mercury 3 and Agile 1 Reader.

protocol

Use this property to specify the protocol to be used during data capture. At this time, only one protocol can be active at a time.

This reader supports two RF protocols, CC915 for UHF, and CC1356 for HF.

The default value = CC915.

readerepcUHF1,

readerepcUHF2, and so on.

readerepcUHF1 specifies the EPC for antenna UHF1. This is the EPC reader value associated with the UHF1, UHF2, HF1, and HF2 antennae of the reader. Replace UHF1 with UHF2, HF1, or HF2 for the other antennae.

A sample value = urn:epc:tag:gid-96:1.2.1

See Additional Properties Information for Mercury 3 and Agile 1 Reader.

antenna

This reader supports two antennae for each protocol: UHF1, UHF2 and HF1, HF2.

This property specifies the antenna from which to read.

The default is to enable all the antennae for the RF protocol that has been enabled (see protocol). For example, if CC915 (the default) is selected, both antennae UHF1 and UHF2 will be active.

See Additional Properties Information for Mercury 3 and Agile 1 Reader


Additional Properties Information for Mercury 3 and Agile 1 Reader



Note - It is not necessary to set the antenna property to enable the various antennae. Setting the EPC identifier for the antenna instructs the RFID Event Manager to discriminate between the antennae if they are enabled. Enabling a specific antenna is done through the use of the antenna property.



To activate only UHF1, use the following antenna property:


	<ems:properties>
		<ems:property>antenna</ems:property>
		<ems:value>1</ems:value>
	</ems:properties>
 



Note - Programming (writing to) an RFID tag can only be done from antenna 1 (UHF1).




Adapter for ThingMagic Mercury4 and Sensormatic Agile 2 Readers

This adapter is used to communicate with the ThingMagic Mercury4 and the Sensormatic Agile 2 RFID Reader. The adapter properties are shown in the following table.


TABLE A-8 Adapter Properties for Mercury4 and Agile 2 Readers

Property Name

Description

Values

Name

Unique name identifying this adapter.

Sample value = ThingMagicReader

classname

Java class name.

com.sun.autoid.adapter.tyco.Mercury4Adapter

Common Properties

See TABLE 2-4 for general description and values

LogLevel

 

 

hostname

 

Must be configured with a static IP address, or to boot from DHCP and obtain the IP address specified in this property.

port

default = 80

readerepc

autoread

communicationTimeout

scanDuration

 

 

Additional Properties

Also see Additional Properties Information for Mercury 3 and Agile 1 Reader.

protocol

Use this property to specify the protocol to be used during data capture.

This reader supports three data capture protocols:

  • EPC0
  • EPC1
  • ISO18000-6B

Default = ALL

readerepcUHF1, readerepcUHF2,and so on.

readerepcUHF1 specifies the EPC for Antenna UHF1.

This EPC reader value is associated with the corresponding UHF1, UHF2, UHF3, UHF4, UHF5, UHF6, UHF7 and UHF8 antennae.

Replace UHF1 with UHF2, UHF3 and so on for the other antennae.

A sample value = urn:epc:tag:gid-96:1.2.1.

antenna

This reader supports two antennae for each protocol: UHF1, UHF2 and HF1, HF2. This property specifies the antenna from which to read.

The default is to enable all the antennae for the RF protocol that has been enabled (see protocol). For example, if CC915 (the default) is selected, both antennae UHF1 and UHF2 will be active.



Adapter for Matrics Readers

This adapter is used to communicate with the Matrics RDR-001 and Matrics AR-400 RFID readers. The adapter properties are shown in the following table.



Note - The use of a serial to network (Ethernet) adapter is required.




TABLE A-9 Adapter Properties for the Matrics Reader

Property Name

Description

Values

Name

Unique name identifying this adapter.

Sample name = MatricsReader

classname

Java class name.

com.sun.autoid.adapter.matrics.MatricsReaderAdapter

Common Properties

See TABLE 2-4 for general description and values

LogLevel

 

 

hostname

IP address for the network-facing interface of the Serial to Ethernet Convertor Port which interfaces to the Matrics RDR-001. Future Matrics readers will have this built in.

example value = 192.168.2.150

port

IP port for the network- facing interface of the Serial to Ethernet Convertor Port which interfaces to the Matrics RDR-001. Future Matrics readers will have this built in.

 

readerepc

 

 

autoread

 

 

communicationTimeout

 

scanDuration

Not used by this reader

 

Additional Properties

Also see Additional Properties Information for Matrics Reader.

ConnectionType

Specifies the type of network being used to connect to the reader.

network - Indicates IP connection

serial - Not currently used

readerepcANTx

Specifies an EPC value associated with one of the specific multiple antennae on the reader, where the variable x is an EPC value associated with antenna 1, 2, 3, and 4 of the reader.

Sample value = urn:epc:tag:gid-96:1.1.1

Node

See Additional Properties Information for Matrics Reader

 

Antennan

Specifies whether a particular antenna is to be used where n, indicates the number of the antenna. This readers supports antenna 1-4.

A value of 1 means it is to be used. A value of zero means it is to be inhibited. For example, to enable Antenna 1, the following is used:

<ems:properties> <ems:property>Antenna1</ems:property>

<ems:value>1</ems:value>

</ems:properties>

Power

Controls the power level transmitted during a given read or write interval

The minimum value is 01hex. The maximum value is FFhex, which specifies a full power condition (in this case 4 watts). The power level is logarithmic. For the RDR-001 reader, the maximum power is about 30dBm. The value C0hex is about 50 percent and 80hex about 25 percent of the maximum power.

Environment

See

 

CombinedAntenna

 

 

FilterLength

Not currently used.

 

Filter

Not currently used.

 

debugflags

Not currently used.

 


Additional Properties Information for Matrics Reader

readerepcANT0 corresponds to physical antenna 1, readerepcANT1 corresponds to antenna 2, readerepcANT2 corresponds to antenna 3, and readerepcANT3 corresponds to antenna 4.



Note - It is necessary to set the antennan (where n is the number of the antenna) property to 1 to enable the use of antenna 1. Setting the EPC identifier for antenna 1 tells the RFID Event Manager to discriminate between the antennae if they are enabled, but enabling the antenna is done through the use of the antennan property.



In an environment where tags move in and out of the read field of a reader, it is important to read as fast as possible to be able to start negotiating with new tags coming into the read field. That is why in dynamic environments the variable is usually small. The environment property is dependent on the location of the system. Generally, it is safe to start with the smallest value (00 for dynamic, 04 for static) to evaluate the performance. To improve reads, adjusting the property up or down might be necessary.

Practically, this value should remain at 4. There are few benefits to changing this value, unless you are sure that your environmental conditions are relatively constant.


	<ems:properties>
		<ems:property>Environment</ems:property>
		<ems:value>4</ems:value>
	</ems:properties>

This property only works for antenna 1. The reader tends to produce antenna faults whenever a value other than antenna 1 is chosen.

Because you generally want to distinguish between antennas, using this property is discouraged and is not connected. The property has been kept in case those interested in using it want to make future modifications.


	<ems:properties>
		<ems:property>CombinedAntenna</ems:property>
		<ems:value>1</ems:value>
	</ems:properties>


Adapter for Printronix RFID Printers

This adapter is used to communicate with the Printronix SL 5000e RFID printer. The adapter properties are shown in following table.


TABLE A-10 Adapter Properties for the Printronix SL 5000e RFID Printer

Name

Description

Values

Name

Unique name identifying this adapter.

Sample name = PrintronixPrinter

classname

Java class name.

com.sun.autoid.adapter.printronix.PrintronixAdapter

Common Properties

See TABLE 2-4 for general description and values

LogLevel

hostname

port

readerepc

autoread

communicationTimeout

 

 

scanDuration

not used by this device

 

Additional Properties

.

template

Specifies the location of the default print template.

/tmp/templatefile.txt

template.variable

Template identified by word variable. There can be zero or more occurences of this property, each with a unique substitution for variable.

The value can be either a URL or local file.

For example, if name =template.case, then sample value = /tmp/templatecase.txt.

 



Adapter for SAMSys Readers

This adapter is used to communicate with the SAMSys MP9320 EPC V2.7 Reader. The adapter properties are shown in the following table.


TABLE A-11 Adapter Properties for the SAMSys Reader

Name

Description

Values

Name

Unique name identifying this adapter.

Sample value = SAMSysReader

classname

Java class name.

com.sun.autoid.adapter.SAMSys.SAMsysAdapter

Common Properties

See TABLE 2-4 for general description and values

LogLevel

 

 

hostname

IP address or host name of the reader where the SAMSys reader is executing

Must be configured with a static IP address, or to boot from DHCP and obtain the IP address specified in this property.

port

 

Default = 2001

readerepc

autoread

 

 

scanDuration

See Additional Properties Information for SAMSys Reader.

communicationTimeout

See Additional Properties Information for SAMSys Reader.

Additional Properties

 

 

enableCommandResponseCRC

Command Response Cyclic Redundancy Check (CRC). See also Additional Properties Information for SAMSys Reader.

true - Perform check

false - Omit check

enableTagReadResponseCRC

Response Cyclic Redundancy Check (CRC). See also Additional Properties Information for SAMSys Reader.

true - Perform check

false - Omit check

protocols

Specifies the type of RF protocol to be scanned for by the reader. When no protocols property is defined, the settings on the reader are used without modification. The reader can scan for multiple types simultaneously.

Multiple protocols can be specified by using a comma-separated list such as, [IS186B,EPC1].

Tested values are IS186B and EPC1.

See also Additional Properties Information for SAMSys Reader.

readerepcANTn

EPC value associated with the ANT1, ANT2, ANT3, and ANT4 antennae of the reader, where the variable n equals the number of the antenna.

Example of usage:

property name = readerepcANT1 and

value = urn:epc:tag:gid-96:1.2.11

antennaSequence

Specifies the specific antenna from which to read. The order of the antennas listed in the property determines the jorder in which the antennae are read.

Default is ANT1.

To activate a sequence of ANT1 then ANT3 then ANT2, use the following value for antennaSequence - ANT1,ANT3,ANT2

cycles

Specifies the Antenna Inventory Round Operations, which is the number of inventory operations performed on each antenna before moving to the next antenna in the antenna sequence.

See also Additional Properties Information for SAMSys Reader.

Default value = 1

antennanPower

Specifies the preferred power level, where the variable n designates the antenna number.

Values can be entered as hexadecimal or decimal digits. Hexadecimal values must be prefixed with the characters 0x.

The following example sets the same power levels for both antenna 1 and antenna 2.

  • property name =antenna1Power with value = 0x60
  • property name = antenna2Power

with value = 96

buzzerMode

The SAMSys reader produces an audible beep when tags are observed in its field of view. The buzzer is enabled or disabled with this property.

Values can be ON or OFF

regulatoryParty

Sets the Transmit Power Configuration (TPC) register within the SAMSys reader.

See also Additional Properties Information for SAMSys Reader.

Values are ETSI and FCC

observationSetTimeout

Sets the timeout threshhold used to detect the end of a reported tag observation set. This is separate and disctinct from the communicationTimeoutproperty, which is used for all other communication timeouts, except the detection of the end of an observation set.

default 100 msec


Additional Properties Information for SAMSys Reader

Both the communicationTimeout and observationSetTimeout properties are used for detecting responses to the read command. The communicationTimeout property is used for the initial response, while observationSetTimeout is used for all subsequent observation responses. communicationTimeout behaves this way for all other commands.

The observationSetTimeout property sets the inactivity threshold for signalling that an observation set has completed. Default is 100 msec. This value can be reduced after observing deployment-specific performance.



Note - It is not necessary to set the antenna property to enable the use of the various antennae. Setting the EPC identifier for the antenna instructs the RFID Event Manager to discriminate between the antennae if they are enabled. Enabling a specific antenna is done through the use of the antennaSequence property.




Adapter for Symbol MC9000-G Readers

This adapter communicates with a custom software program hosted on the Symbol MC9000 device. This adapter opens a server socket over TCP and listens for connections from the Symbol MC9000-G device. The data payload consists of one or more lines of text with two possible formats containing the data fields as shown in the following table.


TABLE A-12 Adapter Data Fields and Descriptions for the Symbol MC9000-G Reader

Data Field

Description

Example

tag

Hexadecimal representation of an EPC starting with the letter H.

H40001403EA000001

 

count

An integer representing the number of times the EPC was read by the device.

1

timestamp

The format is "yyyy-MM-dd'T'HH:mm:ss.SSSZ", where Z is the OffsetTimeZone: Sign Hours::Minutes.

2005-07-15T11:23:10-05:00

classType

 

The letter C followed by the class type.

C1


In this example, the adapter receives three 64-bit EPC tags from the reader. The first tag was detected once, the second tag was detected three times, and the third tag was detected fifteen times. In release 3.0, the adapter ignores the count, and does not pass it to the event listeners.

In this example, the adapter receives three class 1, 64-bit EPC tags from the reader. The first tag was detected once, the second tag was detected three times, and the third tag was detected fifteen times. In release 3.0 , the time that the tag was read is used as the current time. The adapter ignores the count and class type, which are not passed up stream to the event listeners.

Any application hosted on the Symbol MC9000-G device that conforms to this protocol will suffice. In most cases, these applications are built for a specific engagement. Contact your Sun Microsystems, Inc. representative to obtain a sample hand-held application that reads the contents of the comma-separated RFIDTagList.csv file that is generated by the Symbol RFID sample application that is shipped with your device. After reading this file, the sample Sun application sends the tag data that is read to this adapter using the format previously defined.

Applications are expected to use the RFID Software reader or web service APIs to query the tag list. In this case, set the autoread property to false, and have the application control how often to query for tags. Alternatively, a connector can be chained to this adapter to post a list of tags to a listening application. In this case, you might set the autoread property to true. Setting the autoread property to true enables a periodic set of queries can be generated to the handheld device and the list of tags posted when the reader posts its data.



Note - The list of tags is only valid for a single query or posting.



Two consecutive queries to the adapter for a list of tags results in two separate attempts to collect RFID data from the device. Typically, the adapter queries the device for a list of tags on cycle n, resulting in tag list L1. On attempt n+1, the adapter might get an empty list if the hand-held device is not connected. On attempt n+2, the adapter might get tag list L2. A tag list is erased from the adapter buffer after the list is posted to its listeners.

The adapter properties for this reader are shown in TABLE A-13.


TABLE A-13 Adapter Properties for the Symbol MC9000-G Reader

Name

Description

Values

Name

Unique name identifying this adapter.

Sample value = SSocketAdapter

classname

Java class name.

com.sun.autoid.adapter.ssocket.SSocketAdapter

Common Properties

See TABLE 2-4 for general description and values

LogLevel

hostname

readerepc

autoread

 

 

port

Specifies the port on which to create a server socket.

Default = 59000

scanDuration

 

Default = 15,000 msecs

datafmt

This property indicates the data format. Currently, this adapter supports only the comma-separated values (CSV) format described above.

 



Adapter for Zebra Technologies Printers

This adapter is used to communicate with the Zebra Technologies R110XiIIIPlus Printer. The adapter properties are shown in the following table.


TABLE A-14 Adapter Properties for Zebra Technologies RFID Printer

Name

Description

Values

Name

Unique name identifying this adapter.

Sample value = ZebraPrinter

classname

Jjava class name.

com.sun.autoid.adapter.zebra.ZebraR110XiAdapter

Common Properties

See TABLE 2-4 for general description and values

LogLevel

hostname

port

readerepc

autoread

communicationTimeout

 

 

scanDuration

Not used by this device

 

Additional Properties

.

template

Specifies the location of the default print template.

/tmp/templatefile.txt

template.variable

Template identified by the variable. There can be zero or more occurences of this property, each with a unique substitution for variable.

The value can be either a URL or a local file.

For example, if the property name = template.case, then the value = /tmp/templatecase.txt .

description

Specifies a description to be printed on the label.

Value = label description text