com.cognex.mobile.barcode.sdk

Class ReaderDevice

java.lang.Object

com.cognex.mobile.barcode.sdk.ReaderDevice

All Implemented Interfaces:

DataManSystem.OnConnectedListener, DataManSystem.OnConnectionErrorListener, DataManSystem.OnDisconnectedListener, com.cognex.mobile.barcode.sdk.resultcollector.ResultCollector.ResultCollectorListener

public abstract class ReaderDevice
extends java.lang.Object
implements DataManSystem.OnConnectedListener, DataManSystem.OnDisconnectedListener, DataManSystem.OnConnectionErrorListener, com.cognex.mobile.barcode.sdk.resultcollector.ResultCollector.ResultCollectorListener

Represents a Phone Camera or MX barcode reader You should instantiate this class using getPhoneCameraDevice() or getMXDevice() factory methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ReaderDevice.Availability Enum values for ReaderDevice availability
static interface	ReaderDevice.OnConnectionCompletedListener Interface definition for monitoring the state of connection process
static interface	ReaderDevice.OnDeviceBatteryLevelListener Interface definition for device battery level callback
static interface	ReaderDevice.OnLightsListener Interface definition for lights state information callback
static interface	ReaderDevice.OnResetConfigListener Interface definition for device reset callback
static interface	ReaderDevice.OnSymbologyListener Interface definition for symbology enabled callback
static interface	ReaderDevice.ReaderDeviceListener Interface definition for ReaderDevice status and result listener
static class	ReaderDevice.Symbology Enum values for supported barcode symbologies

Method Summary

Modifier and Type	Method and Description
void	beep() Plays a beep on the reader
void	connect(ReaderDevice.OnConnectionCompletedListener connectionCompletedListener) Connects to the barcode reader.
void	disconnect() Disconnects from a connected barcode reader.
void	enableImage(boolean enable) Enable or disable image results from reader
void	enableImageGraphics(boolean enable) Enable or disable SVG image graphics results from reader
abstract ReaderDevice.Availability	getAvailability() Returns the availability of the reader
com.cognex.dataman.sdk.ConnectionState	getConnectionState() Returns the current connection state of the reader
DataManSystem	getDataManSystem() Returns the DataManSystem instance for this ReaderDevice
void	getDeviceBatteryLevel(ReaderDevice.OnDeviceBatteryLevelListener listener) Retrieves the current battery percentage level of the reader.
static ReaderDevice	getMXDevice(android.content.Context context) Creates a ReaderDevice object for a connected MX barcode reader.
static ReaderDevice	getPhoneCameraDevice(android.content.Context context, int cameraMode, int previewOptions, android.view.ViewGroup previewContainer) Creates a ReaderDevice object for a Phone Camera barcode reader.
void	isLightsOn(ReaderDevice.OnLightsListener listener) Retrieves whether all lights of the barcode reader are turned on or off.
void	isSymbologyEnabled(ReaderDevice.Symbology symbology, ReaderDevice.OnSymbologyListener listener) Retrieves whether the specified symbology is enabled or disabled
void	onComplexResultArrived(com.cognex.mobile.barcode.sdk.resultcollector.ComplexResult result)
void	onConnected(DataManSystem dataManSystem) Called after successfully connecting to a reader.
void	onConnectionError(DataManSystem dataManSystem, java.lang.Exception exception) Called when an error occurs while connecting to a reader.
void	onDisconnected(DataManSystem dataManSystem) Called after disconnected from a reader.
void	onSimpleResultDropped(com.cognex.mobile.barcode.sdk.resultcollector.SimpleResult result)
void	resetConfig(ReaderDevice.OnResetConfigListener listener) Resets the reader configurations to factory default
void	setLightsOn(boolean on, ReaderDevice.OnLightsListener listener) Turns on or off all internal lights of the reader
void	setReaderDeviceListener(ReaderDevice.ReaderDeviceListener listener) Registers a listener for read results and connection state changes
void	setSymbologyEnabled(ReaderDevice.Symbology symbology, boolean enable, ReaderDevice.OnSymbologyListener listener) Enable or disable the provided symbology on the reader
abstract boolean	startAvailabilityListening() Starts device availability monitoring
void	startScanning() Starts triggering
abstract void	stopAvailabilityListening() Stops device availability monitoring
void	stopScanning() Stops triggering

Methods inherited from class java.lang.Object

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

Method Detail

getMXDevice

public static ReaderDevice getMXDevice(android.content.Context context)

Creates a ReaderDevice object for a connected MX barcode reader.

Parameters:

context - The application's environment.

Returns:

The newly created ReaderDevice object.

getPhoneCameraDevice

public static ReaderDevice getPhoneCameraDevice(android.content.Context context,
                                                int cameraMode,
                                                int previewOptions,
                                                android.view.ViewGroup previewContainer)

Creates a ReaderDevice object for a Phone Camera barcode reader.

Parameters:

context - The application's environment.

cameraMode - The CameraMode when using the Mobile device camera.

previewOptions - The PreviewOption when using the Mobile device camera.

previewContainer - The container where the camera preview will be placed.

Returns:

The newly created ReaderDevice object.

setReaderDeviceListener

public void setReaderDeviceListener(ReaderDevice.ReaderDeviceListener listener)

Registers a listener for read results and connection state changes

Parameters:

listener - The ReaderDevice.ReaderDeviceListener to be registered

See Also:

ReaderDevice.ReaderDeviceListener

getAvailability

public abstract ReaderDevice.Availability getAvailability()

Returns the availability of the reader

Returns:

ReaderDevice.Availability state of the reader

See Also:

ReaderDevice.Availability

startAvailabilityListening

public abstract boolean startAvailabilityListening()

Starts device availability monitoring

Returns:

true, if device availability can be monitored

stopAvailabilityListening

public abstract void stopAvailabilityListening()

Stops device availability monitoring

enableImage

public void enableImage(boolean enable)

Enable or disable image results from reader

Parameters:

enable - true to enable image results

enableImageGraphics

public void enableImageGraphics(boolean enable)

Enable or disable SVG image graphics results from reader

Parameters:

enable - true to enable image graphics results

getConnectionState

public com.cognex.dataman.sdk.ConnectionState getConnectionState()

Returns the current connection state of the reader

Returns:

the current ConnectionState of the reader

See Also:

ConnectionState

connect

public void connect(ReaderDevice.OnConnectionCompletedListener connectionCompletedListener)

Connects to the barcode reader.

Parameters:

connectionCompletedListener - The ReaderDevice.OnConnectionCompletedListener listener to invoke as the connection process is completed.

See Also:

ReaderDevice.OnConnectionCompletedListener

disconnect

public void disconnect()

Disconnects from a connected barcode reader.

startScanning

public void startScanning()

Starts triggering

stopScanning

public void stopScanning()

Stops triggering

beep

public void beep()

Plays a beep on the reader

getDeviceBatteryLevel

public void getDeviceBatteryLevel(ReaderDevice.OnDeviceBatteryLevelListener listener)

Retrieves the current battery percentage level of the reader.

Parameters:

listener - The ReaderDevice.OnDeviceBatteryLevelListener to be called as the information is available

See Also:

ReaderDevice.OnDeviceBatteryLevelListener

setSymbologyEnabled

public void setSymbologyEnabled(ReaderDevice.Symbology symbology,
                                boolean enable,
                                ReaderDevice.OnSymbologyListener listener)

Enable or disable the provided symbology on the reader

Parameters:

symbology - The ReaderDevice.Symbology to enable or disable

enable - true to enable, false to disable

listener - The callback interface to call as the setting completes

See Also:

ReaderDevice.Symbology, ReaderDevice.OnSymbologyListener

isSymbologyEnabled

public void isSymbologyEnabled(ReaderDevice.Symbology symbology,
                               ReaderDevice.OnSymbologyListener listener)

Retrieves whether the specified symbology is enabled or disabled

Parameters:

symbology - The ReaderDevice.Symbology to check

listener - The callback to be invoked as the information is available

See Also:

ReaderDevice.Symbology, ReaderDevice.OnSymbologyListener

setLightsOn

public void setLightsOn(boolean on,
                        ReaderDevice.OnLightsListener listener)

Turns on or off all internal lights of the reader

Parameters:

on - true, to turn on the lights, false to turn off the lights

listener - The callback to be invoked as the method completes

See Also:

ReaderDevice.OnLightsListener

isLightsOn

public void isLightsOn(ReaderDevice.OnLightsListener listener)

Retrieves whether all lights of the barcode reader are turned on or off.

Parameters:

listener - The callback to be invoked as the result is available

See Also:

ReaderDevice.OnLightsListener

resetConfig

public void resetConfig(ReaderDevice.OnResetConfigListener listener)

Resets the reader configurations to factory default

Parameters:

listener - The callback interface to be invoked as the operation completes

See Also:

ReaderDevice.OnResetConfigListener

getDataManSystem

public DataManSystem getDataManSystem()

Returns the DataManSystem instance for this ReaderDevice

Returns:

DataManSystem instance

onConnected

public void onConnected(DataManSystem dataManSystem)

Description copied from interface: DataManSystem.OnConnectedListener

Called after successfully connecting to a reader.

Specified by:

onConnected in interface DataManSystem.OnConnectedListener

Parameters:

dataManSystem - The DataManSystem object that invoked the callback.

onDisconnected

public void onDisconnected(DataManSystem dataManSystem)

Description copied from interface: DataManSystem.OnDisconnectedListener

Called after disconnected from a reader.

Specified by:

onDisconnected in interface DataManSystem.OnDisconnectedListener

Parameters:

dataManSystem - The DataManSystem object that invoked the callback.

onConnectionError

public void onConnectionError(DataManSystem dataManSystem,
                              java.lang.Exception exception)

Description copied from interface: DataManSystem.OnConnectionErrorListener

Called when an error occurs while connecting to a reader.

Specified by:

onConnectionError in interface DataManSystem.OnConnectionErrorListener

Parameters:

dataManSystem - The DataManSystem object that invoked the callback.

exception - The exception object representing the error

onComplexResultArrived

public void onComplexResultArrived(com.cognex.mobile.barcode.sdk.resultcollector.ComplexResult result)

Specified by:

onComplexResultArrived in interface com.cognex.mobile.barcode.sdk.resultcollector.ResultCollector.ResultCollectorListener

onSimpleResultDropped

public void onSimpleResultDropped(com.cognex.mobile.barcode.sdk.resultcollector.SimpleResult result)

Specified by:

onSimpleResultDropped in interface com.cognex.mobile.barcode.sdk.resultcollector.ResultCollector.ResultCollectorListener