device.sdk

Class RFIDManager

java.lang.Object

device.sdk.RFIDManager

public class RFIDManager
extends java.lang.Object

This class enables user applications to connect, configure and control RFID reader.
The device may connect to RFID reader via Bluetooth, USB or UART interface.
This class is designed as a singleton. Rather than using new keyword, use static method getInstance to get (or create new) instance of this class.

Constructor Summary

Constructors

Constructor and Description
RFIDManager() Default constructor.

Method Summary

Modifier and Type	Method and Description
int	BlockErase(int length, int membank, int offset, java.lang.String password, int blockMode) Commands tag(s) to erase (zero-fill) several blocks in memory bank.
int	BlockWrite(int length, int membank, int offset, java.lang.String writeData, java.lang.String password, int blockMode) Commands tag(s) to write several blocks in memory bank.
int	ClearAllSearchList() Clears all list items used by RFIDManager.MultiSearch().
int	ClearSearchList(int index, int cnt) Clears a series of list items used by RFIDManager.MultiSearch().
void	Close() Closes current interface of the RFID reader.
void	ConnectBTDevice(java.lang.String macAddress, java.lang.String deviceName) Connects to the RFID reader in the Bluetooth mode.
void	DisconnectBTDevice() Disconnects from the RFID reader in the Bluetooth mode.
java.lang.String	GetAllChannel() Queries a list of enabled channels.
int	GetAntSelect(AntSelect antSelect) Queries a configuration for multiple antennas (UART only).
java.lang.String	GetAvailableRegion() Queries a set of available regions (UART only).
int	GetBatteryState() Queries the performance state of battery in RFID reader.
int	GetBattLevel() Queries current battery level of RFID reader.
java.lang.String	GetBtDevice() Gets the name of the connected RFID reader (Bluetooth only).
java.lang.String	GetBtMacAddr() Gets the MAC address of the connected RFID reader (Bluetooth only).
int	GetBuzzerVol() Gets the buzzer volume of RFID reader.
int	GetChannelState(ChannelState channelState) Queries availability of a channel.
int	GetChargingState() Queries whether the battery of RFID reader is charging.
void	GetCustomIntentConfig(CustomIntentConfig customIntentConfig) Queries a configuration for custom intent.
int	GetDataFormat() Queries tag ID format followed by RFIDManager.StartInventory() or tag accessing commands.
int	GetFastID() Queries FastID™ feature setting of RFID reader.
java.lang.String	GetFwVersion() Gets the firmware version of RFID reader.
static RFIDManager	getInstance() Returns (or creates) a singleton instance of RFID Manager.
int	GetInventoryParam(ParamOfInvent paramOfInvent) Queries parameters used by RFIDManager.StartInventory().
int	GetInventoryReportFormat_ext(ReportFormatOfInvent_ext reportFormatOfInvent_ext) Queries the extension report format of RFID inventory (UART only).
int	GetInventoryReportFormat(ReportFormatOfInvent reportFormatOfInvent) Queries the report format of RFID inventory.
int	GetLinkProfile() Queries the RF transceiver link profile of RFID reader.
int	GetMaxPower() Queries the Max. Tx power supported by RFID reader.
int	GetOperationMode(ModeOfInvent moi) Queries the inventory settings of RFID reader.
java.lang.String	GetPrefix() Queries a prefix string.
int	GetResultType() Queries current result notification type.
int	GetSearchList_ext(int index) Queries an item in the tag list used by RFIDManager.MultiSearch().
int	GetSearchList() Queries an entire list of tags used by RFIDManager.MultiSearch().
int	GetSelMask(SelConfig selConfig) Queries tag selection filter.
java.lang.String	GetSuffix() Queries a suffix string.
int	GetTagFocus() Queries TagFocus™ feature setting of RFID reader.
int	GetTerminatorType() Queries current type of the terminator.
int	GetTimer() Gets the internal timer value of RFID reader.
int	GetTxCycle(TxCycle txCycle) Queries Tx ON and OFF durations.
int	GetTxDataFormat() Queries the report format followed by a RFIDManager.StartInventory() command.
int	GetTxPower() Queries current Tx power modifier value of RFID reader.
int	GetVibState() Queries the vibration setting value of RFID reader.
boolean	IsOpened() Queries whether the RFID reader is opened.
int	KillTag(java.lang.String killPwd) Command RFID reader to kill (disable permanently) tag.
int	LockTag(int lockMask, int lockEnable, java.lang.String ACS_PWD) Command RFID reader to lock or unlock memory in tag.
int	MultiSearch() Commands RFID reader to search tags constrained by list of tag IDs.
int	Open(int openDevice) Opens an interface of the RFID reader. (should be called explicitly before using any other RFID APIs).
int	PermaLockTag(int lockMask, int lockEnable, java.lang.String ACS_PWD) Command RFID reader to lock or unlock memory in tag permanently.
int	ReadTag(int length, int membank, int offset, java.lang.String ACS_PWD) Command RFID reader to read memory of tag.
boolean	RegisterRFIDCallback(RFIDCallback callback) Registers a callback handler to be invoked when RFID reader state is changed.
int	SetAntSelect(AntSelect antSelect) Modifies a configuration for multiple antennas (UART only).
int	SetBuzzerVol(int volume) This function sets the buzzer volume of RFID reader.
int	SetChannelState(ChannelState channelState) Enables (or disables) a channel.
void	SetCustomIntentConfig(CustomIntentConfig customIntentConfig) Modifies a configuration for custom intent.
int	SetDataCase(int datacase) Modifies the letter case format when reading data from RFID tag.
int	SetDataFormat(int index) Modifies tag ID format followed by RFIDManager.StartInventory() or tag accessing commands.
int	SetDefaultConfig() Initializes the RFID reader to the default configuration.
int	SetDeviceBaudrate(int baudrate) Modifies the baud rate for UART connection (UART only).
int	SetFastID(int enable) Enables or disables FastID™ feature of RFID reader.
int	SetInventoryParam(ParamOfInvent paramOfInvent) Modifies parameters used by RFIDManager.StartInventory().
int	SetInventoryReportFormat_ext(ReportFormatOfInvent_ext reportFormatOfInvent_ext) Modifies the extension report format of RFID inventory (UART only).
int	SetInventoryReportFormat(ReportFormatOfInvent reportFormatOfInvent) Modifies the report format of RFID inventory
int	SetLinkProfile(int profile) Modifies the RF transceiver link profile of RFID reader.
int	SetOperationMode(ModeOfInvent moi) Modifies the inventory settings of RFID reader.
int	SetPrefix(java.lang.String prefix) Modifies a prefix string.
int	SetRegion(java.lang.String region) Modifies region setting for a device (UART only).
void	SetResultType(int resultType) Modifies the result notification type.
int	SetSearchList(int index, int length, java.lang.String tagId) Modifies a list of tags-of-interest used by RFIDManager.MultiSearch().
int	SetSelMask(SelConfig selConfig) Commands tags to mark themselves "selected" according to filter.
int	SetSuffix(java.lang.String suffix) Modifies a suffix string.
int	SetTagFocus(int enable) Enables or disables TagFocus™ feature of RFID reader.
void	SetTerminatorType(int teminatorType) Modifies type of the terminator.
int	SetTimer(int time) Sets the internal timer value of RFID reader.
int	SetTriggerMode(int mode) Modifies the trigger mode.
int	SetTxCycle(TxCycle txCycle) Modifies Tx ON and OFF durations.
int	SetTxDataFormat(int index) Modifies the report format followed by a RFIDManager.StartInventory() command.
int	SetTxPower(int pwr) Modifies Tx power modifier value of RFID reader.
int	SetVibState(int on) Modifies the vibration setting value of RFID reader.
int	SingleSearch(int length, java.lang.String tagId, int threshold, int step) Commands RFID reader to search a tag constrained by tag ID.
int	StartInventory() Command RFID reader to starts inventory tagging.
int	Stop() Command RFID reader to stop ongoing command.
boolean	UnregisterRFIDCallback(RFIDCallback callback) Unregisters a callback handler that was registered.
int	UpdateFirmware(java.io.File fwFile) Updates firmware for RFID reader (UART only).
int	WildcardSearch(int length, java.lang.String tagId) Commands RFID reader to search tags constrained by wildcards ('*' or '?') patterns.
int	WriteTag(int length, int membank, int offset, java.lang.String ACS_PWD, java.lang.String writeData) Command RFID reader to write memory of tag.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RFIDManager

public RFIDManager()

Default constructor. Rather than using new keyword, use the static method getInstance to get instance of this class.

See Also:

getInstance(void)

Method Detail

getInstance

public static RFIDManager getInstance()

Returns (or creates) a singleton instance of RFID Manager. Rather than using new keyword, use this method to get instance of this class.

Returns:

an instance of this class.

RegisterRFIDCallback

public boolean RegisterRFIDCallback(RFIDCallback callback)

Registers a callback handler to be invoked when RFID reader state is changed.

Parameters:

callback - The handler class which implements callback methods defined by RFIDCallback.

Returns:

true if registration is successful; false otherwise

UnregisterRFIDCallback

public boolean UnregisterRFIDCallback(RFIDCallback callback)

Unregisters a callback handler that was registered.

Parameters:

callback - The handler class which implements callback methods defined by RFIDCallback.

Returns:

true if unregistration is successful; false otherwise

ConnectBTDevice

public void ConnectBTDevice(java.lang.String macAddress,
                            java.lang.String deviceName)

Connects to the RFID reader in the Bluetooth mode. Try to connect to the RFID reader (designated by macAddress and deviceName) via Bluetooth. To check whether the connection is finished in success or not, register a handler which implements call back method RFIDCallback.onNotifyChangedState(int) beforehand. For successful connection, the state will be given as device.common.rfid.RFIDConst.DeviceState.BT_CONNECTED. Otherwise, the state device.common.rfid.RFIDConst.DeviceState.BT_CONNECT_FAILED will be given. Warning: Calling this method closes Bluetooth connection (currently establishing and already established).

Parameters:

macAddress - the hardware address of the RFID reader to connect to

deviceName - the device name of the RFID reader to connect to

DisconnectBTDevice

public void DisconnectBTDevice()

Disconnects from the RFID reader in the Bluetooth mode.

Open

public int Open(int openDevice)

Opens an interface of the RFID reader. (should be called explicitly before using any other RFID APIs).

Only one interface at a time is allowed. In case of switching interface (for example, from Bluetooth to USB), call RFIDManager.Close() and close any current (existing) interface before opening a new interface.

For Bluetooth type RFID reader:
before calling this method, call RFIDManager.ConnectBTDevice(java.lang.String, java.lang.String) and make sure the connection is successfully established.

Parameters:

openDevice - the device type to connect.
RFIDConst.DeviceType.DEVICE_BT for Bluetooth connection.
device.commond.rfid.RFIDConst.DeviceType#DEVICE_USB for USB connection.
RFIDConst.DeviceType.DEVICE_UART for UART connection.

Returns:

RFIDConst.CommandErr.SUCCESS for success in opening interface; RFIDConst.CommandErr.OPEN_FAILED otherwise.

See Also:

RFIDManager.IsOpened()

Close

public void Close()

Closes current interface of the RFID reader.

IsOpened

public boolean IsOpened()

Queries whether the RFID reader is opened.

Returns:

true if RFID reader is opened, false otherwise

See Also:

RFIDManager.Open(int)

GetBtDevice

public java.lang.String GetBtDevice()

Gets the name of the connected RFID reader (Bluetooth only).

Returns:

the name of the RFID reader.

See Also:

RFIDManager.GetBtDevice()

GetBtMacAddr

public java.lang.String GetBtMacAddr()

Gets the MAC address of the connected RFID reader (Bluetooth only).

Returns:

the MAC address of the RFID reader.

See Also:

RFIDManager.GetBtMacAddr()

SetDefaultConfig

public int SetDefaultConfig()

Initializes the RFID reader to the default configuration.

The default parameters are as below.

Parameter	Default value
Beep Volume	Max (2)
Vibrator	Disable (0)
Report State	Trigger / Low Battery
Report Battery	Disable
TX Cycle	On: 60ms, Off: 140ms(30%)
TX Power	0db (Max Power)
Session	Session_1 (1)
Q value	5(32 tags)
Target	Target_A (0)
MASK	Disable
LINK Profile	1
FastID	Disable
Tag Focus	Disable
Data Format	PC+EPC+CRC (0)
Transmission Format	Data As Is (0)
Prefix Data	NULL (0)
Suffix Data	NULL (0)
RFID Data Case	Lower (0)

Returns:

RFIDConst.CommandErr.SUCCESS for success in parameter configuration, RFIDConst.CommandErr.COMM_ERR otherwise

GetFwVersion

public java.lang.String GetFwVersion()

Gets the firmware version of RFID reader.

Returns:

a firmware version string, or null if error occurred

GetTimer

public int GetTimer()

Gets the internal timer value of RFID reader.

NOTE: This method is incompatible with UART-based RFID readers, such as PM500.

Returns:

the timer value (between 0x0 and 0xFF FF FF FF, unit: msec), or RFIDConst.CommandErr.COMM_ERR for communication problem.

See Also:

RFIDManager.SetTimer(int)

SetTimer

public int SetTimer(int time)

Sets the internal timer value of RFID reader.

NOTE: This method is incompatible with UART-based RFID readers, such as PM500.

Parameters:

time - initial timer value to set. Valid range is:

 0 ~ 0xFFFFFFFF (unit: msec)
 

Returns:

RFIDConst.CommandErr.SUCCESS for success in setting; RFIDConst.CommandErr.COMM_ERR otherwise.

See Also:

RFIDManager.GetTimer()

GetBuzzerVol

public int GetBuzzerVol()

Gets the buzzer volume of RFID reader.

NOTE: This method is incompatible with UART-based RFID readers, such as PM500.

Returns:

the buzzer volume. RFIDConst.DeviceConfig.BUZZER_HIGH : buzzer volume is set to high.
RFIDConst.DeviceConfig.BUZZER_LOW : buzzer volume is set to low.
RFIDConst.DeviceConfig.BUZZER_MUTE : buzzer volume is set to muted.
RFIDConst.CommandErr.COMM_ERR : communication error.

See Also:

RFIDManager.SetBuzzerVol(int)

SetBuzzerVol

public int SetBuzzerVol(int volume)

This function sets the buzzer volume of RFID reader. The setting value is stored in non-volatile internal memory. The setting value will remain persistent after power-off and on.

NOTE: This method is incompatible with UART-based RFID readers, such as PM500.

Parameters:

volume - the buzzer volume to set.
RFIDConst.DeviceConfig.BUZZER_HIGH
RFIDConst.DeviceConfig.BUZZER_LOW
RFIDConst.DeviceConfig.BUZZER_MUTE

Returns:

whether set success. Return type is as below. RFIDConst.CommandErr.SUCCESS for success in setting.
RFIDConst.CommandErr.COMM_ERR for communication error.
RFIDConst.CommandErr.WRONG_PARAM for invalid argument.

See Also:

#GetBuzzerVol(void)

GetBattLevel

public int GetBattLevel()

Queries current battery level of RFID reader.

NOTE: This method is incompatible with UART-based RFID readers, such as PM500.

Returns:

the battery level (0 - 100), or RFIDConst.CommandErr.COMM_ERR if communication error.

StartInventory

public int StartInventory()

Command RFID reader to starts inventory tagging. A report on an identified tag will be notified to callback function RFIDCallback.onNotifyReceivedPacket(device.common.rfid.RecvPacket). The report may include ID, time, and RSSI of the identified tag. Use RFIDManager.SetInventoryReportFormat(device.common.rfid.ReportFormatOfInvent) to configure format of the report.

This method uses existing (or default) options. To override existing (or default) options, call RFIDManager.SetOperationMode(device.common.rfid.ModeOfInvent) before invoking this method. Alternatively, RFIDManager.StartInventory_ext(int, int, int) not only starts inventory tagging, but also provides several input arguments for option overriding. For more information on the options, visit RFIDManager.SetOperationMode(device.common.rfid.ModeOfInvent).

Returns:

whether command was successful or not. Possible return values are:

 public final static int SUCCESS = 0;
 // command successful
 public final static int COMM_ERR = -1;
 // communication has been interrupted by error
 

See Also:

RFIDManager.SetOperationMode(device.common.rfid.ModeOfInvent), RFIDManager.GetOperationMode(device.common.rfid.ModeOfInvent), RFIDManager.StartInventory_ext(int, int, int)

Stop

public int Stop()

Command RFID reader to stop ongoing command.

Returns:

whether command was successful or not. Possible return values are:

 public final static int SUCCESS = 0;
 // command successful
 public final static int COMM_ERR = -1;
 // communication has been interrupted by error
 

GetInventoryReportFormat

public int GetInventoryReportFormat(ReportFormatOfInvent reportFormatOfInvent)

Queries the report format of RFID inventory.

Parameters:

reportFormatOfInvent - the container for query result.

 public class ReportFormatOfInvent implements Parcelable {
     public int time;
         // whether the report includes internal timer value.
         // 1 means enabled and 0 means disabled.
     public int rssi;
         // whether the report includes RSSI value.
         // 1 means enabled and 0 means disabled.
 }
 

Returns:

whether query was success or not. Note that return value does not contain actual query results. Instead, look for reportFormatOfInvent argument to check what returned from query.
Possible return values are:

 public final static int SUCCESS = 0;
 // query successful
 public final static int COMM_ERR = -1;
 // communication has been interrupted by error
 

See Also:

RFIDManager.SetInventoryReportFormat(device.common.rfid.ReportFormatOfInvent)

SetInventoryReportFormat

public int SetInventoryReportFormat(ReportFormatOfInvent reportFormatOfInvent)

Modifies the report format of RFID inventory

Parameters:

reportFormatOfInvent - defines settings on report format of inventory.

 public class ReportFormatOfInvent implements Parcelable {
     public int time;
         // whether it include internal timer value.
         // 1 means enabled and 0 means disabled.
     public int rssi;
         // whether it include rssi value.
         // 1 means enabled and 0 means disabled.
 }
 

Returns:

whether modification was successful or not. Possible return values are:

 public final static int SUCCESS = 0;
 // modification successful
 public final static int COMM_ERR = -1;
 // communication has been interrupted by error
 

See Also:

RFIDManager.GetInventoryReportFormat(device.common.rfid.ReportFormatOfInvent)

GetSelMask

public int GetSelMask(SelConfig selConfig)

