Package com.zebra.rfid.api3

Class Config

java.lang.Object

com.zebra.rfid.api3.Config

public class Config
extends Object

This class allows to perform reader configuration GPI and GPO not supported in Android RFID SDK

Field Summary

Fields

Modifier and Type	Field	Description
Antennas	Antennas	The Antenna Object
GPIs	GPI	The GPIs Object
GPOs	GPO	The GPOs Object
static final IRFIDLogger	LOGGER	The IRFIDLogger Object.

Method Summary

Modifier and Type	Method	Description
RFIDResults	activateEndpoint(IotConfigInfo iotConfigInfo)	method to activate different types of endpoints This method helps activate different types of endpoints.
RFIDResults	addCertificate(String filePath)
EndpointConfigurationInfo	getActiveEndpointConfig()	method to get current active management endpoint configuration of the device This method helps to get the current active management endpoint configured on the device.
IotConfigInfo	getActiveEndpoints()	method to get all the active endpoint names for each type of the device This method helps to get the active endpoint names for each type on the device.
AttributeInfo	getAttribute(int attributeNumber, AttributeInfo attributeInfo)	Gets the attribute type and value
BATCH_MODE	getBatchModeConfig()	Gets the Batch Mode Config
Integer	getBatteryHealth()	Gets the Battery health of reader (either overall health in 0-100% or number of charge cycles)
BatteryStatistics	getBatteryStats()	method to get battery informations This method helps to get battery related information and statistics
BEEPER_VOLUME	getBeeperVolume()	Gets the Beeper Config
ENUM_BLUETOOTH_MODE	getBluetoothMode()	method to get the bluetooth mode from the connected sled device This method helps to get the bluetooth mode(CDC Mode or HID mode)
CableLossCompensation	getCableLossCompensation(int antennaID)	Gets Cable Loss Compensation Info for the given Antenna ID
ArrayList<String>	getCertificates()	method to get the wifi status This method get the installed certificates from the reader
boolean	getChargeTerminalState()	Gets the Charge Terminal state
boolean	getCradleStatus()	This method is used to check the CradleStatus
String	getDefaultProfile()	Retrieves the default profile.
String	getDeviceProperty(ENUM_DEVICE_PROPERTY deviceProperty)	Gets the Device Property
void	getDeviceStatus(boolean battery, boolean power, boolean temperature)	API to fetch the device status in terms of battery, power and temperature
void	getDeviceStatus(boolean battery, boolean power, boolean temperature, boolean onCradle)	API to fetch the device status in terms of battery, power, temperature and cradle status for Stryker device
RFIDResults	getDeviceStatus(DeviceStatus deviceStatus)	Retrieves the status of the device.
void	getDeviceVersionInfo(HashMap<String,String> deviceVersion)	API to get the device version information
DYNAMIC_POWER_OPTIMIZATION	getDPOState()	Gets the DPO state
short	getDutyCycleIndex()	method to get DutyCycleIndex
EndpointConfigurationInfo	getEndpointConfigByName(String epName)	method to get endpoint configuration by name of the device This method helps to get the endpoint configured by name on the device.
ArrayList<String>	getEndpointNames()	method to get endpoint names of the device This method helps to get the endpoint names on the device.
String	getFriendlyName()	Retrieves the friendly name of the device.
String	getKeylayoutType()	method to get Keymap
String	GetLogBuffer()	Gets the log buffer from SDK as String
ENUM_NEW_KEYLAYOUT_TYPE	getLowerTriggerValue()	method to get LowerTriggerValue
ENUM_NEW_KEYLAYOUT_TYPE	getLowerTriggerValue(String klType)	method to get LowerTriggerValue
JSONObject	getMode()	getMode
RADIO_POWER_STATE	getRadioPowerState()	Gets the Radio power state to on or off state
void	getreaderlog(String logtype, boolean state)	Retrieves the reader log type and state.
READER_POWER_STATE	getReaderPowerState()	Gets the Reader power state
RegionInfo	getRegionInfo(RegionInfo regionInfo)	method to get region information (hopping, default channels) for given region
RegulatoryConfig	getRegulatoryConfig()	method to get current regulatory configuration set on the reader
String	getRFIDProfile()	Retrieves the RFID profile.
void	GetSaveLlrpConfigStatus(boolean pSaveStatus)	This method is used for get the Llrp configuration status
SCAN_BATCH_MODE	getScanBatchModeConfig()	Gets the Scan Batch Mode Config
StartTrigger	getStartTrigger()	method to get current start trigger settings from reader
StopTrigger	getStopTrigger()	method to get current stop trigger settings from reader
TagStorageSettings	getTagStorageSettings()	Get TagStorageSettings.
TRACE_LEVEL[]	getTraceLevel()	Gets the trace level
void	getTriggerStatus()	method to getTriggerStatus
UNIQUE_TAG_REPORT_SETTING	getUniqueTagReport()	method to fetch Unique tag reporting settings from the reader
ENUM_NEW_KEYLAYOUT_TYPE	getUpperTriggerValue()	method to get UpperTriggerValue
ENUM_NEW_KEYLAYOUT_TYPE	getUpperTriggerValue(String klType)	method to get UpperTriggerValue
USB_BATCH_MODE	getUsbBatchModeConfig()	Gets the Usb Batch Mode Config
ENUM_DUTY_CYCLE	getUserDutyCycle()	Gets the Duty Cycle for the device.
ENUM_WIFI_STATE	getWifiState()	This method is used for the getting the status of Wifi
Boolean	isUsbMiFiEnabled()	method to get USB MiFi status
boolean	Nw_getDhcpStatus()	method to get the dhcp status This method returns whether dhcp is enabled or disabled
RFIDResults	Nw_getNetworkStatus(Network_IPConfig networkconfig)	method to get the current network status This method fetches the configured network data.
RFIDResults	Nw_setDhcpEnable()	method to Enable DHCP This method enables DHCP
RFIDResults	Nw_setStaticIP(Network_IPConfig networkconfig)	method to set the static ip.
RFIDResults	removeAllCertificates()
RFIDResults	removeCertificate(String certName)
void	resetFactoryDefaults()	Restores to factory default settings in the reader.
void	saveConfig()	method to save configuration permanently to the reader
void	SaveLlrpConfig()	This method is used for saveLlrp configuration
void	setAccessOperationWaitTimeout(int timeout)	method to set access operation timeout for all synchronous tag access operations APIs e.g.
void	setAttribute(SetAttribute setAttributeInfo)	method to Set attribute
void	setBatchMode(BATCH_MODE batchMode)	method to Set Batch Mode
void	setBeeperVolume(BEEPER_VOLUME beeperVolume)	method to Set Beeper Volume
RFIDResults	setBluetoothMode(ENUM_BLUETOOTH_MODE mode)	method to configure the bluetooth mode on the connected sled device This method helps to set the bluetooth mode(CDC Mode or HID mode)
RFIDResults	setCableLossCompensation(CableLossCompensation[] cableLossCompensationInfo)	Sets the cable Loss Compensation for antennas
RFIDResults	setChargeTerminalEnable(boolean enable)	method to set charge terminal enable and disable on sled device
boolean	setDefaultConfigurations(Antennas.AntennaRfConfig antennaRfConfig, Antennas.SingulationControl singulationControl, TagStorageSettings tagStorageSettings, boolean deleteAllPrefilters, boolean dpoEnable, SetAttribute[] setAttributes)	method to set default configurations on reader This method helps to set basic required following configuration on reader in rapid manner - Antenna configuration - Singulation settings - Delete all prefitlers (select record) on device - DPO setting - Any five attributes passed as array of attributes - API sets trigger type to immediate In case any object parameter is null then API will not apply particular configurations so that if application does not want to configure particular parameter pass parameter as null
void	setDeviceProperty(ENUM_DEVICE_PROPERTY deviceProperty, String value)	method to setDeviceProperty
void	setDPOState(DYNAMIC_POWER_OPTIMIZATION dpoState)	method to enable or disable DPO
void	setDutyCycleIndex(short dutyCycleIndex)	method to set DutyCycleIndex
RFIDResults	setEndpointConfiguration(EndpointConfigurationInfo endPointConfigurationInfo)	method to set endpoint configuration This method helps to set endpoint configuration.
RFIDResults	setFriendlyName(String friendlyName)	Sets the Reader Friendly Name
void	setInventoryModeSettings(String unit, int value)	setInventoryModeSettings
RFIDResults	setKeylayoutType(ENUM_KEYLAYOUT_TYPE keylayoutType)	method to set Keymap for triggers
RFIDResults	setKeylayoutType(ENUM_NEW_KEYLAYOUT_TYPE upperTriggerval, ENUM_NEW_KEYLAYOUT_TYPE lowerTriggerval)	method to set KeylayoutType
void	setLedBlinkEnable(boolean enable)	method to set host LED mode to blink LED on tag data
void	setLogLevel(Level logLevel)	Setting the Log level up to which logging will be honoured
void	setOperatingMode(ENUM_OPERATING_MODE operatingMode)	setOperatingMode
void	setportalModeSettings(int port, String signal, int stopInterval)	setportalModeSettings
void	setRadioPowerState(RADIO_POWER_STATE radioPowerState)	Sets the Radio power state to on or off state
void	setreaderlog(String logtype, boolean state)	Sets the reader log type and state.
void	setReaderPowerState(READER_POWER_STATE readerPowerState)	Sets the Reader power state
void	setRegulatoryConfig(RegulatoryConfig regulatoryConfig)	method to set regulatory configuration on the reader
boolean	setRFIDProfile(String profileName)	Sets the RFID profile for the device.
RFIDResults	setScanBatchMode(SCAN_BATCH_MODE scanBatchMode)	method to Set Scan Batch Mode
void	setStartTrigger(StartTrigger startTrigger)	method to set start trigger settings - reader require exclusive call for triggers
void	setStopTrigger(StopTrigger stopTrigger)	method to set stop trigger settings - reader require exclusive call for triggers
void	setTagStorageSettings(TagStorageSettings tagStorageSettings)	This method allows configuring the maximum tag-storage capacity and storage to be allocated in the Tag Data object for the memory bank data and Tag ID (EPC).
void	setTraceLevel(TRACE_LEVEL traceLevel)	Sets the trace level
void	setTraceLevel(TRACE_LEVEL[] arrTraceLevel)	Sets the trace level
boolean	setTriggerMode(ENUM_TRIGGER_MODE trigger_mode, boolean updateScannerPlugin)	method to set trigger mode to Barcode or RFID Application can work with either Phone device (left and right) triggers and reader handheld trigger This trigger should be mapped to either invoke Barcode or RFID functionality when trigger is configured for RFID mode, barcode scanner input plugin should be disabled to ignore hardware triggers when trigger is configured for barcode mode, rfid functionality will be disabled to ignore hardware triggers
boolean	setUniqueTagReport(boolean uniqueTagReport)	method to disable/enable Reporting Unique Tags
void	setUsbBatchMode(USB_BATCH_MODE usbBatchMode)	method to Set Batch Mode for USB
void	setUsbMiFiEnable(boolean enable)	method to Enable USB MiFi support
RFIDResults	setUserDutyCycle(ENUM_DUTY_CYCLE duty_cycle)	Sets the Duty Cycle for the device.
void	setUserFeedback(Integer profile)	method to Set user feedback profile to generate custom LED and BEEP
RFIDResults	updateFirmware(String path, String ip)	Update Firmware User needs to make sure that path is obtained using the Android Storage Access Framework.
RFIDResults	wifi_poweron(boolean poweron)	method to power on/off wifi on sled device This method helps to power on wifi
RFIDResults	wifiAddProfile(WifiProfile wifiprofile, boolean isPreferred)	method to add a new wifi profile This method adds a new bss entry
RFIDResults	wifiConnectNonRoaming(String ssid)	method to connect to specified ssid in nonroam mode This method makes a connection to the specified ssid in non road mode
RFIDResults	wifiConnectRoaming()	method to connect in roaming mode This method enables roaming among the configured SSID list and connects to it.
RFIDResults	wifiDeleteProfile(String ssid)	method to deletes a wifi profile This method deletes a specified bss entry.If no ssid is provided deletes all the bss entries.
RFIDResults	wifiDisable()	method to disable the wifi on the connected sled device This method disables wifi on the sled device.
RFIDResults	wifiDisconnect()	method to disconnect the connected ssid.
RFIDResults	wifiEnable()	method to enable the wifi on the connected sled device This method helps to enable wifi on the sled device.
RFIDResults	wifiGetStatus(HashMap<String,String> status)	method to get the wifi status This method get the wifi status, RSSI, Address, channel, state, band, ssid name, mac, netmask
ArrayList<WifiProfile>	wifiListProfile()	method to dump all the bss entries.
RFIDResults	wifiSaveProfile()	method to save all the user configured wifi profiles to flash This method saves all the created bss entries to flash
RFIDResults	wifiScan()	method to request a new bss scan This method requests a new bss scan
HashMap<String,String>	wifiStatusMap(HashMap<String,String> status)

