Scanner class will represent and provides access to the physical scanner device.
Example Usage:
Scanner scanner = barcodeManager.getDevice(DeviceIdentifer.DEFAULT);
scanner.enable();
scanner.addDataListener(this);
scanner.read();
scanner.cancelRead();
scanner.disable();
Public Methods
isEnabled
public boolean isEnabled()
Returns scanner enabled state.
Returns:
boolean - Returns true if scanner is enabled.
isReadPending
public boolean isReadPending()
Another read() cannot be submitted while a read is pending.
Returns:
boolean - Returns true if a read is pending.
getScannerInfo
public ScannerInfo getScannerInfo()
Returns information about the scanner device.
Returns:
com.symbol.emdk.barcode.ScannerInfo - Returns the ScannerInfo object.
getConfig
public ScannerConfig getConfig()
Gets the current configuration settings for this scanner device. If modifications are made to the returned ScannerConfig object, the Scanner.setConfig(ScannerConfig) must be called to take effect. Scanner must be enabled before calling getConfig().
Example Usage:
scanner.enable();
ScannerConfig config = scanner.getConfig();
Returns:
com.symbol.emdk.barcode.ScannerConfig - scannerConfig The valid scanner configuration object will be returned on successful get.
Throws:
com.symbol.emdk.barcode.ScannerException
setConfig
public void setConfig(ScannerConfig scannerConfig)
Changes the settings for this scanner device. The unsupported parameters will be ignored. This method skips the unsupported parameters and continues with setting the supported values.
Example Usage:
ScannerConfig scannerConfig = scanner.getConfig();
scannerConfig.scanParams.decodeLEDTime = 10;
scanner.setConfig(scannerConfig);
Parameters:
scannerConfig - The Parameters to use for this scanner device.
Returns:
void
Throws:
com.symbol.emdk.barcode.ScannerException
Exception will be throw if any error occurs while setting the parameters.
enable
public void enable()
Enables the scanner hardware. This method does not make the scanner to scan or turn on the laser. If the same of scanner is enabled by other applications, this will throws ScannerExceptions. You must call disable() when you are done the scanning, otherwise it will remain locked and be unavailable to other applications.
Example Usage:
scanner.enable();
Returns:
void
Throws:
com.symbol.emdk.barcode.ScannerException
The exception will thrown if the scanner enable fails.
disable
public void disable()
Disables the scanner hardware. Any pending scanned data will be lost. This method releases the scanner hardware resources for other application to use. You must call this as soon as you're done with the scanning.
Example Usage:
scanner.disable();
Returns:
void
Throws:
com.symbol.emdk.barcode.ScannerException
The exception will thrown if the scanner disable fails.
release
public void release()
Releases the scanner object resources. The scanner object is unusable after this call. The new object can be requested using BarcodeManager.getDevice(...). The object will be unusable after this call even if any failure occurs.
Returns:
void
Throws:
com.symbol.emdk.barcode.ScannerException
read
public void read()
Starts an asynchronous Scan. The method will not turn on the scanner. It will, however, put the scanner in a state in which the scanner can be turned ON either by pressing a hardware trigger or can be turned ON automatically. This is determined by the Scanner.triggerType. The data notification must registered in order to scan and get the Scan Data. The read request can be cancelled by issuing a cancelRead.
If a read() is submitted while another read is pending, the method call will fail. It is recommended to check whether a read is pending by calling isReadPending() before submitting a read(). A read() can also be submitted from within onData and onStatus events. If called within onStatus, it should be called only when IDLE status is received. If called within onData, then checking for isReadPending() is recommended.
Example Usage:
scanner.read();
Returns:
void
Throws:
com.symbol.emdk.barcode.ScannerException
cancelRead
public void cancelRead()
This Cancels any pending asynchronous read() calls
Example Usage:
scanner.cancelRead();
Returns:
void
Throws:
com.symbol.emdk.barcode.ScannerException
The exception will thrown if error occurs during the cancelRead request.
addDataListener
public void addDataListener(Scanner.DataListener listener)
The client can register to get data notification via callbacks.
Parameters:
listener - The DataListener callabck object.
Returns:
void
removeDataListener
public void removeDataListener(Scanner.DataListener listener)
The client can un-register to get data notification via callbacks.
Parameters:
listener
Returns:
void
addStatusListener
public void addStatusListener(Scanner.StatusListener listener)
The client can register to get status notification via callbacks.
Parameters:
listener
Returns:
void
removeStatusListener
public void removeStatusListener(Scanner.StatusListener listener)
The client can un-register to get status notification via callbacks.
Parameters:
listener
Returns:
void
getInterfaceConfig
public InterfaceConfig getInterfaceConfig()
Returns:
com.symbol.emdk.barcode.InterfaceConfig
Throws:
com.symbol.emdk.barcode.ScannerException
setInterfaceConfig
public void setInterfaceConfig(InterfaceConfig interfaceConfig)
Parameters:
interfaceConfig
Returns:
void
Throws:
com.symbol.emdk.barcode.ScannerException
Public Fields
triggerType
Specifies the trigger type for the scanner. It is set to HARD by default.
Type:
com.symbol.emdk.barcode.Scanner.TriggerType