rfid.api

Class ReaderManagement

java.lang.Object

rfid.api.ReaderManagement

public class ReaderManagement
extends java.lang.Object

This class encapsulates the Reader Management functionality such as reboot, firmware update. Also, proprietary reader functions such as Antenna Mode (Bi-Static or Mono-static), Enable/Get Read Point status functionality can be performed using this class.

Field Summary

Fields

Modifier and Type	Field and Description
LLRPConnection	LLRPConnection LLRP Connection Object required for LLRP Server/Client connectivity.
boolean	m_PowerNegotiateState
Profile	Profile
ReadPoint	ReadPoint Object of Class Readpoint
TimeZone	TimeZone Object of Class TimeZone
UserApp	UserApp

Constructor Summary

Constructors

Constructor and Description
ReaderManagement() Reader Management constructor
ReaderManagement(API3Abstract rfidApi4Abstract)

Method Summary

Modifier and Type	Method and Description
boolean	clearReaderStatistics() Clears the reader statistics maintained in the reader
void	dispose() Dispose Reader Management
ANTENNA_MODE	getAntennaMode() Gets the antenna mode to enumerations (Mono-Static or Bi-Static)
API3Abstract	getApi3Abstract()
void	getApi3Abstract(API3Abstract api3Abstract)
CableLossCompensation	getCableLossCompensation(int antennaID) Gets Cable Loss Compensation Info for the given Antenna ID
int	getGPIDebounceTimeMilliseconds() Gets the GPI Debounce Time
HEALTH_STATUS	getHealthStatus(SERVICE_ID serviceID) This function gets the health status of the reader
java.lang.String	getLocalTime() Reader's Local time
RadioConfigUpdate	getRadioConfigUpdate() Gets the Radio Config Update object
RadioFirmwareUpdate	getRadioFirmwareUpdate() Gets the reader firmware update object
int	getRadioIdleTimeout() Gets the Radio Idle Timeout configured in the reader
ReaderInfo	getReaderInfo() Reader information
ReaderRegion	getReaderRegion() Region Setting: This class contains methods for getting or setting the reader's region
ReaderStatistics	getReaderStatistics(short antennaID) Gets the Reader Statistics from the reader
SoftwareUpdate	getSoftwareUpdate() Gets the software Update object
SystemInfo	getSystemInfo() This function gets the system information related to the Reader like Reader Name, Firmware version, RAM available, Flash available, Up time (how long the reader is running)
TRACE_LEVEL[]	getTraceLevel() Gets the trace level
USBOperationMode	getUSBOperationMode() USB operation mode of the Reader.
boolean	isLoggedIn() Gets the login status whether logged in or not.
boolean	IsNullOrEmpty(java.lang.String param)
void	login(LoginInfo loginInfo, READER_TYPE readerType) This method allows to login into the reader.
void	logout() This call performs the logout and clean-up activity in the library
void	restart() This method restarts or reboot the reader.To restart the reader for any reasons, this method allows to restart the reader.
void	setAntennaMode(ANTENNA_MODE antennaMode) Sets the antenna mode to enumerations (Mono-Static or Bi-Static) value sets the specified antenna mode in the reader.
void	setCableLossCompensation(CableLossCompensation[] cableLossCompensationInfo) Sets the cable Loss Compensation for antennas
void	setGPIDebounceTimeMilliseconds(int gpiDebounceTimeMilliseconds) Sets the GPI Debounce Time
void	setLocalTime(SYSTEMTIME localTime) Reader's Local time
void	setReaderInfo(ReaderInfo readerInfo) Reader information
void	setTraceLevel(TRACE_LEVEL traceLevel) Sets the trace level
void	setTraceLevel(TRACE_LEVEL[] arrTraceLevel)
void	setUSBOperationMode(USBOperationMode usbOperationMode) USB operation mode of the Reader.
void	setUserLED(LedInfo ledInfo) Sets the User LED information
void	turnOffRadiowhenIdle(int idleTimeout) Turns Off Radio When Idle

Methods inherited from class java.lang.Object

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

Field Detail

Profile

public Profile Profile

UserApp

public UserApp UserApp

m_PowerNegotiateState

public boolean m_PowerNegotiateState

LLRPConnection

public LLRPConnection LLRPConnection

LLRP Connection Object required for LLRP Server/Client connectivity.

ReadPoint

