Class: UgiInventoryDelegate

UgiInventoryDelegate()

This class documents the methods of the delegate object passed to ugi.startInventory() and constants constants used in those methods.

Constructor

new UgiInventoryDelegate()

Source:

Members

(static, readonly) InventoryCompletedReturnValues :Number

Values passed to ugiInventoryDidStop()
Type:
  • Number
Properties:
Name Type Description
OK Number Inventory completed normally
ERROR_SENDING Number Error sending inventory command to reader
LOST_CONNECTION Number Lost connection to the reader
SPI_NOT_WORKING Number Reader error
ENABLE_PIN_NOT_WORKING Number Reader error
INTERRUPT_PIN_NOT_WORKING Number Reader error
HF_NOT_SUPPORTED Number
CRYSTAL_NOT_STABLE Number Reader error
PLL_NOT_LOCKED Number Reader error
BATTERY_TOO_LOW Number Battery
TEMPERATURE_TOO_HIGH Number Temperature
NOT_PROVISIONED Number Reader error
REGION_NOT_SET Number Region must be set
Source:

Methods

ugiInventoryDidStart()

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.
Source:

ugiInventoryDidStop(result)

The reader has stopped doing inventory
Parameters:
Name Type Description
result Result of inventory (UgiInventoryDelegate.InventoryCompletedReturnValues.xxx)
Source:

ugiInventoryHistoryInterval()

A history interval has passed. This method is called at the end of each history interval IF one or more tags are currently visible
Source:

ugiInventoryTagChanged(tag, 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:
Name Type Description
tag The tag that has changed
firstFind YES if this is the first time this tag has been found
Source:

ugiInventoryTagFound(tag, detailedPerReadData)

A new tag has been found
Parameters:
Name Type Description
tag The tag that was found
detailedPerReadData Array of UgiDetailedPerReadData obejcts, if detailed per-read data was requested
Source:

ugiInventoryTagSubsequentFinds(tag, count, detailedPerReadData)

A previously found tag has been found again
Parameters:
Name Type Description
tag The tag
count The number of finds since ugiInventoryTagSubsequentFinds was last called
detailedPerReadData Array of UgiDetailedPerReadData obejcts, if detailed per-read data was requested
Source: