com.zebra.rfid.api3

Class Config

java.lang.Object

com.zebra.rfid.api3.Config

public class Config
extends java.lang.Object

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

Field Summary

Fields

Modifier and Type	Field and Description
Antennas	Antennas
com.zebra.rfid.api3.GPIs	GPI
com.zebra.rfid.api3.GPOs	GPO

Method Summary

Modifier and Type	Method and Description
AttributeInfo	getAttribute(int attributeNumber, AttributeInfo attributeInfo) Gets the attribute type and value
BATCH_MODE	getBatchModeConfig() Gets the Batch Mode Config
BEEPER_VOLUME	getBeeperVolume() Gets the Beeper Config
void	getDeviceStatus(boolean battery, boolean power, boolean temperature) API to fetch the device status in terms of battery, power and temperature
void	getDeviceVersionInfo(java.util.HashMap<java.lang.String,java.lang.String> deviceVersion) API to get the device version information
DYNAMIC_POWER_OPTIMIZATION	getDPOState() Gets the DPO state
short	getDutyCycleIndex()
java.lang.String	GetLogBuffer() Gets the log buffer from SDK as String
RADIO_POWER_STATE	getRadioPowerState() Gets the Radio power state to on or off 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
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
UNIQUE_TAG_REPORT_SETTING	getUniqueTagReport() method to fetch Unique tag reporting settings from the reader
void	resetFactoryDefaults() Restores to factory default settings in the reader.
void	saveConfig() method to save configuration permanently to the reader
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
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	setDPOState(DYNAMIC_POWER_OPTIMIZATION dpoState) method to enable or disable DPO
void	setDutyCycleIndex(short dutyCycleIndex)
void	setLedBlinkEnable(boolean enable) method to set host LED mode to blink LED on tag data
void	setLogLevel(java.util.logging.Level logLevel) Setting the Log level up to which logging will be honoured
void	setRadioPowerState(RADIO_POWER_STATE radioPowerState) Sets the Radio power state to on or off state
void	setRegulatoryConfig(RegulatoryConfig regulatoryConfig) method to set regulatory configuration on the reader
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)
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

Methods inherited from class java.lang.Object

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

Field Detail

Antennas

public Antennas Antennas

GPI

public com.zebra.rfid.api3.GPIs GPI

GPO

public com.zebra.rfid.api3.GPOs GPO

Method Detail

getDutyCycleIndex

public short getDutyCycleIndex()
                        throws InvalidUsageException,
                               OperationFailureException

Throws:

InvalidUsageException

OperationFailureException

setDutyCycleIndex

public void setDutyCycleIndex(short dutyCycleIndex)
                       throws InvalidUsageException,
                              OperationFailureException

Throws:

InvalidUsageException

OperationFailureException

getRadioPowerState

public RADIO_POWER_STATE getRadioPowerState()
                                     throws InvalidUsageException,
                                            OperationFailureException

Gets the Radio power state to on or off state

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)

setLogLevel

public void setLogLevel(java.util.logging.Level logLevel)

Setting the Log level up to which logging will be honoured

Parameters:

logLevel -

GetLogBuffer

public java.lang.String GetLogBuffer()
                              throws InvalidUsageException

Gets the log buffer from SDK as String

Returns:

logBuffer as String

Throws:

InvalidUsageException

getDeviceVersionInfo

public void getDeviceVersionInfo(java.util.HashMap<java.lang.String,java.lang.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

setTraceLevel

public void setTraceLevel(TRACE_LEVEL traceLevel)

Sets the trace level

getTagStorageSettings

public TagStorageSettings getTagStorageSettings()
                                         throws InvalidUsageException,
                                                OperationFailureException

Get TagStorageSettings.

Returns:

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

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

getStopTrigger

public StopTrigger getStopTrigger()
                           throws InvalidUsageException,
                                  OperationFailureException

method to get current stop trigger settings from reader

Returns:

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

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

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:

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:

Throws:

InvalidUsageException

OperationFailureException

setUniqueTagReport

public boolean setUniqueTagReport(boolean uniqueTagReport)
                           throws InvalidUsageException,
                                  OperationFailureException

method to disable/enable Reporting Unique Tags

Parameters:

uniqueTagReport -

Returns:

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:

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