public ReadPoint ReadPoint

Object of Class Readpoint

TimeZone

public TimeZone TimeZone

Object of Class TimeZone

Constructor Detail

ReaderManagement

public ReaderManagement()

Reader Management constructor

ReaderManagement

public ReaderManagement(API3Abstract rfidApi4Abstract)

Method Detail

getApi3Abstract

public API3Abstract getApi3Abstract()

getApi3Abstract

public void getApi3Abstract(API3Abstract api3Abstract)

dispose

public void dispose()
             throws InvalidUsageException,
                    OperationFailureException

Dispose Reader Management

Throws:

InvalidUsageException

OperationFailureException

getTraceLevel

public TRACE_LEVEL[] getTraceLevel()

Gets the trace level

setTraceLevel

public void setTraceLevel(TRACE_LEVEL traceLevel)

Sets the trace level

setTraceLevel

public void setTraceLevel(TRACE_LEVEL[] arrTraceLevel)

getAntennaMode

public ANTENNA_MODE getAntennaMode()
                            throws InvalidUsageException,
                                   OperationFailureException

Gets the antenna mode to enumerations (Mono-Static or Bi-Static)

Throws:

InvalidUsageException

OperationFailureException

setAntennaMode

public void setAntennaMode(ANTENNA_MODE antennaMode)
                    throws InvalidUsageException,
                           OperationFailureException

Sets the antenna mode to enumerations (Mono-Static or Bi-Static) value sets the specified antenna mode in the reader. Changing the antenna mode take few seconds to perform the required operation

Throws:

InvalidUsageException

OperationFailureException

isLoggedIn

public boolean isLoggedIn()

Gets the login status whether logged in or not. If logged in to the reader, it returns true, else false.

getRadioFirmwareUpdate

public RadioFirmwareUpdate getRadioFirmwareUpdate()
                                           throws InvalidUsageException

Gets the reader firmware update object

Returns:

Throws:

InvalidUsageException

getSoftwareUpdate

public SoftwareUpdate getSoftwareUpdate()
                                 throws InvalidUsageException

Gets the software Update object

Throws:

InvalidUsageException

getRadioConfigUpdate

public RadioConfigUpdate getRadioConfigUpdate()
                                       throws InvalidUsageException

Gets the Radio Config Update object

Throws:

InvalidUsageException

IsNullOrEmpty

public boolean IsNullOrEmpty(java.lang.String param)

login

public void login(LoginInfo loginInfo,
                  READER_TYPE readerType)
           throws InvalidUsageException,
                  OperationFailureException

This method allows to login into the reader.

Parameters:

loginInfo - Login information is required for Fixed Reader. It can be null for Hand held readers.

readerType - Specifies the reader type

Throws:

InvalidUsageException

OperationFailureException - Operation Failure exception is thrown when the parameter is invalid

logout

public void logout()
            throws InvalidUsageException,
                   OperationFailureException

This call performs the logout and clean-up activity in the library

Throws:

InvalidUsageException

OperationFailureException

getReaderRegion

public ReaderRegion getReaderRegion()

Region Setting: This class contains methods for getting or setting the reader's region

restart

public void restart()
             throws InvalidUsageException,
                    OperationFailureException

This method restarts or reboot the reader.To restart the reader for any reasons, this method allows to restart the reader. After calling this method, it is always necessary to call the logout method to clean up the resources in the library. To reconnect back, call login method again.

Throws:

InvalidUsageException

OperationFailureException - Operation Failure exception is thrown when it is not logged in

getSystemInfo

public SystemInfo getSystemInfo()
                         throws InvalidUsageException,
                                OperationFailureException

This function gets the system information related to the Reader like Reader Name, Firmware version, RAM available, Flash available, Up time (how long the reader is running)

Returns:

Throws:

InvalidUsageException

OperationFailureException - Operation failure is thrown when it is not logged in

getHealthStatus

public HEALTH_STATUS getHealthStatus(SERVICE_ID serviceID)
                              throws InvalidUsageException,
                                     OperationFailureException

This function gets the health status of the reader

Parameters:

serviceID -

Throws:

InvalidUsageException

OperationFailureException - Operation failure is thrown when it is not logged in

setUserLED

public void setUserLED(LedInfo ledInfo)
                throws InvalidUsageException,
                       OperationFailureException

Sets the User LED information

Parameters:

