Reader Reference

     Previous  Next    Open TOC in new window  Open Index in new window  View as PDF - New Window  Get Adobe Reader - New Window
Content starts here

Configuring RFID Devices

The following sections list all supported RFID devices and describe the configuration properties for each device.

 


Supported RFID Readers Summary

You need one or more RFID readers to use the WebLogic RFID Edge Server. All the supported makes and models of readers are shown in Table 2-1. The reader models marked with an asterisk (*) have substantially similar command sets and capabilities as others in the same row, but they have not been as extensively tested.

Table 2-1 Supported RFID Readers 
Make
Model
Read/Write
Tag Classes Supported
ALX-92X series
WO
EPC Class 1
ALR-9750 (Nanoscanner) 915 MHz RFID
RW
EPC Class 1
ALR-9780 915 MHz RFID
ALR-8780 866 MHz RFID*
RW
EPC Class 1
EPC Class 1 Gen 2
ALR-9800
RW
EPC Class 0, 1
EPC Class 1 Gen 2
6405
WO
EPC Class 1
MPR-2010AN, MPR-2080*
RO
EPC Class 0
MPR-2010AN, MPR-2080*
RW
EPC Class 0+, 1
MPR-3014
RW
EPC Class 0+, 1
EPC Class 1 Gen 2
A928
RW
ISO 18000-6B EPC
EPC Class 1 Gen 2
DS6300-105-010
RO
N/A (bar code reader)
LRP820S, LRP2000
RO
ISO 15693
Generic Barcode Reader
RO
N/A (bar code reader)
SmartController
RO
EPC Class 1 Gen 2
Speedway
RW
EPC Class 1 Gen 2
Intellitag IF5
RW
Intellitag G1
ISO 18000-6B
EPC Class 1 Gen 2
PM4i
RW
ISO 18000-6B
EPC Class 1 Gen 2
Monarch 9855
WO
EPC Class 1
SL5000r Smart Label
WO
EPC Class 0+, 1
EPC Class 1 Gen 2
MP9320 2.7
RW
EPC Class 1
MP9320 2.7
RO
ISO 18000-6B v1.19 EPC
SuperTag EM4022/4222
MP9320 2.8
RW
EPC Class 1
EPC Class 1 Gen 2
MP9320 2.8
RO
ISO 18000-6B v1.19 EPC
SuperTag EM4022/4222
MP 9210
RW
ISO 15693
Philips I-Code
RFID Printer
RW
EPC Class 1 Gen 2
RDR-001
RO
EPC Class 0
AR400
RO
EPC Class 0, 0+
EPC Class 1 Gen2
RW
EPC Class 1 Gen1
XR400
RO
EPC Class 0, 0+
RW
EPC Class 1 Gen 1/Gen 2
DC400*
RO
EPC Class 0, 0+,
EPC Class 1 Gen 1/Gen 2
Medio L100, Medio L200*
RW
ISO 15693
Philips I-Code
Mercury3, Sensormatic Agile 1*
RW
EPC Class 1
Mercury4, Sensormatic Agile 2*, Omron V740*
RO
EPC Class 0, 0+
Mercury4, Sensormatic Agile 2*, Omron V740*
RW
EPC Class 1
EPC Class 1 Gen 2
L-RX900
RO
Wavetrend active tags
R110XiIIIPlus
WO
EPC Class 0+
R110Xi
WO
EPC Class 0+, 1
EPC Class 1 Gen 2
R4MPlus
WO
EPC Class 1

Note: Supported read/write types are Read/Write (RW), Read Only (RO), and Write Only (WO).

If you do not have a reader, you can use the reader simulator provided with the RFID Edge Server. Out of the box, it runs on any workstation and simulates a ThingMagic Mercury4 reader; with minor configuration it can simulate a Printronix reader. The reader simulator is useful for software evaluation, application development, and debugging. See Using the Reader Simulator.

 


Configuring Physical Readers

Some readers may require specific configuration prior to use with WebLogic RFID Edge Server. You can configure the RFID Edge Server to communicate with supported readers in one of two ways:

Configuration properties consist of a name (shown in the Property Name column of the tables in this document) and a value (described in the Property Value and Description column). When written out in the edge.props file, they appear in the following format:

com.connecterra.ale.reader.<deviceID>.<prop1> = <prop1value>

If you are using the Administration Console to add and configure readers, you enter the configuration information in reader-specific fields. In this case, no reader configuration information will be written to the edge.props file; instead, the configuration information you enter will be saved in the persistence store kept by the RFID Edge Server.

Useful tips for configuring readers are included in reader-specific sections. For troubleshooting information that applies to all readers, see General Troubleshooting.

 


RFID Readers Configuration Properties

The following sections provide configuration information for all the supported makes and models of readers.

Accraply

This section describes driver configuration information for the Accraply label printer. This device is capable of connecting to a reader (referred to as the Logical Reader Name for RFID Encoding property value) for tag write operations.

The Accraply reader uses the Easy Plug Label Scripting language. See Using the Easy Plug Label Scripting Language.

Table 2-2 lists the Accraply driver configuration properties.

Table 2-2 Accraply Configuration Properties 
Field Label
Property Name
Required?
Property Value and Description
Device Type
class
Yes
Must be set to: com.connecterra.ale.readertypes.AccraplyPhysicalReader
Reader Hostname
hostname
Yes
The DNS name or IP address of the printer's LAN adapter.
Reader Port
port
No
The TCP port the Edge Server will target when establishing connections to the printer's LAN adapter. The default value is 3001.
Socket Timeout
socketTimeout
No
The TCP socket timeout interval (milliseconds). The default value is 15000 milliseconds (15 seconds).
Logical Reader Name
prnLogicalReaderName
Yes
The logical reader name assigned to the Accraply printer's print head.
N/A
rfPowerLevel
No
See rfAttenuation. Used only for backward compatibility with releases prior to RFTagAware 1.3.
RF Attenuation
rfAttenuation
No
Default antenna power attenuation setting to be passed to the secondary Logical Reader Name.
Valid range: 0 (no attenuation, maximum power) to 160 (maximum attenuation, minimum power), in increments of 10 - each increment representing an additional 1 dB of RF attenuation. Default value is 0.
N/A
defaultFormFilename
No
See easyPlugFilename. Used only for backward compatibility with releases prior to RFTagAware 1.3.
Easy Plug Form
easyPlugFilename
No
Specifies the pathname of a file containing Easy Plug commands defining a smart label form. Typically, the PCSpec readerParameters attribute specifies Easy Plug-based label design. This property provides a mechanism for specifying a default label design in the event the PCSpec does not contain this parameter.
When present, this file name refers to a text file containing the set of Easy Plug commands specifying the smart label layout and dynamic (variable) content.

Note: While optional, this property must point to a valid Easy Plug label script file if it is present.

Fail Form
failFormFilename
No
The form which will be used instead of the Easy Plug Form if the secondary Logical Reader Name's tag write operation fails.
Enable RFID Encoding
programRFID
No
A Boolean (allowed values are true and false) specifying whether the reader driver instructs the printer to program EPC data into an embedded RFID tag. The default value is true.
Logical Reader Name for RFID Encoding
secondaryLogicalReaderName
Yes
Specifies a (secondary) logical reader to write the RFID tag in the label. This logical reader must be properly specified and configured.
Retries
retries
No
The number of attempts that the secondary Logical Reader Name should make to write the RFID tag in the label.

Alien

The RFID Edge Server uses three Alien reader drivers:

Alien ALR-9750

