The type of mode of operation

The type of environment in which the reader operates. Along with the regulatory configuration of the reader, the environment parameter will set the default link profile parameters (i.e., Miller mode, BLF, Tari, etc.) and the receiver dynamic range (interference immunity).

LOW_INTERFERENCE: The reader is operating in an environment when the likelihood of interference is very low or only occurs for very brief periods of time (defined as a single interrogator environment in the Gen2 and ISO standards).

HIGH_INTERFERENCE: The reader is operating in the presence of other readers (defined as a multi-interrogator or dense interrogator environment in the Gen2 and ISO standards).

VERY_HIGH_INTERFERENCE: The reader is operating in an environment where the number of readers is greater than the number of available channels, or when interfering readers are in very close proximity to each other.

AUTO_DETECT: This will cause the reader to try and assess the environment and adjust accordingly.

DEMO: Should be used when demonstrating the maximum performance (fastest read rate) of a reader. This assumes no other readers in the environement.

If absent, the environment is set to HIGH_INTERFERENCE

An array of integers representing the antenna ports to use to read tags. For ATR, the integers represent beam numbers.

If absent, all antennas ports are used; for the ATR, a set of 38 beams are used.

Represents filter on the tag id.

If absent, no filter is used.

Desired Transmit Power (in dbm). If absent, the value is set to 27 dbm; for the ATR, the value is set to 36 dbm EIRP.

Stop Condition for antennas. If absent, the antenna stop condition is set to run a single inventory round for no longer than 1/N seconds. Where N is the number of enabled antennas.

Gen2 query parameters. See Gen2 spec for details. If absent, "sel" is set to ALL, session is set to 1, target is set to A, and tag population set to 1.

Gen2 select parameters. See Gen2 spec for details. If absent, no select will be issued. Cannot be set when filter with prefix type is also set. If there is an array of select objects, all of the selects in the array will be applied to all antennas. If there is an array of array of select objects, each array of select objects will apply to each antenna. The array of arrays must have the same number of entries as the antennas array.

Duration in milliseconds to wait after issuing the final select before issuing a query. If absent, the minimum time will be used.

Gen2 access parameters. See Gen2 spec for details.

If absent, no access will be issued.

If there is an array of access objects, all of the accesss in the array will be applied to all antennas.

If there is an array of array of access objects, each array of access objects will apply to each antenna. The array of arrays must have the same number of entries as the antennas array.

This introduces a delay between antenna cycles if no tags are read or if no unique tags are read. This allows the reader to share the spectrum if there are no tags to be read.

If absent, on the ATR7000 and the FX9600, delayBetweenAntennas cycles is set to wait for 75 mS if no unique tags are read during a antenna cycle.
on the FX7500, delayBetweenAntennas cycles is set to wait for 75 mS if no tags are read during a antenna cycle.

Controls the metadata that is sent when a tag is reported

“ANTENNA” will report the antenna port upon which the tag was inventoried.

“RSSI” will report the rssi (in dbm) of the inventoried tag. If the tag is only reported occasionally (see reportFilter), this tag will be the peak rssi since the last reported read.

“PHASE” will report the phase (in degrees) of the inventoried tag. This value will only be reported if each individual tag read is reported (in other words, if reportFilter duration is set to 0). Otherwise, it will not be reported.

“CHANNEL” will report the channel (in MHz) the reader was using when the tag was inventoried. This value will only be reported if each individual tag read is reported (in other words, if reportFilter duration is set to 0). Otherwise, it will not be reported.

“SEEN_COUNT” will report the number of times the tag has been inventoried since the previous report. This value will always be 1 if each individual tag read is reported (in other words, if reportFilter duration is set to 0).

“PC” will report the PC bits of the inventoried tag as a hex string.

“XPC” will report the XPC bits of the inventoried tag, if present, as a hex string.

“CRC” will report the CRC bits of the inventoried tag as a hex string.

“EPC” will report the entire contents of the EPC bank as a hex string. If only a portion of the memory bank is desired, this can be requested by appending a [] to the string and placing the words requested. For instance, if only the first word is desired, the value can be set as “EPC[1]”. If the first word and the 3-5 word are desired, the value can be set to “EPC[1,3-5]”.

“TID” will report the entire contents of the TID bank as a hex string. If only a portion of the memory bank is desired, this can be requested by appending a [] to the string and placing the words requested. For instance, if only the first word is desired, the value can be set as “TID[1]”. If the first word and the 3-5 word are desired, the value can be set to “TID[1,3-5]”.

“USER” will report the entire contents of the USER bank as a hex string. If only a portion of the memory bank is desired, this can be requested by appending a [] to the string and placing the words requested. For instance, if only the first word is desired, the value can be set as “TID[1]”. If the first word and the 3-5 word are desired, the value can be set to “TID[1,3-5]”.

“MAC” will report the MAC Address of the reader reporting the tag.

“HOSTNAME” will report the hostname of the reader reporting the tag.

“TAGURI” will report the GS1 TDS decoded “EPC Tag URI”. See GS1 TDS documentation for details.

“EPCURI” will report the GS1 TDS decoded “Pure Identity EPC URI”. See GS1 TDS documentation for details.

The array may also contain an object or objects. The object must contain a single name value pair with the name being set to “userDefined” or “antennaNames”

If absent, “SIMPLE” mode does not report any additional meta data, “PORTAL” and “CONVEYOR” modes reports “ANTENNA”, and “INVENTORY” mode reports “ANTENNA”, “RSSI”, and “SEEN_COUNT”.

Controls when, after a “start” is issued, the radio starts trying to inventory tags.

If absent, the radio will immediately begin inventorying tags upon a "start" command.

Controls when an ongoing operation completes.

If absent, the radio will continue trying to inventory tags until a "stop" is issued.

Controls when and how often a tag is reported

NOTE: This cannot be set while in "INVENTORY" mode. Setting the modeSpecificSetting for interval must be used in "INVENTORY" mode.

If absent, each mode uses a different default.

"SIMPLE": report tag read once.

"PORTAL" and "CONVEYOR": report each tag the first time it is read on each antenna.

Tag with RSSI below threshold will not be inventoried by the radio

If absent, rssi filter is not used.

Note: Currently ONLY supported by the FX9600.