Class: UgiRfidConfiguration

UgiRfidConfiguration()

This class encapsulates the RFID configuration.

Constructor

new UgiRfidConfiguration()

Source:

Members

(static, readonly) InventoryTypes :Number

Inventory types passed to startInventory.
Type:
  • Number
Properties:
Name Type Description
LOCATE_DISTANCE Number Locate at a distance
INVENTORY_SHORT_RANGE Number Inventory (count) a large number of tags relatively close
INVENTORY_DISTANCE Number Inventory (count) a at a distance
LOCATE_SHORT_RANGE Number Locate at short range
LOCATE_VERY_SHORT_RANGE Number Locate at very short range
SINGLE_FIND Number Find a single tag
HF_INVENTORY Number
HF_SINGLE_FIND Number
Source:

continual

TRUE to run inventory until stopped, NO to run inventory once (default is TRUE)
Source:

delayAfterSelect

TRUE to delay for 3ms after SELECT (useful for some sensor tags) - requires firmware 1.10.4 or above
Source:

detailedPerReadData

TRUE for reader to report detailed data for each read (default is FALSE)
Source:

forceTari25

TRUE to force a Tari of 25uS (useful for some sensor tags) - requires firmware 1.10.4 or above
Source:

historyDepth

Number of history periods (default is 20)
Source:

historyIntervalMSec

Length of each history period (default is 500ms)
Source:

initialPowerLevel

Power level for running inventory, in dbM
Source:

initialQValue

Initial "Q" value to use when running inventory
Source:

listenBeforeTalk

TRUE for reader to listen-before-talk (default is FALSE)
Source:

maxPowerLevel

Maximum power level for running inventory, in dBm (0 = max)
Source:

maxQValue

Maximum "Q" value to use when running inventory
Source:

maxReservedBytes

Maximum number of RESERVED memory bank bytes to return (0 = don't read RESERVED). Currently supported up to 208 bytes.
Source:

maxRoundsPerSecond

Maximum number of inventory rounds per second (0 = no limit)
Source:

maxTidBytes

Maximum number of TID memory bank bytes to return (0 = don't read TID). Currently supported up to 208 bytes.
Source:

maxUserBytes

Maximum number of USER memory bank bytes to return (0 = don't read USER). Currently supported up to 208 bytes.
Source:

minPowerLevel

Minimum power level for running inventory, in dBm (0 = max)
Source:

minQValue

Minimum "Q" value to use when running inventory
Source:

minReservedBytes

Minimum number of RESERVED memory bank bytes to return. If the RESERVED memory size is known, set minReservedBytes=maxReservedBytes
Source:

minTidBytes

Minimum number of TID memory bank bytes to return. If the TID memory size is known, set minTidBytes=maxTidBytes
Source:

minUserBytes

Minimum number of USER memory bank bytes to return. If the USER memory size is known, set minUserBytes=maxUserBytes
Source:

powerLevelWrite

Power level for writing tags, in dBm (0 = max)
Source:

reportRssi

TRUE for reader to report RSSI data (default is FALSE)
Source:

reportSubsequentFinds

TRUE to report subsequent finds
Source:

roundsWithNoFindsToToggleAB

number of inventory rounds with no finds after which to toggle A/B (0 = never toggle)
Source:

selectBank

Memory bank for SELECT
Source:

selectMask

Mask to use in SELECT before inventory round. If nil (the default) then no SELECT is done before each inventory
Source:

selectMaskBitLength

Length of the mask, in bits. If zero, then selectMask.length*8 is used
Source:

selectOffset

Bit offset for SELECT
Source:

sensitivity

Sensitivity level for running inventory, db
Source:

sensitivityWrite

Sensitivity level for writing tags, db (0 = max)
Source:

session

Sensitivity level for reading/writing tags, db
Source:

setListenBeforeTalk

TRUE for reader to use this listen-before-talk setting, if allowed (default is FALSE)
Source:

singleFindContinueInventory

TRUE to stop inventory in singleFindMode after tag is found - requires firmware 1.12.5 or above
Source:

singleFindMode

TRUE to use single find mode (find one tag only) - requires firmware 1.12.5 or above
Source:

singleFindRampPowerMode

If and how to ramp power from min to max in singleFindMode - requires firmware 1.12.5 or above
Source:

soundType

Type of sounds to make when tags are found
Source:

volume

Volume level (0...1)
Source:

Methods

(static) configWithInventoryType(inventoryType)

Get a configuration object for a pre-defined inventory type
Parameters:
Name Type Description
inventoryType Inventory type: UgiRfidConfiguration.InventoryTypes.xxx
Source:
Returns:
Configuration

(static) nameForInventoryType(inventoryType)

Get the name of an inventory type
Parameters:
Name Type Description
inventoryType Inventory type: UgiRfidConfiguration.InventoryTypes.xxx
Source:
Returns:
Name

(static) numInventoryTypes()

Get the number of inventory types
Source:
Returns:
Number of inventory types