Overview

RFID configuration instances, used by startInventory().

Common configuration instances are provided.

     LOCATE_DISTANCE - for locating a set of EPCs from more than two feet.

Static Public Member Functions
static UgiRfidConfiguration	forInventoryType (InventoryTypes inventoryType)
	Get the RFID configuration for a given type. More...

static UgiRfidConfiguration	forInventoryType (int inventoryType)
	Get the RFID configuration for a given int type. More...

static int	getNumInventoryTypes ()
	Get the number of pre-defined inventory types. More...

static String	getNameForInventoryType (int inventoryType)
	Get the name for an inventory type (unlocalized) More...

static double	getMinAllowablePowerLevel ()
	Get the minimum power value (dBm) More...

static double	getMaxAllowablePowerLevel ()
	Get the maximum power value (dBm) More...

static int	getMinAllowableQValue ()
	Get the minimum Q value. More...

static int	getMaxAllowableQValue ()
	Get the maximum Q value. More...

static int	getMaxAllowableRoundsWithNoFindsToToggleAB ()
	Get the maximum value for roundsWithNoFindsToToggleAB. More...

static int	getMaxAllowableMemoryBankBytes ()
	Get the maximum value for maxTidBytes/maxReservedBytes/maxUserBytes. More...

Classes
enum	InventoryTypes
	Sound types (passed to startInventory) More...

enum	MemoryBank
	References for the four RFID tag memory banks that can be written to. More...

enum	SingleFindRampPowerModes
	Values for singleFindRampPowerMode. More...

enum	SoundTypes
	Sound types (passed to startInventory) More...

Static Public Attributes
static final int	MAX_RFID_CONFIGURATION_MASK_LENGTH_BYTES = 12
	Maximum length of an EPC code, in bytes.

Public Attributes
double	initialPowerLevel
	initial power level for running inventory, in dBm

double	minPowerLevel
	minimum power level for running inventory, in dBm

double	maxPowerLevel
	maximum power level for running inventory, in dBm

int	initialQValue
	the maximum power level for running inventory, in dBm. More...

int	minQValue
	minimum Q value to use when running inventory

int	maxQValue
	maximum Q value to use when running inventory

int	session
	session number to use when running inventory (0, 1, 2 or 3)

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

int	sensitivity
	sensitivity level for running inventory, dB

double	powerLevelWrite
	power level for writing tags, in dBm

int	sensitivityWrite
	sensitivity level for writing tags, dB

boolean	setListenBeforeTalk
	whether to set reader's listen-before-talk setting

boolean	listenBeforeTalk
	the reader's listen-before-talk setting

int	maxRoundsPerSecond
	maximum number of inventory rounds per second (0 = no limit)

int	minTidBytes
	minimum number of TID memory bank bytes to return. More...