Methods inherited from class java.lang.Object

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

Field Details

Antennas

public Antennas Antennas

The Antenna Object

GPI

public GPIs GPI

The GPIs Object

GPO

public GPOs GPO

The GPOs Object

LOGGER

public static final IRFIDLogger LOGGER

The IRFIDLogger Object.

Method Details

getDutyCycleIndex

public short getDutyCycleIndex()
                        throws InvalidUsageException,
OperationFailureException

method to get DutyCycleIndex

Returns:

m_DutyCycleIndex

Throws:

InvalidUsageException

OperationFailureException

setDutyCycleIndex

public void setDutyCycleIndex(short dutyCycleIndex)
                       throws InvalidUsageException,
OperationFailureException

method to set DutyCycleIndex

Throws:

InvalidUsageException

OperationFailureException

getRadioPowerState

public RADIO_POWER_STATE getRadioPowerState()
                                     throws InvalidUsageException,
OperationFailureException

Gets the Radio power state to on or off state

Returns:

m_eRadioPowerState if it is success

Throws:

InvalidUsageException

OperationFailureException

setRadioPowerState

public void setRadioPowerState(RADIO_POWER_STATE radioPowerState)
                        throws InvalidUsageException,
OperationFailureException

Sets the Radio power state to on or off state

Throws:

