com.symbol.emdk.barcode

Class Scanner

java.lang.Object

com.symbol.emdk.barcode.Scanner

public class Scanner
extends java.lang.Object

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();
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Scanner.DataListener An interface for notifying client applications when the scan data is available.
static interface	Scanner.StatusListener An interface for notifying client applications to notify scan events.
static class	Scanner.TriggerType List of supported trigger type

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TAG
Scanner.TriggerType	triggerType Specifies the trigger type for the scanner.

Method Summary

Modifier and Type	Method and Description
void	addDataListener(Scanner.DataListener listener) The client can register to get data notification via callbacks.
void	addStatusListener(Scanner.StatusListener listener) The client can register to get status notification via callbacks.
void	cancelRead() This Cancels any pending asynchronous read() calls.
void	disable() Disables the scanner hardware.
void	enable() Enables the scanner hardware.
ScannerConfig	getConfig() Gets the current configuration settings for this scanner device.
InterfaceConfig	getInterfaceConfig()
Bundle	getParams(Bundle parameters) Gets the current configuration for requested params in Bundle format.
ScannerInfo	getScannerInfo() Returns information about the scanner device.
boolean	isEnabled() Returns scanner enabled state.
boolean	isReadPending() Another read() cannot be submitted while a read is pending.
void	read() Starts an asynchronous Scan.
void	release() Releases the scanner object resources.
void	removeDataListener(Scanner.DataListener listener) The client can un-register to get data notification via callbacks.
void	removeStatusListener(Scanner.StatusListener listener) The client can un-register to get status notification via callbacks.
void	setConfig(ScannerConfig scannerConfig) Changes the settings for this scanner device.
void	setInterfaceConfig(InterfaceConfig interfaceConfig)
void	setParams(Bundle parameters) Sets the param names and values After calling enable(), user must wait for IDLE status before calling setParams() API.

Methods inherited from class java.lang.Object

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

Field Detail

TAG

public static final java.lang.String TAG

See Also:

Constant Field Values

triggerType

public Scanner.TriggerType triggerType

Specifies the trigger type for the scanner. It is set to HARD by default.

Method Detail

isEnabled

public boolean isEnabled()

Returns scanner enabled state.

Returns:

Returns true if scanner is enabled.

isReadPending

public boolean isReadPending()

Another read() cannot be submitted while a read is pending.

Returns:

Returns true if a read is pending.

getScannerInfo

public ScannerInfo getScannerInfo()

Returns information about the scanner device.

Returns:

Returns the ScannerInfo object.

getConfig

public ScannerConfig getConfig()
                        throws ScannerException

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:

scannerConfig The valid scanner configuration object will be returned on successful get.

Throws:

ScannerException

setConfig

public void setConfig(ScannerConfig scannerConfig)
               throws ScannerException

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.

Throws:

ScannerException - Exception will be throw if any error occurs while setting the parameters.

enable

public void enable()
            throws ScannerException

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. After calling enable(), user must wait for IDLE status before calling any other scanner APIs such as setConfig() or read(). 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();
 
 

Throws:

ScannerException - The exception will thrown if the scanner enable fails.

disable

public void disable()
             throws ScannerException

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();
 
 

Throws:

ScannerException - The exception will thrown if the scanner disable fails.

release

public void release()
             throws ScannerException

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.

Throws:

ScannerException

read

public void read()
          throws ScannerException

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. If a read() is submitted while swapping the battery, the method call will fail and return an UNDEFINED ScannerException.

 
 Example Usage:
 scanner.read();
 
 

* @throws ScannerException The exception will thrown if error occurs during the read request.

Throws:

ScannerException

cancelRead

public void cancelRead()
                throws ScannerException

This Cancels any pending asynchronous read() calls. After calling cancelRead(), user must wait for IDLE status before calling any other scanner APIs such as setConfig() or read().

 
 Example Usage:
 scanner.cancelRead();
 
 

Throws:

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.

removeDataListener

public void removeDataListener(Scanner.DataListener listener)

The client can un-register to get data notification via callbacks.

Parameters:

listener -

addStatusListener

public void addStatusListener(Scanner.StatusListener listener)

The client can register to get status notification via callbacks.

Parameters:

listener -

removeStatusListener

public void removeStatusListener(Scanner.StatusListener listener)

The client can un-register to get status notification via callbacks.

Parameters:

listener -

getInterfaceConfig

public InterfaceConfig getInterfaceConfig()
                                   throws ScannerException

Throws:

ScannerException

setInterfaceConfig

public void setInterfaceConfig(InterfaceConfig interfaceConfig)
                        throws ScannerException

Throws:

ScannerException

getParams

public Bundle getParams(Bundle parameters)
                 throws ScannerException

Gets the current configuration for requested params in Bundle format. After calling enable(), user must wait for IDLE status before calling getParams() API.

 
 Example Usage:
 scanner.enable();
 Bundle requiredParams = new Bundle();
 requiredParams.putString("decoder_ean8","");
 requiredParams.putString("decoder_ean13","");
 requiredParams.putString("decoder_code39","");
 requiredParams.putString("decoder_code128","");
 .
 .
 .
 Bundle params = scanner.getParams(requiredParams);
 .
 .
 Bundle allParams = scanner.getParams(new Bundle());
 
 

Parameters:

parameters - An empty bundle or names of the required parameters in bundle format

Returns:

Returns the supported parameters out of requested params list. if an empty bundle is passed as parameters, all supported params will be returned

Throws:

ScannerException

setParams

public void setParams(Bundle parameters)
               throws ScannerException

Sets the param names and values After calling enable(), user must wait for IDLE status before calling setParams() API.

 
 Example Usage:
 scanner.enable();
 Bundle params = new Bundle();
 params.putString("decoder_ean8","true");
 params.putString("beam_timer","1000");
 params.putString("picklist","1");
 scanner.setParams(params);
 
 

Parameters:

parameters - Parameter names and values in Bundle format. Every value must be in String format

Throws:

ScannerException