int	maxTidBytes
	maximum number of TID memory bank bytes to return (0 = don't read TID)

int	minUserBytes
	minimum number of USER memory bank bytes to return. More...

int	maxUserBytes
	maximum number of USER memory bank bytes to return (0 = don't read USER)

int	minReservedBytes
	minimum number of RESERVED memory bank bytes to return. More...

int	maxReservedBytes
	maximum number of RESERVED memory bank bytes to return (0 = don't read RESERVED)

boolean	continual
	whether the reader should run inventory until stopped

boolean	reportRssi
	whether the reader should report RSSI data (default is false)

boolean	detailedPerReadData
	whether the reader should report detailed per-read data (default is false)

int	detailedPerReadNumReads
	number of words to read in each per-read (0, 1 or 2)

MemoryBank	detailedPerReadMemoryBank1
	memory bank for per-read read 1

int	detailedPerReadWordOffset1
	word offset for per-read read 1

MemoryBank	detailedPerReadMemoryBank2
	memory bank for per-read read 2

int	detailedPerReadWordOffset2
	word offset for per-read read 2

boolean	reportSubsequentFinds
	whether to report subsequent finds of the same tag

boolean	forceTari25
	whether to force a Tari of 25uS (useful for some sensor tags) - requires firmware 1.10.4 or above

boolean	delayAfterSelect
	whether to delay for 3ms after SELECT (useful for some sensor tags) - requires firmware 1.10.4 or above

boolean	singleFindMode
	whether to use single find mode (find one tag only) - requires firmware 1.12.5 or above

boolean	singleFindContinueInventory
	whether to stop inventory in singleFindMode after tag is found - requires firmware 1.12.5 or above

SingleFindRampPowerModes	singleFindRampPowerMode
	if and how to ramp power from min to max in singleFindMode - requires firmware 1.12.5 or above

SoundTypes	soundType
	type of sounds to make when tags are found

double	volume
	volume level (0...1)

int	historyIntervalMSec
	length of each history period (default is 500ms)

int	historyDepth
	number of history periods (default is 20)

byte	selectMask []
	mask to use in SELECT before inventory round. More...

int	selectMaskBitLength
	length of the mask, in bits. More...

int	selectOffset
	bit offset for SELECT

MemoryBank	selectBank
	memory bank for SELECT

boolean	useLocalSoundIfPossible
	whether tyo use local soun if possible (USB)

boolean	hf
	whether to use HF inventory

boolean	hfInventoryISO15693
	whether to look for ISO 15693 tags when running inventory

boolean	hfInventoryISO14443A
	whether to look for ISO 14443A tags when running inventory

boolean	hfInventoryTopaz
	whether to look for Topaz tags when running inventory

boolean	hfInventoryFelica
	whether to look for Felica tags when running inventory

boolean	hfIso15693use16slots
	whether to use 16 slots for HF inventory

Member Function Documentation

◆ forInventoryType() [1/2]

static UgiRfidConfiguration com.ugrokit.api.UgiRfidConfiguration.forInventoryType ( InventoryTypes inventoryType )

static

Get the RFID configuration for a given type.

Parameters

inventoryType Inventory type

Returns: Configuration

◆ forInventoryType() [2/2]

static UgiRfidConfiguration com.ugrokit.api.UgiRfidConfiguration.forInventoryType ( int inventoryType )

static

Get the RFID configuration for a given int type.

Parameters

inventoryType Inventory type

Returns: Configuration

◆ getNumInventoryTypes()

static int com.ugrokit.api.UgiRfidConfiguration.getNumInventoryTypes ( )

static

Get the number of pre-defined inventory types.

Returns: Number of pre-defined inventory types

◆ getNameForInventoryType()

static String com.ugrokit.api.UgiRfidConfiguration.getNameForInventoryType ( int inventoryType )

static

Get the name for an inventory type (unlocalized)

Parameters

inventoryType One of UgiInventoryTypes

Returns: Name

◆ getMinAllowablePowerLevel()

static double com.ugrokit.api.UgiRfidConfiguration.getMinAllowablePowerLevel ( )

static

Get the minimum power value (dBm)

Returns: Minimum power value (dBm)

◆ getMaxAllowablePowerLevel()

static double com.ugrokit.api.UgiRfidConfiguration.getMaxAllowablePowerLevel ( )

static

Get the maximum power value (dBm)

Returns: Maximum power value (dBm)

◆ getMinAllowableQValue()

static int com.ugrokit.api.UgiRfidConfiguration.getMinAllowableQValue ( )

static

Get the minimum Q value.

Returns: Minimum Q value

◆ getMaxAllowableQValue()

static int com.ugrokit.api.UgiRfidConfiguration.getMaxAllowableQValue ( )

static

Get the maximum Q value.

Returns: Maximum Q value

◆ getMaxAllowableRoundsWithNoFindsToToggleAB()

static int com.ugrokit.api.UgiRfidConfiguration.getMaxAllowableRoundsWithNoFindsToToggleAB ( )

static

Get the maximum value for roundsWithNoFindsToToggleAB.

Returns: Maximum value for roundsWithNoFindsToToggleAB

◆ getMaxAllowableMemoryBankBytes()

static int com.ugrokit.api.UgiRfidConfiguration.getMaxAllowableMemoryBankBytes ( )

static

Get the maximum value for maxTidBytes/maxReservedBytes/maxUserBytes.

Returns: Maximum value for maxTidBytes/maxReservedBytes/maxUserBytes

Member Data Documentation

◆ initialQValue

int com.ugrokit.api.UgiRfidConfiguration.initialQValue

the maximum power level for running inventory, in dBm.

The reader will start with this Q value, but will vary down to minQValue and up to maxQValue based on the number of tags in the environment.

◆ minTidBytes

int com.ugrokit.api.UgiRfidConfiguration.minTidBytes

minimum number of TID memory bank bytes to return.

If the TID memory size is known, set minTidBytes=maxTidBytes

◆ minUserBytes

int com.ugrokit.api.UgiRfidConfiguration.minUserBytes

minimum number of USER memory bank bytes to return.

If the USER memory size is known, set minUserBytes=maxuserBytes

◆ minReservedBytes

int com.ugrokit.api.UgiRfidConfiguration.minReservedBytes

minimum number of RESERVED memory bank bytes to return.

If the RESERVED memory size is known, set minReservedBytes=maxReservedBytes

◆ selectMask

byte com.ugrokit.api.UgiRfidConfiguration.selectMask[]

mask to use in SELECT before inventory round.

If null (the default) then no SELECT is done before each inventory

◆ selectMaskBitLength

int com.ugrokit.api.UgiRfidConfiguration.selectMaskBitLength

length of the mask, in bits.

If zero, then selectMask.length*8 is used

Public Attributes
	NoRamp =(0)
	Do not ramp power (normal power setting)

	Slow =(1)
	Ramp power slowly (250 rounds from lowest to highest, about 4 seconds)

	Medium =(2)
	Ramp power medium (125 rounds from lowest to highest, about 2 seconds)

	Fast =(3)
	Ramp power quickly (50 rounds from lowest to highest, about 1 second)

Public Attributes
	Reserved =(0)
	Gen2 RESERVED memory bank.

	Epc =(1)
	Gen2 EPC memory bank.

	Tid =(2)
	Gen2 TID memory bank.

	User =(3)
	Gen2 USER memory bank.

Public Attributes
	NONE =(0)
	Make no sounds.

	GEIGER_COUNTER =(1)
	Geiger counter sounds when epc(s) are found.

	FIRST_FIND =(2)
	Found-item sound once when epc is first found.

	FIRST_FIND_AND_LAST =(6)
	Found-item sound once when epc is first found and special sound for last tag.

Static Public Member Functions
static InventoryTypes	fromInt (int i)
	Get an Inventory type for an undelying int value. More...

Public Attributes
	LOCATE_DISTANCE =(1)
	locate at a distance

	INVENTORY_SHORT_RANGE =(2)
	inventory (count) at short range, especially in dense environments

	INVENTORY_DISTANCE =(3)
	inventory (count) at a distance

	LOCATE_SHORT_RANGE =(4)
	locate at a short range

	LOCATE_VERY_SHORT_RANGE =(5)
	locate at very short range. This uses very low power and thus yields much longer battery life

	SINGLE_FIND =(6)
	find a single tag

	HF_INVENTORY =(7)
	Run inventory for HF tags.

	HF_SINGLE_FIND =(8)
	Find a single HF tag.

Overview

Static Public Member Functions

Classes

Static Public Attributes

Public Attributes

Member Function Documentation

◆ forInventoryType() [1/2]

◆ forInventoryType() [2/2]

◆ getNumInventoryTypes()

◆ getNameForInventoryType()

◆ getMinAllowablePowerLevel()

◆ getMaxAllowablePowerLevel()

◆ getMinAllowableQValue()

◆ getMaxAllowableQValue()

◆ getMaxAllowableRoundsWithNoFindsToToggleAB()

◆ getMaxAllowableMemoryBankBytes()

Member Data Documentation

◆ initialQValue

◆ minTidBytes

◆ minUserBytes

◆ minReservedBytes

◆ selectMask

◆ selectMaskBitLength

Overview

Public Attributes

Overview

Public Attributes

Overview

Public Attributes

Overview

Static Public Member Functions

Public Attributes

Member Function Documentation

◆ fromInt()