InvalidUsageException

OperationFailureException

getTraceLevel

public TRACE_LEVEL[] getTraceLevel()

Gets the trace level

setTraceLevel

public void setTraceLevel(TRACE_LEVEL[] arrTraceLevel)

Sets the trace level

setLogLevel

public void setLogLevel(Level logLevel)

Setting the Log level up to which logging will be honoured

Parameters:

logLevel -

setreaderlog

public void setreaderlog(String logtype,
 boolean state)
                  throws InvalidUsageException,
OperationFailureException

Sets the reader log type and state.

Parameters:

logtype - The type of log to set.

state - The state of the log (true to enable, false to disable).

Throws:

InvalidUsageException

OperationFailureException

getreaderlog

public void getreaderlog(String logtype,
 boolean state)
                  throws InvalidUsageException,
OperationFailureException

Retrieves the reader log type and state.

Parameters:

logtype - The type of log to retrieve.

state - The state of the log (true to enable, false to disable).

Throws:

InvalidUsageException

OperationFailureException

GetLogBuffer

public String GetLogBuffer()
                    throws InvalidUsageException

Gets the log buffer from SDK as String

Returns:

logBuffer as String

Throws:

InvalidUsageException

getDeviceVersionInfo

public void getDeviceVersionInfo(HashMap<String,String> deviceVersion)
                          throws InvalidUsageException,
OperationFailureException

API to get the device version information

Parameters:

deviceVersion -

Throws:

InvalidUsageException

OperationFailureException

getDeviceStatus

public void getDeviceStatus(boolean battery,
 boolean power,
 boolean temperature)
                     throws InvalidUsageException,
OperationFailureException

API to fetch the device status in terms of battery, power and temperature

Parameters:

battery - If set to true battery information will be retrieved

power - If set to true power information will be retrieved

temperature - If set to true temperature information will be retrieved

Throws:

InvalidUsageException

OperationFailureException

getDeviceStatus

public RFIDResults getDeviceStatus(DeviceStatus deviceStatus)
                            throws InvalidUsageException,
OperationFailureException

Retrieves the status of the device.

Parameters:

deviceStatus - The device status object that will be populated with the current status.

Returns:

The result of the device status retrieval operation.

Throws:

InvalidUsageException - If the usage of the method is invalid.

OperationFailureException - If the operation to retrieve the device status fails.

getDeviceStatus

public void getDeviceStatus(boolean battery,
 boolean power,
 boolean temperature,
 boolean onCradle)
                     throws InvalidUsageException,
OperationFailureException

API to fetch the device status in terms of battery, power, temperature and cradle status for Stryker device

Throws:

InvalidUsageException

OperationFailureException

getDefaultProfile

public String getDefaultProfile()
                         throws OperationFailureException,
InvalidUsageException

Retrieves the default profile.

Returns:

The default profile as a String.

Throws:

OperationFailureException

InvalidUsageException

getRFIDProfile

public String getRFIDProfile()
                      throws OperationFailureException,
InvalidUsageException

Retrieves the RFID profile. This method retrieves the current RFID profile from the device.

Returns:

The RFID profile as a String. This represents the profile name.

Throws:

OperationFailureException

InvalidUsageException

setRFIDProfile

public boolean setRFIDProfile(String profileName)
                       throws OperationFailureException,
InvalidUsageException

Sets the RFID profile for the device. This method configures the device to use the specified RFID profile.

Parameters:

profileName - The name of the RFID profile to set.

