com.ugrokit.api.UgiInventoryDelegate Interface Reference

Overview

A UgiInventoryDelegate object is passed to the startInventory method of the Ugi singleton.

This object receives notification when inventory events happen.

All of the methods are optional, the delegate only implements the methods it needs.

Classes

interface  InventoryDidStartListener
 Interface to implement to get inventoryDidStart notification. More...
 
interface  InventoryDidStopListener
 Interface to implement to get inventoryDidStop notification. More...
 
interface  InventoryFilterListener
 Interface to implement to get inventoryFilter notification. More...
 
interface  InventoryFilterLowLevelListener
 Interface to implement to get inventoryFilterLowLevel notification. More...
 
interface  InventoryHistoryIntervalListener
 Interface to implement to get inventoryHistoryInterval notification. More...
 
interface  InventoryTagChangedListener
 Interface to implement to get inventoryTagChanged notification. More...
 
interface  InventoryTagFoundListener
 Interface to implement to get inventoryTagFound notification. More...
 
interface  InventoryTagSubsequentFindsListener
 Interface to implement to get inventoryTagSubsequentFinds notification. More...
 
com.ugrokit.api.UgiInventoryDelegate.InventoryDidStartListener Interface Reference

Overview

Interface to implement to get inventoryDidStart notification.

Public Member Functions

void inventoryDidStart ()
 The reader has started doing inventory. More...
 

Member Function Documentation

◆ inventoryDidStart()

void com.ugrokit.api.UgiInventoryDelegate.InventoryDidStartListener.inventoryDidStart ( )

The reader has started doing inventory.

This can happen multiple times during a single startInventory call, since the reader can be connected and disconnected from the host.

com.ugrokit.api.UgiInventoryDelegate.InventoryTagChangedListener Interface Reference

Overview

Interface to implement to get inventoryTagChanged notification.

Public Member Functions

void inventoryTagChanged (UgiTag tag, boolean firstFind)
 The visibility of a tag has changed. More...
 

Member Function Documentation

◆ inventoryTagChanged()

void com.ugrokit.api.UgiInventoryDelegate.InventoryTagChangedListener.inventoryTagChanged ( UgiTag  tag,
boolean  firstFind 
)

The visibility of a tag has changed.

  • A tag has been found for the first time
  • A tag has not been seen for the history period (interval * depth)
  • A tag that had not been seen for the history period has reappeared
Parameters
tagThe tag that has changed
firstFindtrue if this is the first time this tag has been found
com.ugrokit.api.UgiInventoryDelegate.InventoryTagFoundListener Interface Reference

Overview

Interface to implement to get inventoryTagFound notification.

Public Member Functions

void inventoryTagFound (UgiTag tag, UgiInventory.DetailedPerReadData[] detailedPerReadData)
 A new tag has been found. More...
 

Member Function Documentation

◆ inventoryTagFound()

void com.ugrokit.api.UgiInventoryDelegate.InventoryTagFoundListener.inventoryTagFound ( UgiTag  tag,
UgiInventory.DetailedPerReadData []  detailedPerReadData 
)

A new tag has been found.

Parameters
tagThe tag that has been found
detailedPerReadDataArray of UgiDetailedPerReadData obejcts, if detailed per-read data was requested
com.ugrokit.api.UgiInventoryDelegate.InventoryFilterLowLevelListener Interface Reference

Overview

Interface to implement to get inventoryFilterLowLevel notification.

Public Member Functions

boolean inventoryFilterLowLevel (byte[] epc)
 Filter out a tag at the raw EPC level – this is called on an arbitrary thread and must work very quickly. More...
 

Member Function Documentation

◆ inventoryFilterLowLevel()

boolean com.ugrokit.api.UgiInventoryDelegate.InventoryFilterLowLevelListener.inventoryFilterLowLevel ( byte []  epc)

Filter out a tag at the raw EPC level – this is called on an arbitrary thread and must work very quickly.

Parameters
epcThe EPC to filter
Returns
true to filter out the tag (the default is to not filter out any tags)
com.ugrokit.api.UgiInventoryDelegate.InventoryHistoryIntervalListener Interface Reference

Overview

Interface to implement to get inventoryHistoryInterval notification.

Public Member Functions

void inventoryHistoryInterval ()
 A history interval has passed.
 
