public class RFIDReader
extends java.lang.Object
Modifier and Type | Class and Description |
---|---|
static class |
RFIDReader.ModuleCommands |
static class |
RFIDReader.RFIDStatus |
static class |
RFIDReader.SensorCommands |
Constructor and Description |
---|
RFIDReader(java.lang.String sIpAddress,
int iPortNumber)
Group:
Communications Setup and Control
Method:
constructor RFIDReader(String sIpAddress, int iPortNumber)
Summary:
This method creates an instance of the RFIDReader class and creates the underlying
communications class.
|
Modifier and Type | Method and Description |
---|---|
boolean |
ClearErrorList()
Method:
boolean ClearErrorList
Summary:
This command clears the internal error list held by the sensor
|
boolean |
ClearInventoryFilter(boolean makePersistent)
Method:
boolean ClearInventoryFilter(boolean makePersistent)
Summary:
This method clears the filter used during tag inventory cycles.
|
RFIDReader.Config24V |
Get24VDCStatus()
Method:
Config24V Get24VDCStatus()
Summary:
This method returns the current setup of the 24V DC output on the GPIO connector
as well as what its state is when the sensor is started or restarted.
|
int |
GetActiveAntenna()
Methods:
int GetActiveAntenna()
Summary:
Returns the numeric value of the currently active antenna.
|
RFIDReader.PowerSettings |
GetAntennaPowers()
Methods:
PowerSettings GetAntennaPowers()
Summary:
Returns the read power and write power level settings in dBm of the internal antenna
(index 0) and the three external antennas (indexes 1, 2, and 3)
|
boolean[] |
GetConnectedAntennas()
Method:
boolean[] GetConnectedAntennas()
Summary:
This method returns queries each of the ports of the integrated reader and returns
an array sized appropriately for the reader of boolean (true/false) values indicating
whether each of the port is connected or not.
|
double |
GetEnvRSSI()
Method:
double GetEnvRSSI()
Summary:
this method returns the background RSSI of the sensor in dBm.
|
RFIDReader.ErrorList |
GetErrorList()
Method:
ErrorList GetErrorList()
Summary:
This method returns the list of errors detected and recorded by the sensor
|
java.lang.String |
GetFirmwareId()
Method:
String GetFirmwareId()
Summary:
This method retrieves the hardware Major.Minor.Revision number of the sensor.
|
RFIDReader.InventoryParameters |
GetGen2Params()
Methods:
InventoryParameters GetGen2Params()
Summary:
The InventoryParameters object is returned with the various Gen2 parameters
filled in.
|
byte |
GetGPIOSetup()
Method:
byte GetGPIOSetup()
Summary:
This method returns the settings for the general-purpose outputs and the detected
state of the general-purpose inputs
|
java.lang.String |
GetHardwareId()
Group
Top-Level Sensor ID Queries
Method:
String GetHardwareId()
Summary:
This method retrieves the hardware Major.Minor.Revision number of the sensor.
|
RFIDReader.ReaderHeartbeatSettings |
GetHeartbeatConfig()
Method:
ReaderHeartbeatSettings GetHeartbeatConfig()
Summary:
This method returns the IP address and UDP port number over which the heartbeat
is sent as well and the Interval between heartbeat messages and the number (Count)
of messages that are sent before the heartbeat goes silent.
|
RFIDReader.ReaderNetworkSettings |
GetIPv4Info()
Method:
ReaderNetworkSettings GetIPv4Info()
Summary:
This method returns the various parameters comprising the IpV4 network
configuration.
|
byte |
GetLinkParams()
Method:
byte GetLinkParams()
Summary:
The method returns the current Link Parameter setting of the RFIDReader module.
|
java.lang.String |
GetModuleFirmwareId()
Method:
String GetModuleFirmwareId()
Summary:
Returns the RF Module's firmware version number.
|
java.lang.String |
GetModuleHardwareId()
Group:
RF Module ID Queries
Method:
String GetModuleHardwareId()
Summary:
Returns the RF Module's hardware identifier.
|
RFIDReader.PowerSettings |
GetModulePowerSetting()
Method:
PowerSettings GetModulePowerSetting()
Summary:
Returns the read power and write power levels from the reader module.
|
java.lang.String |
GetModuleSerialNumber()
Method:
String GetModuleSerialNumber()
Summary:
This function returns the string value corresponding to the reader module's
internal serial number.
|
double |
GetModuleTemperature()
Method:
double GetModuleTemperature()
Summary:
This method retrieves the internal temperature of the RFIDReader module in
degrees C.
|
double |
GetPortReturnLoss(int antennaNumber)
Method:
double getPortReturnLoss(int antennaNumber)
Summary:
This method returns the background RSSI of sensor in dBm.
|
RFIDReader.ReaderConfig |
GetReaderConfiguration()
Method:
ReaderConfig GetReaderConfiguration()
Summary:
Gets the configuration of the reader
|
java.lang.String |
GetReaderName()
Method:
String GetReaderName()
Summary:
Gets the name advertised by the sensor's heartbeat messages through a direct
firmware query.
|
java.lang.String |
GetReaderType()
Method:
String GetReaderType()
Summary:
Gets the reader type advertised by the sensor's heartbeat messages
through a direct firmware query.
|
RFIDReader.ReadGapTimes |
GetReadGapTimes()
Method:
ReadGapTimes GetReadGapTimes()
Summary:
This command retrieves the current read time interval and the time interval between
read cycles.
|
int[] |
GetReadSequence()
Method:
int[] GetReadSequence()
Summary:
This method retrieves the sequence of antennas that the reader loops through
when performing a continuous tag inventory read cycle.
|
java.lang.String |
GetRegionSetting()
Method:
String GetRegionSetting()
Summary:
This method returns the byte code for the region setting of the reader module.
|
byte |
GetSearchMode()
Method:
byte GetSearchMode()
Summary:
Returns the current search mode for the reader module.
|
java.lang.String |
GetSerialNumber()
Method:
String GetSerialNumber()
Summary:
This method retrieves the serial number of the sensor.
|
byte |
GetSessionParameter()
Method:
byte GetSessionParameter()
Summary:
Returns the current byte value for the session parameter.
|
boolean |
GetTemperatureProtect()
Methods:
boolean GetTemperatureProtect()
Summary:
Returns the status of the modules temperature protection status.
|
RFIDReader.TemperatureNotificationSettings |
GetTempNotificationSetup()
Method:
TemperatureNotificationSettings GetTempNotificationSetup()
Summary:
This method returns the time intervals and thresholds for reporting module
temperature during continuous tag read sessions.
|
boolean |
IsLocatorSignalActive()
Method:
boolean IsLocatorSignalActive()
Summary:
This method returns whether or not the locator flash pattern is active on the sensor.
|
RFIDReader.RFIDStatus |
KillTag(int killPassword,
RFIDReader.TagMask tagMask,
RFIDReader.TagFields tagFields)
Method:
RFIDStatus KillTag(int killPassword, TagMask tagMask, TagFields tagFields )
Summary:
This method kills the tag reference by the specified input mask.
|
RFIDReader.RFIDStatus |
LockTagData(int accessPassword,
RFIDReader.TagMask tagMask,
int killPwdLock,
int accessPwdLock,
int epcLock,
int userDataLock,
RFIDReader.TagFields tagFields)
Method:
RFIDStatus LockTagData(int accessPassword, TagMask tagMask,
int killPwdLock, int accessPwdLock, int epcLock,
int userDataLock, TagFields tagFields)
Summary:
This method locks, unlocks, or permanently locks or unlocks one or more data banks
on the tag.
|
RFIDReader.TagReadInfo |
ReadNextTag()
Method:
TagReadInfo ReadNextTag()
Summary:
This method is used to collect tag information.
|
RFIDReader.TagFields |
ReadTagData(int accessPassword,
RFIDReader.TagMask tagMask,
RFIDReader.TagFields tagFields)
Method:
TagFields ReadTagData(int accessPassword, TagMask tagMask, TagFields tagFields)
Summary:
This method reads the tag data from the specified tag data bank: 0 = Reserved data,
1 = EPC data, 2 = Tag Identifier Data (TID), 3 = User data.
|
boolean |
Reboot()
Method:
boolean Reboot()
Summary:
This method issues the reboot command to the sensor.
|
boolean |
ResetReceiveTimeout()
Method:
boolean ResetReceiveTimeout()
Summary:
This method requests a single inventory read cycle returning any detected tag.
|
boolean |
ResetToDefaultConfiguration()
Methods
boolean ResetToDefaultConfiguration()
Summary:
This method sends a request to the sensor to restore the saved configuration values
that are stored in flash memory.
|
boolean |
RestoreSavedConfiguration()
Method:
boolean RestoreSavedConfiguration()
Summary:
This method sends a request to the sensor to restore the saved
configuration values that are stored in flash memory.
|
boolean |
SaveCurrentConfiguration()
Method:
boolean SaveCurrentConfiguration()
Summary:
This method saves the various configurable setting to flash memory so that
they will be active when the sensor reboots.
|
boolean |
Set24VStatus(RFIDReader.Config24V config24V)
Method:
boolean Set24VStatus(Config24V config24V)
Summary:
This method turns the 24VDC on or off and sets the configuration that determines
whether it is on or off on startup
|
boolean |
SetActiveAntenna(int antennaId)
Method:
boolean SetActiveAntenna(int antennaId)
Summary:
Sets the specified antenna to be the active one for reading or writing.
|
boolean |
SetAntennaPower(int antennaNumber,
RFIDReader.PowerSettings pSettings)
Method:
boolean SetAntennaPower(int antennaNumber, PowerSettings pSettings)
Summary:
Set the read and write power levels for when the reader is transmitting through the
specified antenna
|
RFIDReader.RFIDStatus |
SetGen2Params(RFIDReader.InventoryParameters ip)
Method:
RFIDStatus SetGen2Params(InventoryParameters ip)
Summary:
The Gen2Params for the RFIDReader module are set to the values specified in the
Gen2Params data structure.
|
boolean |
SetGeneralPurposeOutputs(byte newGPOs)
Method:
boolean SetGeneralPurposeOutputs(bytes newGPOs)
Summary:
This method returns the settings for the general-purpose outputs and the
detected state of the general-purpose inputs
|
boolean |
SetHeartbeatConfig(RFIDReader.ReaderHeartbeatSettings settings)
Method:
boolean SetHeartbeatConfig(ReaderHeartbeatSettings settings)
Summary:
This method sets the IP address, UDP port number, interval, and count of the
heartbeat configuration
|
boolean |
SetInventoryFilter(RFIDReader.TagMask filter)
Method:
boolean SetInventoryFilter(TagMask filter)
Summary:
This method sets the filter to be used during tag inventory cycles
|
void |
SetIPv4CommLink(java.lang.String sIPv4Address,
int portNumber)
Method:
void SetIPv4CommLink(String sIPv4Address, int portNumber)
Summary:
The IP address and port number are passed on to the underlying communication
layer which closes the underlying socket if the IP address and port number
don't match the values already set up.
|
boolean |
SetIPv4Info(RFIDReader.ReaderNetworkSettings settings)
Method:
boolean SetIPv4Info(ReaderNetworkSettings settings)
Summary:
This method is used to set the IpV4 network configuration for the sensor.
|
boolean |
SetLinkParams(byte linkParams,
boolean save)
Method:
boolean SetLinkParams(byte linkParams, boolean save)
Summary:
The method returns the current Link Parameter setting of the RFIDReader module.
|
boolean |
SetLocatorSignalState(boolean stateActive)
Method:
boolean SetLocatorSignalState(boolean stateActive)
Summary:
This method activates or deactivates the locator signal on the sensor.
|
boolean |
SetModulePower(RFIDReader.PowerSettings pSettings)
Group:
RF Setup and Query Methods
Method:
boolean SetModulePower(PowerSettings pSettings)
Summary:
This function directly sets the read and write power of the RFIDReader module.
|
boolean |
SetReaderName(java.lang.String readerName)
Method:
boolean SetReaderName(String readerName)
Summary:
Sets the name advertised by the sensor's heartbeat messages.
|
boolean |
SetReadGapTimes(RFIDReader.ReadGapTimes readGapTimes)
Method:
boolean SetReadGapTimes(ReadGapTimes readGapTimes)
Summary:
This method sets the time interval for an inventory read cycle and the time interval
between reads.
|
boolean |
SetReadSequence(int[] antennaSequence)
Method:
boolean SetReadSequence(int[] antennaSequence)
Summary:
This method sets the sequence of antennas that the reader loops through when
performing a continuous tag inventory read cycle.
|
boolean |
SetSearchMode(byte searchMode)
Method:
boolean SetSearchMode(byte searchMode)
Summary:
Set the search mode of the RFID module
|
RFIDReader.RFIDStatus |
SetSessionParameter(byte sessionParam)
Method:
RFIDStatus SetSessionParameter(byte sessionParam)
Summary:
This method sets the Session Parameter.
|
void |
SetTagReadCallback(RFIDReader.OnTagReadResponse tagReadHandler)
Method:
void SetTagReadCallback(OnTagReadResponse tagReadHandler)
Summary:
This method allows the continuous read callback function to be changed or disabled
(by passing the parameter value as null).
|
boolean |
SetTempNotificationSetup(RFIDReader.TemperatureNotificationSettings tempSettings)
Methods
boolean SetTempNotificationSetup(TemperatureNotificationSettings tempSettings)
Summary:
This method sets the time intervals and thresholds for reporting module temperature
during continuous tag read sessions.
|
void |
Shutdown()
Method:
void Shutdown()
Summary:
This method closes down the underlying communications connection.
ReturnType:
No return value is returned from this method
Comments:
Once this method is called, that instance of the RFIDReader class will
no longer be usable.
|
boolean |
StartContinuousRead()
Method:
boolean StartContinuousRead()
Summary:
This method starts a continuous tag inventory session.
|
boolean |
StopContinuousRead()
Method:
boolean StopContinuousRead()
Summary:
This method is called to stop a continuous read cycle started by the StartContinuousRead()
method.
|
RFIDReader.TagFields |
WriteTagData(int accessPassword,
RFIDReader.TagMask tagMask,
RFIDReader.TagFields tagFields)
Method:
TagFields WriteTagData(int accessPassword, TagMask tagMask, TagFields tagFields)
Summary:
This method reads the tag data from the specified tag data bank: 0 = Reserved data,
1 = EPC data, 2 = Tag Identifier data (generally not writable), 3 = User data
using the mask data against the location specified by the maskBank, maskStartBitAddress
(offset into bank in number of bits) with length specified by maskBitLength number
of bits.
|
public RFIDReader(java.lang.String sIpAddress, int iPortNumber)
sIpAddress
- Input parameter with dotted format IP address (e.g. "192.168.1.150").iPortNumber
- Input parameter with the TCP port that the primary command communication will take place over.
public boolean ClearErrorList() throws java.lang.Exception
java.lang.Exception
- A System.TimeoutException will be thrown if the connection to the sensor
cannot be established or the module doesn't respond.
public boolean ClearInventoryFilter(boolean makePersistent) throws java.lang.Exception
makePersistent
- This parameter specifies whether or not any filter saved in the module
should be permanently cleared. If set to false, the next time the module reboots, the prior
saved filter will become active again.java.lang.Exception
- A System.TimeoutException will be thrown if the connection to the sensor
cannot be established or the module doesn't respond.
public RFIDReader.Config24V Get24VDCStatus() throws java.lang.Exception
java.lang.Exception
- A System.TimeoutException will be thrown if the connection to the sensor
cannot be established or the module doesn't respond.public int GetActiveAntenna() throws java.lang.Exception
java.lang.Exception
- A System.TimeoutException will be thrown if a connection to the sensor cannot
be established or the module doesn't respond.
public RFIDReader.PowerSettings GetAntennaPowers() throws java.lang.Exception
java.lang.Exception
- A System.TimeoutException will be thrown if a connection to the sensor cannot
be established or the module doesn't respond.
public boolean[] GetConnectedAntennas() throws java.lang.Exception
java.lang.Exception
- A System.TimeoutException will be thrown if a connection to the sensor
cannot be established or the module doesn't respond.
public double GetEnvRSSI() throws java.lang.Exception
java.lang.Exception
- A System.TimeoutException will be thrown if a connection to the sensor
cannot be established or the module doesn't respond.public RFIDReader.ErrorList GetErrorList() throws java.lang.Exception
java.lang.Exception
- A System.TimeoutException will be thrown if the connection to the sensor cannot be established
or the module doesn't respond.
public java.lang.String GetFirmwareId() throws java.lang.Exception
java.lang.Exception
- A System.TimeoutException will be thrown if a connection to the sensor
cannot be established or the module doesn't respond.
public RFIDReader.InventoryParameters GetGen2Params() throws java.lang.Exception
java.lang.Exception
- A System.TimeoutException will be thrown if a connection to the sensor cannot
be established or the module doesn't respond.
public byte GetGPIOSetup() throws java.lang.Exception
java.lang.Exception
- A System.TimeoutException will be thrown if the connection to the sensor
cannot be established or the module doesn't respond.public java.lang.String GetHardwareId() throws java.lang.Exception
java.lang.Exception
- A System.TimeoutException will be thrown if a connection to the sensor
cannot be established or the module doesn't respond.
public RFIDReader.ReaderHeartbeatSettings GetHeartbeatConfig() throws java.lang.Exception
java.lang.Exception
- A System.TimeoutException will be thrown if a connection to the sensor
cannot be established or the module doesn't respond.public RFIDReader.ReaderNetworkSettings GetIPv4Info() throws java.lang.Exception
java.lang.Exception
- A System.TimeoutException will be thrown if a connection to the
sensor cannot be established or the module doesn't respond.public byte GetLinkParams() throws java.lang.Exception
java.lang.Exception
- A System.TimeoutException will be thrown if a connection to the sensor
cannot be established or the module doesn't respond.
public java.lang.String GetModuleFirmwareId() throws java.lang.Exception
java.lang.Exception
- A System.TimeoutException will be thrown if a connection to the sensor cannot
be established or the module doesn't respond.
public java.lang.String GetModuleHardwareId() throws java.lang.Exception
java.lang.Exception
- A System.TimeoutException will be thrown if a connection to the sensor cannot be
established or the module doesn't respond.
public RFIDReader.PowerSettings GetModulePowerSetting() throws java.lang.Exception
java.lang.Exception
- A System.TimeoutException will be thrown if a connection to the sensor cannot
be established or the module doesn't respond.
public java.lang.String GetModuleSerialNumber() throws java.lang.Exception
java.lang.Exception
- A System.TimeoutException will be thrown if a connection to the sensor cannot
be established or the module doesn't respond.public double GetModuleTemperature() throws java.lang.Exception
java.lang.Exception
- A System.TimeoutException will be thrown if a connection to the sensor
cannot be established or the module doesn't respond.public double GetPortReturnLoss(int antennaNumber) throws java.lang.Exception
antennaNumber
- Input to the method for which the return loss will be read. This
parameter must have a value in the range from 0 to 3.java.lang.Exception
- A System.TimeoutException will be thrown if a connection to the sensor
cannot be established or the module doesn't respond.
public RFIDReader.ReaderConfig GetReaderConfiguration() throws java.lang.Exception
java.lang.Exception
- A System.TimeoutException will be thrown if a connection to the sensor
cannot be established or the module doesn't respond.public java.lang.String GetReaderName() throws java.lang.Exception
java.lang.Exception
- A System.TimeoutException will be thrown if a connection to the
sensor cannot be established or the module doesn't respond.public java.lang.String GetReaderType() throws java.lang.Exception
java.lang.Exception
- A System.TimeoutException will be thrown if a connection to the
sensor cannot be established or the module doesn't respond.public RFIDReader.ReadGapTimes GetReadGapTimes() throws java.lang.Exception
java.lang.Exception
- A System.TimeoutException will be thrown if the connection to the sensor
cannot be established or the module doesn't respond.public int[] GetReadSequence() throws java.lang.Exception
java.lang.Exception
- A System.TimeoutException will be thrown if the connection to the sensor
cannot be established or the module doesn't respond.
public java.lang.String GetRegionSetting() throws java.lang.Exception
java.lang.Exception
- A System.TimeoutException will be thrown if the connection to the sensor
cannot be established or the module doesn't respond.public byte GetSearchMode() throws java.lang.Exception
java.lang.Exception
- A System.TimeoutException will be thrown if a connection to the sensor
cannot be established or the module doesn't respond.public java.lang.String GetSerialNumber() throws java.lang.Exception
java.lang.Exception
- A System.TimeoutException will be thrown if a connection to the
sensor cannot be established or the module doesn't respond.public byte GetSessionParameter() throws java.lang.Exception
java.lang.Exception
- A System.TimeoutException will be thrown if the connection to the sensor
cannot be established or the module doesn't respond.public boolean GetTemperatureProtect() throws java.lang.Exception
java.lang.Exception
- A System.TimeoutException will be thrown if a connection to the sensor cannot
be established or the module doesn't respond.
public RFIDReader.TemperatureNotificationSettings GetTempNotificationSetup() throws java.lang.Exception
java.lang.Exception
- A System.TimeoutException will be thrown if a connection to the sensor
cannot be established or the module doesn't respond.
public boolean IsLocatorSignalActive() throws java.lang.Exception
java.lang.Exception
- A System.TimeoutException will be thrown if a connection to the sensor
cannot be established or the module doesn't respond.
public RFIDReader.RFIDStatus KillTag(int killPassword, RFIDReader.TagMask tagMask, RFIDReader.TagFields tagFields) throws java.lang.Exception
killPassword
- This parameter specifies the 32 bit kill password that must have been programmed
into the tag prior to making this calltagMask
- This parameter is used to select a specific tag to be killed.tagFields
- this parameter is used to return the errorCode back to the caller. Typical error codes are:
1 - the specified parameters are not supported, 2 - the password specified was wrong or provided insufficient
privileges (e.g., 0 when associated parts of the tag are locked, and 3 - mask or data locations and/or lengths
were not specified correctly. These error codes correspond to the values documented in Annex I of the EPCGlobal
Gen2 Specification (Nov-2013, Version 2.0).java.lang.Exception
- A System.TimeoutException will be thrown if the connection to the sensor cannot be established
or the module doesn't respond.public RFIDReader.RFIDStatus LockTagData(int accessPassword, RFIDReader.TagMask tagMask, int killPwdLock, int accessPwdLock, int epcLock, int userDataLock, RFIDReader.TagFields tagFields) throws java.lang.Exception
accessPassword
- Specifies the password needed to lock the tag data.tagMask
- object used to filter which tag is to be readkillPwdLock
- Specify the type of lock to be applied
accessPwdLock
- Specify the type of lock to be applied
epcLock
- Specify the type of lock to be applied
userDataLock
- Specify the type of lock to be applied
tagFields
- Used to return any error codes back to the caller.java.lang.Exception
- A System.TimeoutException will be thrown if the connection to the sensor cannot
be established or the module doesn't respond.public RFIDReader.TagReadInfo ReadNextTag() throws java.lang.Exception
java.lang.Exception
- Generally, no exceptions will be thrown for this call. As always, it is good practice
to put this in a try/catch block to handle unusual situations that might crop up and cause your application
to crash if not caught.
public RFIDReader.TagFields ReadTagData(int accessPassword, RFIDReader.TagMask tagMask, RFIDReader.TagFields tagFields) throws java.lang.Exception
accessPassword
- This specifies the password needed when reading the tag data. In general,
specifying a non-zero value is only needed when the access password and/or kill password have
been locked. For all other data banks and to read the passwords when they are not locked, either 0
or the value that matches the currently programmed password for the tag can be used.tagMask
- This parameter is a TagMask object containing the mask information.tagFields
- This parameter is a TagFields object that will contain the information read from
the tag.java.lang.Exception
- A System.TimeoutException will be thrown if the connection to the sensor
cannot be established or the module doesn't respond. A System.IndexOutOfRangeException will
be thrown if the "data" array was not allocated with at least a size of dataWordLength.public boolean Reboot() throws java.lang.Exception
java.lang.Exception
- A System.TimeoutException will be thrown if a connection to the sensor
cannot be established or the module doesn't respond.
public boolean ResetReceiveTimeout()
public boolean ResetToDefaultConfiguration() throws java.lang.Exception
java.lang.Exception
- A System.TimeoutException will be thrown if a connection to the sensor
cannot be established or the module doesn't respond.
public boolean RestoreSavedConfiguration() throws java.lang.Exception
java.lang.Exception
- A System.TimeoutException will be thrown if a connection to the sensor
cannot be established or the module doesn't respond.
public boolean SaveCurrentConfiguration() throws java.lang.Exception
java.lang.Exception
- A System.TimeoutException will be thrown if a connection to the sensor
cannot be established or the module doesn't respond.
public boolean Set24VStatus(RFIDReader.Config24V config24V) throws java.lang.Exception
config24V
- This input parameter is a Config24V object that contains a boolean,
state24V, that turns 24VDC power on when true and off when false, and a boolean,
startupState24V, that determines whether the 24VDC power is on (true) when the sensor
is restarted, or off (false).java.lang.Exception
- A System.TimeoutException will be thrown if the connection to the sensor
cannot be established or the module doesn't respond.
public boolean SetActiveAntenna(int antennaId) throws java.lang.Exception
antennaId
- The id of the antenna for transmitting RF power. This value must
be between 0 (the internal antenna) and 3.java.lang.Exception
- A System.TimeoutException will be thrown if a connection to the sensor cannot
be established or the module doesn't respond.
public boolean SetAntennaPower(int antennaNumber, RFIDReader.PowerSettings pSettings) throws java.lang.Exception
antennaNumber
- The number of the antenna for which the power is to be set. Range
is from 0 to 3pSettings
- Object containing readPower and writePower. readPower is to be used
when reading tags in dBm. Valid range is from 5 to 30. writePower is
to be used when writing tags in dBm. Valid range is from 5 to 30.java.lang.Exception
- A System.TimeoutException will be thrown if a connection to the sensor cannot
be established or the module doesn't respond.public RFIDReader.RFIDStatus SetGen2Params(RFIDReader.InventoryParameters ip) throws java.lang.Exception
ip
- This is from the InventoryParamers object containing the various Gen2
p0arametersjava.lang.Exception
- A System.TimeoutException will be thrown if a connection to the
sensor cannot be established or the module doesn't respond.
public boolean SetGeneralPurposeOutputs(byte newGPOs) throws java.lang.Exception
newGPOs
- This input parameter is sent to the sensor to turn the general-purpose
outputs on or off. The 8 bits of the value are [0, 0, 0, 0, 04, 03, 02, 01]. A 1 turns
the output on, and a 0 turns it offjava.lang.Exception
- A System.TimeoutException will be thrown if the connection to the sensor
cannot be established or the module doesn't respond.public boolean SetHeartbeatConfig(RFIDReader.ReaderHeartbeatSettings settings) throws java.lang.Exception
settings
- This parameter is an object of ReaderHeartbeatSettings containing the
heartbeat configuration to be set in the reader.java.lang.Exception
- A System.TimeoutException will be thrown if a connection to the sensor
cannot be established or the module doesn't respond.
public boolean SetInventoryFilter(RFIDReader.TagMask filter) throws java.lang.Exception
filter
- This input parameter is a TagMask object that contains the mask information
to be used in the filter.java.lang.Exception
- A System.TimeoutException will be thrown if the connection to the sensor
cannot be established or the module doesn't respond.
public void SetIPv4CommLink(java.lang.String sIPv4Address, int portNumber)
sIPv4Address
- Input parameter with dotted format IP address (e.g., "192.168.1.150").portNumber
- Input parameter with the TCP port that the primary command communication will take place over.
public boolean SetIPv4Info(RFIDReader.ReaderNetworkSettings settings) throws java.lang.Exception
settings
- This input object contains the input values for DHCPActive, IpV4
address, IpV4 netmask, IPv4Gateway, IPv4DNSServer, sensorPort.java.lang.Exception
- A System.TimeoutException will be thrown if a connection to the sensor
cannot be established or the module doesn't respond. A System.FormatException will be
Thrown if any of the parameters IPv4Address, IPv4Netmask, IpV4Gateway, or IpV4DNSServer
is not a valid dot notation IP address.
public boolean SetLinkParams(byte linkParams, boolean save) throws java.lang.Exception
linkParams
- this parameter sets the link parameters to the following values:
save
- this parameter sets whether or not the link parameters will be saved to the
module after a power cycle.java.lang.Exception
- A System.TimeoutException will be thrown if a connection to the sensor
cannot be established or the module doesn't respond.
public boolean SetLocatorSignalState(boolean stateActive) throws java.lang.Exception
stateActive
- Input parameter, when true, turns the locator flash
pattern on, and when false, returns the flash pattern to normal operating
mode indication.java.lang.Exception
- A System.TimeoutException will be thrown if a connection to the sensor
cannot be established or the module doesn't respond.
public boolean SetModulePower(RFIDReader.PowerSettings pSettings) throws java.lang.Exception
pSettings
- Object containing readPower and writePower. readPower is to be used
when reading tags in dBm. Valid range is from 5 to 30. writePower is
to be used when writing tags in dBm. Valid range is from 5 to 30.java.lang.Exception
- A System.TimeoutException will be thrown if a connection to the sensor cannot
be established or the module doesn't respond.public boolean SetReaderName(java.lang.String readerName) throws java.lang.Exception
readerName
- Input parameter specifying the name of the reader to be advertised
in the sensor's heartbeat message. The name cannot be longer than 31 characters.java.lang.Exception
- A System.TimeoutException will be thrown if a connection to the
sensor cannot be established or the module doesn't respond.public boolean SetReadGapTimes(RFIDReader.ReadGapTimes readGapTimes) throws java.lang.Exception
readGapTimes
- This input parameter is a ReadGapTimes object that contains the read
time and gap time to be set in the sensor.java.lang.Exception
- A System.TimeoutException will be thrown if the connection to the sensor
cannot be established or the module doesn't respond.
public boolean SetReadSequence(int[] antennaSequence) throws java.lang.Exception
antennaSequence
- This input parameter is used to pass an array of antenna numbers
to the reader to set the sequence of antennas that it will cycle through during a continuous
inventory read cycle.java.lang.Exception
- A System.TimeoutException will be thrown if the connection to the sensor cannot
be established or the module doesn't respond.
public boolean SetSearchMode(byte searchMode) throws java.lang.Exception
searchMode
- This parameter specifies the search mode (0) - dual or (1) - single
to be set.java.lang.Exception
- A System.TimeoutException will be thrown if a connection to the sensor
cannot be established or the module doesn't respond.public RFIDReader.RFIDStatus SetSessionParameter(byte sessionParam) throws java.lang.Exception
sessionParam
- This input parameter passes in the value for the session parameter
to be set. The values are 0 through 3 for session 0 through 3.java.lang.Exception
- A System.TimeoutException will be thrown if the connection to the sensor
cannot be established or the module doesn't respond.
public void SetTagReadCallback(RFIDReader.OnTagReadResponse tagReadHandler)
tagReadHandler
- this parameter specifies the callback routine that is calledtagReadHandler
- each time tag data is reported during a continuous inventory cycle.
public boolean SetTempNotificationSetup(RFIDReader.TemperatureNotificationSettings tempSettings) throws java.lang.Exception
tempSettings
- input TemperatureNotificationSetting object that contains the
information to be set to the reader.java.lang.Exception
- A System.TimeoutException will be thrown if a connection to the sensor
cannot be established or the module doesn't respond.
public void Shutdown()
public boolean StartContinuousRead() throws java.lang.Exception
java.lang.Exception
- a System.TimeoutException will be thrown if the initial connection to the sensor
cannot be established.
public boolean StopContinuousRead() throws java.lang.Exception
java.lang.Exception
- A System.TimeoutException will be thrown if the connection to the sensor has been
lost and cannot be reestablished in a timely manner.
public RFIDReader.TagFields WriteTagData(int accessPassword, RFIDReader.TagMask tagMask, RFIDReader.TagFields tagFields) throws java.lang.Exception
accessPassword
- Described in detail under the ReadTagData() method.tagMask
- Described in detail under the ReadTagData() method.tagFields
- TagFields object containing the information to be written to the tag.java.lang.Exception
- A System.TimeoutException will be thrown if the connection to the sensor
cannot be established or the module doesn't respond.