UGrokItApi.UgiRfidConfiguration Class Reference

Overview

RFID configuration instances, used by startInventory(). Common configuration instances are provided.

Class Methods

static UgiRfidConfiguration ConfigWithInventoryType (InventoryTypes type)
 Create a configuration object from a pre-defined inventory type More...
 
static string GetNameForInventoryType (int inventoryType)
 Get the name for a pre-defined inventory type (unlocalized) More...
 

Properties

double InitialPowerLevel [get, set]
 Initial power level for running inventory, in dBm. The reader will start at this power level, but will vary down to minPowerLevel and up to maxPowerLevel More...
 
double MinPowerLevel [get, set]
 Minimum power level for running inventory, in dBm More...
 
double MaxPowerLevel [get, set]
 Maximum power level for running inventory, in dBm More...
 
int InitialQValue [get, set]
 Initial Q value to use when running inventory. 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. More...
 
int MinQValue [get, set]
 Minimum Q value to use when running inventory More...
 
int MaxQValue [get, set]
 Maximum Q value to use when running inventory More...
 
int Session [get, set]
 Session number to use when running inventory (0, 1, 2 or 3) More...
 
int RoundsWithNoFindsToToggleAB [get, set]
 Number of inventory rounds with no finds after which to toggle A/B (0 = never toggle) More...
 
int Sensitivity [get, set]
 Sensitivity level for running inventory, db More...
 
double PowerLevelWrite [get, set]
 Power level for writing tags, in dBm More...
 
int SensitivityWrite [get, set]
 Sensitivity level for writing tags, dB More...
 
bool SetListenBeforeTalk [get, set]
 true for reader to use this listen-before-talk setting, if allowed (default is false) More...
 
bool ListenBeforeTalk [get, set]
 true for reader to listen-before-talk (default is false) More...
 
int MaxRoundsPerSecond [get, set]
 Maximum number of inventory rounds per second (0 = no limit) More...
 
int MinTidBytes [get, set]
 Minimum number of TID memory bank bytes to return. If the TID memory size is known, set minTidBytes=maxTidBytes More...
 
int MaxTidBytes [get, set]
 Maximum number of TID memory bank bytes to return (0 = don't read TID). More...
 
int MinUserBytes [get, set]
 Minimum number of USER memory bank bytes to return. If the USER memory size is known, set minUserBytes=maxUserBytes More...
 
int MaxUserBytes [get, set]
 Maximum number of USER memory bank bytes to return (0 = don't read USER). More...
 
int MinReservedBytes [get, set]
 Minimum number of RESERVED memory bank bytes to return. If the RESERVED memory size is known, set minReservedBytes=maxReservedBytes More...
 
int MaxReservedBytes [get, set]
 Maximum number of RESERVED memory bank bytes to return (0 = don't read RESERVED). More...
 
byte [] SelectMask [get, set]
 Mask to use in SELECT before inventory round. If nil (the default) then no SELECT is done before each inventory More...
 
int SelectMaskBitLength [get, set]
 Length of the mask, in bits. If zero, then selectMask.length*8 is used More...
 
int SelectOffset [get, set]
 Bit offset for SELECT More...
 
MemoryBank SelectBank [get, set]
 Memory bank for SELECT More...
 
bool Continual [get, set]
 true to run inventory until stopped, NO to run inventory once (default is true) More...
 
bool ReportRssi [get, set]
 true for reader to report RSSI data (default is false) More...
 
bool DetailedPerReadData [get, set]
 true for reader to report detailed data for each read (default is false) More...
 
int DetailedPerReadNumReads [get, set]
 Number of words for reader to read every time the tags is read (0, 1, or 2) More...
 
MemoryBank DetailedPerReadMemoryBank1 [get, set]
 memory bank #1 to read for detailed per-read More...
 
int DetailedPerReadWordOffset1 [get, set]
 word offset #1 to read for detailed per-read More...
 
MemoryBank DetailedPerReadMemoryBank2 [get, set]
 memory bank #2 to read for detailed per-read More...
 
int DetailedPerReadWordOffset2 [get, set]
 word offset #2 to read for detailed per-read More...
 
bool ReportSubsequentFinds [get, set]
 true to report subsequent finds More...
 
bool ForceTari25 [get, set]
 true to force a Tari of 25uS (useful for some sensor tags) - requires firmware 1.10.4 or above More...
 
bool DelayAfterSelect [get, set]
 true to delay for 3ms after SELECT (useful for some sensor tags) - requires firmware 1.10.4 or above More...
 
bool SingleFindMode [get, set]
 true to use single find mode (find one tag only) - requires firmware 1.12.5 or above More...
 
bool SingleFindContinueInventory [get, set]
 true to stop inventory in singleFindMode after tag is found - requires firmware 1.12.5 or above More...
 
SingleFindRampPowerModes SingleFindRampPowerMode [get, set]
 If and how to ramp power from min to max in singleFindMode - requires firmware 1.12.5 or above More...
 
SoundTypes SoundType [get, set]
 Type of sounds to make when tags are found More...
 
double Volume [get, set]
 Volume level (0...1) More...
 
int HistoryIntervalMSec [get, set]
 Length of each history period (default is 500ms) More...
 
int HistoryDepth [get, set]
 Number of history periods (default is 20) More...
 
static double MinAllowablePowerLevel [get]
 Gets the minimum allowable power level (dBm) More...
 
static double MaxAllowablePowerLevel [get]
 Gets the maximum allowable power level (dBm) More...
 
static int MinAllowableQValue [get]
 Gets the minimum allowable Q value. More...
 
static int MaxAllowableQValue [get]
 Gets the maximum allowable Q value. More...
 
static int MaxAllowableRoundsWithNoFindsToToggleAB [get]
 Gets the maximum allowable value for roundsWithNoFindsToToggleAB More...
 
static int MaxAllowableMemoryBankBytes [get]
 Gets the maximum allowable value for maxTidBytes/maxReservedBytes/maxUserBytes More...
 
static int NumInventoryTypes [get]
 Gets the number of pre-defined inventory types More...
 

Types

enum  SoundTypes { SoundTypes.None, SoundTypes.GeigerCounter, SoundTypes.FirstFind, SoundTypes.FirstFindAndLast }
 Sound types. More...
 
enum  MemoryBank { MemoryBank.Reserved, MemoryBank.Epc, MemoryBank.Tid, MemoryBank.User }
 References for the four RFID tag memory banks that can be written to More...
 
enum  SingleFindRampPowerModes { SingleFindRampPowerModes.NoRamp, SingleFindRampPowerModes.Slow, SingleFindRampPowerModes.Medium, SingleFindRampPowerModes.Fast }
 Values for singleFindRampPowerMode More...
 
enum  InventoryTypes {
  InventoryTypes.LocateDistance = 1, InventoryTypes.InventoryShortRange = 2, InventoryTypes.InventoryDistance = 3, InventoryTypes.LocateShortRange = 4,
  InventoryTypes.LocateVeryShortRange = 5, InventoryTypes.SingleFind = 6
}
 Pre-defined inventory types More...
 

Instance Method Documentation

◆ ConfigWithInventoryType()

static UgiRfidConfiguration UGrokItApi.UgiRfidConfiguration.ConfigWithInventoryType ( InventoryTypes  type)
inlinestatic

Create a configuration object from a pre-defined inventory type

Parameters
typeInventoryTypes.xxx
Returns
Configuration

◆ GetNameForInventoryType()

static string UGrokItApi.UgiRfidConfiguration.GetNameForInventoryType ( int  inventoryType)
inlinestatic

Get the name for a pre-defined inventory type (unlocalized)

Returns
name
Parameters
inventoryTypeInventory type.

Property Documentation

◆ InitialPowerLevel

double UGrokItApi.UgiRfidConfiguration.InitialPowerLevel
getset

Initial power level for running inventory, in dBm. The reader will start at this power level, but will vary down to minPowerLevel and up to maxPowerLevel

The initial power level.

◆ MinPowerLevel

double UGrokItApi.UgiRfidConfiguration.MinPowerLevel
getset

Minimum power level for running inventory, in dBm

The minimum power level.

◆ MaxPowerLevel

double UGrokItApi.UgiRfidConfiguration.MaxPowerLevel
getset

Maximum power level for running inventory, in dBm

The max power level.

◆ InitialQValue

int UGrokItApi.UgiRfidConfiguration.InitialQValue
getset

Initial Q value to use when running inventory. 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.

The initial Q value.

◆ MinQValue

int UGrokItApi.UgiRfidConfiguration.MinQValue
getset

Minimum Q value to use when running inventory

The minimum Q value.

◆ MaxQValue

int UGrokItApi.UgiRfidConfiguration.MaxQValue
getset

Maximum Q value to use when running inventory

The max Q value.

◆ Session

int UGrokItApi.UgiRfidConfiguration.Session
getset

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

The session.

◆ RoundsWithNoFindsToToggleAB

int UGrokItApi.UgiRfidConfiguration.RoundsWithNoFindsToToggleAB
getset

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

The rounds with no finds to toggle A/B

◆ Sensitivity

int UGrokItApi.UgiRfidConfiguration.Sensitivity
getset

Sensitivity level for running inventory, db

The sensitivity.

◆ PowerLevelWrite

double UGrokItApi.UgiRfidConfiguration.PowerLevelWrite
getset

Power level for writing tags, in dBm

The power level write.

◆ SensitivityWrite

int UGrokItApi.UgiRfidConfiguration.SensitivityWrite
getset

Sensitivity level for writing tags, dB

The sensitivity write.

◆ SetListenBeforeTalk

bool UGrokItApi.UgiRfidConfiguration.SetListenBeforeTalk
getset

true for reader to use this listen-before-talk setting, if allowed (default is false)

true if set listen before talk; otherwise, false.

◆ ListenBeforeTalk

bool UGrokItApi.UgiRfidConfiguration.ListenBeforeTalk
getset

true for reader to listen-before-talk (default is false)

true if listen before talk; otherwise, false.

◆ MaxRoundsPerSecond

int UGrokItApi.UgiRfidConfiguration.MaxRoundsPerSecond
getset

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

The max rounds per second.

◆ MinTidBytes

int UGrokItApi.UgiRfidConfiguration.MinTidBytes
getset

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

The minimum TID bytes.

◆ MaxTidBytes

int UGrokItApi.UgiRfidConfiguration.MaxTidBytes
getset

Maximum number of TID memory bank bytes to return (0 = don't read TID).

The max TID bytes.

◆ MinUserBytes

int UGrokItApi.UgiRfidConfiguration.MinUserBytes
getset

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

The minimum USER bytes.

◆ MaxUserBytes

int UGrokItApi.UgiRfidConfiguration.MaxUserBytes
getset

Maximum number of USER memory bank bytes to return (0 = don't read USER).

The max USER bytes.

◆ MinReservedBytes

int UGrokItApi.UgiRfidConfiguration.MinReservedBytes
getset

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

The minimum RESERVED bytes.

◆ MaxReservedBytes

int UGrokItApi.UgiRfidConfiguration.MaxReservedBytes
getset

Maximum number of RESERVED memory bank bytes to return (0 = don't read RESERVED).

The max RESERVED bytes.

◆ SelectMask

byte [] UGrokItApi.UgiRfidConfiguration.SelectMask
getset

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

The select mask.

◆ SelectMaskBitLength

int UGrokItApi.UgiRfidConfiguration.SelectMaskBitLength
getset

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

The length of the select mask bit.

◆ SelectOffset

int UGrokItApi.UgiRfidConfiguration.SelectOffset
getset

Bit offset for SELECT

The select offset.

◆ SelectBank

MemoryBank UGrokItApi.UgiRfidConfiguration.SelectBank
getset

Memory bank for SELECT

The select bank.

◆ Continual

bool UGrokItApi.UgiRfidConfiguration.Continual
getset

true to run inventory until stopped, NO to run inventory once (default is true)

true if continual; otherwise, false.

◆ ReportRssi

bool UGrokItApi.UgiRfidConfiguration.ReportRssi
getset

true for reader to report RSSI data (default is false)

true if report rssi; otherwise, false.

◆ DetailedPerReadData

bool UGrokItApi.UgiRfidConfiguration.DetailedPerReadData
getset

true for reader to report detailed data for each read (default is false)

true if detailed per read data; otherwise, false.

◆ DetailedPerReadNumReads

int UGrokItApi.UgiRfidConfiguration.DetailedPerReadNumReads
getset

Number of words for reader to read every time the tags is read (0, 1, or 2)

The detailed per read number reads.

◆ DetailedPerReadMemoryBank1

MemoryBank UGrokItApi.UgiRfidConfiguration.DetailedPerReadMemoryBank1
getset

memory bank #1 to read for detailed per-read

The detailed per read memory bank1.

◆ DetailedPerReadWordOffset1

int UGrokItApi.UgiRfidConfiguration.DetailedPerReadWordOffset1
getset

word offset #1 to read for detailed per-read

The detailed per read word offset1.

◆ DetailedPerReadMemoryBank2

MemoryBank UGrokItApi.UgiRfidConfiguration.DetailedPerReadMemoryBank2
getset

memory bank #2 to read for detailed per-read

The detailed per read memory bank2.

◆ DetailedPerReadWordOffset2

int UGrokItApi.UgiRfidConfiguration.DetailedPerReadWordOffset2
getset

word offset #2 to read for detailed per-read

The detailed per read word offset2.

◆ ReportSubsequentFinds

bool UGrokItApi.UgiRfidConfiguration.ReportSubsequentFinds
getset

true to report subsequent finds

true if report subsequent finds; otherwise, false.

◆ ForceTari25

bool UGrokItApi.UgiRfidConfiguration.ForceTari25
getset

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

true if force-tari-25; otherwise, false.

◆ DelayAfterSelect

bool UGrokItApi.UgiRfidConfiguration.DelayAfterSelect
getset

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

true if delay-after-select; otherwise, false.

◆ SingleFindMode

bool UGrokItApi.UgiRfidConfiguration.SingleFindMode
getset

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

true if single-find-mode; otherwise, false.

◆ SingleFindContinueInventory

bool UGrokItApi.UgiRfidConfiguration.SingleFindContinueInventory
getset

true to stop inventory in singleFindMode after tag is found - requires firmware 1.12.5 or above

true if single-find-continue-inventory; otherwise, false.

◆ SingleFindRampPowerMode

SingleFindRampPowerModes UGrokItApi.UgiRfidConfiguration.SingleFindRampPowerMode
getset

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

ramp mode

◆ SoundType

SoundTypes UGrokItApi.UgiRfidConfiguration.SoundType
getset

Type of sounds to make when tags are found

The type of the sound.

◆ Volume

double UGrokItApi.UgiRfidConfiguration.Volume
getset

Volume level (0...1)

The volume.

◆ HistoryIntervalMSec

int UGrokItApi.UgiRfidConfiguration.HistoryIntervalMSec
getset

Length of each history period (default is 500ms)

The history interval M sec.

◆ HistoryDepth

int UGrokItApi.UgiRfidConfiguration.HistoryDepth
getset

Number of history periods (default is 20)

The history depth.

◆ MinAllowablePowerLevel

double UGrokItApi.UgiRfidConfiguration.MinAllowablePowerLevel
staticget

Gets the minimum allowable power level (dBm)

The minimum allowable power level (dBm)

◆ MaxAllowablePowerLevel

double UGrokItApi.UgiRfidConfiguration.MaxAllowablePowerLevel
staticget

Gets the maximum allowable power level (dBm)

The maximum allowable power level (dBm)

◆ MinAllowableQValue

int UGrokItApi.UgiRfidConfiguration.MinAllowableQValue
staticget

Gets the minimum allowable Q value.

The minimum allowable Q value.

◆ MaxAllowableQValue

int UGrokItApi.UgiRfidConfiguration.MaxAllowableQValue
staticget

Gets the maximum allowable Q value.

The maximum allowable Q value.

◆ MaxAllowableRoundsWithNoFindsToToggleAB

int UGrokItApi.UgiRfidConfiguration.MaxAllowableRoundsWithNoFindsToToggleAB
staticget

Gets the maximum allowable value for roundsWithNoFindsToToggleAB

The maximum allowable value for roundsWithNoFindsToToggleAB

◆ MaxAllowableMemoryBankBytes

int UGrokItApi.UgiRfidConfiguration.MaxAllowableMemoryBankBytes
staticget

Gets the maximum allowable value for maxTidBytes/maxReservedBytes/maxUserBytes

The maximum allowable value for maxTidBytes/maxReservedBytes/maxUserBytes

◆ NumInventoryTypes

int UGrokItApi.UgiRfidConfiguration.NumInventoryTypes
staticget

Gets the number of pre-defined inventory types

The number of pre-defined inventory types

Enumeration Documentation

◆ SoundTypes

Sound types.

Enumerator
None 

Make no sounds

GeigerCounter 

Geiger counter sounds when epc(s) are found

FirstFind 

Found-item sound once when epc is first found

FirstFindAndLast 

Found-item sound once when epc is first found and special sound for last tag

◆ MemoryBank

References for the four RFID tag memory banks that can be written to

Enumerator
Reserved 

Gen2 RESERVED memory bank

Epc 

Gen2 EPC memory bank

Tid 

Gen2 TID memory bank

User 

Gen2 USER memory bank

◆ SingleFindRampPowerModes

Values for singleFindRampPowerMode

Enumerator
NoRamp 

Do not ramp power (normal power setting)

Slow 

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

Medium 

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

Fast 

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

◆ InventoryTypes

Pre-defined inventory types

Enumerator
LocateDistance 

locate at a distance

InventoryShortRange 

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

InventoryDistance 

inventory (count) at a distance

LocateShortRange 

locate at a short range

LocateVeryShortRange 

locate at very short range

SingleFind 

Find a single tag