Queries tag selection filter. A subset of tags which satisfy the condition of filter are marked as "selected". Calling RFIDManager.StartInventory_ext(int, int, int) method with select mode (or exclusion select mode) results in responses from only tags marked as "selected" (or doesn't marked as "selected").

Parameters:

selConfig - the container for query result.

 public class SelConfig {
     public int index;
         // index for the filter. Up to 8 filters can be saved.
         // value is from 0 to 7.
     public int length;
         // length of the selectData (unit: bit).
         // for example, if selectData="ABCD", then set length to 16 
         // (=4 bits × 4 characters).
         // value is from 0 to 255, where 0 disables current filter.
     public int memBank;
         // a memory bank in the tag where this filter will be applied to
         //  0 means RESERVED
         //  1 means EPC
         //  2 means TID
         //  3 means USER
     public int offset;
         // an offset from the beginning of the memory bank where this
         // filter will be applied to (unit: bit).
         // value is from 0 to 255
     public String selectData;
         // a filter value in a string of hexadecimal digits.
         // Note: common prefixes for hexadecimal notation, such as "0x",
         //  are not necessary.
     public int target;
         // a flag in a tag.
         // tags receiving select command invoked by RFIDManager.SetSelMask(device.common.rfid.SelConfig) 
         // may modify its "inventoried" or "select" flag according to
         // action parameter.
         //   0, 1, 2 and 3 mean "inventoried" flag for session 0, 1, 2
         //    and 3, respectively
         //   4 means "select" flag
         // For more information, refer to section "6.3.2.12.1.1 Select" 
         // in EPC UHF RFID G2 Standard document, available at
         // https://www.gs1.org/standards/epc-rfid/uhf-air-interface-protocol
     public int action;
         // a rule to modify a flag (designated by target) in tags
         // value is from 0 to 7
         // For more information, refer to "Table 6-30: Tag response to Action parameter"
         // in EPC UHF RFID G2 Standard document, available at
         // https://www.gs1.org/standards/epc-rfid/uhf-air-interface-protocol
 }
 

Returns:

whether query was successful or not. Note that return value does not contain actual query results. Instead, look for selConfig argument to check what returned from query.
Possible return values are:

 public final static int SUCCESS = 0;
 // query successful
 public final static int COMM_ERR = -1;
 // communication has been interrupted by error while querying
 

See Also:

RFIDManager.SetSelMask(device.common.rfid.SelConfig)

SetSelMask

public int SetSelMask(SelConfig selConfig)

Commands tags to mark themselves "selected" according to filter. The latest filter setting will be stored at the RFID reader device as well, which can be referred later by RFIDManager.GetSelMask(device.common.rfid.SelConfig).

Parameters:

selConfig - tag selection filter

 public class SelConfig {
     public int index;
         index for the select list that users set.
         available from 0 to 7.
     public int length;
         length of the data that users set(unit. bit).
         available from 0 to 7. 0 means disable.
     public int memBank;
         memory bank of the tag with data.
             0 means RESERVED bank
             1 means EPC bank
             2 means TID bank
             3 means USER bank
     public int offset;
         offset of the data in the memory bank(unit. bit).
         available from 0 to 255
     public String selectData;
         data that users set 
     public int target;
         default 4 to use select mode
     public int action;
         whether include or exclude tag
             0 means include single tag
             1 means include multi tag
             4 means exclude single tag
 }
 

Returns:

whether command was successful or not. Possible return values are:

 public final static int SUCCESS = 0;
 // query successful
 public final static int COMM_ERR = -1;
 // communication has been interrupted by error while querying
 

See Also:

RFIDManager.GetSelMask(device.common.rfid.SelConfig)

ReadTag

public int ReadTag(int length,
                   int membank,
                   int offset,
                   java.lang.String ACS_PWD)

Command RFID reader to read memory of tag. Tag selection mask defined by RFIDManager.SetSelMask(device.common.rfid.SelConfig) is used to define which tag (or a group of tags) is affected by this command. To check current selection mask, use RFIDManager.GetSelMask(device.common.rfid.SelConfig).

The return value of this method does NOT contain a read result. The read result can be obtained via notifications, such as:

• callback,
• custom intent,
• keyboard event, or
• copy & paste event.

The read result includes content in the memory, followed by a tag ID, delimited by comma(","). For example, if data "abcd" has been read from a tag which EPC ID is "0x1234", then return format will be "abcd,e=1234".

To check or modify tag ID format for read result, use RFIDManager.GetDataFormat() or RFIDManager.SetDataFormat(int).

To check and modify type of notification for read result, use RFIDManager.GetResultType() or RFIDManager.SetResultType(int).

Parameters:

length - the length of data that users want to read. value is from 1 to 255 (unit: word).

membank - the memory bank of the tag to read.

  0 // RESERVED bank
  1 // EPC bank
  2 // TID bank
  3 // USER bank
 

offset - an offset from the beginning of the memory bank. value is from 0 to 255 (unit: word).

ACS_PWD - the access password. Both decimal or hexadecimal notation is allowed. A string starting "0x" will be interpreted as hexadecimal number.

Returns:

whether the command success. Possible return values are:

 public final static int SUCCESS = 0;
 // command successful
 public final static int COMM_ERR = -1;
 // communication has been interrupted by error

See Also:

RFIDManager.WriteTag(int, int, int, java.lang.String, java.lang.String), RFIDManager.SetSelMask(device.common.rfid.SelConfig), RFIDManager.GetSelMask(device.common.rfid.SelConfig), RFIDManager.GetDataFormat(), RFIDManager.SetDataFormat(int), RFIDManager.GetResultType(), RFIDManager.SetResultType(int)

WriteTag

public int WriteTag(int length,
                    int membank,
                    int offset,
                    java.lang.String ACS_PWD,
                    java.lang.String writeData)

Command RFID reader to write memory of tag. Tag selection mask defined by RFIDManager.SetSelMask(device.common.rfid.SelConfig) is used to define which tag (or a group of tags) is affected by this command. To check current selection mask, use RFIDManager.GetSelMask(device.common.rfid.SelConfig).

The return value of this method does NOT contain a write result. The write result can be obtained via notifications, such as:

• callback,
• custom intent,
• keyboard event, or
• copy & paste event.

The write result from tag includes "e=", followed by a tag ID from accessed tag.

     e=[tag ID]

To check or modify tag ID format for write result, use RFIDManager.GetDataFormat() or RFIDManager.SetDataFormat(int).

To check and modify type of notification for write result, use RFIDManager.GetResultType() or RFIDManager.SetResultType(int).

Parameters:

length - the length of data that users want to write. value is from 0 to 255 (unit: word).

membank - the memory bank of the tag to write.

  0 // RESERVED bank
  1 // EPC bank
  2 // TID bank
  3 // USER bank
 

offset - an offset from the beginning of the memory bank. value is from 0 to 255 (unit: word).

ACS_PWD - the access password. Both decimal or hexadecimal notation is allowed. A string starting "0x" will be interpreted as hexadecimal number.

writeData - the data to write. This value will be handled as hexadecimal and prefix "0x" is not necessary.
The length of writeData should be the quadruple of length.

Returns:

whether command success. Possible return values are:

 public final static int SUCCESS = 0;
 // command successful
 public final static int COMM_ERR = -1;
 // communication has been interrupted by error
 

See Also:

RFIDManager.ReadTag(int, int, int, java.lang.String), RFIDManager.SetSelMask(device.common.rfid.SelConfig), RFIDManager.GetSelMask(device.common.rfid.SelConfig), RFIDManager.GetDataFormat(), RFIDManager.SetDataFormat(int), RFIDManager.GetResultType(), RFIDManager.SetResultType(int)

KillTag

public int KillTag(java.lang.String killPwd)

Command RFID reader to kill (disable permanently) tag. Tag selection mask defined by RFIDManager.SetSelMask(device.common.rfid.SelConfig) is used to define which tag (or a group of tags) is affected by this command. To check current selection mask, use RFIDManager.GetSelMask(device.common.rfid.SelConfig).

The return value of this method does NOT contain a kill result. The kill result can be obtained via notifications, such as:

• callback,
• custom intent,
• keyboard event, or
• copy & paste event.

The kill result from tag includes "e=", followed by a tag ID from accessed tag.

     e=[tag ID]

To check or modify tag ID format for kill result, use RFIDManager.GetDataFormat() or RFIDManager.SetDataFormat(int).

To check and modify type of notification for kill result, use RFIDManager.GetResultType() or RFIDManager.SetResultType(int).

Parameters:

killPwd - the kill password. It must not 0.

Returns:

whether command was successful or not. Possible return values are:

 public final static int SUCCESS = 0;
 // command successful
 public final static int COMM_ERR = -1;
 // communication has been interrupted
 

See Also:

RFIDManager.KillTag(java.lang.String), RFIDManager.SetSelMask(device.common.rfid.SelConfig), RFIDManager.GetSelMask(device.common.rfid.SelConfig), RFIDManager.GetDataFormat(), RFIDManager.SetDataFormat(int), RFIDManager.GetResultType(), RFIDManager.SetResultType(int)

LockTag

public int LockTag(int lockMask,
                   int lockEnable,
                   java.lang.String ACS_PWD)

Command RFID reader to lock or unlock memory in tag. The parameters lockmask and lockEnable are interpreted as bitmap. Refer to the following table for mapping between bits and memory locations.

bit location	memory location
9	User
8	N/A
7	TID
6	N/A
5	EPC
4	N/A
3	Access password
2	N/A
1	Kill password
0	N/A

For example, if you want to lock User memory, and unlock EPC memory, set lockMask as 0x220, and set lockEnable as 0x200.

Tag selection mask defined by RFIDManager.SetSelMask(device.common.rfid.SelConfig) is used to define which tag (or a group of tags) is affected by this command. To check current selection mask, use RFIDManager.GetSelMask(device.common.rfid.SelConfig).

The return value of this method does NOT contain a kill result. The kill result can be obtained via notifications, such as:

• callback,
• custom intent,
• keyboard event, or
• copy & paste event.

The kill result from tag includes "e=", followed by a tag ID from accessed tag.

     e=[tag ID]

To check or modify tag ID format for kill result, use RFIDManager.GetDataFormat() or RFIDManager.SetDataFormat(int).

To check and modify type of notification for kill result, use RFIDManager.GetResultType() or RFIDManager.SetResultType(int).

Parameters:

lockMask - a bit mask to mark which memory to apply lockEnable. A memory location marked as zero bit in the mask will be ignored. A memory location marked as non-zero bit in the mask will be processed as lockEnable.

lockEnable - a bit mask to lock or unlock. A zero bit at the valid bit location will unlock corresponding memory location. A non-zero bit at the valid bit location will lock corresponding memory location.

ACS_PWD - the access password. Both decimal or hexadecimal notation is allowed. A string starting "0x" will be interpreted as hexadecimal number.

Returns:

whether command was successful or not. Possible return values are:

 public final static int SUCCESS = 0;
 // command successful
 public final static int COMM_ERR = -1;
 // communication has been interrupted by error
 

See Also:

RFIDManager.SetSelMask(device.common.rfid.SelConfig), RFIDManager.GetSelMask(device.common.rfid.SelConfig), RFIDManager.GetDataFormat(), RFIDManager.SetDataFormat(int), RFIDManager.GetResultType(), RFIDManager.SetResultType(int)

PermaLockTag

public int PermaLockTag(int lockMask,
                        int lockEnable,
                        java.lang.String ACS_PWD)

Command RFID reader to lock or unlock memory in tag permanently. The parameters lockmask and lockEnable are interpreted as bitmap. Refer to the following table for mapping between bits and memory locations.

bit location	memory location
9	User
8	N/A
7	TID
6	N/A
5	EPC
4	N/A
3	Access password
2	N/A
1	Kill password
0	N/A

For example, if you want to lock User memory, and unlock EPC memory, set lockMask as 0x220, and set lockEnable as 0x200.

Tag selection mask defined by RFIDManager.SetSelMask(device.common.rfid.SelConfig) is used to define which tag (or a group of tags) is affected by this command. To check current selection mask, use RFIDManager.GetSelMask(device.common.rfid.SelConfig).

The return value of this method does NOT contain a kill result. The kill result can be obtained via notifications, such as:

• callback,
• custom intent,
• keyboard event, or
• copy & paste event.

The kill result from tag includes "e=", followed by a tag ID from accessed tag.

     e=[tag ID]

To check or modify tag ID format for kill result, use RFIDManager.GetDataFormat() or RFIDManager.SetDataFormat(int).

To check and modify type of notification for kill result, use RFIDManager.GetResultType() or RFIDManager.SetResultType(int).

Parameters:

lockMask - a bit mask to mark which memory to apply lockEnable. A memory location marked as zero bit in the mask will be ignored. A memory location marked as non-zero bit in the mask will be processed as lockEnable.

lockEnable - a bit mask to lock or unlock. A zero bit at the valid bit location will unlock corresponding memory location. A non-zero bit at the valid bit location will lock corresponding memory location.

ACS_PWD - the access password. Both decimal or hexadecimal notation is allowed. A string starting "0x" will be interpreted as hexadecimal number.

Returns:

whether command was successful or not. Possible return values are:

 public final static int SUCCESS = 0;
 // command successful
 public final static int COMM_ERR = -1;
 // communication has been interrupted by error
 

See Also:

RFIDManager.SetSelMask(device.common.rfid.SelConfig), RFIDManager.GetSelMask(device.common.rfid.SelConfig), RFIDManager.GetDataFormat(), RFIDManager.SetDataFormat(int), RFIDManager.GetResultType(), RFIDManager.SetResultType(int)

GetInventoryParam

public int GetInventoryParam(ParamOfInvent paramOfInvent)

Queries parameters used by RFIDManager.StartInventory().

Parameters:

paramOfInvent - the container for query result.

 public class ParamOfInvent {
     public int session;
         // Determines how long the flags in tags expires.
         // The flags includes inventoried flags, which is referred in
         // inventoryFlag parameter.
         // Refer to "Table 6-20. Tag flags and persistence values"
         // from UHF RFID standard[1] for more information.
             public static final int SESSION_0 = 0; // None
             public static final int SESSION_1 = 1; // from 500 msecs to 5 secs
             public static final int SESSION_2 = 2; // more than 2 secs
             public static final int SESSION_3 = 3; // more than 2 secs
     public int q;
         // Determines a tag response probability (=1/2Q).
         // Adjust this value in consideration of tag population.
         // Larger Q value is recommended for a large number of
         // (or dense) tags.
         // Smaller Q value is recommended for a few number of
         // (or sparse) tags.
         // Refer to "Inventorying Tag populations" section from UHF
         // RFID standard[1] for more information.
         available from 0 to 15.
     public int inventoryFlag;
         // Filter tags by inventoried flag at selected session.
         // A tag has four independent inventoried flags for each session.
         // Each flag can represent one of binary states "A" or "B".
         // Refer to "Sessions and inventoried flags" section from UHF
         // RFID standard[1] for more information.
             public static final int TARGET_A = 0;
             // only tags with inventoried flag "A" are identified.
             public static final int TARGET_B = 1;
             // only tags with inventoried flag "B" are identified.
             public static final int TARGET_AB = 2;
             // only tags with inventoried flag "A" or "B "are identified.     * }
 

[1] "EPC Radio-Frequency Identity Protocols Generation-2 UHF RFID, Specification for RFID Air Interface Protocol for Communications at 860 MHz - 960 MHz," Version 2.1, EPC Global, Jul. 2018.

Returns:

query was success or not. Note that return value does not contain actual query results. Instead, look for paramOfInvent argument to check what returned from query. Possible return values are:

 public final static int SUCCESS = 0;
 // query successful
 public final static int COMM_ERR = -1;
 // communication has been interrupted by error
 

See Also:

RFIDManager.SetInventoryParam(device.common.rfid.ParamOfInvent)

SetInventoryParam

public int SetInventoryParam(ParamOfInvent paramOfInvent)

Modifies parameters used by RFIDManager.StartInventory().

Parameters:

paramOfInvent - parameters used during inventory.

 public class ParamOfInvent {
     public int session;
         // Determines how long the flags in tags expires.
         // The flags includes inventoried flags, which is referred in
         // inventoryFlag parameter.
         // Refer to "Table 6-20. Tag flags and persistence values"
         // from UHF RFID standard[1] for more information.
             public static final int SESSION_0 = 0; // None
             public static final int SESSION_1 = 1; // from 500 msecs to 5 secs
             public static final int SESSION_2 = 2; // more than 2 secs
             public static final int SESSION_3 = 3; // more than 2 secs
     public int q;
         // Determines a tag response probability (=1/2Q).
         // Adjust this value in consideration of tag population.
         // Larger Q value is recommended for a large number of
         // (or dense) tags.
         // Smaller Q value is recommended for a few number of
         // (or sparse) tags.
         // Refer to "Inventorying Tag populations" section from UHF
         // RFID standard[1] for more information.
         available from 0 to 15.
     public int inventoryFlag;
         // Filter tags by inventoried flag at selected session.
         // A tag has four independent inventoried flags for each session.
         // Each flag can represent one of binary states "A" or "B".
         // Refer to "Sessions and inventoried flags" section from UHF
         // RFID standard[1] for more information.
             public static final int TARGET_A = 0;
             // only tags with inventoried flag "A" are identified.
             public static final int TARGET_B = 1;
             // only tags with inventoried flag "B" are identified.
             public static final int TARGET_AB = 2;
             // only tags with inventoried flag "A" or "B "are identified.
 }
 

[1] "EPC Radio-Frequency Identity Protocols Generation-2 UHF RFID, Specification for RFID Air Interface Protocol for Communications at 860 MHz - 960 MHz," Version 2.1, EPC Global, Jul. 2018.

Returns:

whether modification was successful or not. Possible return values are:

 public final static int SUCCESS = 0;
 // modification successful
 public final static int COMM_ERR = -1;
 // communication has been interrupted by error
 

See Also:

RFIDManager.GetInventoryParam(device.common.rfid.ParamOfInvent)

GetTxPower

public int GetTxPower()

Queries current Tx power modifier value of RFID reader. TX power is determined by (MaxPower - modifier). Increasing TX power also increases power consumption from battery.

Returns:

Tx power modifier value in dB scale. The higher the modifier value is, the weaker the Tx power of RFID reader will be. Value range is from 0 to MaxPower.
COMM_ERR may be returned if communication has been interrupted by error while querying.

See Also:

RFIDManager.SetTxPower(int), RFIDManager.GetMaxPower()

SetTxPower

public int SetTxPower(int pwr)

Modifies Tx power modifier value of RFID reader. TX power is determined by (MaxPower - pwr).
Increasing TX power also increases power consumption from battery.

Parameters:

pwr - Tx power modifier value in dB scale. The higher the pwr is, the weaker the Tx power of RFID reader will be. Value range is from 0 to MaxPower.

Returns:

whether modification was successful or not. Possible return values are:

 public final static int SUCCESS = 0;
 // modification successful
 public final static int COMM_ERR = -1;
 // communication has been interrupted by error
 

See Also:

RFIDManager.GetTxPower(), RFIDManager.GetMaxPower()

GetMaxPower

public int GetMaxPower()

Queries the Max. Tx power supported by RFID reader.

Returns:

max. power value in dBm.

GetTxCycle

public int GetTxCycle(TxCycle txCycle)

Queries Tx ON and OFF durations. To modify TX ON and OFF durations, use RFIDManager.SetTxCycle(device.common.rfid.TxCycle).

Parameters:

txCycle - the container for query result.

     public class TxCycle implements Parcelable {
         public int onTime;
             // Tx ON duration
             // available from 40 to 400 (unit: msec)
         public int offTime;
             // Tx OFF duration
             // available from 0 to 255 (unit: msec)
 }
 

Returns:

whether query was successful or not. Note that return value does not contain actual query results. Instead, look for txCycle argument to check what returned from query.
Possible return values are:

 public final static int SUCCESS = 0;
 // query successful
 public final static int COMM_ERR = -1;
 // communication has been interrupted by error while querying
 

See Also:

RFIDManager.SetTxCycle(device.common.rfid.TxCycle)

SetTxCycle

public int SetTxCycle(TxCycle txCycle)

Modifies Tx ON and OFF durations. For the maximum performance, set OFF duration as 0 at the cost of reduced battery lifetime. To query current TX ON and OFF durations, use RFIDManager.GetTxCycle(device.common.rfid.TxCycle).

Parameters:

txCycle - Tx ON and OFF duration

     public class TxCycle implements Parcelable {
         public int onTime;
             // Tx ON duration
             // available from 40 to 400 (unit: msec)
         public int offTime;
             // Tx OFF duration
             // available from 0 to 255 (unit: msec)
 }
 

Returns:

whether modification was successful or not. Possible return values are:

 public final static int SUCCESS = 0;
 // modification successful
 public final static int COMM_ERR = -1;
 // communication has been interrupted by error 
 

See Also:

RFIDManager.GetTxCycle(device.common.rfid.TxCycle)

GetAllChannel

public java.lang.String GetAllChannel()

Queries a list of enabled channels. Channel indexes are enumerated as positive integers starting from 1.

To query availability of a channel, use RFIDManager.GetChannelState(device.common.rfid.ChannelState). To enable or disable a channel, use RFIDManager.SetChannelState(device.common.rfid.ChannelState).

Returns:

a comma-separated string notation for list of enabled channel indexes. For example, assume channel indexes 4, 7, 10, and 13 are enabled. Then return value will be "4,7,10,13". Note that in case of communication has been interrupted by error, null is returned.

See Also:

RFIDManager.GetChannelState(device.common.rfid.ChannelState), RFIDManager.SetChannelState(device.common.rfid.ChannelState)

GetChannelState

public int GetChannelState(ChannelState channelState)

Queries availability of a channel. To get a list of enabled channels, use RFIDManager.GetAllChannel(). To enable or disable a channel, use RFIDManager.SetChannelState(device.common.rfid.ChannelState).

Parameters:

channelState - the container for query result.

 public class ChannelState implements Parcelable {
         public int channelIndex;
             // channel index to check
         public int enable;
             // 1 means enabled and 0 means disabled.
 }
 

Returns:

whether query was successful or not. Note that return value does not contain actual query results. Instead, look for channelState argument to check what returned from query.
Possible return values are:

 public final static int SUCCESS = 0;
 // query successful
 public final static int COMM_ERR = -1;
 // communication has been interrupted by error while querying
 

See Also:

RFIDManager.GetAllChannel(), RFIDManager.SetChannelState(device.common.rfid.ChannelState)

SetChannelState

public int SetChannelState(ChannelState channelState)

Enables (or disables) a channel. To get a list of enabled channels, use RFIDManager.GetAllChannel(). To check whether a channel is enabled, use RFIDManager.GetChannelState(device.common.rfid.ChannelState).

Parameters:

channelState - channel status.

 public class ChannelState implements Parcelable {
         public int channelIndex;
             // channel index to check
         public int enable;
             // 1 means enabled and 0 means disabled.
 }
 

Returns:

whether modification was successful or not. Possible return values are:

 public final static int SUCCESS = 0;
 // modification successful
 public final static int COMM_ERR = -1;
 // communication has been interrupted by error
 

See Also:

RFIDManager.GetAllChannel(), RFIDManager.GetChannelState(device.common.rfid.ChannelState)

GetLinkProfile

public int GetLinkProfile()

Queries the RF transceiver link profile of RFID reader.

To modify link profile, use RFIDManager.SetLinkProfile(int).

Returns:

on success, one of link profile indexes is returned.

 public static final int LINK_PROFILE_0 = 0;
 public static final int LINK_PROFILE_1 = 1;
 public static final int LINK_PROFILE_2 = 2;
 public static final int LINK_PROFILE_3 = 3;
 

Profile index	Modulation	DeModulation	Frequency(KHz)	DataRate(kbps)
0	DSB-ASK	FM0	40	40
1	PR-ASK	Miller Subcarrier 4	250	32.5
2	PR_ASK	Miller Subcarrier 4	300	75
3	DSB-ASK	FM0	400	400

on communication error, RFIDConst.CommandErr.COMM_ERR is returned.

See Also:

RFIDManager.SetLinkProfile(int)

SetLinkProfile

public int SetLinkProfile(int profile)

Modifies the RF transceiver link profile of RFID reader.

To check current link profile, use RFIDManager.GetLinkProfile().

Parameters:

profile - link profile index.

 public static final int LINK_PROFILE_0 = 0;
 public static final int LINK_PROFILE_1 = 1;
 public static final int LINK_PROFILE_2 = 2;
 public static final int LINK_PROFILE_3 = 3;
 

Profile index	Modulation	DeModulation	Frequency(KHz)	DataRate(kbps)
0	DSB-ASK	FM0	40	40
1	PR-ASK	Miller Subcarrier 4	250	32.5
2	PR_ASK	Miller Subcarrier 4	300	75
3	DSB-ASK	FM0	400	400

Returns:

whether modification was successful or not. Possible return values are:

 public final static int SUCCESS = 0;
 // modification successful
 public final static int COMM_ERR = -1;
 // communication has been interrupted by error
 

See Also:

RFIDManager.GetLinkProfile()

GetVibState

public int GetVibState()

Queries the vibration setting value of RFID reader.

To modify vibration setting, use RFIDManager.SetVibState(int).

NOTE: This method is incompatible with UART-based RFID readers, such as PM500.

Returns:

vibration state (1 for enabled, 0 for disabled), or RFIDConst.CommandErr.COMM_ERR if an error occurred during communication to RFID reader.

See Also:

RFIDManager.SetVibState(int)

SetVibState

public int SetVibState(int on)

Modifies the vibration setting value of RFID reader.

To check current vibration setting, use RFIDManager.GetVibState().

NOTE: This method is incompatible with UART-based RFID readers, such as PM500.

Parameters:

on - vibration setting value.

 0 means vibrator is disable
 1 means vibrator is enable
 

Returns:

whether modification was successful or not. Possible return values are:

 public final static int SUCCESS = 0;
 // modification successful
 public final static int COMM_ERR = -1;
 // communication has been interrupted by error
 

See Also:

RFIDManager.GetVibState()

SetTriggerMode

public int SetTriggerMode(int mode)

Modifies the trigger mode.

NOTE: This method is incompatible with UART-based RFID readers, such as PM500.

Parameters:

mode - the trigger mode

 0 means RFID mode
 1 means Barcode Scanner mode
 

Returns:

whether modification was successful or not. Possible return values are:

 public final static int SUCCESS = 0;
 // modification successful
 public final static int COMM_ERR = -1;
 // communication has been interrupted by error
 

GetBatteryState

public int GetBatteryState()

Queries the performance state of battery in RFID reader.

NOTE: This method is incompatible with UART-based RFID readers, such as PM500.

Returns:

the performance state of battery. possible values are:

 0  // battery replacement is necessary
 1  // battery is in good condition
 

RFIDConst.CommandErr.COMM_ERR is returned if communication error is occurred.

GetChargingState

public int GetChargingState()

Queries whether the battery of RFID reader is charging.

Note: If battery is fully (100%) charged, the return value may be incorrect.

NOTE: This method is incompatible with UART-based RFID readers, such as PM500.

Returns:

the battery charging state.

 0 // battery is NOT charging.
 1 // battery is charging.
 

RFIDConst.CommandErr.COMM_ERR is returned if communication error is occurred.

SingleSearch

public int SingleSearch(int length,
                        java.lang.String tagId,
                        int threshold,
                        int step)

Commands RFID reader to search a tag constrained by tag ID.

The return value of this method does NOT contain search result. The result can be obtained via notifications, such as:

• callback,
• custom intent,
• keyboard event, or
• copy & paste event.

The search result includes a tag ID, followed by TX power of the reader, delimited by comma(","). The tag ID is a joined string of PC and EPC.

  [tag ID],p=[power]

To check and modify type of notification for the search result, use RFIDManager.GetResultType() or RFIDManager.SetResultType(int).

NOTE: This method is incompatible with UART-based RFID readers, such as PM500.

Parameters:

length - the length of tagId.

tagId - the ID (PC + EPC) of the targeted tag to find for.

threshold - the lower bound of TX power (unit. dBm).

step - the amount of TX power to be reduced (unit. dBm).

Returns:

whether command was successful or not. Possible return values are:

 public final static int SUCCESS = 0;
 // command successful
 public final static int COMM_ERR = -1;
 // communication has been interrupted by error

MultiSearch

public int MultiSearch()

Commands RFID reader to search tags constrained by list of tag IDs. To check or modify the list, use RFIDManager.GetSearchList() or RFIDManager.SetSearchList(int, int, java.lang.String).

The return value of this method does NOT contain a search result. The search list can be obtained via notifications, such as:

• callback,
• custom intent,
• keyboard event, or
• copy & paste event.

The search result includes an index of the list to which the found tag is applied, followed by a tag ID, delimited by colon(":"). The tag ID is a joined string of PC and EPC.

  [index]:[tag ID]

To check and modify type of notification for the list of tag found, use RFIDManager.GetResultType() or RFIDManager.SetResultType(int).

NOTE: This method is incompatible with UART-based RFID readers, such as PM500.

Returns:

whether command was successful or not. Possible return values are:

 public final static int SUCCESS = 0;
 // command successful
 public final static int COMM_ERR = -1;
 // communication has been interrupted by error
 

See Also:

RFIDManager.GetSearchList(), RFIDManager.SetSearchList(int, int, java.lang.String), RFIDManager.GetSearchList_ext(int), RFIDManager.ClearSearchList(int, int), RFIDManager.ClearAllSearchList(), RFIDManager.GetResultType(), RFIDManager.SetResultType(int)

WildcardSearch

public int WildcardSearch(int length,
                          java.lang.String tagId)

Commands RFID reader to search tags constrained by wildcards ('*' or '?') patterns.

The return value of this method does NOT contain a search result. The search result can be obtained via notifications, such as:

• callback,
• custom intent,
• keyboard event, or
• copy & paste event.

The search result is a string notation of tag IDs, one tag per line. The tag ID is a joined string of PC and EPC.

To check and modify type of notification for the list of tag found, use RFIDManager.GetResultType() or RFIDManager.SetResultType(int).

NOTE: This method is incompatible with UART-based RFID readers, such as PM500.

Parameters:

length - the length of pattern tagId (unit: characters).

tagId - the tag ID (PC + EPC) pattern to search for. The pattern may includes wildcards ('*' and '?'). Filtering rule is as below.

 * matches any String
 ? matches any single character
 ex) 12345678*
     123?5678?
 

Returns:

whether command was successful or not. Possible return values are:

 public final static int SUCCESS = 0;
 // command successful
 public final static int COMM_ERR = -1;
 // communication has been interrupted by error
 

See Also:

RFIDManager.WildcardSearch(int, java.lang.String), RFIDManager.GetResultType(), RFIDManager.SetResultType(int)

GetSearchList

public int GetSearchList()

Queries an entire list of tags used by RFIDManager.MultiSearch().

The return value of this method does NOT contain the list. The list can be obtained via notifications, such as:

• callback,
• custom intent,
• keyboard event, or
• copy & paste event.

To check and modify type of notifications, use RFIDManager.GetResultType() or RFIDManager.SetResultType(int).

A notification includes an item index followed by a tag ID, delimited by colon(":"). The tag ID is a joined string of PC and EPC.

  [index]:[tag ID]

NOTE: This method is incompatible with UART-based RFID readers, such as PM500.

Returns:

whether query was successful or not. Possible return values are:

 public final static int SUCCESS = 0;
 // query successful
 public final static int COMM_ERR = -1;
 // communication has been interrupted by error
 

See Also:

RFIDManager.GetSearchList_ext(int), RFIDManager.SetSearchList(int, int, java.lang.String), RFIDManager.GetSearchList_ext(int), RFIDManager.SetSearchList(int, int, java.lang.String), RFIDManager.ClearSearchList(int, int), RFIDManager.ClearAllSearchList(), RFIDManager.MultiSearch()

GetSearchList_ext

public int GetSearchList_ext(int index)

Queries an item in the tag list used by RFIDManager.MultiSearch().

The return value of this method does NOT contain the list item. The list item can be obtained via notifications, such as:

• callback,
• custom intent,
• keyboard event, or
• copy & paste event.

To check and modify type of notifications, use RFIDManager.GetResultType() or RFIDManager.SetResultType(int).

A notification includes an item index followed by a tag ID, delimited by colon(":"). The tag ID is a joined string of PC and EPC.

  [index]:[tag ID]

NOTE: This method is incompatible with UART-based RFID readers, such as PM500.

Parameters:

index - the item index to query for.

     available from 0 to 49
 

Returns:

whether query was successful or not. Possible return values are:

 public final static int SUCCESS = 0;
 // query successful
 public final static int COMM_ERR = -1;
 // communication has been interrupted by error

See Also:

RFIDManager.GetSearchList(), RFIDManager.SetSearchList(int, int, java.lang.String), RFIDManager.GetSearchList(), RFIDManager.SetSearchList(int, int, java.lang.String), RFIDManager.ClearSearchList(int, int), RFIDManager.ClearAllSearchList(), RFIDManager.MultiSearch()

SetSearchList

public int SetSearchList(int index,
                         int length,
                         java.lang.String tagId)

Modifies a list of tags-of-interest used by RFIDManager.MultiSearch(). RFIDManager.MultiSearch()

NOTE: This method is incompatible with UART-based RFID readers, such as PM500.

Parameters:

index - the item index to modify.

     available from 0 to 49
 

length - the length of tagId.

     available from 4 to 36 (unit: characters) 
 

tagId - the tag ID (PC and EPC) to look for.

Returns:

whether modification was successful or not. Possible return values are:

 public final static int SUCCESS = 0;
 // modification successful
 public final static int COMM_ERR = -1;
 // communication has been interrupted by error
 

See Also:

RFIDManager.GetSearchList(), RFIDManager.GetSearchList_ext(int), RFIDManager.ClearSearchList(int, int), RFIDManager.ClearAllSearchList(), RFIDManager.MultiSearch()

ClearSearchList

public int ClearSearchList(int index,
                           int cnt)

Clears a series of list items used by RFIDManager.MultiSearch().

NOTE: This method is incompatible with UART-based RFID readers, such as PM500.

Parameters:

index - the starting index of list item.

     available from 0 to 49 (default = 0)
 

cnt - the number of items to clear from the starting index.

     available from 1 to 50 (default = 50)
 

For example, ClearSearchList(2, 3) clears three items in a row from the second item. In other words, it clears the 2nd, 3rd, and 4th item.

Returns:

whether the command success. Possible return values are:

 public final static int SUCCESS = 0;
 // command successful
 public final static int COMM_ERR = -1;
 // communication has been interrupted by error
 

See Also:

RFIDManager.GetSearchList_ext(int), RFIDManager.GetSearchList(), RFIDManager.SetSearchList(int, int, java.lang.String), RFIDManager.ClearAllSearchList(), RFIDManager.MultiSearch()

ClearAllSearchList

public int ClearAllSearchList()

Clears all list items used by RFIDManager.MultiSearch().

NOTE: This method is incompatible with UART-based RFID readers, such as PM500.

Returns:

whether the command success. Possible return values are:

 public final static int SUCCESS = 0;
 // command successful
 public final static int COMM_ERR = -1;
 // communication has been interrupted by error
 

See Also:

RFIDManager.GetSearchList_ext(int), RFIDManager.GetSearchList(), RFIDManager.SetSearchList(int, int, java.lang.String), RFIDManager.ClearSearchList(int, int), RFIDManager.MultiSearch()

BlockWrite

public int BlockWrite(int length,
                      int membank,
                      int offset,
                      java.lang.String writeData,
                      java.lang.String password,
                      int blockMode)

Commands tag(s) to write several blocks in memory bank. Tag selection mask defined by RFIDManager.SetSelMask(device.common.rfid.SelConfig) is used to define which tag (or a group of tags) is affected by this command. To check current selection mask, use RFIDManager.GetSelMask(device.common.rfid.SelConfig).

Use with caution and carefully design tag selection mask, so as not to overwrite precious data in unwanted tag(s) by mistake.

The return value of this method does NOT contain responses from tags. The responses from tags can be obtained via:

• callback,
• custom intent,
• keyboard event, or
• copy & paste event.

To check and modify type of notification for tag responses, use RFIDManager.GetResultType() or RFIDManager.SetResultType(int).

A response from tag includes "e=", followed by a tag ID from accessed tag.

     e=[tag ID]

To check or modify tag ID format for responses, use RFIDManager.GetDataFormat() or RFIDManager.SetDataFormat(int).

Parameters:

length - the number of blocks to write.

     available from 1 to 64 (unit: word)
 

membank - the memory bank where the target blocks for write are located.

     0 // RESERVED
     1 // EPC
     2 // TID
     3 // USER
 

offset - an offset from the beginning of the memory bank.

     available from 0 to 255 (unit: word)
 

writeData - the data to write.

password - the access password.

blockMode - the block write unit.

     0 // auto detect (default)
     1 // force one word block write
     2 // force two word block write
 

Returns:

whether the command success. Possible return values are:

 public final static int SUCCESS = 0;
 // command successful
 public final static int COMM_ERR = -1;
 // communication has been interrupted by error

See Also:

RFIDManager.BlockErase(int, int, int, java.lang.String, int), RFIDManager.SetSelMask(device.common.rfid.SelConfig), RFIDManager.GetSelMask(device.common.rfid.SelConfig), RFIDManager.GetTxDataFormat(), RFIDManager.SetTxDataFormat(int), RFIDManager.GetResultType(), RFIDManager.SetResultType(int)

BlockErase

public int BlockErase(int length,
                      int membank,
                      int offset,
                      java.lang.String password,
                      int blockMode)

Commands tag(s) to erase (zero-fill) several blocks in memory bank. Tag selection mask defined by RFIDManager.SetSelMask(device.common.rfid.SelConfig) is used to define which tag (or a group of tags) is affected by this command. To check current selection mask, use RFIDManager.GetSelMask(device.common.rfid.SelConfig).

Use with caution and carefully design tag selection mask, so as not to erase precious data in unwanted tag(s) by mistake.

The return value of this method does NOT contain responses from tags. The responses from tags can be obtained via:

• callback,
• custom intent,
• keyboard event, or
• copy & paste event.

To check and modify type of notification for tag responses, use RFIDManager.GetResultType() or RFIDManager.SetResultType(int).

A response from tag includes "e=", followed by a tag ID from accessed tag.

     e=[tag ID]

To check or modify tag ID format for responses, use RFIDManager.GetDataFormat() or RFIDManager.SetDataFormat(int).

Parameters:

length - the number of blocks to delete.

     available from 1 to 255 (unit: word)
 

membank - the memory bank where the target blocks for erase are located

     0 // RESERVED
     1 // EPC
     2 // TID
     3 // USER
 

offset - an offset from the beginning of the memory bank.

     available from 0 to 255 (unit: word)
 

password - the access password.

blockMode - the block erase unit.

     0 // auto detect (default)
     1 // force one word block erase
     2 // force two word block erase
 

Returns:

whether the command success. Possible return values are:

 public final static int SUCCESS = 0;
 // command successful
 public final static int COMM_ERR = -1;
 // communication has been interrupted by error

See Also:

RFIDManager.BlockWrite(int, int, int, java.lang.String, java.lang.String, int), RFIDManager.SetSelMask(device.common.rfid.SelConfig), RFIDManager.GetSelMask(device.common.rfid.SelConfig), RFIDManager.GetTxDataFormat(), RFIDManager.SetTxDataFormat(int), RFIDManager.GetResultType(), RFIDManager.SetResultType(int)

GetTagFocus

public int GetTagFocus()

Queries TagFocus™ feature setting of RFID reader. TagFocus lets reader to focus on undiscovered tags, by preventing tags from responding to the same RFID reader again, once they are discovered.

For optimal performance, both RFID reader and tag should support TagFocus feature. Monza 4, 5, 6, and X series tags manufactured by Impinj are known to support TagFocus feature.

To enable or disalbe TagFocus feature, use RFIDManager.SetTagFocus(int).

TagFocus is a proprietary chip technology made by Impinj. TagFocus is a registered trademark of Impinj, Inc.

Returns:

current TagFocus setting value, or RFIDConst.CommandErr.COMM_ERR if error occurred.

     0 // TagFocus feature is disabled
     1 // TagFocus feature is enabled
 

See Also:

RFIDManager.SetTagFocus(int)

SetTagFocus

public int SetTagFocus(int enable)

Enables or disables TagFocus™ feature of RFID reader. TagFocus lets reader to focus on undiscovered tags, by preventing tags from responding to the same RFID reader again, once they are discovered.

For optimal performance, both RFID reader and tag should support TagFocus feature. Monza 4, 5, 6, and X series tags manufactured by Impinj are known to support TagFocus feature.

To check if TagFocus feature is enabled, use RFIDManager.GetTagFocus().

TagFocus is a proprietary chip technology made by Impinj. TagFocus is a registered trademark of Impinj, Inc.

Parameters:

enable - flag.

     0 // disables TagFocus feature
     1 // enables TagFocus feature
 

Returns:

whether modification was successful or not. Possible return values are:

 public final static int SUCCESS = 0;
 // modification successful
 public final static int COMM_ERR = -1;
 // communication has been interrupted by error
 

See Also:

RFIDManager.GetTagFocus()

GetFastID

public int GetFastID()

Queries FastID™ feature setting of RFID reader. FastID may reduce time to acquire Tag Identifier (TID), by embedding a process of fetching TIDs of tags to inventory process.

For optimal performance, both RFID reader and tag should support FastID feature. Monza 4, 5, 6, and X series tags manufactured by Impinj are known to support FastID feature.

To enable or disable FastID feature, use RFIDManager.SetFastID(int).

FastID is a proprietary chip technology made by Impinj. FastID is a registered trademark of Impinj, Inc.

Returns:

current FastID setting value, or RFIDConst.CommandErr.COMM_ERR if error occurred.

     0 // FastID feature is disabled
     1 // FastID feature is enabled
 

See Also:

RFIDManager.SetFastID(int)

SetFastID

public int SetFastID(int enable)

Enables or disables FastID™ feature of RFID reader. FastID may reduce time to acquire Tag Identifier (TID), by embedding a process of fetching TIDs of tags to inventory process.

For optimal performance, both RFID reader and tag should support FastID feature. Monza 4, 5, 6, and X series tags manufactured by Impinj are known to support FastID feature.

To check if FastID feature is enabled, use RFIDManager.GetFastID().

FastID is a proprietary chip technology made by Impinj. FastID is a registered trademark of Impinj, Inc.

Parameters:

enable - flag.

     0 // disables FastID feature
     1 // enables FastID feature
 

Returns:

whether modification was successful or not. Possible return values are:

 public final static int SUCCESS = 0;
 // modification successful
 public final static int COMM_ERR = -1;
 // communication has been interrupted by error
 

See Also:

RFIDManager.GetFastID()

GetDataFormat

public int GetDataFormat()

Queries tag ID format followed by RFIDManager.StartInventory() or tag accessing commands. Tag accessing commands are:

• RFIDManager.ReadTag(int, int, int, java.lang.String)
• RFIDManager.WriteTag(int, int, int, java.lang.String, java.lang.String)
• RFIDManager.KillTag(java.lang.String)
• RFIDManager.LockTag(int, int, java.lang.String)
• RFIDManager.PermaLockTag(int, int, java.lang.String)
• RFIDManager.BlockWrite(int, int, int, java.lang.String, java.lang.String, int)
• RFIDManager.BlockErase(int, int, int, java.lang.String, int)

To modify current tag ID format, use RFIDManager.SetDataFormat(int).

NOTE: This method is incompatible with UART-based RFID readers, such as PM500.

Returns:

tag ID format, or RFIDConst.CommandErr.COMM_ERR if communication error.

 public static final int PC_EPC_CRC = 0;
 // PC + EPC + CRC
 public static final int PC_EPC = 1;
 // PC + EPC
 public static final int EPC_CRC = 2; 
 // EPC + CRC
 public static final int EPC_ONLY = 3;
 // EPC
 

See Also:

RFIDManager.SetDataFormat(int)

SetDataFormat

public int SetDataFormat(int index)

Modifies tag ID format followed by RFIDManager.StartInventory() or tag accessing commands. Tag accessing commands are:

• RFIDManager.ReadTag(int, int, int, java.lang.String)
• RFIDManager.WriteTag(int, int, int, java.lang.String, java.lang.String)
• RFIDManager.KillTag(java.lang.String)
• RFIDManager.LockTag(int, int, java.lang.String)
• RFIDManager.PermaLockTag(int, int, java.lang.String)
• RFIDManager.BlockWrite(int, int, int, java.lang.String, java.lang.String, int)
• RFIDManager.BlockErase(int, int, int, java.lang.String, int)

To query current tag ID format, use RFIDManager.GetDataFormat().

NOTE: This method is incompatible with UART-based RFID readers, such as PM500.

Parameters:

index - the tag ID format.

 public static final int PC_EPC_CRC = 0;
 // PC + EPC + CRC
 public static final int PC_EPC = 1;
 // PC + EPC
 public static final int EPC_CRC = 2; 
 // EPC + CRC
 public static final int EPC_ONLY = 3;
 // EPC
 

Returns:

whether modification was successful or not. Possible return values are:

 public final static int SUCCESS = 0;
 // modification successful
 public final static int COMM_ERR = -1;
 // communication has been interrupted by error
 

See Also:

RFIDManager.GetDataFormat()

GetTxDataFormat

public int GetTxDataFormat()

Queries the report format followed by a RFIDManager.StartInventory() command.

To modify current report format, use RFIDManager.SetTxDataFormat(int).
To modify prefix or suffix, use RFIDManager.SetPrefix(java.lang.String) or RFIDManager.SetSuffix(java.lang.String).

Returns:

the report format.

 public static final int TAG_DATA = 0;
 // no prefix, no suffix. Tag data only.
 public static final int PREFIX_TAG_DATA = 1;
 // prefix followed by tag data.
 public static final int TAG_DATA_SUFFIX = 2;
 // tag data followed by suffix.
 public static final int PREFIX_TAG_DATA_SUFFIX = 3;
 // tag data enclosed by both prefix and suffix.
 

See Also:

RFIDManager.SetTxDataFormat(int), RFIDManager.GetPrefix(), RFIDManager.GetSuffix()

SetTxDataFormat

public int SetTxDataFormat(int index)

Modifies the report format followed by a RFIDManager.StartInventory() command.

To check current report format, use RFIDManager.GetTxDataFormat().
To modify prefix or suffix, use RFIDManager.SetPrefix(java.lang.String) or RFIDManager.SetSuffix(java.lang.String).

Parameters:

index - the report format.

 public static final int TAG_DATA = 0;
 // no prefix, no suffix. Tag data only.
 public static final int PREFIX_TAG_DATA = 1;
 // prefix followed by tag data.
 public static final int TAG_DATA_SUFFIX = 2;
 // tag data followed by suffix.
 public static final int PREFIX_TAG_DATA_SUFFIX = 3;
 // tag data enclosed by both prefix and suffix.
 

Returns:

whether modification was successful or not. Possible return values are:

 public final static int SUCCESS = 0;
 // modification successful
 public final static int COMM_ERR = -1;
 // communication has been interrupted by error
 

See Also:

RFIDManager.GetTxDataFormat(), RFIDManager.SetPrefix(java.lang.String), RFIDManager.SetSuffix(java.lang.String)

GetPrefix

public java.lang.String GetPrefix()

Queries a prefix string. A prefix may be added at the start of response messages from RFID reader, if RFIDManager.GetTxDataFormat() is equal to RFIDConst.RFIDConfig.TX_FORMAT_PREFIX_TAG_DATA_SUFFIX or RFIDConst.RFIDConfig.TX_FORMAT_PREFIX_TAG_DATA.

To modify the current prefix string, use RFIDManager.SetPrefix(java.lang.String).
To check or modify data format, use RFIDManager.GetTxDataFormat() or RFIDManager.SetTxDataFormat(int).

Returns:

the prefix string, or null if error occurred.

See Also:

RFIDManager.SetPrefix(java.lang.String), RFIDManager.GetTxDataFormat(), RFIDManager.SetTxDataFormat(int)

SetPrefix

public int SetPrefix(java.lang.String prefix)

Modifies a prefix string. A prefix may be added at the start of response messages from RFID reader, if RFIDManager.GetTxDataFormat() is equal to RFIDConst.RFIDConfig.TX_FORMAT_PREFIX_TAG_DATA_SUFFIX or RFIDConst.RFIDConfig.TX_FORMAT_PREFIX_TAG_DATA.

To check the current prefix string, use RFIDManager.GetPrefix().
To check or modify data format, use RFIDManager.GetTxDataFormat() or RFIDManager.SetTxDataFormat(int).

Parameters:

prefix - a prefix string.

Returns:

whether modification was successful or not. Possible return values are:

 public final static int SUCCESS = 0;
 // modification successful
 public final static int COMM_ERR = -1;
 // communication has been interrupted by error
 

See Also:

RFIDManager.GetPrefix(), RFIDManager.GetTxDataFormat(), RFIDManager.SetTxDataFormat(int)

GetSuffix

public java.lang.String GetSuffix()

Queries a suffix string. A suffix may be added at the end of response messages from RFID reader, if RFIDManager.GetTxDataFormat() is equal to RFIDConst.RFIDConfig.TX_FORMAT_PREFIX_TAG_DATA_SUFFIX or RFIDConst.RFIDConfig.TX_FORMAT_TAG_DATA_SUFFIX.

To modify the current suffix string, use RFIDManager.SetSuffix(java.lang.String).
To check or modify data format, use RFIDManager.GetTxDataFormat() or RFIDManager.SetTxDataFormat(int).

Returns:

the suffix string, or null if error occurred.

See Also:

RFIDManager.SetSuffix(java.lang.String), RFIDManager.GetTxDataFormat(), RFIDManager.SetTxDataFormat(int)

SetSuffix

public int SetSuffix(java.lang.String suffix)

Modifies a suffix string. A suffix may be added at the end of response messages from RFID reader, if RFIDManager.GetTxDataFormat() is equal to RFIDConst.RFIDConfig.TX_FORMAT_PREFIX_TAG_DATA_SUFFIX or RFIDConst.RFIDConfig.TX_FORMAT_TAG_DATA_SUFFIX.

To check the current suffix string, use RFIDManager.GetSuffix().
To check or modify data format, use RFIDManager.GetTxDataFormat() or RFIDManager.SetTxDataFormat(int).

Parameters:

suffix - a suffix string.

Returns:

whether modification was successful or not. Possible return values are:

 public final static int SUCCESS = 0;
 // modification successful
 public final static int COMM_ERR = -1;
 // communication has been interrupted by error
 

See Also:

RFIDManager.GetSuffix(), RFIDManager.GetTxDataFormat(), RFIDManager.SetTxDataFormat(int)

SetDataCase

public int SetDataCase(int datacase)

Modifies the letter case format when reading data from RFID tag.

NOTE: This method is incompatible with UART-based RFID readers, such as PM500.

Parameters:

datacase - letter case format.

     0 // use lower case (default)
     1 // use upper case
 

Returns:

whether modification was successful or not. Possible return values are:

 public final static int SUCCESS = 0;
 // modification successful
 public final static int COMM_ERR = -1;
 // communication has been interrupted by error
 

GetOperationMode

public int GetOperationMode(ModeOfInvent moi)

Queries the inventory settings of RFID reader.

Parameters:

moi - the container for query result.

 public class ModeOfInvent {
     public int single;
         0 means continuous mode
         1 means single mode
     public int select;
         0 means non-select mode(default)
         2 means exclusion select mode
         3 means selece mode
     public int timeout;
         0 means infinite(default)
         available from 1 to 0xFFFFFFFF(unit. msec)
 }
 

Returns:

whether query was success or not. Note that return value does not contain actual query results. Instead, look for moi argument to check what returned from query.
Possible return values are:

 public final static int SUCCESS = 0;
 // query successful
 public final static int COMM_ERR = -1;
 // communication has been interrupted by error
 

See Also:

RFIDManager.SetOperationMode(device.common.rfid.ModeOfInvent)

SetOperationMode

public int SetOperationMode(ModeOfInvent moi)

Modifies the inventory settings of RFID reader.

To check current inventory settings, use RFIDManager.GetOperationMode(device.common.rfid.ModeOfInvent).

Parameters:

moi - the inventory settings.

 public class ModeOfInvent {
     public int single;
         0 means continuous mode
         1 means single mode
     public int select;
         0 means non-select mode(default)
         2 means exclusion select mode
         3 means selece mode
     public int timeout;
         0 means infinite(default)
         available from 1 to 0xFFFFFFFF(unit. msec)
 }
 

Option name	Description	Default value
Single	Single - inventory process stops as soon as the RFID reader identifies a tag. continuous - inventory process continues until invocation of RFIDManager.Stop() or timeout.	continuous
Select	Non-select mode - no selection filter is applied. All tags respond. Exclusion select mode - selection filter is applied negatively. Tags DOES NOT satisfying selection filter specified by RFIDManager.SetSelMask(device.common.rfid.SelConfig) will respond. Select mode - selection filter is applied positively. Only tags satisfying selection filter specified by RFIDManager.SetSelMask(device.common.rfid.SelConfig) will respond.	Non-select mode
Timeout	0 (=infinite) 1 to 0xFFFFFFFF (unit: ms)	0(=infinite)

Returns:

whether modification was successful or not. Possible return values are:

 public final static int SUCCESS = 0;
 // modification successful
 public final static int COMM_ERR = -1;
 // communication has been interrupted by error
 

See Also:

RFIDManager.GetOperationMode(device.common.rfid.ModeOfInvent)

GetResultType

public int GetResultType()

Queries current result notification type.

To modify current result notification type, use RFIDManager.SetResultType(int).

Returns:

the result notification type, or RFIDConst.CommandErr.COMM_ERR if an error occurred during communication to RFID reader.

 public static final int RFID_RESULT_CALLBACK = 0;
 public static final int RFID_RESULT_KBDMSG = 1;
 public static final int RFID_RESULT_COPYPASTE = 2;
 public static final int RFID_RESULT_CUSTOM_INTENT = 4;
 

See Also:

RFIDManager.SetResultType(int), RFIDManager.GetCustomIntentConfig(device.common.rfid.CustomIntentConfig), RFIDManager.SetCustomIntentConfig(device.common.rfid.CustomIntentConfig)

SetResultType

public void SetResultType(int resultType)

Modifies the result notification type.

To check current result notification type, use RFIDManager.GetResultType().

Parameters:

resultType - means the result notification type.

 public static final int RFID_RESULT_CALLBACK = 0;
 public static final int RFID_RESULT_KBDMSG = 1;
 public static final int RFID_RESULT_COPYPASTE = 2;
 public static final int RFID_RESULT_CUSTOM_INTENT = 4;
 

See Also:

RFIDManager.GetResultType(), RFIDManager.GetCustomIntentConfig(device.common.rfid.CustomIntentConfig), RFIDManager.SetCustomIntentConfig(device.common.rfid.CustomIntentConfig)

GetTerminatorType

public int GetTerminatorType()

Queries current type of the terminator. A terminator is used to declare the end of message from RFID reader to a host device. Type of terminator varies according to RFID reader models. Therefore, choose proper type of the terminator in accordance with RFID reader model. Choosing improper type of the terminator may cause error in reader-to-host communication.

Asynchronous commands, of which result is not given immediately as return value, are affected by terminator setting. Below is a list of such commands.

• RFIDManager.StartInventory()
• RFIDManager.ReadTag(int, int, int, java.lang.String)
• RFIDManager.WriteTag(int, int, int, java.lang.String, java.lang.String)
• RFIDManager.LockTag(int, int, java.lang.String)
• RFIDManager.KillTag(java.lang.String)
• RFIDManager.PermaLockTag(int, int, java.lang.String)
• RFIDManager.SingleSearch(int, java.lang.String, int, int)
• RFIDManager.MultiSearch()
• RFIDManager.WildcardSearch(int, java.lang.String)
• RFIDManager.GetSearchList()
• RFIDManager.GetSearchList_ext(int)
• RFIDManager.BlockWrite(int, int, int, java.lang.String, java.lang.String, int)
• RFIDManager.BlockErase(int, int, int, java.lang.String, int)

To modify type of terminator, use RFIDManager.SetTerminatorType(int).

Returns:

type of the terminator, or RFIDConst.CommandErr.COMM_ERR if communication error occurred.

 public static final int RFID_TERMINATOR_NONE = 0;
 public static final int RFID_TERMINATOR_SPACE = 1;
 public static final int RFID_TERMINATOR_TAB = 2;
 public static final int RFID_TERMINATOR_LF = 3;
 public static final int RFID_TERMINATOR_TAB_LF = 4;
 

See Also:

RFIDManager.SetTerminatorType(int)

SetTerminatorType

public void SetTerminatorType(int teminatorType)

Modifies type of the terminator. A terminator is used to declare the end of message from RFID reader to a host device. Type of terminator varies according to RFID reader models. Therefore, choose proper type of the terminator in accordance with RFID reader model. Choosing improper type of the terminator may cause error in reader-to-host communication.

Asynchronous commands, of which result is not given immediately as return value, are affected by terminator setting. Below is a list of such commands.

• RFIDManager.StartInventory()
• RFIDManager.ReadTag(int, int, int, java.lang.String)
• RFIDManager.WriteTag(int, int, int, java.lang.String, java.lang.String)
• RFIDManager.LockTag(int, int, java.lang.String)
• RFIDManager.KillTag(java.lang.String)
• RFIDManager.PermaLockTag(int, int, java.lang.String)
• RFIDManager.SingleSearch(int, java.lang.String, int, int)
• RFIDManager.MultiSearch()
• RFIDManager.WildcardSearch(int, java.lang.String)
• RFIDManager.GetSearchList()
• RFIDManager.GetSearchList_ext(int)
• RFIDManager.BlockWrite(int, int, int, java.lang.String, java.lang.String, int)
• RFIDManager.BlockErase(int, int, int, java.lang.String, int)

To check current type of terminator, use RFIDManager.GetTerminatorType().

Parameters:

teminatorType - type of the teminator to be used in reader-to-host communication.

 public static final int RFID_TERMINATOR_NONE = 0;
 public static final int RFID_TERMINATOR_SPACE = 1;
 public static final int RFID_TERMINATOR_TAB = 2;
 public static final int RFID_TERMINATOR_LF = 3;
 public static final int RFID_TERMINATOR_TAB_LF = 4;
 

See Also:

RFIDManager.GetTerminatorType()

GetInventoryReportFormat_ext

public int GetInventoryReportFormat_ext(ReportFormatOfInvent_ext reportFormatOfInvent_ext)

Queries the extension report format of RFID inventory (UART only).

NOTE: This method is only compatible with UART-based RFID readers, such as PM500.

Parameters:

reportFormatOfInvent_ext - the container for query result.

 public class ReportFormatOfInvent_ext implements Parcelable {
   public int time;
         // whether the report includes internal timer value.
         // 1 means enabled and 0 means disabled.
   public int rssi;
         // whether the report includes RSSI value.
         // 1 means enabled and 0 means disabled.
   public int channel;
         // whether the report includes channel value.
         // 1 means enabled and 0 means disabled.
   public int temp;
         // whether the report includes temperature value of the reader.
         // 1 means enabled and 0 means disabled.
   public int phase;
         // whether the report includes phase of the identified tag.
         // 1 means enabled and 0 means disabled.
   public int ant;
         // whether the report includes which antenna identified the tag.
         // 1 means enabled and 0 means disabled.
 }
 

Returns:

whether query was success or not. Note that return value does not contain actual query results. Instead, look for reportFormatOfInvent_ext argument to check what returned from query.
Possible return values are:

 public final static int SUCCESS = 0;
 // query successful
 public final static int COMM_ERR = -1;
 // communication has been interrupted by error
 public final static int NOT_SUPPORTED = -8;
 // this function cannot work on devices other than UART-based reader
 

See Also:

ReportFormatOfInvent_ext, RFIDManager.SetInventoryReportFormat_ext(device.common.rfid.ReportFormatOfInvent_ext)

SetInventoryReportFormat_ext

public int SetInventoryReportFormat_ext(ReportFormatOfInvent_ext reportFormatOfInvent_ext)

Modifies the extension report format of RFID inventory (UART only).

NOTE: This method is only compatible with UART-based RFID readers, such as PM500.

Parameters:

reportFormatOfInvent_ext - defines settings on report format of inventory.

 public class ReportFormatOfInvent_ext implements Parcelable {
   public int time;
         // whether the report includes internal timer value.
         // 1 means enabled and 0 means disabled.
   public int rssi;
         // whether the report includes RSSI value.
         // 1 means enabled and 0 means disabled.
   public int channel;
         // whether the report includes channel value.
         // 1 means enabled and 0 means disabled.
   public int temp;
         // whether the report includes temperature value of the reader.
         // 1 means enabled and 0 means disabled.
   public int phase;
         // whether the report includes phase of the identified tag.
         // 1 means enabled and 0 means disabled.
   public int ant;
         // whether the report includes which antenna identified the tag.
         // 1 means enabled and 0 means disabled.
 }
 

Returns:

whether modification was successful or not. Possible return values are:

 public final static int SUCCESS = 0;
 // modification successful
 public final static int COMM_ERR = -1;
 // communication has been interrupted by error
 public final static int NOT_SUPPORTED = -8;
 // this function cannot work on devices other than UART-based reader
 

See Also:

ReportFormatOfInvent_ext, RFIDManager.GetInventoryReportFormat_ext(device.common.rfid.ReportFormatOfInvent_ext)

SetDeviceBaudrate

public int SetDeviceBaudrate(int baudrate)

Modifies the baud rate for UART connection (UART only). Changes will take effect after reset.

NOTE: This method is only compatible with UART-based RFID readers, such as PM500.

Parameters:

baudrate - the baud rate (unit: bps). Supported baud rates are:

• 9600
• 19200
• 38400
• 57600
• 115200 (default)
• 230400
• 460800
• 921600

Returns:

whether modification was successful or not. Possible return values are:

 public final static int SUCCESS = 0;
 // modification successful
 public final static int COMM_ERR = -1;
 // communication has been interrupted by error
 public final static int NOT_SUPPORTED = -8;
 // this function cannot work on devices other than UART-based reader
 

GetAntSelect

public int GetAntSelect(AntSelect antSelect)

Queries a configuration for multiple antennas (UART only). Up to two antennas are supported.

NOTE: This method is only compatible with UART-based RFID readers, such as PM500.

Parameters:

antSelect - the container for query result.

 public class AntSelect {
 public int ant_1;
     configuration for antenna #1.
     1 means enabled and 0 means disabled.
 public int ant_2;
     configuration for antenna #2.
     1 means enabled and 0 means disabled.
 }
 

Returns:

whether query was successful or not. Note that return value does not contain actual query results. Instead, look for antSelect argument to check what returned from query.
Possible return values are:

 public final static int SUCCESS = 0;
 // query successful
 public final static int COMM_ERR = -1;
 // communication has been interrupted by error while querying
 public final static int NOT_SUPPORTED = -8;
 // this function cannot work on devices other than UART-based reader
 

See Also:

AntSelect, RFIDManager.SetAntSelect(AntSelect)

SetAntSelect

public int SetAntSelect(AntSelect antSelect)

Modifies a configuration for multiple antennas (UART only). Each antenna can be enabled or disabled individually. Up to two antennas are supported.

NOTE: This method is only compatible with UART-based RFID readers, such as PM500.

Parameters:

antSelect - defines configuration of each antennas. AntSelect type is as below.

 public class AntSelect {
 public int ant_1;
     configuration for antenna #1.
     1 means enabled and 0 means disabled.
 public int ant_2;
     configuration for antenna #2.
     1 means enabled and 0 means disabled.
 }
 

Returns:

whether modification was successful or not. Possible return values are:

 public final static int SUCCESS = 0;
 // modification successful
 public final static int COMM_ERR = -1;
 // communication has been interrupted by error
 public final static int NOT_SUPPORTED = -8;
 // this function cannot work on devices other than UART-based reader
 

See Also:

AntSelect, RFIDManager.GetAntSelect(AntSelect)

GetAvailableRegion

public java.lang.String GetAvailableRegion()

Queries a set of available regions (UART only). A result varies from model. The device can be configured to a specific region using RFIDManager.SetRegion(String)

NOTE: This method is only compatible with UART-based RFID readers, such as PM500.

Returns:

a comma-separated string notation for list of available regions. For example, assume FCC, KOR, and AUS regions are available. Then return value will be "FCC,KOR,AUS". Note that in case of communication has been interrupted by error, or using this method other than UART-based RFID model, null is returned.

See Also:

RFIDManager.SetRegion(String)

SetRegion

public int SetRegion(java.lang.String region)

Modifies region setting for a device (UART only). In order to comply with rules and regulations governing the region, the device shall be configured to a proper region.

NOTE: This method is only compatible with UART-based RFID readers, such as PM500.

Parameters:

region - a region should be one in the list of available regions, which can be retrieved via RFIDManager.GetAvailableRegion(). It uses upper case only.

Returns:

whether modification was successful or not. Possible return values are:

 public final static int SUCCESS = 0;
 // query successful
 public final static int COMM_ERR = -1;
 // communication has been interrupted by error while querying
 public final static int NOT_SUPPORTED = -8;
 // this function cannot work on devices other than UART-based reader
 

See Also:

RFIDManager.GetAvailableRegion()

GetCustomIntentConfig

public void GetCustomIntentConfig(CustomIntentConfig customIntentConfig)

Queries a configuration for custom intent. When RFID reader identifies a tag, it reports a read result via notification, among one of:

• callback,
• keyboard event,
• copy&paste, or
• custom intent.

The read result will be delivered via custom intent, if the notification type is set to custom intent (RFIDManager.GetResultType(), RFIDManager.SetResultType(int)). Use this method to know how to configure an intent filter for your app.

Parameters:

customIntentConfig - the container for query result.

 public class CustomIntentConfig {
 public String action;
 public String category;
     // action and category are used to define intent filter for your app.
 public String extraRfidData;
     // a name (key) to get extra data from an intent received.
     // the extra data may contain EPC ID of a tag, RSSI, and more.
 }
 

See Also:

RFIDManager.SetCustomIntentConfig(device.common.rfid.CustomIntentConfig), RFIDManager.GetResultType(), RFIDManager.SetResultType(int)

SetCustomIntentConfig

public void SetCustomIntentConfig(CustomIntentConfig customIntentConfig)

Modifies a configuration for custom intent. When RFID reader identifies a tag, it reports a read result via notification, among one of:

• callback,
• keyboard event,
• copy&paste, or
• custom intent.

The read result will be delivered via custom intent, if the notification type is set to custom intent (RFIDManager.GetResultType(), RFIDManager.SetResultType(int)). Use this method to modify custom intent configuration.

Parameters:

customIntentConfig - defines custom intent configuration. CustomIntentConfig type is as below.

 public class CustomIntentConfig {
 public String action;
 public String category;
     // action and category are used to define intent filter for your app.
 public String extraRfidData;
     // a name (key) to get extra data from an intent received.
     // the extra data may contain EPC ID of a tag, RSSI, and more.
 }
 

See Also:

RFIDManager.GetCustomIntentConfig(device.common.rfid.CustomIntentConfig), RFIDManager.GetResultType(), RFIDManager.SetResultType(int)

UpdateFirmware

public int UpdateFirmware(java.io.File fwFile)
                   throws java.io.IOException,
                          java.io.FileNotFoundException

Updates firmware for RFID reader (UART only).

NOTE: This method is only compatible with UART-based RFID readers, such as PM500.

Parameters:

fwFile - an firmware file to load.

Returns:

whether update was success or not. possible return values are:

 public final static int SUCCESS = 0;
 // update successful
 public final static int FW_NOT_EXISTED = -9;
 // firmware file does not exist
 public final static int NOT_SUPPORTED = -8;
 // model does not support firmware update by this method
 public final static int OPEN_FAILED = -2;
 // failed to open UART communication to RFID module
 public final static int FW_UPDATE_FAILED = -10;
 // an error occurred while updating firmware
 

Throws:

java.io.IOException

java.io.FileNotFoundException