Returns:

`true` if the RFID profile was set successfully, `false` otherwise.

Throws:

OperationFailureException

InvalidUsageException

setDeviceProperty

public void setDeviceProperty(ENUM_DEVICE_PROPERTY deviceProperty,
 String value)
                       throws OperationFailureException,
InvalidUsageException

method to setDeviceProperty

Parameters:

deviceProperty - - Enum value to set device property

value - - set property value

Throws:

InvalidUsageException

OperationFailureException

getDeviceProperty

public String getDeviceProperty(ENUM_DEVICE_PROPERTY deviceProperty)
                         throws OperationFailureException,
InvalidUsageException

Gets the Device Property

Parameters:

deviceProperty - - Enum value to get device property

Returns:

value

Throws:

InvalidUsageException

OperationFailureException

setTraceLevel

public void setTraceLevel(TRACE_LEVEL traceLevel)

Sets the trace level

getTagStorageSettings

public TagStorageSettings getTagStorageSettings()
                                         throws InvalidUsageException,
OperationFailureException

Get TagStorageSettings.

Returns:

tagStorageSettings

Throws:

InvalidUsageException

OperationFailureException

setTagStorageSettings

public void setTagStorageSettings(TagStorageSettings tagStorageSettings)
                           throws InvalidUsageException,
OperationFailureException

This method allows configuring the maximum tag-storage capacity and storage to be allocated in the Tag Data object for the memory bank data and Tag ID (EPC). Also, it allows to set the number of tags to be queued in side the Library. The application can use this method to customize the tag data size(EPC and Memory Bank) based on the requirements. Also, this method allows to configure the queue size of the Library maintained. Tags reported from the reader as part of inventory or read-access operation will be queued internally in the library till it is called using GetReadTag. When the number of tags queued in the library exceeds the max tag count, the event enabled for BUFFER_FULL_WARNING_EVENT will be signalled. This event also be signalled when reader internal buffers are full. It is recommended to use the default settings unless it is explicitly required for advanced user to optimize the performance or necessary to adjust the EPC or memory bank size

Parameters:

tagStorageSettings - Settings like MaxTagCount, MaxMemoryBankSize, MaxEPCID, selection of tag fields

Throws:

InvalidUsageException

OperationFailureException - This exception is thown when the parameters are invalid

resetFactoryDefaults

public void resetFactoryDefaults()
                          throws InvalidUsageException,
OperationFailureException

Restores to factory default settings in the reader. Once this method is called, all the settings will be lost. For eg. events, singulation control. The application is required to redo the basic steps for initializing the reader.

Throws:

InvalidUsageException

OperationFailureException

SaveLlrpConfig

public void SaveLlrpConfig()
                    throws InvalidUsageException,
OperationFailureException

This method is used for saveLlrp configuration

Throws:

InvalidUsageException - If the usage of the method is invalid.

OperationFailureException - If the operation to retrieve the device status fails.

GetSaveLlrpConfigStatus

public void GetSaveLlrpConfigStatus(boolean pSaveStatus)
                             throws InvalidUsageException,
OperationFailureException

This method is used for get the Llrp configuration status

Throws:

InvalidUsageException - If the usage of the method is invalid.

OperationFailureException - If the operation to retrieve the device status fails.

getStartTrigger

public StartTrigger getStartTrigger()
                             throws InvalidUsageException,
OperationFailureException

method to get current start trigger settings from reader

Returns:

StartTrigger

Throws:

InvalidUsageException

OperationFailureException

setStartTrigger

public void setStartTrigger(StartTrigger startTrigger)
                     throws InvalidUsageException,
OperationFailureException

method to set start trigger settings - reader require exclusive call for triggers

Parameters:

startTrigger -

Throws:

InvalidUsageException

OperationFailureException

setKeylayoutType

public RFIDResults setKeylayoutType(ENUM_KEYLAYOUT_TYPE keylayoutType)
                             throws InvalidUsageException,
OperationFailureException

method to set Keymap for triggers

Parameters:

keylayoutType -

Throws:

InvalidUsageException

OperationFailureException

setKeylayoutType

public RFIDResults setKeylayoutType(ENUM_NEW_KEYLAYOUT_TYPE upperTriggerval,
 ENUM_NEW_KEYLAYOUT_TYPE lowerTriggerval)
                             throws InvalidUsageException,
OperationFailureException

method to set KeylayoutType

Parameters:

upperTriggerval - used for setting upperTriggerval

lowerTriggerval - used for setting lowerTriggerval

Throws:

InvalidUsageException

OperationFailureException

getKeylayoutType

public String getKeylayoutType()
                        throws InvalidUsageException,
OperationFailureException

method to get Keymap

Returns:

keylayoutType

Throws:

InvalidUsageException

OperationFailureException

getUpperTriggerValue

public ENUM_NEW_KEYLAYOUT_TYPE getUpperTriggerValue(String klType)
                                             throws InvalidUsageException,
OperationFailureException

method to get UpperTriggerValue

Returns:

keylayoutType

Throws:

InvalidUsageException

OperationFailureException

getUpperTriggerValue

public ENUM_NEW_KEYLAYOUT_TYPE getUpperTriggerValue()
                                             throws InvalidUsageException,
OperationFailureException

method to get UpperTriggerValue

Returns:

keylayoutType

Throws:

InvalidUsageException

OperationFailureException

getLowerTriggerValue

public ENUM_NEW_KEYLAYOUT_TYPE getLowerTriggerValue(String klType)
                                             throws InvalidUsageException,
OperationFailureException

method to get LowerTriggerValue

Returns:

keylayoutType

Throws:

InvalidUsageException

OperationFailureException

getLowerTriggerValue

public ENUM_NEW_KEYLAYOUT_TYPE getLowerTriggerValue()
                                             throws InvalidUsageException,
OperationFailureException

method to get LowerTriggerValue

Returns:

keylayoutType

Throws:

InvalidUsageException

OperationFailureException

getStopTrigger