This driver is used to interface the WebLogic RFID Edge Server with an Alien Technology ALR-9750 (Nanoscanner 915 MHz) RFID Reader. The reader driver implements the Alien text-based communications protocol for configuring and operating its RFID readers. This text-based reader/ host protocol is specified in the Nanoscanner Reader User Guide (Alien Doc # 8101024-000 Rev B).

Table 2-3 lists the Alien ALR-9750 reader driver configuration properties.

Table 2-3 Alien ALR-9750 Configuration Properties 
Field Label
Property Name
Required?
Property Value and Description
Device Type
class
Yes
For backward compatibility with releases prior to RFTagAware 1.1.2, set to: com.connecterra.ale.readertypes.AlienReaderGroup
Otherwise, set to: com.connecterra.ale.readertypes.AlienALR9750PhysicalReader
Reader Hostname
hostname
Yes
The DNS name or IP address of the Alien reader.
Reader Port
port
No
The TCP port the Edge Server will target when establishing connections to the printer's LAN adapter. The default value is 23.
Default Rate
defaultRate
No
The period (in milliseconds) between the start of one read cycle and the start of the next. Note that if multiple logical readers are simultaneously active, then each logical reader will be read at an interval equal to the default rate times the number of logical readers.
Socket Timeout
socketTimeout
Yes
The TCP socket timeout interval (milliseconds). The integer property value must be greater than or equal to 0. A timeout of 0 is interpreted as an infinite timeout. The default is 15000 milliseconds (15 seconds).
User Name
username
Yes
The user name the Edge Server will use for gaining access to the Alien reader. Must be the same as the user name you configured when setting up the Alien reader.

Note: The user name is case sensitive and must be entirely lowercase.

Password
password
Yes
The password the Edge Server will use for gaining access to the Alien reader. Must be the same as the password you configured when setting up the Alien reader.

Note: The password is case sensitive and must be entirely lowercase.

Disable Programming Cycle Check
disableProgrammingCycleCheck
No
An optional Boolean property (allowed values are true and false) specifying whether the driver disables the "check operation" (verification that there is a single tag in an antenna's field prior to conducting a tag programming operation). The default value is false, meaning the driver conducts the check operation.
Antenna 0 Logical Reader Name
Antenna 1 Logical Reader Name
uhf1LogicalReaderName
uhf2LogicalReaderName
Must configure one
Specifies the logical reader name for each UHF antenna. At least one logical reader name must be specified or the Edge Server will generate an error on startup.
Antenna 0 Filter Names
Antenna 1 Filter Names
uhf1LogicalReaderFilterNames
uhf2LogicalReaderFilterNames
No
A blank-separated list of filter names for each logical reader. This value is defined in the Administration Console or in the edge.props file.

The Alien reader obtains its IP network configuration dynamically via DHCP, or statically through one of the reader configuration interfaces. Refer to the Alien Nanoscanner Reader User Guide for further details.

The Edge Server Alien reader driver assumes that the Alien reader has also been configured, through the Alien Web interface or command-line interface, with the following configuration settings. These configuration settings must be saved to the reader's flash memory so that reader reboots do not result in their loss.

Alien>Set Username=<username>
Alien>Set Password=<password>

Alien ALR-9780

This driver is used to interface the WebLogic RFID Edge Server with two models of Alien Technology readers: the ALR-9780 915 MHz RFID reader and the ALR-8780 866 MHz RFID reader.

The reader driver implements the Alien text-based communications protocol for configuring and operating its RFID readers. This text-based reader/host protocol is specified in the ALR-9780 Reader Interface Guide (Alien Doc # 8101938-000 Rev 01).

Table 2-4 lists the Alien ALR-9780 reader driver configuration properties.

Table 2-4 Alien ALR-9780 Configuration Properties 
Field Label
Property Name
Required?
Property Value and Description
Device Type
class
Yes
Set to: com.connecterra.ale.readertypes.AlienALR9780PhysicalReader
Reader Hostname
hostname
Yes
The DNS name or IP address of the Alien reader.
Reader Port
port
No
The TCP port the Edge Server will use when establishing connections to the Alien reader. The default is 23.
Default Rate
defaultRate
Yes
The period (in milliseconds) between the start of one read cycle and the start of the next. Note that if multiple logical readers are simultaneously active, then each logical reader will be read at an interval equal to the default rate times the number of logical readers.
Socket Timeout
socketTimeout
No
The TCP socket timeout interval (milliseconds). The integer property value must be greater than or equal to 0. A timeout of 0 is interpreted as an infinite timeout. The default is 15000 milliseconds (15 seconds).
User Name
username
Yes
The user name the Edge Server will use for gaining access to the Alien reader. Must be the same as the user name you configured when setting up the Alien reader.

Note: The user name is case sensitive and must be lowercase.

Password
password
Yes
The password the Edge Server will use for gaining access to the Alien reader. Must be the same as the password you configured when setting up the Alien reader.

Note: The password is case sensitive and must be lowercase.

Reader Network Timeout
readerNetworkTimeout
No
The amount of time (in seconds) the reader maintains an idle connection with the Edge Server before closing the connection. The integer property value must be greater than 0.
Valid range is 1-65535 seconds; default value is 90 seconds.
Read RF Attenuation
readRfAttenuation
No
Sets antenna power attenuation for tag read operations.
Valid range: from 0 (no attenuation, maximum power) to 160 (maximum attenuation, minimum power), in increments of 10; each increment representing an additional 1 dB of RF attenuation. Default value is 0.
Write RF Attenuation
writeRfAttenuation
No
Sets antenna power attenuation for program tag operations.
Valid range: from 0 (no attenuation, maximum power) to 160 (maximum attenuation, minimum power), in increments of 10; each increment representing an additional 1 dB of RF attenuation. Default value is 0.
This property may be overridden at run-time by the application reader parameter rfAttenuation.
Disable Programming Cycle Check
disableProgrammingCycleCheck
No
An optional Boolean property (allowed values are true and false) specifying whether the driver disables the "check operation" (verification that there is a single tag in an antenna's field prior to conducting a tag programming operation). The default value is false, meaning the driver conducts the check operation.
Enable Global Scroll Mode
enableGlobalScrollMode
No
An optional Boolean property specifying whether tags are to be acquired in the Global Scroll mode. The default value is false (the driver acquires tags in the Inventory mode).
Antenna 0 Logical Reader Name
Antenna 1 Logical Reader Name
Antenna 2 Logical Reader Name
Antenna 3 Logical Reader Name
uhf1LogicalReaderName
uhf2LogicalReaderName
uhf3LogicalReaderName
uhf4LogicalReaderName
Must configure one
Specifies the logical reader name for each UHF antenna. At least one logical reader name must be specified or the Edge Server will generate an error on startup.
If multiple UHF antennas are assigned the same logical reader name, then the driver will treat them as a single combined antenna. The lowest-numbered antenna in the combined antenna grouping is checked to set antenna-specific properties and used for tag programming.
Antenna 0 Acq. Cycles
Antenna 1 Acq. Cycles
Antenna 2 Acq. Cycles
Antenna 3 Acq. Cycles
uhf1AcqCycles
uhf2AcqCycles
uhf3AcqCycles
uhf4AcqCycles
No
The number of acquisition cycles that are performed each time a logical reader conducts a read cycle (is issued a "Get TagList" command). Each logical reader operates with its own value. Integer property values range from 1 to 255. The default value is 1. See chapters 3 and 4 of the Alien Technology Reader Interface Guide for further information on this Acquire Parameter.
Antenna 0 Wake Count at Start of Cycle
Antenna 1 ...
Antenna 2 ...
Antenna 3 ...
uhf1AcqEnterWakeCount
uhf2AcqEnterWakeCount
uhf3AcqEnterWakeCount
uhf4AcqEnterWakeCount
No
The number of RF wake commands the Alien reader issues at the start of each acquisition cycle. Each logical reader operates with its own value. Integer property values range from 0 to 255. The default value is 3. See chapters 3 and 4 of the Alien Technology Reader Interface Guide for further information on this Acquire Parameter.
Antenna 0 Field Reads per Cycle
Antenna 1 Field Reads per Cycle
Antenna 2 Field Reads per Cycle
Antenna 3 Field Reads per Cycle
uhf1AcqCount
uhf2AcqCount
uhf3AcqCount
uhf4AcqCount
No
The number of field reads (anti-collision searches) that are performed in each acquisition cycle. Each logical reader operates with its own value. Integer property values range from 1 to 255. The default value is 3. See chapters 3 and 4 of the Alien Technology Reader Interface Guide for further information on this Acquire Parameter.
Antenna 0 Sleep Commands per Read
Antenna 1 ...
Antenna 2 ...
Antenna 3 ...
uhf1AcqSleepCount
uhf2AcqSleepCount
uhf3AcqSleepCount
uhf4AcqSleepCount
No
The number of RF sleep commands the Alien reader issues after each field read. Each logical reader operates with its own value. Integer property values range from 0 to 255. The default value is 1. See chapters 3 and 4 of the Alien Technology Reader Interface Guide for further information on this Acquire Parameter.
Antenna 0 Wake Commands at end of each read
Antenna 1 ...
Antenna 2 ...
Antenna 3 ...
uhf1AcqExitWakeCount
uhf2AcqExitWakeCount
uhf3AcqExitWakeCount
uhf4AcqExitWakeCount
No
The number of RF wake commands the Alien reader issues at the end of each acquisition cycle. Each logical reader operates with its own value. Integer property values range from 0 to 255. The default value imposed by the RFID Edge Server is 1. See chapters 3 and 4 of the Alien Technology Reader Interface Guide for further information on this Acquire Parameter.
Antenna 0 Field Inventory Timeout
Antenna 1 Field Inventory Timeout
Antenna 2 Field Inventory Timeout
Antenna 3 Field Inventory Timeout
uhf1GetTagListTimeout
uhf2GetTagListTimeout
uhf3GetTagListTimeout
uhf4GetTagListTimeout
No
The timeouts (in milliseconds) for field inventories (Alien Reader "Get TagList" commands). Each logical reader operates with its own timeout value. This configuration parameter, rather than the socketTimeout property, will serve as the socket timeout value when the Edge Server is awaiting a response to a "Get TagList" command. The integer property value must be greater than or equal to 0. A timeout of 0 is interpreted as an infinite timeout. The default value is the value of the Socket Timeout property (or its default).
Antenna 0 Filter Names
Antenna 1 Filter Names
Antenna 2 Filter Names
Antenna 3 Filter Names
uhf1LogicalReaderFilterNames
uhf2LogicalReaderFilterNames
uhf3LogicalReaderFilterNames
uhf4LogicalReaderFilterNames
No
A blank-separated list of filter names for each logical reader. This value is defined in the Administration Console or in the edge.props file.
Stack Light A Logical Reader Name
stackLightALogicalReaderName
No
Specifies a logical reader to control the left stack light. For more information on stack light configuration, see Configuring and Controlling Stack Lights.
Red Light IO Mask
stackLightAredLightIOMask
No
Defines GPIO port output lines to control the red light on the stack. The valid range is 0-15; the default value is 0.
Green Light IO Mask
stackLightAgreenLightIOMask
No
Defines GPIO port output lines to control the green part of the stack light. The valid range is 0-15; the default value is 0.
Stack Light B Logical Reader Name
stackLightBLogicalReaderName
No
Specifies a logical reader to control the right stack light. For more information on stack light configuration, see Configuring and Controlling Stack Lights.
Red Light IO Mask
stackLightBredLightIOMask
No
Defines GPIO port output lines to control the red light on the stack. The valid range is 0-15; the default value is 0.
Green Light IO Mask
stackLightBgreenLightIOMask
No
Defines GPIO port output lines to control the green part of the stack light. The valid range is 0-15; the default value is 0.
List of Protocols
rfProtocol
No
A blank-separated list of RF protocols. Alien ALR-9780 is a multi-protocol reader. To improve efficiency, the read operation will only attempt to collect tags encoded with the specified protocols. At present, valid values are:
All
epcClass1
epcClass1Gen2
The default value is All.

Note: For tag programming, select a single protocol type.

The Alien reader obtains its IP network configuration dynamically via DHCP, or statically through one of the reader configuration interfaces. Refer to the Alien Reader Interface Guide for further details.

The Edge Server Alien reader driver assumes the Alien reader has also been configured, through the Alien Web interface or command-line interface, with the following configuration settings. These configuration settings must be saved to the reader's flash memory so that reader reboots do not result in their loss.

Alien>Set Username=<username>
Alien>Set Password=<password>

Alien ALR-9800

This driver is used to interface the WebLogic RFID Edge Server with the Alien Technology ALR-9800 reader.

Notes: The ALR-9800 reader antennas must be used in pairs for all operations; for example, use antenna 0 and 1 together to read or write tags, likewise, antennas 2 and 3.
Note: BEA recommends configuring the driver to use antennas pairs; for example, configure UHF Antenna 0 and UHF Antenna 1 with the same logical reader name.
Note: With regard to antenna placement, the ALR-9800 reader antennas must be connected in pairs and each antenna in the pair must point to the same tag location. For example, you must connect both antenna 0 and antenna 1 when querying for information from either logical antenna 0 or 1.
Note: For more information, see the Alien Technology, Reader Interface Guide (DOC. CONTROL# 8101938-000, REV E, Sept. 2005).

Table 2-5 Alien ALR-9800 Configuration Properties 
Field Label
Property Name
Required?
Property Value and Description
Device Type
class
Yes
Set to: com.connecterra.ale.readertypes.AlienALR9800PhysicalReader
Reader Hostname
hostname
Yes
The DNS name or IP address of the Alien reader.
Reader Port
port
No
The TCP port the Edge Server will use when establishing connections to the Alien reader. The default is 23.
Socket Timeout
socketTimeout
No
The TCP socket timeout interval (milliseconds). The integer property value must be greater than or equal to 0. A timeout of 0 is interpreted as an infinite timeout. The default is 15000 milliseconds (15 seconds).
Read Timeout
readTimeout
No
Specifies the maximum amount of time (in milliseconds) the reader may spend when servicing a request to read tags in a single antenna's field. The default value is 250 milliseconds.
Write Timeout
writeTimeout
No
Specifies the maximum amount of time (in milliseconds) the reader may spend when servicing a request to program a tag across a single antenna. The default value is 250 milliseconds.
Default Rate
defaultRate
Yes
The period (in milliseconds) between the start of one read cycle and the start of the next. Note that if multiple logical readers are simultaneously active, then each logical reader will be read at an interval equal to the default rate times the number of logical readers.
User Name
username
Yes
The user name the Edge Server will use for gaining access to the Alien reader. Must be the same as the user name you configured when setting up the Alien reader.

Note: The user name is case sensitive and must be lowercase.

Password
password
Yes
The password the Edge Server will use for gaining access to the Alien reader. Must be the same as the password you configured when setting up the Alien reader.

Note: The password is case sensitive and must be lowercase.

Reader Network Timeout
readerNetworkTimeout
No
The amount of time (in seconds) the reader maintains an idle connection with the Edge Server before closing the connection. The integer property value must be greater than 0.
Valid range is 1-65535 seconds; default value is 90 seconds.
Read RF Attenuation
readRfAttenuation
No
Sets antenna power attenuation for tag read operations.
Valid range: from 0 (no attenuation, maximum power) to 160 (maximum attenuation, minimum power), in increments of 10; each increment representing an additional 1 dB of RF attenuation. Default value is 0.
Write RF Attenuation
writeRfAttenuation
No
Sets antenna power attenuation for program tag operations.
Valid range: from 0 (no attenuation, maximum power) to 160 (maximum attenuation, minimum power), in increments of 10; each increment representing an additional 1 dB of RF attenuation. Default value is 0.
This property may be overridden at run-time by the application reader parameter rfAttenuation.
Disable Programming Cycle Check
disableProgrammingCycleCheck
No
An optional Boolean property (allowed values are true and false) specifying whether the driver disables the "check operation" (verification that there is a single tag in an antenna's field prior to conducting a tag programming operation). The default value is false, meaning the driver conducts the check operation.
Enable Global Scroll Mode
enableGlobalScrollMode
No
An optional Boolean property specifying whether tags are to be acquired in the Global Scroll mode. The default value is false (the driver acquires tags in the Inventory mode).
Antenna 0 Logical Reader Name
Antenna 1 Logical Reader Name
Antenna 2 Logical Reader Name
Antenna 3 Logical Reader Name
uhf1LogicalReaderName
uhf2LogicalReaderName
uhf3LogicalReaderName
uhf4LogicalReaderName
Must configure one
Specifies the logical reader name for each UHF antenna. At least one logical reader name must be specified or the Edge Server will generate an error on startup.
If multiple UHF antennas are assigned the same logical reader name, then the driver will treat them as a single combined antenna. The lowest-numbered antenna in the combined antenna grouping is checked to set antenna-specific properties and used for tag programming.
Antenna 0 Filter Names
Antenna 1 Filter Names
Antenna 2 Filter Names
Antenna 3 Filter Names
uhf1LogicalReaderFilterNames
uhf2LogicalReaderFilterNames
uhf3LogicalReaderFilterNames
uhf4LogicalReaderFilterNames
No
A blank-separated list of filter names for each logical reader. This value is defined in the Administration Console or in the edge.props file.
Antenna 0 Acq. Cycles
Antenna 1 Acq. Cycles
Antenna 2 Acq. Cycles
Antenna 3 Acq. Cycles
uhf1AcqCycles
uhf2AcqCycles
uhf3AcqCycles
uhf4AcqCycles
No
The number of acquisition cycles that are performed each time a logical reader conducts a read cycle (is issued a "Get TagList" command). Each logical reader operates with its own value. Integer property values range from 1 to 255. The default value is 1. See chapters 3 and 4 of the Alien Technology Reader Interface Guide for further information on this Acquire Parameter.
Antenna 0 Wake Count at Start of Cycle
Antenna 1 ...
Antenna 2 ...
Antenna 3 ...
uhf1AcqEnterWakeCount
uhf2AcqEnterWakeCount
uhf3AcqEnterWakeCount
uhf4AcqEnterWakeCount
No
The number of RF wake commands the Alien reader issues at the start of each acquisition cycle. Each logical reader operates with its own value. Integer property values range from 0 to 255. The default value is 3. See chapters 3 and 4 of the Alien Technology Reader Interface Guide for further information on this Acquire Parameter.
Antenna 0 Field Reads per Cycle
Antenna 1 Field Reads per Cycle
Antenna 2 Field Reads per Cycle
Antenna 3 Field Reads per Cycle
uhf1AcqCount
uhf2AcqCount
uhf3AcqCount
uhf4AcqCount
No
The number of field reads (anti-collision searches) that are performed in each acquisition cycle. Each logical reader operates with its own value. Integer property values range from 1 to 255. The default value is 3. See chapters 3 and 4 of the Alien Technology Reader Interface Guide for further information on this Acquire Parameter.
Antenna 0 Sleep Commands per Read
Antenna 1 ...
Antenna 2 ...
Antenna 3 ...
uhf1AcqSleepCount
uhf2AcqSleepCount
uhf3AcqSleepCount
uhf4AcqSleepCount
No
The number of RF sleep commands the Alien reader issues after each field read. Each logical reader operates with its own value. Integer property values range from 0 to 255. The default value is 1. See chapters 3 and 4 of the Alien Technology Reader Interface Guide for further information on this Acquire Parameter.
Antenna 0 Wake Commands at end of each read
Antenna 1 ...
Antenna 2 ...
Antenna 3 ...
uhf1AcqExitWakeCount
uhf2AcqExitWakeCount
uhf3AcqExitWakeCount
uhf4AcqExitWakeCount
No
The number of RF wake commands the Alien reader issues at the end of each acquisition cycle. Each logical reader operates with its own value. Integer property values range from 0 to 255. The default value imposed by the RFID Edge Server is 1. See chapters 3 and 4 of the Alien Technology Reader Interface Guide for further information on this Acquire Parameter.
Antenna 0 Field Inventory Timeout
Antenna 1 Field Inventory Timeout
Antenna 2 Field Inventory Timeout
Antenna 3 Field Inventory Timeout
uhf1GetTagListTimeout
uhf2GetTagListTimeout
uhf3GetTagListTimeout
uhf4GetTagListTimeout
No
The timeouts (in milliseconds) for field inventories (Alien reader "Get TagList" commands). Each logical reader operates with its own timeout value. This configuration parameter, rather than the socketTimeout property, will serve as the socket timeout value when the Edge Server is awaiting a response to a "Get TagList" command. The integer property value must be greater than or equal to 0. A timeout of 0 is interpreted as an infinite timeout. The default value is the value of the Socket Timeout property (or its default).
UHF Antenna 0 Starting Q Value
UHF Antenna 1 Starting Q Value
UHF Antenna 2 Starting Q Value
UHF Antenna 3 Starting Q Value
uhf1Gen2Q
uhf2Gen2Q
uhf3Gen2Q
uhf4Gen2Q
No
The starting "Q" value used to tune the performance of the Class 1 Gen 2 air protocol. Integer property values range from 0 to 5. The default value is 3.
Small Gen 2 tag populations benefit from a small Q value (0-1), while larger Gen 2 tag populations benefit from a higher Q value (2-5).
Stack Light A Logical Reader Name
stackLightALogicalReaderName
No
Specifies a logical reader to control the left stack light. For more information on stack light configuration, see Configuring and Controlling Stack Lights.
Red Light IO Mask
stackLightAredLightIOMask
No
Defines GPIO port output lines to control the red light on the stack. The valid range is 0-15; the default value is 0.
Green Light IO Mask
stackLightAgreenLightIOMask
No
Defines GPIO port output lines to control the green part of the stack light. The valid range is 0-15; the default value is 0.
Stack Light B Logical Reader Name
stackLightBLogicalReaderName
No
Specifies a logical reader to control the right stack light. For more information on stack light configuration, see Configuring and Controlling Stack Lights.
Red Light IO Mask
stackLightBredLightIOMask
No
Defines GPIO port output lines to control the red light on the stack. The valid range is 0-15; the default value is 0.
Green Light IO Mask
stackLightBgreenLightIOMask
No
Defines GPIO port output lines to control the green part of the stack light. The valid range is 0-15; the default value is 0.
Invert External Outputs
invertOutputs
No
A Boolean property (allowed values are true and false) specifying whether to invert external ouputs. When inverted, setting an output high drives the voltage low. The default value is false.
RF Modulation Mode
rfModulation
No
Valid values are:
  • Standard (default)—good for general purpose use and meets the EPCglobal Dense Reader Mode spectral mask requirements.
  • High Speed—uses high reader-to-tag data rates for better performance in environments with few readers.
  • DRM (Dense Reader Mode)—provides enhanced filtering for better performance in "noisy" environments. Recommended when many readers are operating in the same area. Meets the EPCglobal Dense Reader Mode spectral mask requirements.
RF Protocol
rfProtocol
No
A blank-separated list of RF protocols. Alien ALR-9800 is a multi-protocol reader. To improve efficiency, the read operation will only attempt to collect tags encoded with the specified protocols. At present, valid values are:
All
epcClass1
epcClass1Gen2
The default value is All.

Note: For tag programming, select a single protocol type.

PLC Transport Name
plcTransport
No
The PLC transport name defined in the edge.props file.

Configuring ALR-9800 GPIO

The Alien ALR-9800 reader has eight external output lines, numbered 0 through 7, and four external input lines, numbered 0 through 3. WebLogic RFID Edge Server lets you configure these GPIO like a PLC device. See Configuring the Edge Server for PLC Communications. When configuring data items for the ALR-9800, use out0, out1, out2, ...out7 for outputs, and in0, ....in3 for inputs.

Listing 2-1 illustrates configuring the Alien ALR-9800 reader for controlling a 5-color stack light connected to the reader's external outputs 1 through 5.

Listing 2-1 Alien ALR-9800 GPIO Configuration
#In edge.props file
#Define the PLC Transport `Reader'
com.connecterra.ale.plc.plcTransport.Alien9800GPIO.metaName = Reader
com.connecterra.ale.plc.plcTransport.Alien9800GPIO.pollInterval = 1000
#Define the message convention `Simple'
com.connecterra.ale.plc.plcMessageConvention.simple.metaName = Simple
com.connecterra.ale.plc.plcMessageConvention.simple.plcTransport = Alien9800GPIO
#Define the message convention `Multiple'
com.connecterra.ale.plc.plcMessageConvention.multiple.metaName = Multiple
com.connecterra.ale.plc.plcMessageConvention.multiple.plcTransport = Alien9800GPIO
#Define outboundMessage for left stack light
com.connecterra.ale.plc.outboundMessage.mystacklightleft.plcMessageConvention = multiple
com.connecterra.ale.plc.outboundMessage.mystacklightleft.items = out1 out2 out3 out4 out5
#Define inboundMessage
com.connecterra.ale.plc.inboundMessage.AlienInputs.plcMessageConvention = simple
com.connecterra.ale.plc.inboundMessage.AlienInputs.receiveItem = in1
com.connecterra.ale.plc.inboundMessage.AlienInputs.matchValues = false
#Define left stacklight. Alternatively, this can be done in the Administration
#Console by defining a PLC Stack Light device.
#See PLC Stack Light Example.
com.connecterra.ale.reader.stacklightleft.class = com.connecterra.ale.readertypes.PLCStackLightPhysicalReader
com.connecterra.ale.reader.stacklightleft.plcMessage = mystacklightleft
com.connecterra.ale.reader.stacklightleft.defaultRate = 0
com.connecterra.ale.reader.stacklightleft.stackLightLogicalReaderName = StackLightLeft

Avery

This section describes driver configuration information for the Avery 6405 RFID label printer. The printer supports the writing (programming) of Class 1 tags embedded within label stock ("smart labels") and the printing of those labels.

Table 2-6 lists the Avery 6405 reader driver configuration properties.

Table 2-6 Avery 6405 Configuration Properties 
Field Label
Property Name
Required?
Property Value and Description
Device Type
class
Yes
Must be set to: com.connecterra.ale.readertypes.Avery6405PhysicalReader
Reader Hostname
hostname
Yes
The DNS name or IP address of the printer's LAN adapter.
Reader Port
port
No
The TCP port the Edge Server will target when establishing connections to the printer's LAN adapter. The default value is 4000.
Socket Timeout
socketTimeout
No
The TCP socket timeout interval (milliseconds). The default value is 15000 milliseconds (15 seconds).
N/A
defaultFormFilename
No
See easyPlugFilename. Used only for backward compatibility with releases prior to RFTagAware 1.3.
Easy Plug Form
easyPlugFilename
No
Specifies the pathname of a file containing Easy Plug commands defining a smart label form. Typically, the PCSpec readerParameters attribute specifies Easy Plug-based label design. This property provides a mechanism for specifying a default label design in the event the PCSpec does not contain this parameter.
When present, the file name refers to a text file containing the set of Easy Plug commands specifying the smart label layout and dynamic (variable) content.

Note: While optional, this property must point to a valid Easy Plug label script file if it is present.

Enable RFID Encoding
programRFID
No
A Boolean (allowed values are true and false) specifying whether the reader driver instructs the printer to program EPC data into an embedded RFID tag. The default value is true.
Logical Reader Name
uhf1LogicalReaderName
Yes
The logical reader name assigned to the Avery printer's single integrated UHF antenna.
Retries
retries
No
Defines the number of labels to retry in case of a failed RFID operation. The valid range is 1 through 10. The default value is 3.

Using the Easy Plug Label Scripting Language

Easy Plug is a scripting language for specifying the layout and contents of printed labels. Easy Plug is described in detail in the Avery document, Manual Easy Plug, Release 3.00, 11/2003. Commands specific to the Avery 6405 are described in the document, How to RFID with Avery 6405.

The Avery 6405 and Accraply smart label printer drivers send their printers a separate collection of Easy Plug commands with each "smart label" (a printed label with an embedded RFID tag) to be printed and programmed. Users specify a smart label's Easy Plug commands when defining a PCSpec (see Programming with the ALE and ALEPC APIs). A PCSpec readerParameters field carries the Easy Plug script as a String object; the corresponding reader parameter name is easyPlugScript (or one of easyPlugScript.accraply or easyPlugScript.avery if your WebLogic RFID Edge Server installation supports more than one device that uses EasyPlug).

As an alternative to specifying Easy Plug within a PCSpec, the Edge Server administrator may specify a default Easy Plug script using the reader driver Easy Plug Form property. This property provides a mechanism for specifying Easy Plug commands that serve as a default label design in the event the PCSpec readerParameters field does not carry a key/value pair containing an Easy Plug script.

The Easy Plug script, whether defined within the PCSpec or contained in a file identified by the easyPlugFilename property, must contain only Easy Plug commands. Here is an example script:

#!A1
#IMSR100/152.4//6/89/0V
#ER
#R000.00/000.00
#J100#T20.0
#M1/1
#YN100/0/100///THIS IS A TEST
#J50#T25.0
#YN100/0/58///[EPC_TAG_URI]
#Q1/
#!P1

Refer to Avery or Accraply documentation for additional information on Easy Plug.

AWID

This section describes driver configuration information for the AWID MPR-2010AN reader.

For the AWID MPR-3014 reader, the configuration properties are the same as for the AWID MPR-2010AN reader, plus the additional properties listed in Table 2-8.

Table 2-7 lists the AWID MPR-2010AN reader driver configuration properties.

Table 2-7 AWID MPR-2010AN Configuration Properties 
Field Label
Property Name
Required?
Property Value and Description
Device Type
class
Yes
Must be set to: com.connecterra.ale.readertypes.AWID2010ANPhysicalReader
Reader Hostname
hostname
Yes
The DNS name or IP address of the AWID MPR-2010AN reader.
Reader Port
port
No
Specifies the TCP port the reader driver will target when establishing connections to the AWID MPR-2010AN reader. The default value is 4000.
Default Rate
defaultRate
Yes
The period (in milliseconds) between polls of a logical reader.
Read Timeout
readTimeout
No
The time interval (in milliseconds) allocated to acquiring Class 1 tags. This interval is a portion of the defaultRate described earlier. The default value is 500 milliseconds.
Write Timeout
writeTimeout
No
The time interval (in milliseconds) allocated to programming Class 1 tags. The default value is 500 milliseconds.
Sensitivity
sensitivity
No
The sensitivity setting of the reader channel. The range of valid values is from 0 (minimum sensitivity) to 255 (maximum sensitivity). The default setting is 255.
Socket Timeout
socketTimeout
No
The driver's TCP socket timeout interval, expressed in milliseconds. The integer property must be greater than or equal to 0. A timeout of zero is interpreted as an infinite timeout. The default value is 15000 milliseconds.
RF Power Level
rfPowerLevel
No
The RF power setting of the reader. The range of valid values is from 0 (minimum power) to 255 (maximum power). The default value is 0.
Disable Programming Cycle Check
disableProgrammingCycleCheck
No
Instructs the reader driver not to perform a program cycle check. Valid values are:
true
false
The default value is false. This property can be specified as true only if one of the writable protocols is listed in the rfProtocols property, otherwise the driver will generate a configuration error.
Logical Reader Name
uhf1LogicalReaderName
Yes
A logical reader name bound to the AWID MPR-2010AN reader's UHF antenna. This reader has only one UHF antenna; hence, only one logical reader.
Logical Reader Filter Names
uhf1LogicalReaderFilterNames
No
A blank-separated list of filter names for each logical reader. This value is defined in the Administration Console or in the edge.props file.
List of Protocols
rfProtocols
Yes
Valid values are:
epcClass0
epcClass1
The default value is epcClass1.

Table 2-8 AWID MPR-3014 Additional Configuration Properties 
Field Label
Property Name
Required?
Property Value and Description
Antenna 1 Logical Reader Name
Antenna 2 Logical Reader Name
Antenna 3 Logical Reader Name
Antenna 4 Logical Reader Name
uhf1LogicalReaderName
uhf2LogicalReaderName
uhf3LogicalReaderName
uhf4LogicalReaderName
Must configure one
A logical reader name bound to the AWID MPR-3014 reader's UHF antenna. This reader supports up to 4 UHF antennas. At least one logical reader name must be specified.

Tips For AWID MPR-2010AN and MPR-3014 Readers

When setting up AWID MPR-2010AN and MPR-3014 readers, follow the instructions provided in the MPRSetupGuide.pdf file (from the original CD).

When connecting to the reader for the first time, you need to set up a local network where the host computer is assigned an IP address in the 192.168.xxx space (the default address is 192.168.1.91).

Note: The reader comes with DHCP enabled by default. Disconnect from any external network where a DHCP server might be active while configuring the reader for the first time.

If you do not know the IP address assigned to the reader, you may restore the factory defaults by pressing and holding a hidden button with a sharp object while rebooting the reader. Release the button when the reader powers up.

MPR-3014

This reader supports up to four UHF antennas. At the present time, the reader cannot reliably detect which antenna ports have antennas attached. It relies on user input to enable and disable appropriate antenna ports. Therefore, when configuring logical readers, it is important that you do not attempt to configure antennas that are not physically attached; it is possible to damage the reader by doing this.

MPR-3014 and Combined Antenna Mode

Unlike some readers, MPR-3014 can only support one antenna group. As always, the group is created by assigning the same logical reader name to several uhf antennas. The antenna group must be contiguous; for example, it must start with uhf1, and cannot skip antennas. If you assign the logical reader name "LR1" to uhf antenna 1 and uhf antenna 2, and then attempt to assign a different name to uhf antenna 3, the driver will interpret this as an attempt to create a second combined antenna group, and will generate an error: "AWID MPR-3014 allows only one combined antenna group".

For more information on antenna groups, see Combined Antenna Mode.

CAEN

This section describes driver configuration information for the CAEN Technologies A928 RFID reader. Note that the RFID Edge Server requires the separate installation of the CAEN Java library to enable interoperation with the CAEN A928 RFID reader. Please contact your CAEN supplier for access to the file CAENRFIDLibrary.jar. This file should be copied into the lib subdirectory of your WebLogic RFID Edge Server installation before starting the software.

Table 2-9 lists the CAEN reader driver properties.

Table 2-9 CAEN Configuration Properties 
Field Label
Property Name
Required?
Property Value and Description
Device Type
class
Yes
Must be set to: com.connecterra.ale.readertype.CaenA928PhysicalReader
Reader Hostname
hostname
Yes
The DNS name or IP address of the reader.
Default Rate
defaultRate
Yes
The period (in milliseconds) between the start of one read cycle and the start of the next. Note that if multiple logical readers are simultaneously active, then each logical reader will be read at an interval equal to the defaultRate times the number of logical readers.
RF Protocol
rfProtocols
No
The RF protocol currently being used by the CAEN A928. The read operation will only attempt to collect tags encoded with the protocol specified. At least one protocol must be specified. The valid values are epcClass1Gen2 and iso18000-6B (the default).
EPC Byte Offset
epcByteOffset
No
Specifies the byte offset of the EPC within a tag's addressable memory. Values may range from 0 to the amount of available tag memory; the default value is 0.
Byte Length
byteLength
No
Data length in bytes (1-16).
Antenna 0 Logical Reader Name
Antenna 1 Logical Reader Name
Antenna 2 Logical Reader Name
Antenna 3 Logical Reader Name
uhf1LogicalReaderName
uhf2LogicalReaderName
uhf3LogicalReaderName
uhf4LogicalReaderName
Must configure one
Specifies the logical reader name for each UHF antenna. At least one logical reader name must be specified or the Edge Server will generate an error on startup.
Read RF Power, mW
uhf1ReadRfPower
uhf2ReadRfPower
uhf3ReadRfPower
uhf4ReadRfPower
No
The strength of the RF signal used to read tags, in milliwatts.
Valid values are 0-4000; the default value is 500. The maximum value allowable is determined by the reader; see the reader documentation for more information.
Write RF Power, mW
uhf1WriteRfPower
uhf2WriteRfPower
uhf3WriteRfPower
uhf4WriteRfPower
No
The strength of the RF signal used to write tags, in milliwatts.
Valid values are 0-4000; the default value is 500. The maximum value allowable is determined by the reader; see the reader documentation for more information.
Antenna 0 Filter Names
Antenna 1 Filter Names
Antenna 2 Filter Names
Antenna 3 Filter Names
uhf1LogicalReaderFilterNames
uhf2LogicalReaderFilterNames
uhf3LogicalReaderFilterNames
uhf4LogicalReaderFilterNames
No
A blank-separated list of filter names for each logical reader. This value is defined in the Administration Console or in the edge.props file.
IO Gate 1
IO Gate 2
IO Gate 3
IO Gate 4
ioGateLine1
ioGateLine2
ioGateLine3
ioGateLine4
No
This field should be left blank.
IO Gate Logical Reader Name
ioGateLine1.logicalReaderName
ioGateLine2.logicalReaderName
ioGateLine3.logicalReaderName
ioGateLine4.logicalReaderName
No
Specifies the logical reader controlled by this IO line. The value for this property must match one of the configured Logical Reader Names.
IO Mask
ioGateLine1.ioMask
ioGateLine2.ioMask
ioGateLine3.ioMask
ioGateLine4.ioMask
No
Specifies the IO mask associated with this IO line. Values range from 0 to 15. A value of 0 means "disable IO gating signal".

DataLogic

This section describes driver configuration information for the DataLogic DS6300-105-010 bar code reader. By default, the DataLogic bar code reader reads up to 12 alphanumeric digits (a-z, 0-9).

Table 2-10 lists the DataLogic reader driver configuration properties.

Table 2-10 DataLogic Configuration Properties 
Field Label
Property Name
Required?
Property Value and Description
Device Type
class
Yes
Must be set to: com.connecterra.ale.readertypes.DatalogicPhysicalReader
Reader Hostname
hostname
Yes
The DNS name or IP address of the DataLogic reader.
Reader Port
port
No
The TCP port the Edge Server will use when establishing connections to the DataLogic reader. The default is 23.
Default Rate
defaultRate
Yes
The period (in milliseconds) between the start of one read cycle and the start of the next. Note that if multiple logical readers are simultaneously active, then each logical reader will be read at an interval equal to the defaultRate times the number of logical readers.
Socket Timeout
socketTimeout
No
The TCP socket timeout interval (milliseconds). The integer property value must be greater than or equal to 0. A timeout of 0 is interpreted as an infinite timeout. The default is 15000 milliseconds (15 seconds).
Logical Reader Name
bcrLogicalReaderName
Yes
A logical reader name specifying the DataLogic bar code reader.

Escort Memory Systems (EMS)

This section describes driver configuration information for the Escort Memory Systems (EMS) LRP820S and LRP2000 readers.

Table 2-11 lists the EMS reader driver configuration properties.

Table 2-11 EMS Configuration Properties 
Field Label
Property Name
Required?
Property Value and Description
Device Type
class
Yes
Must be set to: com.connecterra.ale.readertypes.EMSLRPPhysicalReader
N/A
gatewayName
No
See hostname. Used only for backward compatibility with releases prior to RFTagAware 1.3.
Reader Hostname
hostname
Yes
The DNS name or IP address of the MOXA serial-to-Ethernet adapter to which the reader is connected.
N/A
gatewayPort
No
See port. Used only for backward compatibility with releases prior to RFTagAware 1.3.
Reader Port
port
No
The TCP port the Edge Server will use when establishing connections to the MOXA serial-to-Ethernet adapter. The default value is 8080.
Default Rate
defaultRate
Yes
The period (in milliseconds) between the start of one read cycle and the start of the next. Note that if multiple logical readers are simultaneously active, then each logical reader will be read at an interval equal to the default rate times the number of logical readers.
Socket Timeout
socketTimeout
No
The TCP socket timeout interval (milliseconds). The integer property value must be greater than or equal to 0. A timeout of 0 is interpreted as an infinite timeout. The default is 15000 milliseconds (15 seconds).
EPC Byte Offset
epcByteOffset
No
Specifies the byte offset of the EPC within a tag's addressable memory. The readers supported by this driver read and write ISO 15693 tags that have 48 bytes of reprogrammable memory; thus, the integer property values range from 0 to 47. The default value is 0.
Enable Little Endian Byte Order?
epcByteOrdering
No
Specifies the byte ordering of the EPC within a tag's addressable memory.
Allowed values are:
true
false
The default value is false.
Reader Model
model
Yes
Specifies the particular model of LRP series reader. Valid values are:
LRP820S
LRP2000
Logical Reader Name
hf1LogicalReaderName
Yes
Specifies the logical reader name for the single HF antenna attached to the EMS LRP reader (the LRP2000 and LRP820S readers each support a single HF antenna).
Logical Reader Filter Names
hf1LogicalReaderFilterNames
No
A blank-separated list of filter names for the logical reader. This value is defined in the Administration Console or in the edge.props file.
Command Timeout
hf1CommandTimeout
No
Specifies the command timeout value (in milliseconds) that the EMS LRP reader is provided in the commands the driver issues. Integer property values range from 50 to 65,534 (0xFFFE). The default value is 250 milliseconds.

The WebLogic RFID Edge Server requires the use of a MOXA serial-to-Ethernet adapter for LAN access to EMS LRP readers.

Generic Barcode Reader

The following section describes driver configuration information for a generic barcode reader. This driver supports most generic barcode readers.

Table 2-12 Generic Barcode Reader Configuration Properties
Field Label
Property Name
Required?
Property Value and Description
Device Type
class
Yes
Must be set to: com.connecterra.ale.readertypes.GenericBCRAsyncPhysicalReader
Reader Hostname
hostname
Yes
The DNS name or IP address of the reader or a serial/Ethernet adapter.
Reader Port
port
No
The TCP port the Edge Server will target when establishing connections to the reader. The default value is 4001.
Socket Timeout
socketTimeout
No
The TCP socket timeout interval (milliseconds). The default value is 15000 milliseconds (15 seconds). The integer property value must be set to 0 or a greater value. A timeout of 0 is interpreted as an indefinite timeout.
Barcode Scanner 1 Logical Reader Name
bcrLogicalReaderName
No
A logical reader name specifying the barcode reader
Barcode Scanner 1 Filter Name
bcrLogicalReaderFilterNames
No
A blank-separated list of filter names for the logical reader. The value is defined using the Administration Console or in the edge.props file.
Start Frame Token
startOfFrameToken
No
A hexadecimal US-ASCII code of a character used by the BCR protocol as a start of message frame. Many devices use 02 (ASCII character STX). The default is an empty string.
End Frame Token
endOfFrameToken
No
A hexadecimal US-ASCII code of a character used by the BCR protocol as an end of message frame. Many devices use 03 (ASCII character ETX). The default is an empty string.
Activation Token
activationToken
No
A space separated sequence of hexadecimal US-ASCII codes used by the scanner protocol to activate the scanner. The default is an empty string.
Deactivation Token
deactivationToken
No
A space separated sequence of hexadecimal US-ASCII codes used by the scanner protocol to deactivate the scanner. The default is an empty string.

IER

This section describes the IER SmartController driver configuations. Table  describes the driver configuration properties.

Table 2-13 IER Configuration Properties
Field Label
Property Name
Required?
Property Value and Description
Device Type
class
Yes
Must be set to com.connecterra.ale.readertypes.IERPhysicalReader.
Reader Hostname
hostname
Yes
Specifies the domain name or IP address of the reader.
Admin Port
adminPort
No
Specifies the admin connection port to reader. The default value is 1234.
Input Port
inputPort
No
Specifies the input connection port to the reader. The default value is 1235.
Client Port
clientPort
No
Specifies the event listening port to the reader. The default value is 2468.
Socket Timeout
socketTimeout
No
Specifies the TCP socket timeout. The default value is 15000.
UHF1 Logical Reader Name
uhf1LogicalreaderName
No
Specifies the logical reader name for the UHF antenna1
UHF2Logical Reader Name
uhf2LogicalreaderName
No
Specifies the logical reader name for the UHF antenna2
UHF3 Logical Reader Name
uhf3LogicalreaderName
No
Specifies the logical reader name for the UHF antenna3
UHF4 Logical Reader Name
uhf4LogicalreaderName
No
Specifies the logical reader name for the UHF antenna4

Impinj

The following sections describe driver configuration information for the Impinj Speedway reader which uses the Mach1 protocol. The Impinj reader supports reading and writing of EPC Class 1 Gen 2 tags, including reading and writing tag memory, tag locking, and tag killing.

Note: Tag reading and programming operations are mutually exclusive.
Note: For tag programming, only a single tag should be in the antenna RF field. If more than one tag is present, you cannot ensure programming the desired tag.
Caution: Because the asynchronous read cycles of the Impinj reader can be very short, ECSpecs executed using the poll() or immediate() methods should avoid using a duration measured in read cycles. Otherwise, the reader may not be active for a long enough time to return accurate tag reads.

Table 2-14 lists the Impinj Speedway reader configuration properties.

Table 2-14 Impinj Configuration Properties 
Field Label
Property Name
Required?
Property Value and Description
Device Type
class
Yes
Must be set to: com.connecterra.ale.readertypes.ImpinjPhysicalReader
Reader Hostname
hostname
Yes
The DNS name or IP address of the reader.
Reader Port
port
No
The TCP port the Edge Server will target when establishing connections to the reader. The default value is 49380.
Socket Timeout
socketTimeout
No
The TCP socket timeout interval (milliseconds). The default value is 15000 milliseconds (15 seconds).
Write Timeout
writeTimeout
No
Specifies the maximum amount of time (in milliseconds) the reader may spend when servicing a request to program a tag across a single antenna. The default value is 100 milliseconds.
Inventory Profile
invtProfile
No
Pre-defined reader profile modes:
Max_Throughput—Optimized for speed, for detecting as many tags as possible.
80/160_Hybrid
Dense_Reader_M=4
Dense_Reader_M=8
—Optimized for accuracy, for detecting tags in dense reader mode ("noisy" environments).
The default is Max_Throughput.
Inventory Session
invtSession
No
The EPC Gen2 reader inventory session number, as specified in the EPCglobal, EPC Radio-Frequency Identity Protocols Class 1 Generation 2 UHF Air Interface Protocol Standard Version 1.0.9.
S0
S1
S2
S3
The default value is S2.
Estimated Tag Count
tagCount
No
Specifies the expected number of tags in the RF field. The default value is 10
Regulatory Region
regulatoryRegion
No
The name of the regulatory policy to which the reader conforms during its operation. Select the value that matches the regulatory policy where the reader is used.
Valid values are:
FCC-Part-15.247
ETSI-EN-302-220
ETSI-EN-302-208
HongKong
Taiwan
The default value is FCC-Part-15.247.
Antenna 1 Logical Reader Name
Antenna 2 Logical Reader Name
Antenna 3 Logical Reader Name
Antenna 4 Logical Reader Name
uhf1LogicalReaderName
uhf2LogicalReaderName
uhf3LogicalReaderName
uhf4LogicalReaderName
Must configure one
Specifies the logical reader name for each antenna. At least one logical reader name must be specified.
Antenna 1 Filter Names
Antenna 2 Filter Names
Antenna 3 Filter Names
Antenna 4 Filter Names
uhf1LogicalReaderFilterNames
uhf2LogicalReaderFilterNames
uhf3LogicalReaderFilterNames
uhf4LogicalReaderFilterNames
No
A blank-separated list of filter names for each logical reader. This value is defined in the Administration Console or in the edge.props file.
Antenna 1 Power Level
Antenna 2 Power Level
Antenna 3 Power Level
Antenna 4 Power Level
uhf1PowerLevel
uhf2PowerLevel
uhf3PowerLevel
uhf4PowerLevel
No
The power level for each UHF antenna. The range of valid values is from 15.0dBm to 30.0dBm, in 0.25 increments.The default power level is 30.0dBm.

Note: In this release, the Impinj RF power level is reader-based instead of antenna-based. Therefore, the reader RF power is set to the maximum of all the configured antennas.

List of Protocols
rfProtocol
No
epcClass1Gen2 is the only valid value (and the default).
GPIO Transport Name
gpioTransportName
No
The PLC transport name, defined in the edge.props file, used to configure the reader GPIO port.

Configuring Impinj GPIO

The Impinj Speedway reader has eight external output pins, numbered 0 through 7, and four external input pins, numbered 0 through 3. WebLogic RFID Edge Server lets you configure these GPIO like a PLC device. See Configuring the Edge Server for PLC Communications. When configuring GPIO pins for the Impinj reader, use GPO0, GPO1, GPO2, ...GPO7 for outputs, and GPI0, ....GPO3 for inputs.

Note: By default, the Impinj reader is configured to generate a GPI alert when the GPI status changes from Lo to HI only.

Intermec

The following sections describe driver configuration information for the Intermec Intellitag IF5 Reader and EasyCoder PM4i Printer:

Intellitag IF5 Reader

Table 2-15 lists the Intermec Intellitag IF5 reader driver configuration properties.

Table 2-15 Intermec Intellitag Configuration Properties 
Field Label
Property Name
Required?
Property Value and Description
Device Type
class
Yes
Must be set to: com.connecterra.ale.readertypes.IntermecIF5PhysicalReader
Reader Hostname
hostname
Yes
The DNS name or IP address of the reader.
Reader Port
port
No
The TCP port the Edge Server will target when establishing connections to the reader. The default value is 2189.
Default Rate
defaultRate
Yes
The period (in milliseconds) between the start of one read cycle and the start of the next. If multiple logical readers are active simultaneously, then each logical reader will be read at an interval equal to the defaultRate times the number of logical readers.
Socket Timeout
socketTimeout
No
The TCP socket timeout interval (milliseconds). The default value is 15000 milliseconds (15 seconds). This value must be greater than 0.
RF Protocol
rfProtocols
No
The RF protocol currently being used by the Intermec reader. The Intellitag IF5 is a multi-protocol reader. To improve efficiency, the read operation will only attempt to collect tags encoded with the specified protocols. At least one protocol must be specified.
The valid values are:
epcClass1Gen2
iso18000-6B
V119
MIXED
(iso18000-6B and V119)
The default value is MIXED.
ID Tries
idTries
No
Maximum number of identify attempts on a given tag. Values range from 1-255; the default value is 3.
Read Tries
readTries
No
Maximum number of read attempts on a given tag. Values range from 1-255; the default value is 3.
Write Tries
writeTries
No
Maximum number of write attempts on a given tag. Values range from 1-255; the default value is 3.
EPC Byte Offset
epcByteOffset
No
Specifies the byte offset of the EPC within a tag's addressable memory. Values may range from 0 to the amount of available tag memory, minus the amount specified in the Byte Length property (below); the default value is 0. When writing ISO18000-6B tags, this value should be equal to or greater than 8. When the Class 1 Gen 2 protocol is selected, this value is ignored by the driver.
Byte Length
byteLength
No
Data length in bytes (0-16). The default value is 8. When the Class 1 Gen 2 protocol is selected, this value is ignored by the driver.
Disable Programming Cycle Check
disableProgrammingCycleCheck
No
An optional Boolean property (allowed values are true and false) specifying whether the driver disables the "check operation" (verification that there is a single tag in an antenna's field prior to conducting a tag programming operation). The default value is false, meaning the driver conducts the check operation.
Note that if the check operation is disabled (this property value is set to true) and multiple tags are present in the antenna's field when conducting a tag programming operation, then all tags in the field will be programmed with the same EPC.
Antenna 0 Logical Reader Name
Antenna 1 Logical Reader Name
Antenna 2 Logical Reader Name
Antenna 3 Logical Reader Name
uhf1LogicalReaderName
uhf2LogicalReaderName
uhf3LogicalReaderName
uhf4LogicalReaderName
Must configure one
Specifies the logical reader name for each antenna. At least one logical reader name must be specified.
If one of these properties is left undefined, there will be no logical reader associated with the corresponding antenna, and that antenna will not be accessible via the ALE API.
Antenna 0 Filter Names
Antenna 1 Filter Names
Antenna 2 Filter Names
Antenna 3 Filter Names
uhf1LogicalReaderFilterNames
uhf2LogicalReaderFilterNames
uhf3LogicalReaderFilterNames
uhf4LogicalReaderFilterNames
No
A blank-separated list of filter names for each logical reader. This value is defined in the Administration Console or in the edge.props file.
Antenna 0 Read RF Power
Antenna 1 Read RF Power
Antenna 2 Read RF Power
Antenna 3 Read RF Power
uhf1ReadRfPower
uhf2ReadRfPower
uhf3ReadRfPower
uhf4ReadRfPower
No
The percentage of maximum RF antenna power for read operations.
Valid values are 0-100; the default value is 100.
Antenna 0 Write RF Power
Antenna 1 Write RF Power
Antenna 2 Write RF Power
Antenna 3 Write RF Power
uhf1WriteRfPower
uhf2WriteRfPower
uhf3WriteRfPower
uhf4WriteRfPower
No
The percentage of maximum RF antenna power for write operations.
Valid values are 0-100; the default value is 100.
PLC Transport Name
plcTransport
No
The PLC transport name defined in the edge.props file.

Configuring Intermec IF5 GPIO

The Intermec IF5 reader has four external output lines, numbered 1 through 4, and four external input lines, numbered 1 through 4. WebLogic RFID Edge Server lets you configure these GPIO like a PLC device. See Configuring the Edge Server for PLC Communications. When configuring data items for the Intermec IF5, use out1, out2, ...out4 for outputs, and in1, ...in4 for inputs.

Listing 2-2 illustrates configuring the Intermec IF5 reader for controlling a 4-color stack light connected to the reader's external outputs 1 through 4. Note that while the reader only has 4 outputs, 5 data items must be defined in the PLC message (one for each color, White, Blue, Green, Amber, Red). Use NA for the unused light. In the following example, outputs are defined for White, Blue, Green, and Amber lights; Red is unused.

Listing 2-2 Intermec IF5 GPIO Configuration
#In edge.props file
#Define the PLC Transport `Reader'
com.connecterra.ale.plc.plcTransport.IF5GPIO.metaName = Reader
com.connecterra.ale.plc.plcTransport.IF5GPIO.pollInterval = 1000
#Define the message convention `Simple'
com.connecterra.ale.plc.plcMessageConvention.simple.metaName = Simple
com.connecterra.ale.plc.plcMessageConvention.simple.plcTransport = IF5GPIO
#Define the message convention `Multiple'
com.connecterra.ale.plc.plcMessageConvention.multiple.metaName = Multiple
com.connecterra.ale.plc.plcMessageConvention.multiple.plcTransport = IF5GPIO
#Define outboundMessage for left stack light
com.connecterra.ale.plc.outboundMessage.mystacklightleft.plcMessageConvention = multiple
com.connecterra.ale.plc.outboundMessage.mystacklightleft.items = out1 out2 out3 out4 NA
#Define inboundMessage
com.connecterra.ale.plc.inboundMessage.IF5INPUTS.plcMessageConvention = simple
com.connecterra.ale.plc.inboundMessage.IF5INPUTS.receiveItem = in1
com.connecterra.ale.plc.inboundMessage.IF5INPUTS.matchValues = false
#Define left stacklight. Alternatively, this can be done in the Administration
#Console by defining a PLC Stack Light device.
#See PLC Stack Light Example.
com.connecterra.ale.reader.stacklightleft.class = com.connecterra.ale.readertypes.PLCStackLightPhysicalReader
com.connecterra.ale.reader.stacklightleft.plcMessage = mystacklightleft
com.connecterra.ale.reader.stacklightleft.defaultRate = 0
com.connecterra.ale.reader.stacklightleft.stackLightLogicalReaderName = StackLightLeft

PM4i Printer

Table 2-16 lists the Intermec PM4i label printer driver configuration properties.

Table 2-16 Intermec PM4i Printer 
Field Label
Property Name
Required?
Property Value and Description
Device Type
class
Yes
Must be set to: com.connecterra.ale.readertypes.IntermecPM4iPhysicalReader
Reader Hostname
hostname
Yes
The DNS name or IP address of the printer.
Reader Port
port
No
The TCP port the Edge Server will target when establishing connections to the printer. The default value is 9100.
Socket Timeout
socketTimeout
No
The TCP socket timeout interval (milliseconds). The default value is 15000 milliseconds (15 seconds). This value must be greater than 0.
UHF Antenna 1 Logical Reader Name
uhf1LogicalReaderName
Yes
The logical reader name assigned to the device's single integrated UHF antenna.
Enable RFID Encoding
programRFID
No
A Boolean (allowed values are true and false) specifying whether the reader driver instructs the printer to program EPC data into an embedded RFID tag. The default value is true.
Script File
fpFilename
No
Specifies the pathname of a file containing Intermec Fingerprint® commands defining a label form. Typically the Fingerprint script-based label design is specified within the PCSpec readerParameters attribute; the reader parameter name is fpScript. This property provides a mechanism for specifying a default label design in the event the PCSpec does not contain PM4i reader parameters. When present, the PM4i reader parameter is a string containing the set of Fingerprint commands specifying a label layout.
Retries Count
retries
No
Defines the number of labels to retry in case of a failed RFID operation. The valid range is 1 through 255, the default value is 3.

Using the Intermec Fingerprint Programming Language

Intermec Fingerprint is a BASIC-inspired, printer-resident programming language for use with the Intermec EasyCoder bar code label printers. The Intermec Fingerprint programming language is described in detail in the Intermec Fingerprint v8.70.0/v10.0.0 Programmer´s Reference Manual (16 Jan. 2006).

The Intermec PM4i printer drivers send the printer a collection of Fingerprint commands with each label to be printed and programmed. Users specify a label's Fingerprint commands when defining a PCSpec (see Programming with the ALE and ALEPC APIs). A PCSpec readerParameters field carries the Fingerprint script as a String object; the reader parameter name is fpScript.

As an alternative to specifying Fingerprint commands within a PCSpec, the Edge Server administrator may specify a default Fingerprint script using the Intermec reader driver Script File property. This property provides a mechanism for specifying Fingerprint commands that serve as a default label design in the event the PCSpec readerParameters field does not carry a key/value pair containing a template script.

The Fingerprint script, whether defined within the PCSpec or contained in a file identified by the Script File property, must only contain immediate mode commands, without the line numbers, should not contain a page feed (PF) command, and should contain no RFID commands and no "END" command. The following is an example Fingerprint script:

OPTIMIZE "BATCH" OFF
LTS& OFF
NASC -2:AN 7
CLIP ON
XORMODE OFF
MAG 1,1
BF "Monospace 821 BT",14,0,0,1,1 ON
'PP 59,208:DIR 1:BT "EAN128":BM 4:BH 160:PB "[EPC_HEX]"
PP 59,208:DIR 1:"[EPC_HEX]"
AN 8
MAG 1,1
PP 394,859:FT "Swiss 721 BT",14,0,100:NI:PT "As part of a test to improve
product"
PP 416,811:NI:PT " availability for consumers, packaging"
PP 406,763:NI:PT "contains an Electronic Product Code"

Paxar

This section describes driver configuration information for the Paxar Monarch 9855 smart label printer. You will need to consult the Monarch® 9855™ RFID Printer Operator's Handbook and enable status polling to allow the printer to respond to status requests from the RFID Edge Server.

Table 2-17 lists the Paxar Monarch 9855 reader driver configuration properties.

Table 2-17 Paxar Monarch Configuration Properties 
Field Label
Property Name
Required?
Property Value and Description
Device Type
class
Yes
Must be set to: com.connecterra.ale.readertypes.Monarch9855PhysicalReader
Reader Hostname
hostname
Yes
The DNS name or IP address of the printer.
Reader Port
port
No
The TCP port the Edge Server will target when establishing connections to the printer. The printer default value is 9100.
Socket Timeout
socketTimeout
No
The TCP socket timeout interval (milliseconds). The default value is 15000 milliseconds (15 seconds). This value must be greater than 0.
Logical Reader Name
uhf1LogicalReaderName
Yes
The logical reader name assigned to the device's single integrated UHF antenna.
Enable RFID Encoding
programRFID
No
A Boolean (allowed values are true and false) specifying whether the reader driver instructs the printer to program EPC data into an embedded RFID tag. The default value is true.
MPCL Form
mpclFilename
No
Specifies the pathname of a file containing MPCL commands defining a smart label's form. Typically the MPCL-based label design will be specified within the PCSpec readerParameters attribute. This property provides a mechanism for specifying a default label design in the event the PCSpec does not contain Monarch 9855 reader parameters. When present, the Monarch reader parameter is a string containing the set of MPCL commands specifying a smart label's layout.

Printronix

This section describes driver configuration information for the Printronix SL5000r label printer with an integrated RFID UHF encoder. Although the Printronix device has a "reader driver," it does not support tag reading. Instead, it supports the writing (programming) of Class 1, Class 0+, and Class 1 Gen 2 tags embedded within label stock ("smart labels") and the printing of those labels.

Table 2-18 lists the Printronix SL5000r reader configuration properties.

Table 2-18 Printronix Configuration Properties 
Field Label
Property Name
Required?
Property Value and Description
Device Type
class
Yes
Must be set to: com.connecterra.ale.readertypes.PrintronixT5000ePhysicalReader
Reader Hostname
hostname
Yes
The DNS name or IP address of the printer's LAN adapter.
Reader Port
port
No
The TCP port the Edge Server will target when establishing connections to the printer's LAN adapter. The default value is 9100, the Printronix device's factory default.
Socket Timeout
socketTimeout
No
The TCP socket timeout interval (milliseconds). The default value is 15000 milliseconds (15 seconds).
Write Timeout
writeTimeout
No
Specifies the maximum amount of time (in milliseconds) the printer may spend when servicing a request to program a tag across a single antenna. The default value is 6000 milliseconds (6 seconds).
EPC Memory Bank Length
epcMemoryBankLength
No
Specifies the memory bank length (in bits) for storing EPC data. Valid values are: 64 and 96. The default value is 96 bits.
UHF Antenna 1 Logical Reader Name
uhf1LogicalReaderName
Yes
The logical reader name assigned to the Printronix device's single integrated UHF antenna.
Enable Direct Connection for Label Printing
enablePrint
No
A Boolean (allowed values are true and false) specifying whether a direct connection to printer for label printing and RFID programming is enabled. The default value is true.
Enable RFID Encoding
programRFID
No
A Boolean (allowed values are true and false) specifying whether the reader driver instructs the printer to program EPC data into an embedded RFID tag. The default value is true.
PGL Form
pglFilename
No
Specifies the pathname of a file containing Printronix PGL commands defining a smart label form. Typically, the PCSpec readerParameters attribute specifies PGL-based label design; the reader parameter name is pglScript. This property provides a mechanism for specifying a default label design in the event the PCSpec does not contain Printronix reader parameters.
When present, the file name refers to a text file (label.pgl) containing the set of PGL create-mode commands specifying the smart label layout and non-EPC content.
Enable PXML Port Connection for Printer Status Monitoring
enablePXML
No
An optional Boolean property (allowed values are true and false), specifying whether the PXML port for printer status monitoring is enabled. The default value is false. If it is set to true, enter values for the next two properties to properly configure communications via the PXML port.
PXML Port
pxmlPort
No
The port used by the Edge Server to obtain printer status via the printer's Ethernet adapter. The default value is 3007.
PXML Message Description File
pxmlMessageFile
No
The path and name of the file that defines Printronix PXML messages, their associated message IDs, severity level, and description. The contents of this file can be edited. This file is based on Printronix's PXML message definition.
See the PXMLMessage.props example file in the etc subdirectory of your Edge Server installation.
Enable GPIO Port Connection for Printer Status Monitoring
enableGPIO
No
An optional Boolean property (allowed values are true and false), specifying whether the GPIO port for printer status monitoring is enabled. The default value is false. If it is set to true, enter values for the next two properties to properly configure communications via the GPIO port.
GPIO Port
gpioPort
No
The general-purpose I/O (GPIO) port used by the Edge Server to obtain printer status via the printer's Ethernet adapter. The default value is 3002.

Note: The GPIO properties are only available for use after installing and configuring the GPIO Accessory Module, available from the manufacturer.

GPIO Port Heart Beat Timeout
gpioHeartBeatTimeout
No
The printer regularly sends "heartbeat" messages to the Edge Server to confirm connectivity. (Consult the manufacturer or printer documentation for information on how often these messages are sent.) This value defines how long, in milliseconds, the Edge Server will wait for a message before attempting to re-establish a connection with the printer. The default value is 11000. This property must be set to a value greater than the interval between heartbeat messages.
GPIO Message Content File
gpioMessageFile
No
The path and name of the file that defines Printronix GPIO messages and their associated message IDs. The contents of this file can be edited, but the file should always contain entries for Heart_Beat_Normal and Heart_Beat_Error messages. This file is based on Printronix's GPIO message definition.
See the GPIOMessage.props example file in the etc subdirectory of your Edge Server installation.

Using the Printronix Graphics Language (PGL)

The Printronix Graphics Language (PGL) is a scripting language for specifying the layout and content of printed labels. PGL is described in detail in the Printronix document, IGP/PGL Emulation for Thermal Line Matrix, and Laser Printers: Printronix Graphics Language Programmer's Reference Manual.

The Printronix smart label printer drivers send the printer a separate collection of PGL commands with each "smart label" (a printed label with an embedded RFID tag) to be printed and programmed. Users specify a smart label's PGL commands when defining a PCSpec (see Programming with the ALE and ALEPC APIs). A PCSpec readerParameters field carries the PGL script as a String object; the reader parameter name is pglScript.

As an alternative to specifying PGL within a PCSpec, the Edge Server administrator may specify a default PGL script using the Printronix reader driver PGL Form property. This property provides a mechanism for specifying PGL commands that serve as a default label design in the event the PCSpec readerParameters field does not carry a key/value pair containing a PGL script.

The PGL script, whether defined within the PCSpec or contained in a file identified by the PGL Form property, must only contain IGP/PGL Create Form mode commands. Below is an example PGL script:

SCALE;DOT;200;200
FONT;FACE 92250
ALPHA
POINT;60;50;8;8;*SHIP FROM:*
POINT;90;50;10;10;*ACME*
POINT;120;50;10;10;*Corporation*
POINT;150;50;10;10;*P.O. Box 1000*
POINT;180;50;10;10;*Dallas, TX75261*
POINT;60;365;8;8;*SHIP TO:*
POINT;90;365;10;10;*Retailer Distribution Center*
POINT;120;365;10;10;*200 Main Street*
POINT;150;365;10;10;*Springfield, MA01103*
STOP
HORZ
4;200;40;790
STOP
VERT
3;343;60;200
STOP
ALPHA
POINT;235;50;8;8;*(420)SHIP TO POSTAL CODE:*
POINT;285;100;12;12;*(420) 01103*
POINT;235;385;8;8;*CARRIER:*
POINT;285;400;12;12;*Acme Freightways*
POINT;330;400;10;10;*PRO: 1234*
POINT;370;400;10;10;*B/L: 5678*
STOP
BARCODE
C128C;XRD3:3:6:6:9:9:12:12;H7;283;75
*01103*
STOP
HORZ
4;425;40;790
STOP
VERT
3;374;200;425
STOP
ALPHA
POINT;465;50;12;12;*EPC:*
AF512;25;POINT;550;70;14;14
STOP
HORZ
4;625;40;779
STOP
ALPHA
POINT;665;50;12;12;*SKU:*
POINT;705;70;14;14;*ABC21270*
STOP
HORZ
4;750;40;779
STOP
ALPHA
POINT;790;50;12;12;*GTIN:*
POINT;840;270;12;12;*(01) 10036000212706*
STOP
BARCODE 
C128C;XRD3:3:6:6:9:9:12:12;H7;850;250
*10036000212706*
STOP

The user-defined PGL script must not contain an RFWRITE Create Form mode command; the reader driver will insert the necessary RFWRITE command if it is called on to program a smart label's embedded RFID tag.

If the user wishes to print a specified EPC value on the smart label, the user-supplied PGL must use special substitution strings, indicating in what representation the tag values are to be printed. The RFID Edge Server recognizes the following substitution string values:

[EPC_HEX]
Will be replaced by the hexadecimal representation of the tag value.
[EPC_ID_URI]
Will be replaced by the pure identity URN representation of the tag value.
[EPC_TAG_URI]
Will be replaced by the tag URN representation of the tag value.

Example:

ALPHA
POINT;465;50;12;12;*EPC:*
POINT;550;70;14;14;*[EPC_ID_URI]*
STOP

Please refer to Printronix documentation for additional information on IGP/PGL.

Using the Printronix Device Management Language (PXML)

The Printronix Device Management Language (PXML) is a printer device management protocol to control and monitor job and printer status. To use PXML, copy the following required JAR files from Printronix into the lib subdirectory of your WebLogic RFID Edge Server installation: pxml.jar, commonlib.jar, and jdom.jar.

PXML is an XML-based language that allows a client application to issue commands to a Printronix SL5000r printer and receive responses from the printer, including:

Responses can be either solicited (in response to a command) or autonomous (generated by events that occur during printer operation).

PNE is the Printronix proprietary device management protocol used by the Printronix PrintNet Enterprise software. PXML is the XML-based device management protocol to interface with third party software. Currently there is no auto switching between the two protocols and only one device management protocol can be active at any time. The printer factory default is PNE mode. Therefore, third party software must configure the printer for PXML before it can be used. This can be done either by sending the PTX_SETUP commands to the printer or setting the printer front panel menu.

Consult the Printronix documentation for detailed PXML setup information.

SAMSys

The RFID Edge Server uses two SAMSys reader drivers:

SAMSys MP9320

This section describes driver configuration information for the SAMSys MP9320 RFID reader. SAMSys MP9320 2.8 readers feature a single-color stack light, which requires no configuration.

The SAMSys MP9320 reader drivers use the following properties

Table 2-19 SAMSys MP9320 Configuration Properties 
Field Label
Property Name
Required?
Property Value and Description
Device Type
class
Yes
Must be set to: com.connecterra.ale.readertypes.SAMSysMP9320PhysicalReader
Reader Hostname
hostname
Yes
The DNS name or IP address of the reader.
Reader Port
port
No
The TCP port the SAMSys MP9320 reader driver will target when establishing connections to the SAMSys reader. The default value is 2101.
Default Rate
defaultRate
Yes
The period (in milliseconds) between polls of a logical reader. The same value applies to all logical readers provisioned on a single physical reader.
Socket Timeout
socketTimeout
No
The TCP socket timeout interval (milliseconds).
Must be greater than or equal to zero. A timeout of zero is interpreted as an infinite timeout.
The default value is 15000 milliseconds (15 seconds).
Disable Programming Cycle Check
disableProgrammingCycleCheck
No
A Boolean property (allowed values are true and false) specifying whether the driver disables the Program Cycle Check (verification that there is exactly one programmable tag in an antenna's field prior to conducting a tag programming operation). The default value is false, meaning the driver conducts the check operation. Note that if the check operation is disabled (this property value is set to true) and multiple tags are present in the antenna's field when conducting a tag programming operation, then all tags in the field will be programmed with the same EPC.
List of Protocols
rfProtocols
No
A blank-separated list of RF protocols. SAMSys MP9320 is a multi-protocol reader. To improve efficiency, the read operation will only attempt to collect tags encoded with the specified protocols. At present, valid values are:
epcClass1 (includes epcClass1-64 and epcClass1-96)
epcClass1-64 (EPC Class 1 Gen 1 64-bit)
epcClass1-96 (EPC Class 1 Gen 1 96-bit)
epcClass1Gen2
epcClass1G1G2
(includes epcClass1 and epcClass1Gen2.)

Note: This choice is Read Only. For tag programming, select a single protocol type.

iso18000-6B-64
iso18000-6B-96

Note: Only one of the ISO18000-6B protocols at a time can be specified. The Edge Server will generate an error if both protocols are listed.

EM4022-4222

Note: The EM4022-4222 and iso18000-6B protocols are mutually exclusive. You cannot enable them both at the same time.

The default value is epcClass1.
Enable Reader Beep
enableReaderBeep
No
A Boolean (allowed values are true and false) specifying whether the reader driver instructs the reader to beep when reading an RFID tag. The default value is false.
Reader Operation Mode
operationMode
No
Indicates the behavior of the SAMSys reader in response to a request for data from an application. A value of poll means that the reader is idle between requests, but performs a tag read when it receives a request for data. A value of autopoll means that the reader continuously reads tags and stores the data in memory between requests, and forwards all stored tag information when it receives a request from the application.
Valid values are:
poll
autopoll
The default value is poll.
Antenna 1 Logical Reader Name
Antenna 2 Logical Reader Name
Antenna 3 Logical Reader Name
Antenna 4 Logical Reader Name
uhf1LogicalReaderName
uhf2LogicalReaderName
uhf3LogicalReaderName
uhf4LogicalReaderName
Must configure one
A set of properties specifying a logical reader name bound to each of the SAMSys MP9320 reader's UHF antennas. At least one logical reader name must be specified.
The SAMSys MP9320 reader supports up to four logical readers. If a property within this set is left undefined, there will be no logical reader associated with the corresponding antenna.
Antenna 1 Filter Names
Antenna 2 Filter Names
Antenna 3 Filter Names
Antenna 4 Filter Names
uhf1LogicalReaderFilterNames
uhf2LogicalReaderFilterNames
uhf3LogicalReaderFilterNames
uhf4LogicalReaderFilterNames
No
A blank-separated list of filter names for each logical reader. This value is defined in the Administration Console or in the edge.props file.
Antenna 1 RF Power Level
Antenna 2 RF Power Level
Antenna 3 RF Power Level
Antenna 4 RF Power Level
uhf1PowerLevel
uhf2PowerLevel
uhf3PowerLevel
uhf4PowerLevel
No
The RF power setting of the reader. The range of valid values is from RF power level 2 (34.7dBm (2.95W)) to RF power level 80 (16 dBm (40 mW)). The default value is RF power level 24 (1W).

Note: The lower the RF power level value the higher the power output.

Refer to the RF power level table in the SAMSys MP9320, Low Power UHF Antenna Application Note, Version 2.0.

Setting the Baud Rate

To attain the maximum output from the SAMSys MP9320 2.7 and 2.8 readers, BEA Systems recommends setting the reader to 57600 bps. If you change the baud rate of the reader in the RFID Edge Server, you will need to perform these steps again to keep the baud rate settings the same throughout the hardware and software.

Use the following instructions set the baud rate:

  1. Use a serial cable to connect the reader RS232 port to your computer serial port.
  2. Run the SAMSys reader RF Command Suite software.
  3. Select the Reader Connection | Connect via Serial Port menu option.
  4. The software should detect the reader connected to your computer serial port.

  5. If you cannot establish a connection, select the menu item Reader Connection | Serial Port Settings, and use the Maximum Speed field to set the correct baud rate to connect to the reader.
  6. Open a Web browser and navigate to http://<IP.address.of.reader>/.
  7. This URL will launch a Java applet. You will need to enable Java in your Web browser to see the applet. If you would prefer to perform this configuration via Telnet, skip step 5 and follow the instructions in Appendix C of the MP9320 2.7 User's Guide.

  8. On the applet that displays, click Serial Ports on the left side of the page, change the Baud Rate to 57600, then click Save.
  9. In the RF Command Suite software, click the Command tab, and type the command }Cw,d:scw,b:00161616,f:1! to set the reader baud rate to 57600.
  10. Close the RF Command Suite and the Web browser window.
  11. Power-cycle the reader.
  12. Afterward, the reader external RS232 port and the external serial port on the Digi Connect ME Module are set to a baud rate of 57600.

    Note: If the reader stops responding, use HyperTerminal to connect to the reader, power-cycle it, and press the Enter key three times. This will set the reader to the factory default.

SAMSys MP9210

The SAMSys MP9210 reader driver requires the use of a MOXA serial-to-Ethernet adapter, available from Symbol Technologies.

Table 2-20 lists the SAMSys MP9210 reader configuration properties.

Table 2-20 SAMSys MP9210 Configuration Properties 
Field Label
Property Name
Required?
Property Value and Description
Device Type
class
Yes
Must be set to: com.connecterra.ale.readertypes.SAMSysMP9210PhysicalReader
Reader Hostname
hostname
Yes
The DNS name or IP address of the MOXA serial-to-Ethernet adapter to which the reader is connected.
Reader Port
port
No
The TCP port the Edge Server will use when establishing connections to the MOXA serial-to-Ethernet adapter. The default value is 4001.
Default Rate
defaultRate
Yes
The period (in milliseconds) between polls of a logical reader. The same value applies to all logical readers provisioned on a single physical reader.
Socket Timeout
socketTimeout
No
The TCP socket timeout interval (milliseconds).
Must be greater than or equal to zero. A timeout of zero is interpreted as an infinite timeout.
The default value is 15000 milliseconds (15 seconds).
List of Protocols
rfProtocols
No
A blank-separated list of RF protocols. SAMSys MP9210 is a multi-protocol reader. To improve efficiency, the read operation will only attempt to collect tags encoded with the specified protocols. The valid values are:
iso15693
Philips_I_Code
The default value is iso15693.
Antenna 1 Logical Reader Name
hf1LogicalReaderName
Yes
A set of properties specifying a logical reader name bound to the SAMSys MP9210 reader's HF antenna.
Antenna 1 Filter Names
uhf1LogicalReaderFilterNames
No
A blank-separated list of filter names for the logical reader. This value is defined in the Administration Console or in the edge.props file.
Memory Block Offset
memBlockOffset
Yes
The memory block location where EPC data written to the tag begins. For example, an offset of 3 means that the first two memory blocks in the user memory area are skipped and the EPC data begins at the third memory block.
Number of Memory Blocks
memBlockLength
No
The number of memory blocks used in storing EPC data. For example, a 96-bit tag uses three 32-bit blocks.
User Data Byte Ordering
memByteOrder
No
Specifies the byte ordering of the EPC within a tag's addressable memory. Allowed values are:
bigEndian
littleEndian
Values are case insensitive.

Configuring The MOXA Device

The SAMSys MP9210 reader will be connected to an IP network with a MOXA serial server. The serial configuration is shown below. If the reader's serial configuration is changed, adjust these settings accordingly.

Baud rate:
9600
Parity:
None
Data bits:
8
Stop bit:
1
Flow control:
None
UART FIFO:
Disable
Interface:
RS-232

A null modem is required if using a straight serial cable (DB9, female-to-male).

SATO

This section describes driver configuration information for the SATO RFID printer. SATO RFID printers support writing (programming) Class 1 Gen 2 tags embedded within label stock ("smart labels") and tags with embedded RFID transponders. For required printer setup information, see Configuring the SATO Printer.

Table 2-21 lists the SATO RFID printer driver configuration properties.

Table 2-21 SATO Configuration Properties 
Field Label
Property Name
Required?
Property Value and Description
Device Type
class
Yes
Must be set to: com.connecterra.ale.readertypes.SATOPrinterPhysicalReader
Reader Hostname
hostname
Yes
The DNS name or IP address of the printer's LAN adapter.
Reader Port
port
No
The TCP port the Edge Server will target when establishing connections to the printer's LAN adapter. The default value is 1024.
Socket Timeout
socketTimeout
No
The TCP socket timeout interval (milliseconds). The default value is 15000 milliseconds (15 seconds).
Write Timeout
writeTimeout
No
Specifies the maximum amount of time (in milliseconds) the printer may spend when servicing a request to program a tag across a single antenna. The default value is 10000 milliseconds (10 seconds).
UHF Antenna 1 Logical Reader Name
uhf1LogicalReaderName
Yes
The logical reader name assigned to the SATO device's single integrated UHF antenna.
Enable RFID Encoding
programRFID
No
A Boolean (allowed values are true and false) specifying whether the reader driver instructs the printer to program EPC data into an embedded RFID tag. The default value is false.
SBPL Script File
sbplScript
No
Specifies the pathname of the SATO Barcode Programming Language (SBPL) script file.
Printer Status Protocol
statusProtocol
No
An optional property specifying whether the Edge Server solicits printer status, and if so, which status protocol (message format) to use. The default value is NO_STATUS; valid values are:
NO_STATUS (Edge Server does not solicit printer status)
STATUS3
STATUS4
STATUS5
(manufacturer's preferred setting)
Status Message File
statusMessageFile
No
Specifies the pathname of the status message file. The status message file contains the status code description and severity classification. If not specified, a default status message file is used.
Three default status message files are located in the etc subdirectory of your Edge Server installation:
SatoStatus3Message.props
SatoStatus4Message.props
SatoStatus5Message.props
You can edit the status code descriptions and severity classifications in these files to override the default settings.

Configuring the SATO Printer

Use the operator panel located on the printer front to configure these SATO printer settings, shown in Table 2-22. For detailed SATO printer configuration information, see the printer model Operator Manual.

Tip: Upon initial connection to the printer, the Edge Server interrogates and displays the supported printer status protocol in the Edge Server console output and as an INFO level message in the RFID Device Alerts page in the Administration Console.

Table 2-22 SATO Printer Configuration 
Parameter
Required?
Description
Connection Port Number
No
The TCP port for establishing connections to the printer's LAN adapter. This setting is not available in some printer models.
Status Protocol
Yes
Specifies the communication protocol for sending printer status to the Edge Server. Printer model protocol support varies. Also, different protocols may be supported on different ports. Contact SATO for detailed information.
Status Replay Timing
Yes
Specifies printer status delivery timing. Must be set to Enq—(Inquiry) Printer sends status upon request.

Symbol (Matrics)

The RFID Edge Server uses two Symbol (Matrics) reader drivers:

Symbol (Matrics) AR400/XR400

Table 2-23 lists the Symbol (Matrics) AR400 and XR400 readers configuration properties.

Table 2-23 Symbol (Matrics) AR400/XR400 Configuration Properties 
Field Label
Property Name
Required?
Property Value and Description
Device Type
class
Yes
Must be set to: com.connecterra.ale.readertypes.MatricsAR400PhysicalReader
Reader Hostname
hostname
Yes
The DNS name or IP address of the reader.
Reader Port
port
No
The TCP port the Edge Server will target when establishing connections to the reader. The default value is 3000.
Default Rate
defaultRate
Yes
The period (in milliseconds) between polls of a logical reader. The same value applies to all logical readers provisioned on a single physical reader.
Socket Timeout
socketTimeout
No
The TCP socket timeout interval (milliseconds). The default value is 15000 milliseconds (15 seconds).
Frequency Channel
frequencyChannel
No
The frequency channel the AR400 reader will use to read tags. This property MUST ONLY be used with Symbol/Matrics FCC part 90 readers. Integer property values range from 0 to 13, corresponding to 914.25 MHz to 917.25 MHz, in 500 kHz steps. There is no default value. When not specified, the Set Frequency Channel command is not issued.
Disable Programming Cycle Check
disableProgrammingCycleCheck
No
A Boolean property (allowed values are true and false) specifying whether the driver disables the Program Cycle Check (verification that there is exactly one programmable tag in an antenna's field prior to conducting a tag programming operation). The default value is false, meaning the driver conducts the check operation. Note that if the check operation is disabled (this property value is set to true) and multiple tags are present in the antenna's field when conducting a tag programming operation, then all tags in the field will be programmed with the same EPC.
Antenna 0 Logical Reader Name
Antenna 1 Logical Reader Name
Antenna 2 Logical Reader Name
Antenna 3 Logical Reader Name
uhf1LogicalReaderName
uhf2LogicalReaderName
uhf3LogicalReaderName
uhf4LogicalReaderName
Must configure one
A set of properties specifying a logical reader name bound to each of the reader's UHF antennas. At least one logical reader name must be specified. (The AR400/XR400 readers support up to four logical readers.) If a property within this set is left undefined, there will be no logical reader associated with the corresponding antenna.

Note: The AR 400 antennas work in pairs (require two antennas to make a read point, one to receive signals and one to transmit them).

If multiple UHF antennas are assigned the same logical reader name, then the driver will treat them as a single combined antenna. The lowest-numbered antenna in the combined antenna grouping is checked to set antenna-specific properties and used for tag programming. If running in this combined antenna mode, see Combined Antenna Mode.
Antenna 0 Environment Variable
Antenna 1 Environment Variable
Antenna 2 Environment Variable
Antenna 3 Environment Variable
uhf1EnvironmentVariable
uhf2EnvironmentVariable
uhf3EnvironmentVariable
uhf4EnvironmentVariable
No
A property controlling the length of time the AR400 reader gives itself when reading tags within a single antenna's field in response to a single "Read Full Field" Command. Integer property values range from 0 to 8, with full field read times lengthening with increasing environment variable property value. The default environment variable value is 3.
Antenna 0 Power Level
Antenna 1 Power Level
Antenna 2 Power Level
Antenna 3 Power Level
uhf1PowerLevel
uhf2PowerLevel
uhf3PowerLevel
uhf4PowerLevel
No
A set of properties specifying UHF antenna (n=1..4) power levels. Integer property values range from 1 to 255. Power level is logarithmic; hence, 192 is about 50% of and 128 is about 25% of an antenna's maximum power. The default power level is 192.
Antenna 0 Filter Names
Antenna 1 Filter Names
Antenna 2 Filter Names
Antenna 3 Filter Names
uhf1LogicalReaderFilterNames
uhf2LogicalReaderFilterNames
uhf3LogicalReaderFilterNames
uhf4LogicalReaderFilterNames
No
A blank-separated list of filter names for each logical reader. This value is defined in the Administration Console or in the edge.props file.
Left Stack Light Logical Reader Name
leftStackLightLogicalReaderName
No
Specifies a logical reader to control the left stack light. See Configuring and Controlling Stack Lights for more information on stack light configuration.
Right Stack Light Logical Reader Name
rightStackLightLogicalReaderName
No
Specifies a logical reader to control the right stack light. See Configuring and Controlling Stack Lights for more information on stack light configuration.
List of Protocols
rfProtocol
No
A blank-separated list of RF protocols. The valid values are:
epcClass0 (EPC Class 0)
epcClass1 (EPC Class 1 Gen 1)
epcClass1Gen2 (EPC Class 1 Gen 2)
epcClass1G1G2 (includes epcClass1 and epcClass1Gen2)
all
The default value is all.
Stack Light Control Protocol
stacklightProtocol
No
Specifies the protocol to use for stack light control. The default value is Bytestream; valid values are:
Bytestream
http

Note: If the firmware does not work well with the Bytestream protocol, try the http protocol.

Enable Reader GPIO Mode
enableGPIO
No
An optional Boolean property (allowed values are true and false), specifying whether GPIO mode is enabled. The default value is false.
GPIO Transport Name
gpioTransportName
No
Applies only to the XR400 reader. The PLC transport name defined in the edge.props file.
GPIO Port Polling Interval
gpioPollInterval
No
Applies only to the XR400 reader. The period (in milliseconds) between the start of one poll cycle and the start of the next. The default value is 500 milliseconds.

Enabling GPIO Mode (Symbol XR400 Reader Only)

To capture the reader GPIO input, you must enable GPIO mode by performing the following steps:

  1. In the Administration Console or the edge.props file, set Enable Reader GPIO Mode (enableGPIO) to true.
  2. Configure GPIO mode in the reader:
    1. Open a Web browser and enter the following URL: http://reader_ipaddress
    2. Log in to the Symbol XR400 Reader Administrator Console.
    3. See the Symbol Reader Manual, XR Series RFID Reader Integrator Guide (Part Number 72E-71773-03 Rev. A, February 2006), for login instructions.

    4. Under Options on the left, select Configuration.
    5. On the Reader Configuration page, select Advanced Reader (ipAddr:...).
    6. On the Modify a Reader Configuration page, select the check box Do not detect Symbol Light Indication Box and click Modify Reader.
    7. Under Options on the left, select Commit/Revert, then click the Commit button.
    8. Under Options, select Logout.
  3. Restart the reader (power off and on).
Configuring the Symbol XR400 GPIO

The Symbol XR400 reader has five external output lines. Listing 2-3 illustrates configuring the Symbol XR400 reader for controlling a stack light connected to the reader's external outputs.

Listing 2-3 Symbol XR400 GPIO Configuration
######################################################
# Define the Reader's GPIO output for stack light use
########################################################
#In edge.props
#Define the PLC Transport 'Reader'
com.connecterra.ale.plc.plcTransport.myreadergpio.metaName = Reader
com.connecterra.ale.plc.plcTransport.myreadergpio.pollInterval = 500
#Define the message convention 'Multiple'
com.connecterra.ale.plc.plcMessageConvention.mymultiplemsg.metaName = Multiple
com.connecterra.ale.plc.plcMessageConvention.mymultiplemsg.plcTransport = myreadergpio
#Define outboundMessage message for left stack light 
com.connecterra.ale.plc.outboundMessage.mystacklightleft.plcMessageConvention = mymultiplemsg
#(NA-not applicable, LG-left green, LY-left yellow, LR-left red)
com.connecterra.ale.plc.outboundMessage.mystacklightleft.items = NA NA LG LY LR
#Define left stacklight. Alternatively, this can be done in the Administration
#Console by defining a PLC Stack Light device.
#See PLC Stack Light Example.
com.connecterra.ale.reader.stacklightleft.class = com.connecterra.ale.readertypes.PLCStackLightPhysicalReader
com.connecterra.ale.reader.stacklightleft.plcMessage = mystacklightleft
com.connecterra.ale.reader.stacklightleft.defaultRate = 0
com.connecterra.ale.reader.stacklightleft.stackLightLogicalReaderName = StackLightLeft
#Define outboundMessage message for right stack light
com.connecterra.ale.plc.outboundMessage.mystacklightright.plcMessageConvention = mymultiplemsg
#(NA-not applicable, RG-right green, RY-right yellow, RR-right red)
com.connecterra.ale.plc.outboundMessage.mystacklightright.items = NA NA RG RY RR
#Define right stacklight. Alternatively, this can be done in the Administration
#Console by defining a PLC Stack Light device.
#See PLC Stack Light Example.
com.connecterra.ale.reader.stacklightRight.class = com.connecterra.ale.readertypes.PLCStackLightPhysicalReader
com.connecterra.ale.reader.stacklightRight.plcMessage = mystacklightright
com.connecterra.ale.reader.stacklightRight.defaultRate = 0
com.connecterra.ale.reader.stacklightRight.stackLightLogicalReaderName = StackLightRight
#define the input trigger
com.connecterra.ale.triggerDriver.plcmessage.class=com.connecterra.ale.triggertypes.PLCTriggerDriver
#########################################################
# Define the GPIO input for sensors/photoelectric eyes
###########################################################
#In edge.props
#Define the message convention
com.connecterra.ale.plc.plcMessageConvention.mysimplemsg.metaName = Simple
com.connecterra.ale.plc.plcMessageConvention.mysimplemsg.plcTransport = myreadergpio
#Define inboundMessage message
com.connecterra.ale.plc.inboundMessage.photoeye1.plcMessageConvention = mysimplemsg
#Input pin 5 for photo eye1
com.connecterra.ale.plc.inboundMessage.photoeye1.receiveItem = input5
com.connecterra.ale.plc.inboundMessage.photoeye1.matchValues = true
com.connecterra.ale.plc.inboundMessage.photoeye2.plcMessageConvention = mysimplemsg
#Input pin 4 for photo eye2
com.connecterra.ale.plc.inboundMessage.photoeye2.receiveItem = input4
com.connecterra.ale.plc.inboundMessage.photoeye2.matchValues = true
#Define the direction trigger
com.connecterra.ale.triggerDriver.door1.class=com.connecterra.ale.triggertypes.DirectionTriggerDriver
com.connecterra.ale.triggerDriver.door1.timeout=10000
com.connecterra.ale.triggerDriver.door1.aTrigger=plcmessage:photoeye1
com.connecterra.ale.triggerDriver.door1.bTrigger=plcmessage:photoeye2
Combined Antenna Mode

The AR400 and XR400 reader drivers in the RFID Edge Server run a bytestream protocol. The bytestream protocol driver now supports combined antenna operations. To enable combined antenna operations, assign the same logical reader name to multiple physical antenna ports. All antennas combined within a single logical group must operate with the same set of antenna-specific configuration options (Power Level, Environment Variable). The driver will use the configuration properties assigned to the lowest numbered antenna port in a group for all antennas in that group. So, if two logical readers are combined into the same group, then the power level and environment variable properties specified for the first will also apply to the second.

Tips For Symbol AR/XR-400 Readers

Before using a Symbol reader with the RFID Edge Server, verify that the reader is not running in "polled" mode. An easy way to do this is to wave a tag in front of the antenna and watch the yellow LED. If it blinks when the tag is in the antenna field, the reader is in "polled" mode. Follow the steps in Symbol AR400 hardware configuration.doc to disable polling.

Symbol (Matrics) RDR-001

The Symbol (Matrics) RDR-001 reader driver requires the use of a MOXA serial-to-Ethernet adapter, available from Symbol Technologies.

Table 2-24 lists the Symbol (Matrics) RDR-001 reader configuration properties.

Table 2-24 Symbol (Matrics) RDR-001 Configuration Properties 
Field Label
Property Name
Required?
Property Value and Description
Device Type
class
Yes
Must be set to: com.connecterra.ale.readertypes.MatricsRDR001PhysicalReader
N/A
gatewayName
No
See hostname. Used only for backward compatibility with releases prior to RFTagAware 1.3.
Reader Hostname
hostname
Yes
The DNS name or IP address of the MOXA serial-to-Ethernet adapter to which the reader is connected.
N/A
gatewayPort
No
See port. Used only for backward compatibility with releases prior to RFTagAware 1.3.
Reader Port
port
No
The TCP port the Edge Server will use when establishing connections to the MOXA serial-to-Ethernet adapter. The default value is 8080.
Default Rate
defaultRate
Yes
The period (in milliseconds) between the start of one read cycle and the start of the next. Note that if multiple logical readers are simultaneously active, then each logical reader will be read at an interval equal to the defaultRate times the number of logical readers.
Socket Timeout
socketTimeout
No
The TCP socket timeout interval (milliseconds). The default is 15000 milliseconds (15 seconds).
Frequency Channel
frequencyChannel
No
The frequency channel the RDR-001 reader will use to read tags. This property MUST ONLY be used with RDR-001 readers running FCC Part 90 Firmware. Integer property values range from 0 to 13, corresponding to 914.25 MHz to 917.25 MHz, in 500 kHz steps. There is no default value.
Node Address
nodeAddress
No
The reader's RS-485 protocol node address. Integer property values range from 0 (00 hex) to 31 (1F hex). The default value is 4.
Antenna 0 Logical Reader Name
Antenna 1 Logical Reader Name
Antenna 2 Logical Reader Name
Antenna 3 Logical Reader Name
uhf1LogicalReaderName
uhf2LogicalReaderName
uhf3LogicalReaderName
uhf4LogicalReaderName
Must configure one
Specifies the logical reader name for each UHF antenna. At least one logical reader name must be specified or the Edge Server will generate an error on startup.
Antenna 0 Environment Variable
Antenna 1 Environment Variable
Antenna 2 Environment Variable
Antenna 3 Environment Variable
uhf1EnvironmentVariable
uhf2EnvironmentVariable
uhf3EnvironmentVariable
uhf4EnvironmentVariable
No
Controls the length of time the RDR-001 reader gives itself when reading tags within a single antenna's field. The value of this property must be an integer in the range 0 to 8, where greater numbers indicate longer time. The default is 3.
Antenna 0 Power Level
Antenna 1 Power Level
Antenna 2 Power Level
Antenna 3 Power Level
uhf1PowerLevel
uhf2PowerLevel
uhf3PowerLevel
uhf4PowerLevel
No
The power level for each UHF antenna. The value of this property must be an integer in the range 1 to 255. Power level is logarithmic; hence, 192 is about 50% of and 128 is about 25% of an antenna's maximum power. The default power level is 192.
Antenna 0 Filter Names
Antenna 1 Filter Names
Antenna 2 Filter Names
Antenna 3 Filter Names
uhf1LogicalReaderFilterNames
uhf2LogicalReaderFilterNames
uhf3LogicalReaderFilterNames
uhf4LogicalReaderFilterNames
No
A blank-separated list of filter names for each logical reader. This value is defined in the Administration Console or in the edge.props file.

Tagsys

This section describes driver configuration information for the Tagsys Medio L100 and L200 RFID readers. Note that the RFID Edge Server requires the separate installation of the Tagsys Java library to enable interoperation with the Tagsys RFID readers. Please contact your Tagsys supplier for access to the file com.tagsys.jar. This file should be copied into the lib subdirectory of your WebLogic RFID Edge Server installation before starting the software.

The Tagsys Medio L100 and L200 reader drivers require the use of a MOXA serial-to-Ethernet adapter, available from Symbol Technologies.

Table 2-25 lists the Tagsys Medio L100 and L200 reader configuration properties.

Table 2-25 Tagsys Reader Configuration Properties 
Field Label
Property Name
Required?
Property Value and Description
Device Type
class
Yes
Must be set to: com.connecterra.ale.readertypes.TagsysLX00PhysicalReader
Reader Hostname
hostname
Yes
The DNS name or IP address of the MOXA serial-to-Ethernet adapter to which the reader is connected.
Reader Port
port
No
The TCP port the Edge Server will use when establishing connections to the MOXA serial-to-Ethernet adapter. The default value is 4001.
Socket Timeout
socketTimeout
No
The TCP socket timeout interval (milliseconds). The default value is 10000 milliseconds (10 seconds).
Default Rate
defaultRate
Yes
The period (in milliseconds) between polls of a logical reader. The same value applies to all logical readers provisioned on a single physical reader.
RF Protocols
rfProtocols
No
A blank-separated list of RF protocols. The Tagsys readers are multi-protocol readers. To improve efficiency, the read operation will only attempt to collect tags encoded with the specified protocols. At present, valid values are:
Philips_I_code
iso15693
The default value is iso15693.
Reader Operation Mode
operationMode
No
Indicates the behavior of the Tagsys reader in response to a request for data from an application. A value of poll means that the reader is idle between requests, but performs a tag read when it receives a request for data. A value of autopoll means that the reader continuously reads tags and stores the data in memory between requests, and forwards all stored tag information when it receives a request from the application.
Valid values are:
poll
autopoll
The default value is poll.
To read multiple tags using multiple antennas, autopoll mode is recommended.
Enable Slow Communication Mode?
enableSlowComMode
No
An optional Boolean property (allowed values are true and false). Slow communication mode enforces a data transmission integrity check operation (cyclic redundancy check (CRC)). The default value is false.
Some types of serial-to-Ethernet adapters might require using slow communication mode.
Read UID/EPC
readEPCUID
No
Specifies whether to read the UID (as raw 64-bit data) or the EPC. The default is UID.
Memory Block Offset
memBlockOffset
Yes
The memory block location where EPC data written to the tag begins. For example, an offset of 3 means that the first two memory blocks in the user memory area are skipped and the EPC data begins at the third memory block.
Number of Memory Blocks
memBlockLength
No
The number of memory blocks used in storing EPC data. For example, a 96-bit tag uses three 32-bit blocks. The default is 3.
Enable Little Endian Byte Order?
memByteOrder
Yes
Specifies the byte ordering of the EPC within a tag's addressable memory. Allowed values are:
true
false
The default value is false.
RF Power Level
readRFPower
No
The RF power setting of the Tagsys reader. The range of valid values is from 250 (minimum power) to 7000 (maximum power). The default value is 1000mW.
RF Read Timeout
rfReadTimeout
No
Specifies the amount of RF time (in milliseconds) the reader may spend when servicing a request to read tags in a single antenna's field. The default value is 100 ms.
Expected Tag Count
tagCount
No
Specifies the number of tags expected to be read. The default value is 10.
Time Slots Number
timeslots
No
Specifies the number of time slots used by the RF protocol for anti-collision during tag reading.
Valid values are: 1, 4, 8, 16, 32, 64, 128, 256.
For one tag, use a value of 1. For multiple tags, try different values to achieve the best performance. If not specified, the driver calculates a value (not necessarily the optimal value).
Buffer Depth
bufferDepth
No
Sets the reader's temporary memory storage of tag data in number of tags.
For one tag, use a value of 1. For multiple tags, use a value of 48. If not specified, the driver calculates a value (not necessarily the optimal value).
RPU Filter Bandwidth
receiverFilter
No
Sets the receiver filtering bandwidth of the Radio Processing Unit (RPU).
Valid values are:
BandPass (between 5 and 600 kHz)
HighPass (between 80 and 600 kHz)
The default is BandPass.
Antenna Multiplexing - RF Duration Per Antenna Scan
muxDurationPerScan
No
Applies only to combined antenna operations. Specifies the amount of time (in milliseconds) each antenna spends reading tags. The default value is 20 milliseconds.
Antenna Multiplexing - Enable Antenna Pair
muxEnableAntennaPair
No
Applies only to combined antenna operations. Allowed values are true and false. True means that antennas 1 and 2 are paired, and antennas 3 and 4 are paired. The default value is false.
Antenna Multiplexing - Antenna Phase Shift Angle
muxPhaseShiftAngle
No
Applies only to combined antenna operations. Specifies the RF scanning phase shift angle between antennas 1 and 3, and between antennas 2 and 4.
The reader firmware supports a RF scanning phase shift angle of 180 degrees; some firmware may support a 90 degree shift angle.
ch 1 Logical Reader Name
ch 2 Logical Reader Name
ch 3 Logical Reader Name
ch 4 Logical Reader Name
ch1LogicalReaderName
ch2LogicalReaderName
ch3LogicalReaderName
ch4LogicalReaderName
No
Specifies the logical reader name for each HF antenna. At least one logical reader name must be specified or the Edge Server will generate an error on startup. Please note that the L100 reader has two antennas and the L200 reader has four antennas.
ch 0 Filter Names
ch 1 Filter Names
ch 2 Filter Names
ch 3 Filter Names
ch1LogicalReaderFilterNames
ch2LogicalReaderFilterNames
ch3LogicalReaderFilterNames
ch4LogicalReaderFilterNames
No
A blank-separated list of filter names for each logical reader. This value is defined in the Administration Console or in the edge.props file.

Antenna Multiplexing Configuration

The Tagsys Medio L100 and L200 readers support combined antenna operations and can manage up to four antennas, organized into two pairs of antennas. Each antenna is able to transmit an RF field, but only one antenna in the pair can receive at a single time. This means that each antenna can transmit an RF field used to read tags, but tag contents can only be read by one antenna of the pair at a given time.

Configuring Tagsys readers to perform read operations on both antennas (or antenna pair) one after the other enhances tag reading performance. The multiplexing mode implements several antenna combinations that are applied one after the other in a loop.

Antenna multiplexing information is organized into patterns. A pattern contains information about which antennas are enabled at the same time as well as the phase shift angle values between the enabled antennas.

If antenna pairs are used, the multiplexing patterns are shown in Table 2-26.

Table 2-26 Multiplexing Patterns With Antenna Pairs 
Multiplexing Patterns
PAIR 1
(Antenna 1 + Antenna 2)
PAIR 2
(Antenna 3 + Antenna 4)
Pattern 1
enabled
disabled
enabled
disabled
Pattern 2
disabled
enabled
disabled
enabled

If no antenna pairs are used, the multiplexing patters are shown in Table 2-27.

Table 2-27 Multiplexing Patterns With No Antenna Pairs 
Multiplexing Pattern
Antenna 1
Antenna 2
Antenna 3
Antenna 4
Pattern 1
enabled
disabled
disabled
disabled
Pattern 2
disabled
enabled
disabled
disabled
Pattern 3
disabled
disabled
enabled
disabled
Pattern 4
disabled
disabled
disabled
enabled

For more information on combined antenna operations, see Combined Antenna Mode. For detailed multiplexing configuration information, see Lx00 Platform Firmware Reference Guide (Tagsys Document Reference 10958D0).

Configuring The MOXA Device

The Tagsys reader will be connected to an IP network with a MOXA serial server. The serial configuration is shown below. If the reader's serial configuration is changed, adjust these settings accordingly.

Baud rate:
38400
Parity:
None
Data bits:
8
Stop bit:
1
Flow control:
None
UART FIFO:
Disable
Interface:
RS-232

A null modem is required if using a straight serial cable (DB9, female-to-male).

ThingMagic

The RFID Edge Server uses two ThingMagic reader drivers:

ThingMagic Mercury3

Table 2-28 lists the ThingMagic Mercury3 reader configuration properties.

Table 2-28 ThingMagic Mercury 3 Reader Configuration Properties 
Field Label
Property Name
Required?
Property Value and Description
Device Type
class
Yes
Must be set to: com.connecterra.ale.readertypes. ThingMagicMercury3PhysicalReader
Reader Hostname
hostname
Yes
The DNS name or IP address of the ThingMagic reader
Reader Port
port
No
The TCP port the Edge Server will use when establishing connections to the ThingMagic Reader. The default is 8080.
Default Rate
defaultRate
Yes
The period (in milliseconds) between the start of one read cycle and the start of the next. Note that if multiple logical readers are simultaneously active, then each logical reader will be read at an interval equal to the default rate times the number of logical readers.
Socket Timeout
socketTimeout
No
The TCP socket timeout interval (milliseconds). The default is 15000 milliseconds (15 seconds).
Read Timeout
readTimeout
No
Specifies the maximum amount of time (in milliseconds) the reader may spend when servicing a request to read tags in a single antenna's field. The default value is 250 milliseconds.
Write Timeout
writeTimeout
No
Specifies the maximum amount of time (in milliseconds) the reader may spend when servicing a request to program a tag across a single antenna. The default value is 250 milliseconds.
Disable Programming Cycle Check
disableProgrammingCycleCheck
No
An optional Boolean property (allowed values are true and false) specifying whether the driver disables the "check operation" (verification that there is a single tag in an antenna's field prior to conducting a tag programming operation). The default value is false, meaning the driver conducts the check operation.
Note that if the check operation is disabled (this property value is set to true) and multiple tags are present in the antenna's field when conducting a tag programming operation, then all tags in the field will be programmed with the same EPC.
UHF Antenna 1 Logical Reader Name
UHF Antenna 2 Logical Reader Name
uhf1LogicalReaderName
uhf2LogicalReaderName
Must configure one
Specifies the logical reader name for each UHF (915 MHz) antenna. At least one logical reader name must be specified.
If one of these properties is left undefined, there will be no logical reader associated with the corresponding antenna, and that antenna will not be accessible via the ALE API.
If multiple UHF antennas are assigned the same logical reader name, then the driver will treat them as a single combined antenna. The lowest-numbered antenna in the combined antenna grouping is checked to set antenna-specific properties and used for tag programming.
UHF Antenna 1 Filter Names
UHF Antenna 2 Filter Names
uhf1LogicalReaderFilterNames
uhf2LogicalReaderFilterNames
No
A blank-separated list of filter names for each logical reader. This value is defined in the Administration Console or in the edge.props file.
HF Antenna 1 Logical Reader Name
HF Antenna 2 Logical Reader Name
hf1LogicalReaderName
hf2LogicalReaderName
Must configure one
Specifies the logical reader name for each HF (13.56 MHz) antenna. At least one logical reader name must be specified.
If one of these properties is left undefined, there will be no logical reader associated with the corresponding antenna, and that antenna will not be accessible via the ALE API.
HF Antenna 1 Filter Names
HF Antenna 2 Filter Names
hf1LogicalReaderFilterNames
hf2LogicalReaderFilterNames
No
A blank-separated list of filter names for each logical reader. This value is defined in the Administration Console or in the edge.props file.

ThingMagic Mercury4

Table 2-29 lists the ThingMagic Mercury4 reader configuration properties.

Table 2-29 ThingMagic Mercury 4 Reader Configuration Properties 
Field Label
Property Name
Required?
Property Value and Description
Device Type
class
Yes
Must be set to: com.connecterra.ale.readertypes.ThingMagicMercury4PhysicalReader
Reader Hostname
hostname
Yes
The DNS name or IP address of the ThingMagic reader
Reader Port
port
No
The TCP port the Edge Server will use when establishing connections to the ThingMagic Reader. The default is 8080.
Default Rate
defaultRate
Yes
The period (in milliseconds) between the start of one read cycle and the start of the next. Note that if multiple logical readers are simultaneously active, then each logical reader will be read at an interval equal to the default rate times the number of logical readers.
Socket Timeout
socketTimeout
No
The TCP socket timeout interval (milliseconds). The default is 15000 milliseconds (15 seconds).
Read Timeout
readTimeout
No
Specifies the maximum amount of time (in milliseconds) the reader may spend when servicing a request to read tags in a single antenna's field. The default value is 250 milliseconds.
Write Timeout
writeTimeout
No
Specifies the maximum amount of time (in milliseconds) the reader may spend when servicing a request to program a tag across a single antenna. The default value is 250 milliseconds.
Disable Programming Cycle Check
disableProgrammingCycleCheck
No
An optional Boolean property (allowed values are true and false) specifying whether the driver disables the "check operation" (verification that there is a single tag in an antenna's field prior to conducting a tag programming operation). The default value is false, meaning the driver conducts the check operation.
Note that if the check operation is disabled (this property value is set to true) and multiple tags are present in the antenna's field when conducting a tag programming operation, then all tags in the field will be programmed with the same EPC.
UHF Antenna 1 Logical Reader Name
UHF Antenna 2 Logical Reader Name
UHF Antenna 3 Logical Reader Name
...
UHF Antenna 8 Logical Reader Name
uhf1LogicalReaderName
uhf2LogicalReaderName
uhf3LogicalReaderName
...
uhf8LogicalReaderName
Must configure one
Specifies the logical reader name for each UHF (915 MHz) antenna. At least one logical reader name must be specified.
If one of these properties is left undefined, there will be no logical reader associated with the corresponding antenna, and that antenna will not be accessible via the ALE API.
If multiple UHF antennas are assigned the same logical reader name, then the driver will treat them as a single combined antenna. The lowest-numbered antenna in the combined antenna grouping is checked to set antenna-specific properties and used for tag programming.
UHF Antenna 1 Filter Names
UHF Antenna 2 Filter Names
UHF Antenna 3 Filter Names
...
UHF Antenna 8Filter Names
uhf1LogicalReaderFilterNames
uhf2LogicalReaderFilterNames
uhf3LogicalReaderFilterNames
...
uhf8LogicalReaderFilterNames
No
A blank-separated list of filter names for each logical reader. This value is defined in the Administration Console or in the edge.props file.
N/A
rfProtocols
No
See rfProtocols. Used only for backward compatibility with releases prior to RFTagAware 1.3.
List of Protocols
rfProtocols
No
A blank-separated list of RF protocols. Mercury4 is a multi-protocol reader and can operate in read-only or read-write mode. At least one protocol must be specified. At present, the valid values are:
epcClass0
epcClass1

epcClass1Gen2
ALL
The default value is ALL.

The ThingMagic reader obtains its IP network configuration dynamically via DHCP, or statically through one of the reader configuration interfaces. Refer to the ThingMagic User Guide for further details.

Wavetrend

This section describes driver configuration information for the Wavetrend L-RX900 reader. This reader supports reading Wavetrend active tags.

Table 2-30 Waveternd Configuration Properties
Field Label
Property Name
Required?
Property Value and Description
Device Type
class
Yes
Must be set to: com.connecterra.ale.readertypes.WaveTrendPhysicalReader
Reader Hostname
hostname
Yes
The DNS name or IP address of the Wavetrend reader
Reader Port
port
No
The TCP port the Edge Server will use when establishing connections to the ThingMagic Reader. The default is xxx.
Socket Timeout
socketTimeout
No
The TCP socket timeout interval (milliseconds). The default is 15000 milliseconds (15 seconds).
Read Timeout
readTimeout
No
Specifies the maximum amount of time (in milliseconds) the reader may spend when servicing a request to read tags in a single antenna's field. The default value is 250 milliseconds.
Write Timeout
writeTimeout
No
Specifies the maximum amount of time (in milliseconds) the reader may spend when servicing a request to program a tag across a single antenna. The default value is 250 milliseconds.
UHF Antenna 1 Logical Reader Name
uhf1LogicalReaderName
Yes
Specifies the logical reader name for the UHF antenna.
If this property is left undefined, there will be no logical reader associated with the corresponding antenna, and that antenna will not be accessible via the ALE API.
UHF Antenna 1 Filter Names
uhf1LogicalReaderFilterNames
No
A blank-separated list of filter names for the logical reader. This value is defined in the Administration Console or in the edge.props file.
Reader ID
readerId
No
An optional 1 byte value stored in the reader EEPROM.
Site Code
siteCode
No
A site code is assigned to Wavetrend tags at programming time. This optional property is passed to the reader and stored in the reader EEPROM. This property can be used for filtering, where only tags with a matching site code are reported.
When set to 0 (the default), site code filtering is disabled. Enable site code filtering by setting this property to 1.
Receiver Gain
receiverGain
No
This value sets the gain for the reader RF module. 1 sets the gain to long range (the default) and 0 sets the gain to low range.
GPIO Transport Name
gpioTransportName
No
The general-purpose I/O (GPIO) port used by the Edge Server to obtain reader status.

Configuring Wavetrend GPIO

The Wavetrend L-RX900 reader has two external output lines, numbered 0 and 1.WebLogic RFID Edge Server lets you configure these GPIO like a PLC device. See Configuring the Edge Server for PLC Communications. When configuring data items for the L-RX900, use out0 and out1 for outputs. The following provides an example of programming the L-RX900 GPIO.

Listing 2-4 Wavetrend L-RX900 GPIO Configuration
#In edge.props file
#Define the PLC Transport `Reader'
com.connecterra.ale.plc.plcTransport.wtgpio.metaName = Reader
com.connecterra.ale.plc.plcTransport. wtgpio.pollInterval = 1000
#Define the message convention `Simple'
com.connecterra.ale.plc.plcMessageConvention.simple.metaName = Simple
com.connecterra.ale.plc.plcMessageConvention.simple.plcTransport = wtgpio
#Define the message convention `Multiple'
com.connecterra.ale.plc.plcMessageConvention.multiple.metaName = Multiple
com.connecterra.ale.plc.plcMessageConvention.multiple.plcTransport = wtgpio
#Define outboundMessage for left stack light
com.connecterra.ale.plc.outboundMessage.mystacklightleft.plcMessageConvention = multiple
com.connecterra.ale.plc.outboundMessage.mystacklightleft.items = out0 out1 NA NA NA
#Define inboundMessage
com.connecterra.ale.plc.inboundMessage.wtinputs.plcMessageConvention = simple
com.connecterra.ale.plc.inboundMessage. wtinputs.receiveItem = in0
com.connecterra.ale.plc.inboundMessage. wtinputs.matchValues = false
#Define left stacklight. Alternatively, this can be done in the Administration
#Console by defining a PLC Stack Light device.
#See PLC Stack Light Example.
com.connecterra.ale.reader.stacklightleft.class = com.connecterra.ale.readertypes.PLCStackLightPhysicalReader
com.connecterra.ale.reader.stacklightleft.plcMessage = mystacklightleft
com.connecterra.ale.reader.stacklightleft.defaultRate = 0
com.connecterra.ale.reader.stacklightleft.stackLightLogicalReaderName = StackLightLeft

Zebra

This section describes driver configuration information for the Zebra R110XiIIIPlus, R110Xi and R4MPlus label printers.

The Zebra R110XiIIIPlus, R110Xi and R4MPlus printer drivers share all the same properties except class, as shown in the following table

Table 2-31 Zebra Configuration Properties 
Field Label
Property Name
Required?
Property Value and Description
Device Type
class
Yes
R110XiIIIPlus: com.connecterra.ale.readertypes.ZebraR110XiIIIPlusPhysicalReader
R110Xi: com.connecterra.ale.readertypes.ZebraR110XiIIIPlusPhysicalReader
R4MPlus: com.connecterra.ale.readertypes.ZebraR4MPlusPhysicalReader
Reader Hostname
hostname
Yes
The DNS name or IP address of the printer's LAN adapter.
Reader Port
port
No
The TCP port the Edge Server will target when establishing connections to the printer's LAN adapter. The default value is 9100, the Zebra R110XiIIIPlus device's factory default.
Socket Timeout
socketTimeout
No
The TCP socket timeout interval (milliseconds). The default value is 15000 milliseconds (15 seconds).
Logical Reader Name
uhf1LogicalReaderName
Yes
The logical reader name assigned to the Zebra device's single integrated UHF antenna.
Enable RFID Encoding
programRFID
No
A Boolean (allowed values are true and false) specifying whether the reader driver instructs the printer to program EPC data into an embedded RFID tag. The default value is true.
ZPL Form
zplFilename
No
Specifies the pathname of a file containing Zebra ZPL commands defining a smart label form.
Typically, the PCSpec readerParameters attribute specifies ZPL-based label design; the reader parameter name is zplScript. This property provides a mechanism for specifying a default label design in the event the PCSpec does not contain ZPL reader parameters. When present, the ZPL Form refers to a text file (label.zpl) containing the set of ZPL commands specifying the smart label layout and dynamic (variable) content. See Using the Zebra Printing Language (ZPL II).

Note: If specified, this property must point to a valid ZPL file.

Retries
retries
No
Defines the number of labels to retry in case of a failed RFID operation. The valid range is 1 through 10, the default value is 3.
Error Handling
errorHandling
No
Specifies an error handling operation, if an RFID operation fails after the number of retries (specified in the retries property). The valid values are:
NO_ACTION
PAUSE_MODE
ERROR_MODE
The default value is NO_ACTION.
Status Message FIle
statusMessageFile
No
Specifies the pathname of a file containing a table of all known status codes, descriptions, and severity levels. The file can be edited by the end user (commonly editing the severity levels). The file must be present for the driver to work, but the field can be left blank. A blank field is interpreted as the default file: etc/ZebraPrintStatus.props
Transponder Position
transponderDisplacement
No
Applies only to R4MPlus printer. Specifies the value of parameter in the ^RS command issued to the printer. Use this property only if necessary. Refer to Zebra R4MPlus User Guide for explanation and usage guidelines
Verify Pre-encoded A5A5
verifyValidData
No
Applies only to R4MPlus printer. A Boolean (allowed values are true and false). The default value is false.
When true, the printer fails the tag programming operation if the first two bytes of the tag are not 0xA5A5.

Using the Zebra Printing Language (ZPL II)

ZPL is a scripting language for specifying the layout and contents of printed labels. ZPL is described in detail in the Zebra document, ZPLII Programming Guide (Zebra Document 45541LB-R3).

The Zebra printer driver sends its printer a separate collection of ZPL commands with each "smart label" (a printed label with an embedded RFID tag) to be printed and programmed. Users specify smart label ZPL commands when defining a PCSpec (see Programming with the ALE and ALEPC APIs). A PCSpec readerParameters field carries the ZPL script as a String object; the reader parameter name is zplScript. As an alternative to specifying ZPL within a PCSpec, the Edge Server administrator may specify a default ZPL script using the Zebra reader driver ZPL Form property. This property provides a mechanism for specifying ZPL commands that serve as a default label design in the event the PCSpec readerParameters field does not carry a key/value pair containing a ZPL script.

Below is an example ZPL script:

^XA
^FX *** NOTE: Lines, beginning with ^FX are comments ***^FS
^FX Set home position ^FS
^LH30,35
^FX Write EPC HEX ^FS
^WT,,,,1^FD[EPC_HEX]^FS
^FX "Ship From" text ^FS
^FO20,15^A0N,18,,^FDSHIP FROM:^FS
^FO20,40^A0N,26,,^FDAcme^FS
^FO20,65^A0N,26,,^FDCorporation^FS
^FO20,90^A0N,26,,^FDP.O. Box 61900^FS
^FO20,115^A0N,26,,^FDDallas, TX 75261^FS
^FX Draw vertical line ^FS
^FO300,0^GB0,180,2^FS
^FX "Ship to" text ^FS
^FO320,15^A0N,18,,^FDSHIP TO:^FS
^FO320,40^A0N,26,,^FDRetailer Distribution Center^FS
^FO320,65^A0N,26,,^FD200 Main Street^FS
^FO320,90^A0N,26,,^FDSpringfield, MA01103^FS
^FX Draw horizontal line ^FS
^FO0,180^GB720,0,4^FS
^FX Postal code text ^FS
^FO20,195^A0N,18,,^FDSHIP TO POSTAL CODE:^FS
^FO30,275^A0N,32,,^BC,90,,Y,^FD(420) 01103^FS
^FX Draw vertical line ^FS
^FO340,180^GB0,270,2^FS
^FX Carrier text ^FS
^FO360,195^A0N,18,,^FDCARRIER:^FS
^FO360,245^A0N,36,,^FDAcme Freightways^FS
^FO360,295^A0N,30,,^FDPRO: 1234^FS
^FO360,345^A0N,30,,^FDB/L: 5678^FS
^FX Draw horizontal line ^FS
^FO0,450^GB720,0,4^FS
^FX EPC text ^FS
^FO0,465^A0N,32,,^FDEPC:^FS
^FO20,575^A0N,32,,^FD[EPC_TAG_URI]^FS
^FX Draw horizontal line ^FS 
^FO0,670^GB720,0,4^FS
^FX SKU text ^FS 
^FO0,685^A0N,32,,^FDSKU:^FS
^FO15,724^A0N,36,,^FDABC21270^FS
^FX Draw hoarizontal line ^FS
^FO0,785^GB720,0,4^FS
^FX GTIN text ^FS
^FO0,800^A0N,32,,^FDGTIN^FS
^FO100,890^A0N,32,,^BC,90,,Y,^FD>; (01) 10036000212706 ^FS
^XZ

If you want to print a specified EPC value on the smart label, the user-supplied ZPL must include special substitution strings, indicating in what representation the tag values are to be printed. The RFID Edge Server recognizes the following pre-programmed substitution string values:

[EPC_HEX]
Will be replaced by the hexadecimal representation of the tag value.
[EPC_ID_URI]
Will be replaced by the pure identity URN representation of the tag value.
[EPC_TAG_URI]
Will be replaced by the tag URN representation of the tag value.

Example:

^XA
^FO20,575^A0N,32,,^FD[EPC_TAG_URI]^FS
^XZ

The RFID Edge Server also recognizes user-defined substitution strings. User-defined parameters are specified in square brackets, but the substitution values must be provided in the PC spec in reader parameters as in the following example:

<readerParameters>
parameter map. Note that all of the [CT_..] fields should be either keys or replaced -->
<readerParameter name="MY_CUSTOM_PARAMETER1">parameterValue1 </readerParameter>
<readerParameter name="MY_CUSTOM_PARAMETER2">parameterValue2 </readerParameter> 
...
</readerParameters>

Status Polling and RFID Log Processing

The Zebra110 driver supports host status polling and RFID log processing.

Host status is polled at the interval defined by the deviceStatusUpdateInterval property in the edge.props file. Note that this value applies to all drivers.

An RFID log entry is returned for each job that contains an RFID operation (Enable RFID Encoding is set to true). The status code extracted from the log is matched against the customizeable status file (by default, etc/ZebraPrintStatus.props) for description and severity level and then processed according to severity level.

 


General Troubleshooting

The section applies to all readers.

Problem: While an active subscription is running, the reader frequently displays a failed connection message.

Possible reason: Verify that the socketTimeout field is blank (the default setting is 15000 ms). You can change this value, but it is impractical to set it lower than 5000.

Problem: You see unusually high CPU utilization when running an active subscription.

Possible reason: Verify that the defaultRate value is a non-zero positive number.


  Back to Top       Previous  Next