com.ugrokit.api.UgiInventoryDelegate.InventoryFilterListener Interface Reference

Overview

Interface to implement to get inventoryFilter notification.

Public Member Functions

boolean inventoryFilter (UgiEpc epc)
 Determine whether a newly found tag should be filtered out (not sent to inventoryTagFound or inventoryTagChanged, not put into the tags array). More...
 

Member Function Documentation

◆ inventoryFilter()

boolean com.ugrokit.api.UgiInventoryDelegate.InventoryFilterListener.inventoryFilter ( UgiEpc  epc)

Determine whether a newly found tag should be filtered out (not sent to inventoryTagFound or inventoryTagChanged, not put into the tags array).

Parameters
epcThe new EPC the reader has found
Returns
true to filter out the EPC (the default is to not filter out any EPCs)
com.ugrokit.api.UgiInventoryDelegate.InventoryDidStopListener Interface Reference

Overview

Interface to implement to get inventoryDidStop notification.

Public Member Functions

void inventoryDidStop (int completedResult)
 The reader has stopped doing inventory. More...
 

Public Attributes

int UGI_INVENTORY_COMPLETED_OK = 0
 Values passed to inventoryDidStopWithResult. More...
 
int UGI_INVENTORY_COMPLETED_ERROR_SENDING = 98
 Error sending inventory command to reader.
 
int UGI_INVENTORY_COMPLETED_LOST_CONNECTION = 99
 Lost connection.
 
int UGI_INVENTORY_COMPLETED_SPI_NOT_WORKING = 1
 Reader error.
 
int UGI_INVENTORY_COMPLETED_ENABLE_PIN_NOT_WORKING = 2
 Reader error.
 
int UGI_INVENTORY_COMPLETED_INTERRUPT_PIN_NOT_WORKING = 3
 Reader error.
 
int UGI_INVENTORY_COMPLETED_HF_NOT_SUPPORTED = 4
 Reader error.
 
int UGI_INVENTORY_COMPLETED_CRYSTAL_NOT_STABLE = 5
 Reader error.
 
int UGI_INVENTORY_COMPLETED_PLL_NOT_LOCKED = 6
 Reader error.
 
int UGI_INVENTORY_COMPLETED_BATTERY_TOO_LOW = 7
 Battery level is too low to run inventory.
 
int UGI_INVENTORY_COMPLETED_TEMPERATURE_TOO_HIGH =8
 Grokker temperature is too high. This should only happen in a very hot environment.
 
int UGI_INVENTORY_COMPLETED_NOT_PROVISIONED =9
 Grokker is not provisioned. This should never happen.
 
int UGI_INVENTORY_COMPLETED_REGION_NOT_SET =10
 The region (of the world) has not been set.
 

Member Function Documentation

◆ inventoryDidStop()

void com.ugrokit.api.UgiInventoryDelegate.InventoryDidStopListener.inventoryDidStop ( int  completedResult)

The reader has stopped doing inventory.

This can happen multiple times during a single startInventory call, since the reader can be connected and disconnected from the host.

Parameters
completedResultResult of inventory: UGI_INVENTORY_COMPLETED_xxx

Member Data Documentation

◆ UGI_INVENTORY_COMPLETED_OK

int com.ugrokit.api.UgiInventoryDelegate.InventoryDidStopListener.UGI_INVENTORY_COMPLETED_OK = 0

Values passed to inventoryDidStopWithResult.

Inventory completed normally

com.ugrokit.api.UgiInventoryDelegate.InventoryTagSubsequentFindsListener Interface Reference

Overview

Interface to implement to get inventoryTagSubsequentFinds notification.

Public Member Functions

void inventoryTagSubsequentFinds (UgiTag tag, int count, UgiInventory.DetailedPerReadData[] detailedPerReadData)
 A previously found tag has been found again. More...
 

Member Function Documentation

◆ inventoryTagSubsequentFinds()

void com.ugrokit.api.UgiInventoryDelegate.InventoryTagSubsequentFindsListener.inventoryTagSubsequentFinds ( UgiTag  tag,
int  count,
UgiInventory.DetailedPerReadData []  detailedPerReadData 
)

A previously found tag has been found again.

Parameters
tagThe tag
countThe number of finds since inventoryTagSubsequentFinds was last called
detailedPerReadDataArray of UgiDetailedPerReadData obejcts, if detailed per-read data was requested