com.elo.device.peripherals

Interface BarCodeReader

public interface BarCodeReader

This interface provides methods by which an application can interact with the Bar Code reader present in an Elo View device

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	BarCodeReader.BarcodeReadCallback Callback invoked when a barcode is scanned

Method Summary

Modifier and Type	Method and Description
void	beep(BeepType beepType) This method allows the application to set the BeepType for the Bar Code Reader.
java.lang.String	getFirmwareVersion() This method returns the Firmware Version installed on Bar Code reader.
java.lang.String	getModelName() This method returns the Bar Code Model Name as a string.
Status	getStatus() This method returns the enable/disable status of the Bar Code Reader.
boolean	isKbMode() This method determines if the Barcode reader is in keyboard mode
byte[]	sendCommand(byte[] command) Send a command to the barcode scanner, and return the result.
void	setBarcodeReadCallback(BarCodeReader.BarcodeReadCallback callback) Sets or clears the callback that is invoked when the barcode scanner reads a code.
void	setEnabled(boolean enabled) This method is used to enable or disable Bar Code reader.
void	setKbMode() This method sets the Barcode reader into keyboard mode
void	setTriggerMode(TriggerMode triggerMode) This method allows the Application to set the Trigger Mode for the Bar Code reader.

Method Detail

setEnabled

void setEnabled(boolean enabled)

This method is used to enable or disable Bar Code reader. See BcrEnableControl, provided by the Inventory class, for details of what level of enable control is available

Parameters:

enabled -

getStatus

Status getStatus()

This method returns the enable/disable status of the Bar Code Reader. On some models, this information may not be available

Returns:

Current status of the reader

See Also:

Status

getModelName

java.lang.String getModelName()

This method returns the Bar Code Model Name as a string. In the product/platform where there is an integrated Bar Code reader present, this will return the product/platform name as Model Name

Returns:

The name of the model

See Also:

EloPlatform

getFirmwareVersion

java.lang.String getFirmwareVersion()
                             throws UnsupportedPeripheralMethodException

This method returns the Firmware Version installed on Bar Code reader. In the cases where Bar Code Reader is built in, this will throw UnsupportedPeripheralMethodException

Returns:

Firmware version, as a String

Throws:

UnsupportedPeripheralMethodException

setTriggerMode

void setTriggerMode(TriggerMode triggerMode)

This method allows the Application to set the Trigger Mode for the Bar Code reader. If trigger mode is not supported, this method will have no effect. This is specifically in the case of PayPoint 1.0 and Rev B platforms

Parameters:

triggerMode - Trigger mode to set

See Also:

TriggerMode

beep

void beep(BeepType beepType)

This method allows the application to set the BeepType for the Bar Code Reader. If BeepType is not supported, this method will have no effect. This is specifically in the case of PayPoint 1.0 and Rev B platforms

Parameters:

beepType -

See Also:

BeepType

setKbMode

void setKbMode()

This method sets the Barcode reader into keyboard mode

isKbMode

boolean isKbMode()

This method determines if the Barcode reader is in keyboard mode

Returns:

true if the reader is in keyboard mode, false otherwise

setBarcodeReadCallback

void setBarcodeReadCallback(BarCodeReader.BarcodeReadCallback callback)

Sets or clears the callback that is invoked when the barcode scanner reads a code. It is recommended that the callback be cleared when the owning Activity is stopped. If the installed barcode scanner does not support a callback, or if the scanner is in keyboard mode, this method will have no effect.

Parameters:

callback - Callback to be invoked, or null to clear

sendCommand

byte[] sendCommand(byte[] command)

Send a command to the barcode scanner, and return the result. Note: a reader callback must already be installed when using this command

Parameters:

command - ASCII string of bytes to be sent as the command. It is assumed that the length of the command is equal to the size of the byte[] array passed in.

Returns:

Byte string of the reply from the scanner. Returns null if command was not sent due to error condition.