public StopTrigger getStopTrigger()
                           throws InvalidUsageException,
OperationFailureException

method to get current stop trigger settings from reader

Returns:

stopTrigger

Throws:

InvalidUsageException

OperationFailureException

setStopTrigger

public void setStopTrigger(StopTrigger stopTrigger)
                    throws InvalidUsageException,
OperationFailureException

method to set stop trigger settings - reader require exclusive call for triggers

Parameters:

stopTrigger -

Throws:

InvalidUsageException

OperationFailureException

getTriggerStatus

public void getTriggerStatus()
                      throws OperationFailureException,
InvalidUsageException

method to getTriggerStatus

Throws:

InvalidUsageException

OperationFailureException

setAccessOperationWaitTimeout

public void setAccessOperationWaitTimeout(int timeout)
                                   throws InvalidUsageException,
OperationFailureException

method to set access operation timeout for all synchronous tag access operations APIs e.g. readWait,writeWait,lockWait,blockWriteWait Note: This timeout is not applicable for asynchronous APIs e.g. readEvent,writeEvent etc.

Parameters:

timeout -

Throws:

InvalidUsageException

OperationFailureException

getDPOState

public DYNAMIC_POWER_OPTIMIZATION getDPOState()
                                       throws InvalidUsageException,
OperationFailureException

Gets the DPO state

Returns:

DYNAMIC_POWER_OPTIMIZATION ENABLE / DISABLE

Throws:

InvalidUsageException

OperationFailureException

setDPOState

public void setDPOState(DYNAMIC_POWER_OPTIMIZATION dpoState)
                 throws InvalidUsageException,
OperationFailureException

method to enable or disable DPO

Parameters:

dpoState -

Throws:

InvalidUsageException

OperationFailureException

getBatchModeConfig

public BATCH_MODE getBatchModeConfig()
                              throws InvalidUsageException,
OperationFailureException

Gets the Batch Mode Config

Returns:

BATCH_MODE configurations

Throws:

InvalidUsageException

OperationFailureException

setBatchMode

public void setBatchMode(BATCH_MODE batchMode)
                  throws InvalidUsageException,
OperationFailureException

method to Set Batch Mode

Parameters:

batchMode -

Throws:

InvalidUsageException

OperationFailureException

getUsbBatchModeConfig

public USB_BATCH_MODE getUsbBatchModeConfig()
                                     throws InvalidUsageException,
OperationFailureException

Gets the Usb Batch Mode Config

Returns:

USB_BATCH_MODE configurations

Throws:

InvalidUsageException

OperationFailureException

setUsbBatchMode

public void setUsbBatchMode(USB_BATCH_MODE usbBatchMode)
                     throws InvalidUsageException,
OperationFailureException

method to Set Batch Mode for USB

Parameters:

usbBatchMode -

Throws:

InvalidUsageException

OperationFailureException

getScanBatchModeConfig

public SCAN_BATCH_MODE getScanBatchModeConfig()
                                       throws InvalidUsageException,
OperationFailureException

Gets the Scan Batch Mode Config

Returns:

SCAN_BATCH_MODE configurations

Throws:

InvalidUsageException

OperationFailureException

setScanBatchMode

public RFIDResults setScanBatchMode(SCAN_BATCH_MODE scanBatchMode)
                             throws InvalidUsageException,
OperationFailureException

method to Set Scan Batch Mode

Parameters:

scanBatchMode -

Returns:

RFIDResults

Throws:

InvalidUsageException

OperationFailureException

getBeeperVolume

public BEEPER_VOLUME getBeeperVolume()
                              throws InvalidUsageException,
OperationFailureException

Gets the Beeper Config

Returns:

BEEPER_VOLUME

Throws:

InvalidUsageException

OperationFailureException

setBeeperVolume

public void setBeeperVolume(BEEPER_VOLUME beeperVolume)
                     throws InvalidUsageException,
OperationFailureException

method to Set Beeper Volume

Parameters:

beeperVolume -

Throws:

InvalidUsageException

OperationFailureException

getAttribute

public AttributeInfo getAttribute(int attributeNumber,
 AttributeInfo attributeInfo)
                           throws InvalidUsageException,
OperationFailureException

Gets the attribute type and value

Parameters:

attributeNumber -

Returns:

AttributeInfo

Throws:

InvalidUsageException

OperationFailureException

setAttribute

public void setAttribute(SetAttribute setAttributeInfo)
                  throws InvalidUsageException,
OperationFailureException

method to Set attribute

Parameters:

setAttributeInfo -

Throws:

InvalidUsageException

OperationFailureException

saveConfig

public void saveConfig()
                throws InvalidUsageException,
OperationFailureException

method to save configuration permanently to the reader

Throws:

InvalidUsageException

OperationFailureException

getRegulatoryConfig

public RegulatoryConfig getRegulatoryConfig()
                                     throws InvalidUsageException,
OperationFailureException

method to get current regulatory configuration set on the reader

Returns:

regulatoryConfig

Throws:

InvalidUsageException

OperationFailureException

setRegulatoryConfig

public void setRegulatoryConfig(RegulatoryConfig regulatoryConfig)
                         throws InvalidUsageException,
OperationFailureException

method to set regulatory configuration on the reader

Parameters:

regulatoryConfig -

Throws:

InvalidUsageException

OperationFailureException

getRegionInfo

public RegionInfo getRegionInfo(RegionInfo regionInfo)
                         throws InvalidUsageException,
OperationFailureException

method to get region information (hopping, default channels) for given region

Parameters:

regionInfo -

Returns:

regionInfo

Throws:

InvalidUsageException

OperationFailureException

setUniqueTagReport

public boolean setUniqueTagReport(boolean uniqueTagReport)
                           throws InvalidUsageException,
OperationFailureException

method to disable/enable Reporting Unique Tags

Parameters:

uniqueTagReport -

Returns:

RFIDResults

Throws:

InvalidUsageException

OperationFailureException

getUniqueTagReport

public UNIQUE_TAG_REPORT_SETTING getUniqueTagReport()
                                             throws InvalidUsageException,
OperationFailureException

method to fetch Unique tag reporting settings from the reader

Returns:

m_eUniqueTagReport

Throws:

InvalidUsageException

OperationFailureException

setLedBlinkEnable

public void setLedBlinkEnable(boolean enable)
                       throws InvalidUsageException,
OperationFailureException

method to set host LED mode to blink LED on tag data

Parameters:

enable - when enabled LED will blink on each tag data read through inventory or access operation

Throws:

InvalidUsageException

OperationFailureException

setTriggerMode

public boolean setTriggerMode(ENUM_TRIGGER_MODE trigger_mode,
 boolean updateScannerPlugin)
                       throws InvalidUsageException,
OperationFailureException

method to set trigger mode to Barcode or RFID Application can work with either Phone device (left and right) triggers and reader handheld trigger This trigger should be mapped to either invoke Barcode or RFID functionality when trigger is configured for RFID mode, barcode scanner input plugin should be disabled to ignore hardware triggers when trigger is configured for barcode mode, rfid functionality will be disabled to ignore hardware triggers

Parameters:

trigger_mode - ENUM selection between BARCODE or RFID mode

updateScannerPlugin - SDK tries to disable scanner input plugin if RFID mode is selected and enable if BARCODE mode is selected

Returns:

RFIDResults

Throws:

InvalidUsageException

OperationFailureException

setUserDutyCycle

public RFIDResults setUserDutyCycle(ENUM_DUTY_CYCLE duty_cycle)
                             throws OperationFailureException,
InvalidUsageException

Sets the Duty Cycle for the device. This method configures the device to use the specified Duty Cycle.

Parameters:

duty_cycle - To set Duty Cycle as MIN,MAX or MEDIUM.

Returns:

RFIDResults

Throws:

InvalidUsageException

OperationFailureException

getUserDutyCycle

public ENUM_DUTY_CYCLE getUserDutyCycle()
                                 throws OperationFailureException,
InvalidUsageException

Gets the Duty Cycle for the device. This method configures the device to get the specified Duty Cycle.

Returns:

Duty Cycle as 0=MIN,1=MAX or 2=MEDIUM

Throws:

InvalidUsageException

OperationFailureException

setDefaultConfigurations

public boolean setDefaultConfigurations(Antennas.AntennaRfConfig antennaRfConfig,
 Antennas.SingulationControl singulationControl,
 TagStorageSettings tagStorageSettings,
 boolean deleteAllPrefilters,
 boolean dpoEnable,
 SetAttribute[] setAttributes)
                                 throws InvalidUsageException,
OperationFailureException

method to set default configurations on reader This method helps to set basic required following configuration on reader in rapid manner - Antenna configuration - Singulation settings - Delete all prefitlers (select record) on device - DPO setting - Any five attributes passed as array of attributes - API sets trigger type to immediate In case any object parameter is null then API will not apply particular configurations so that if application does not want to configure particular parameter pass parameter as null

Parameters:

antennaRfConfig - anteanna configurations like power, link profile and tar

singulationControl - Query parameters

tagStorageSettings - Tag reporting fields

deleteAllPrefilters - boolean true clear selectrecord on reader, false doesn't alter

dpoEnable - boolean enable disable DPO

setAttributes - array of attributes

Returns:

Throws:

InvalidUsageException

OperationFailureException

getBatteryStats

public BatteryStatistics getBatteryStats()
                                  throws OperationFailureException,
InvalidUsageException

method to get battery informations This method helps to get battery related information and statistics

Returns:

batteryStatistics

Throws:

InvalidUsageException

OperationFailureException

setBluetoothMode

public RFIDResults setBluetoothMode(ENUM_BLUETOOTH_MODE mode)
                             throws InvalidUsageException,
OperationFailureException

method to configure the bluetooth mode on the connected sled device This method helps to set the bluetooth mode(CDC Mode or HID mode)

Returns:

RFIDResults (RFID_API_SUCCESS or other)

Throws:

InvalidUsageException

OperationFailureException

getBluetoothMode

public ENUM_BLUETOOTH_MODE getBluetoothMode()
                                     throws InvalidUsageException,
OperationFailureException

method to get the bluetooth mode from the connected sled device This method helps to get the bluetooth mode(CDC Mode or HID mode)

Returns:

RFIDResults (RFID_API_SUCCESS or other)

Throws:

InvalidUsageException

OperationFailureException

wifi_poweron

public RFIDResults wifi_poweron(boolean poweron)
                         throws InvalidUsageException,
OperationFailureException

method to power on/off wifi on sled device This method helps to power on wifi

Parameters:

poweron - -true indicates power on and false indicates power off

Returns:

RFIDResults (RFID_API_SUCCESS or other)

Throws:

InvalidUsageException

OperationFailureException

getWifiState

public ENUM_WIFI_STATE getWifiState()
                             throws OperationFailureException,
InvalidUsageException

This method is used for the getting the status of Wifi

Throws:

InvalidUsageException

OperationFailureException

wifiEnable

public RFIDResults wifiEnable()
                       throws InvalidUsageException,
OperationFailureException

method to enable the wifi on the connected sled device This method helps to enable wifi on the sled device.

Returns:

RFIDResults (RFID_API_SUCCESS or other)

Throws:

InvalidUsageException

OperationFailureException

wifiDisable

public RFIDResults wifiDisable()
                        throws InvalidUsageException,
OperationFailureException

method to disable the wifi on the connected sled device This method disables wifi on the sled device.

Returns:

RFIDResults (RFID_API_SUCCESS or other)

Throws:

InvalidUsageException

OperationFailureException

wifiAddProfile

public RFIDResults wifiAddProfile(WifiProfile wifiprofile,
 boolean isPreferred)
                           throws InvalidUsageException,
OperationFailureException

method to add a new wifi profile This method adds a new bss entry

Returns:

RFIDResults (RFID_API_SUCCESS or other)