ledInfo - LED information required for the Reader.

Throws:

InvalidUsageException

OperationFailureException - Operation failure is thrown when it is not logged in

getGPIDebounceTimeMilliseconds

public int getGPIDebounceTimeMilliseconds()
                                   throws InvalidUsageException,
                                          OperationFailureException

Gets the GPI Debounce Time

Throws:

InvalidUsageException

OperationFailureException

setGPIDebounceTimeMilliseconds

public void setGPIDebounceTimeMilliseconds(int gpiDebounceTimeMilliseconds)
                                    throws InvalidUsageException,
                                           OperationFailureException

Sets the GPI Debounce Time

Throws:

InvalidUsageException

OperationFailureException

getLocalTime

public java.lang.String getLocalTime()
                              throws InvalidUsageException,
                                     OperationFailureException

Reader's Local time

Returns:

Reader Local Time

Throws:

InvalidUsageException

OperationFailureException

setLocalTime

public void setLocalTime(SYSTEMTIME localTime)
                  throws InvalidUsageException,
                         OperationFailureException

Reader's Local time

Parameters:

localTime - Local Time to Set in the reader

Throws:

InvalidUsageException

OperationFailureException

getUSBOperationMode

public USBOperationMode getUSBOperationMode()
                                     throws InvalidUsageException,
                                            OperationFailureException

USB operation mode of the Reader.

Returns:

USB operation mode used in reader

Throws:

InvalidUsageException

OperationFailureException - Operation failure is thrown when it is not logged in

setUSBOperationMode

public void setUSBOperationMode(USBOperationMode usbOperationMode)
                         throws InvalidUsageException,
                                OperationFailureException

USB operation mode of the Reader.

Throws:

InvalidUsageException

OperationFailureException - Operation failure is thrown when it is not logged in

getReaderInfo

public ReaderInfo getReaderInfo()
                         throws InvalidUsageException,
                                OperationFailureException

Reader information

Returns:

Throws:

InvalidUsageException

OperationFailureException - Operation failure is thrown when it is not logged in

setReaderInfo

public void setReaderInfo(ReaderInfo readerInfo)
                   throws InvalidUsageException,
                          OperationFailureException

Reader information

Throws:

InvalidUsageException

OperationFailureException - Operation failure is thrown when it is not logged in

getReaderStatistics

public ReaderStatistics getReaderStatistics(short antennaID)
                                     throws InvalidUsageException,
                                            OperationFailureException

Gets the Reader Statistics from the reader

Parameters:

antennaID -

Returns:

ReaderStatistics Object for the requested Antenna ID

Throws:

InvalidUsageException

OperationFailureException

clearReaderStatistics

public boolean clearReaderStatistics()
                              throws InvalidUsageException,
                                     OperationFailureException

Clears the reader statistics maintained in the reader

Returns:

Throws:

InvalidUsageException

OperationFailureException

turnOffRadiowhenIdle

public void turnOffRadiowhenIdle(int idleTimeout)
                          throws InvalidUsageException,
                                 OperationFailureException

Turns Off Radio When Idle

Parameters:

idleTimeout - Radio will be turned off after specified Timeout if Idle (no radio operation is performed), 0 - Disables the Idle mode

Throws:

InvalidUsageException

OperationFailureException

getRadioIdleTimeout

public int getRadioIdleTimeout()
                        throws InvalidUsageException,
                               OperationFailureException

Gets the Radio Idle Timeout configured in the reader

Returns:

Radio Idle Timeout

Throws:

InvalidUsageException

OperationFailureException

setCableLossCompensation

public void setCableLossCompensation(CableLossCompensation[] cableLossCompensationInfo)
                              throws InvalidUsageException,
                                     OperationFailureException

Sets the cable Loss Compensation for antennas

Parameters:

cableLossCompensationInfo - Array of Cable Length Details for each Antenna ID to be configured. If Antenna ID specified as 0, settings will be applied to all the antennas

Throws:

InvalidUsageException

OperationFailureException

getCableLossCompensation

public CableLossCompensation getCableLossCompensation(int antennaID)
                                               throws InvalidUsageException,
                                                      OperationFailureException

Gets Cable Loss Compensation Info for the given Antenna ID

Parameters:

antennaID - Antenna ID

Returns:

CableLossCompensation Object

Throws:

InvalidUsageException

OperationFailureException