Throws:

InvalidUsageException

OperationFailureException

wifiDeleteProfile

public RFIDResults wifiDeleteProfile(String ssid)
                              throws InvalidUsageException,
OperationFailureException

method to deletes a wifi profile This method deletes a specified bss entry.If no ssid is provided deletes all the bss entries.

Returns:

RFIDResults (RFID_API_SUCCESS or other)

Throws:

InvalidUsageException

OperationFailureException

wifiSaveProfile

public RFIDResults wifiSaveProfile()
                            throws InvalidUsageException,
OperationFailureException

method to save all the user configured wifi profiles to flash This method saves all the created bss entries to flash

Returns:

RFIDResults (RFID_API_SUCCESS or other)

Throws:

InvalidUsageException

OperationFailureException

wifiConnectNonRoaming

public RFIDResults wifiConnectNonRoaming(String ssid)
                                  throws InvalidUsageException,
OperationFailureException

method to connect to specified ssid in nonroam mode This method makes a connection to the specified ssid in non road mode

Returns:

RFIDResults (RFID_API_SUCCESS or other)

Throws:

InvalidUsageException

OperationFailureException

wifiConnectRoaming

public RFIDResults wifiConnectRoaming()
                               throws InvalidUsageException,
OperationFailureException

method to connect in roaming mode This method enables roaming among the configured SSID list and connects to it.

Returns:

RFIDResults (RFID_API_SUCCESS or other)

Throws:

InvalidUsageException

OperationFailureException

wifiDisconnect

public RFIDResults wifiDisconnect()
                           throws InvalidUsageException,
OperationFailureException

method to disconnect the connected ssid. This method shuts down the connection to the connected ssid.

Returns:

RFIDResults (RFID_API_SUCCESS or other)

Throws:

InvalidUsageException

OperationFailureException

wifiScan

public RFIDResults wifiScan()
                     throws InvalidUsageException,
OperationFailureException

method to request a new bss scan This method requests a new bss scan

Returns:

RFIDResults (RFID_API_SUCCESS or other)

Throws:

InvalidUsageException

OperationFailureException

wifiListProfile

public ArrayList<WifiProfile> wifiListProfile()
                                       throws InvalidUsageException,
OperationFailureException

method to dump all the bss entries. This method lists all the configured wifi profiles

Returns:

WifiProfile wifiprofile[] :Array of WifiProfile class objects

Throws:

InvalidUsageException

OperationFailureException

wifiGetStatus

public RFIDResults wifiGetStatus(HashMap<String,String> status)
                          throws InvalidUsageException,
OperationFailureException

method to get the wifi status This method get the wifi status, RSSI, Address, channel, state, band, ssid name, mac, netmask

Returns:

RFIDResults (RFID_API_SUCCESS or other)

Throws:

InvalidUsageException

OperationFailureException

getCertificates

public ArrayList<String> getCertificates()
                                  throws InvalidUsageException,
OperationFailureException

method to get the wifi status This method get the installed certificates from the reader

Returns:

ArrayList

Throws:

InvalidUsageException

OperationFailureException

wifiStatusMap

public HashMap<String,String> wifiStatusMap(HashMap<String,String> status)
                                     throws InvalidUsageException,
OperationFailureException

Throws:

InvalidUsageException

OperationFailureException

addCertificate

public RFIDResults addCertificate(String filePath)
                           throws InvalidUsageException,
OperationFailureException

Throws:

InvalidUsageException

OperationFailureException

removeCertificate

public RFIDResults removeCertificate(String certName)
                              throws InvalidUsageException,
OperationFailureException

Throws:

InvalidUsageException

OperationFailureException

removeAllCertificates

public RFIDResults removeAllCertificates()
                                  throws InvalidUsageException,
OperationFailureException

Throws:

InvalidUsageException

OperationFailureException

Nw_setDhcpEnable

public RFIDResults Nw_setDhcpEnable()
                             throws InvalidUsageException,
OperationFailureException

method to Enable DHCP This method enables DHCP

Returns:

RFIDResults (RFID_API_SUCCESS or other)

Throws:

InvalidUsageException

OperationFailureException

Nw_setStaticIP

public RFIDResults Nw_setStaticIP(Network_IPConfig networkconfig)
                           throws InvalidUsageException,
OperationFailureException

method to set the static ip. This method sets up a static ip for the sled device.

Returns:

RFIDResults (RFID_API_SUCCESS or other)

Throws:

InvalidUsageException

OperationFailureException

Nw_getNetworkStatus

public RFIDResults Nw_getNetworkStatus(Network_IPConfig networkconfig)
                                throws InvalidUsageException,
OperationFailureException

method to get the current network status This method fetches the configured network data.

Returns:

RFIDResults (RFID_API_SUCCESS or other)

Throws:

InvalidUsageException

OperationFailureException

Nw_getDhcpStatus

public boolean Nw_getDhcpStatus()
                         throws InvalidUsageException,
OperationFailureException

method to get the dhcp status This method returns whether dhcp is enabled or disabled

Returns:

boolean True:Dhcp is enabled, False:Dhcp is disabled

Throws:

InvalidUsageException

OperationFailureException

setChargeTerminalEnable

public RFIDResults setChargeTerminalEnable(boolean enable)
                                    throws InvalidUsageException,
OperationFailureException

method to set charge terminal enable and disable on sled device

Parameters:

enable - -true indicates enable and false indicates disable charge terminal

Returns:

RFIDResults (RFID_API_SUCCESS or other)

Throws:

InvalidUsageException

OperationFailureException

getChargeTerminalState

public boolean getChargeTerminalState()

Gets the Charge Terminal state

setFriendlyName

public RFIDResults setFriendlyName(String friendlyName)
                            throws InvalidUsageException,
OperationFailureException

Sets the Reader Friendly Name

Parameters:

friendlyName - Required

Returns:

RFIDResults (RFID_API_SUCCESS or other)

Throws:

InvalidUsageException

OperationFailureException

getFriendlyName

public String getFriendlyName()
                       throws InvalidUsageException,
OperationFailureException

Retrieves the friendly name of the device.

Returns:

The friendly name of the device as a `String`.

Throws:

InvalidUsageException

OperationFailureException

getCradleStatus

public boolean getCradleStatus()
                        throws InvalidUsageException,
OperationFailureException

This method is used to check the CradleStatus

Throws:

InvalidUsageException

OperationFailureException

getReaderPowerState

public READER_POWER_STATE getReaderPowerState()
                                       throws InvalidUsageException,
OperationFailureException

Gets the Reader power state

Returns:

READER_POWER_STATE

Throws:

InvalidUsageException

OperationFailureException

setReaderPowerState

public void setReaderPowerState(READER_POWER_STATE readerPowerState)
                         throws InvalidUsageException,
OperationFailureException

Sets the Reader power state

Parameters:

readerPowerState - Required power state

Throws:

InvalidUsageException

OperationFailureException

setUserFeedback

public void setUserFeedback(Integer profile)
                     throws InvalidUsageException,
OperationFailureException

method to Set user feedback profile to generate custom LED and BEEP

Parameters:

profile -

Throws:

InvalidUsageException

OperationFailureException

getBatteryHealth

public Integer getBatteryHealth()
                         throws InvalidUsageException,
OperationFailureException

Gets the Battery health of reader (either overall health in 0-100% or number of charge cycles)

Returns:

Battery health as Integer

Throws:

InvalidUsageException

OperationFailureException

setUsbMiFiEnable

public void setUsbMiFiEnable(boolean enable)
                      throws OperationFailureException,
InvalidUsageException

method to Enable USB MiFi support

Parameters:

enable - - boolean value to enable and disable

Throws:

InvalidUsageException

OperationFailureException

isUsbMiFiEnabled

public Boolean isUsbMiFiEnabled()
                         throws OperationFailureException,
InvalidUsageException

method to get USB MiFi status

Returns:

Boolean - indicates MiFi status

Throws:

InvalidUsageException

OperationFailureException

getMode

public JSONObject getMode()

getMode

Returns:

Boolean - indicates current operating mode

Throws:

InvalidUsageException

OperationFailureException

setOperatingMode

public void setOperatingMode(ENUM_OPERATING_MODE operatingMode)

setOperatingMode

Parameters:

operatingMode - operating modes can be 1. Simple 2. Inventory 3. Portal 4. Conveyor 5. Custom

Throws:

InvalidUsageException

OperationFailureException

setInventoryModeSettings

public void setInventoryModeSettings(String unit,
 int value)

setInventoryModeSettings

Parameters:

unit - unit can be hours, seconds , minutes , days

value - unit value

Throws:

InvalidUsageException

OperationFailureException

setportalModeSettings

public void setportalModeSettings(int port,
 String signal,
 int stopInterval)

setportalModeSettings

Parameters:

port - denotes port number

signal - signal can be HIGH or LOW

stopInterval - stopInterval is the interval at which to stop reads after the last unique tag is read (seconds).

Throws:

InvalidUsageException

OperationFailureException

updateFirmware

public RFIDResults updateFirmware(String path,
 String ip)
                           throws InvalidUsageException,
OperationFailureException

Update Firmware User needs to make sure that path is obtained using the Android Storage Access Framework. IP address of the interface from where reader reach your android device hosting the firmware files.

Parameters:

path - path of the new firmware file on the terminal/hostdevice

ip - Local terminal IP address

Returns:

RFIDResults (RFID_API_SUCCESS or other)

Throws:

InvalidUsageException

OperationFailureException

setCableLossCompensation

public RFIDResults 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

setEndpointConfiguration

public RFIDResults setEndpointConfiguration(EndpointConfigurationInfo endPointConfigurationInfo)
                                     throws InvalidUsageException,
OperationFailureException

method to set endpoint configuration This method helps to set endpoint configuration.

Parameters:

endPointConfigurationInfo - parameters configured for endpoints

Returns:

RFIDResults (RFID_API_SUCCESS or other)

Throws:

InvalidUsageException

OperationFailureException

getActiveEndpointConfig

public EndpointConfigurationInfo getActiveEndpointConfig()
                                                  throws InvalidUsageException,
OperationFailureException

method to get current active management endpoint configuration of the device This method helps to get the current active management endpoint configured on the device.

Returns:

RFIDResults (RFID_API_SUCCESS or other)

Throws:

InvalidUsageException

OperationFailureException

getEndpointConfigByName

public EndpointConfigurationInfo getEndpointConfigByName(String epName)
                                                  throws InvalidUsageException,
OperationFailureException

method to get endpoint configuration by name of the device This method helps to get the endpoint configured by name on the device.

Parameters:

epName - name of the endpoint

Returns:

RFIDResults (RFID_API_SUCCESS or other)

Throws:

InvalidUsageException

OperationFailureException

getEndpointNames

public ArrayList<String> getEndpointNames()
                                   throws InvalidUsageException,
OperationFailureException

method to get endpoint names of the device This method helps to get the endpoint names on the device.

Returns:

RFIDResults (RFID_API_SUCCESS or other)

Throws:

InvalidUsageException

OperationFailureException

getActiveEndpoints

public IotConfigInfo getActiveEndpoints()
                                 throws InvalidUsageException,
OperationFailureException

method to get all the active endpoint names for each type of the device This method helps to get the active endpoint names for each type on the device.

Returns:

RFIDResults (RFID_API_SUCCESS or other)

Throws:

InvalidUsageException

OperationFailureException

activateEndpoint

public RFIDResults activateEndpoint(IotConfigInfo iotConfigInfo)
                             throws InvalidUsageException,
OperationFailureException

method to activate different types of endpoints This method helps activate different types of endpoints.

Parameters:

iotConfigInfo - endpoint to be activated for each type of endpoint

Returns:

RFIDResults (RFID_API_SUCCESS or other)

Throws:

InvalidUsageException

OperationFailureException