BaseReader

java.lang.Object
- com.unitech.lib.reader.BaseReader

All Implemented Interfaces:

com.unitech.lib.event.ITransportEventListener

Direct Known Subclasses:

BarcodeReader
```
public abstract class BaseReader
extends java.lang.Object
implements com.unitech.lib.event.ITransportEventListener
```
The BaseReader class represents a base reader in the library. It implements the ITransportEventListener interface and provides methods for handling transport events. It also maintains references to various objects such as a BaseProtocol, BaseDevice, BaseEngine, and BaseTransport. It provides methods for handling various reader events.

Field Summary

Fields
Modifier and Type	Field and Description
`protected com.unitech.lib.device.BaseDevice`	`_baseDevice` The BaseDevice object representing the device.
`protected BaseEngine`	`_baseEngine` The BaseEngine object representing the engine.
`protected com.unitech.lib.transport.BaseTransport`	`_baseTransport` The BaseTransport object used for transport operations.
`protected int`	`_failCount` The number of failed attempts to connect to the device.
`protected java.lang.String`	`_firmwareVersion` The firmware version of the device.
`protected static int`	`_id`
`protected boolean`	`_isKeepAliveThreadAlive`
`protected java.lang.Runnable`	`_keepAliveRunnable`
`protected java.lang.Thread`	`_keepAliveThread`
`protected long`	`_lastTime`
`protected java.lang.String`	`_serialNumber` The serial number of the device.
`protected boolean`	`_triggerDisconnect`
`protected int`	`DEFAULT_BATTERY_CHECK_INTERVAL`
`protected int`	`RETRY_COUNT`
`protected java.lang.String`	`TAG` The tag used for logging.

Constructor Summary

Constructors
Constructor and Description

BaseReader(UnitechDevice device)
Constructs a new BaseReader object with the specified UnitechDevice.

Constructors
Constructor and Description
`BaseReader(UnitechDevice device)` Constructs a new BaseReader object with the specified UnitechDevice.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addListener(IReaderEventListener listener)` Adds a listener to the instance of the BaseReader class.
`protected void`	`alive()` Use only within the SDK.
`void`	`checkError()` Use only within the SDK.
`void`	`checkError(boolean resetTime)` Use only within the SDK.
`void`	`clearListener()` Removes all listeners from the instance of the BaseReader class.
`boolean`	`connect()` Establishes a connection with the device.
`void`	`destroy()` Destroys an instance of the BaseReader class and cleans up resources.
`boolean`	`disconnect()` Disconnects from the device.
`java.lang.String`	`getAddress()` Returns the address of the device associated with an instance of the BaseReader class.
`BaseEngine`	`getBaseEngine()` Returns an instance of the BaseEngine class that defines the engine used by the Device.
`int`	`getCheckBatteryInterval()` Returns the interval for checking the battery status.
`ConnectState`	`getConnectState()` Returns the connection status of the device with the instance of the BaseReader class.
`ConnectType`	`getConnectType()` Returns the instance of BaseReader associated with device.
`java.lang.String`	`getDeviceName()` Returns the name of the Device associated with an instance of the BaseReader class.
`DeviceType`	`getDeviceType()` Returns the type of Device to which the instance is connected.
`com.unitech.lib.protocol.BaseProtocol`	`getProtocol()` Returns an instance of the BaseProtocol class that defines the protocol used by the Device.
`java.lang.String`	`getSerialNumber()` Returns the serial number of the device.
`com.unitech.lib.transport.BaseTransport`	`getTransport()` Returns an instance of the BaseTransport class that connects an instance of the BaseReader class to the Device.
`java.lang.String`	`getVersion()` Returns the firmware version of the device associated with the instance of the BaseReader class.
`protected abstract boolean`	`initReader()`
`void`	`onTransportConnectStateChanged(ConnectState state, java.lang.Object params)` Called when the connection state changes.
`void`	`removeListener(IReaderEventListener listener)` Removes a listener from the instance of the BaseReader class.
`void`	`resetError()` Use only within the SDK.
`void`	`setCheckBatteryInterval(int checkBatteryInterval)` Sets the interval for checking the battery status.
`protected void`	`triggerBarcodeEvent(BaseReader reader, BarcodeID id, byte[] data, java.lang.Object params)`
`protected void`	`triggerBatteryPercentageChanged(BaseReader reader, byte batteryPercentage, boolean charging, java.lang.Object params)`
`protected void`	`triggerBatteryStateChanged(BaseReader reader, BatteryState batteryState, java.lang.Object params)`
`protected void`	`triggerConnectStateChanged(BaseReader reader, ConnectState state, java.lang.Object params)`
`protected void`	`triggerNotificationEvent(BaseReader reader, NotificationID id, java.lang.Object params)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - TAG
```
protected java.lang.String TAG
```
    The tag used for logging.
  - _id
```
protected static int _id
```
  - DEFAULT_BATTERY_CHECK_INTERVAL
```
protected final int DEFAULT_BATTERY_CHECK_INTERVAL
```
    See Also:
    
    Constant Field Values
  - RETRY_COUNT
```
protected final int RETRY_COUNT
```
    See Also:
    
    Constant Field Values
  - _baseTransport
```
protected com.unitech.lib.transport.BaseTransport _baseTransport
```
    The BaseTransport object used for transport operations.
  - _baseDevice
```
protected com.unitech.lib.device.BaseDevice _baseDevice
```
    The BaseDevice object representing the device.
  - _baseEngine
```
protected BaseEngine _baseEngine
```
    The BaseEngine object representing the engine.
  - _serialNumber
```
protected java.lang.String _serialNumber
```
    The serial number of the device.
  - _firmwareVersion
```
protected java.lang.String _firmwareVersion
```
    The firmware version of the device.
  - _failCount
```
protected volatile int _failCount
```
    The number of failed attempts to connect to the device.
  - _lastTime
```
protected volatile long _lastTime
```
  - _triggerDisconnect
```
protected volatile boolean _triggerDisconnect
```
  - _isKeepAliveThreadAlive
```
protected volatile boolean _isKeepAliveThreadAlive
```
  - _keepAliveThread
```
protected java.lang.Thread _keepAliveThread
```
  - _keepAliveRunnable
```
protected java.lang.Runnable _keepAliveRunnable
```
- Constructor Detail
  - BaseReader
```
public BaseReader(UnitechDevice device)
```
    Constructs a new BaseReader object with the specified UnitechDevice.
    
    Parameters:
    
    device - The UnitechDevice to use.
- Method Detail
  - destroy
```
public void destroy()
```
    Destroys an instance of the BaseReader class and cleans up resources.
  - connect
```
public boolean connect()
```
    Establishes a connection with the device.
    
    Returns:
    
    True if the connection is successfully established, false otherwise.
  - disconnect
```
public boolean disconnect()
```
    Disconnects from the device.
    
    Returns:
    
    True if the disconnection is successful, false otherwise.
  - getDeviceType
```
public DeviceType getDeviceType()
```
    Returns the type of Device to which the instance is connected.
    
    Returns:
    
    The DeviceType enumeration indicating the type of device.
  - getDeviceName
```
public java.lang.String getDeviceName()
```
    Returns the name of the Device associated with an instance of the BaseReader class.
    
    Returns:
    
    A string representing the name of the Device.
  - getSerialNumber
```
public java.lang.String getSerialNumber()
```
    Returns the serial number of the device.
    
    Returns:
    
    A string representing the serial number of the Device.
  - getVersion
```
public java.lang.String getVersion()
```
    Returns the firmware version of the device associated with the instance of the BaseReader class.
    
    Returns:
    
    A string representing the firmware version.
  - getAddress
```
public java.lang.String getAddress()
```
    Returns the address of the device associated with an instance of the BaseReader class.
    
    Returns:
    
    A string representing the address of the Device.
  - getConnectType
```
public ConnectType getConnectType()
```
    Returns the instance of BaseReader associated with device.
    
    Returns:
    
    A ConnectType enumeration that indicates how the device is connected.
  - getConnectState
```
public ConnectState getConnectState()
```
    Returns the connection status of the device with the instance of the BaseReader class.
    
    Returns:
    
    A ConnectState enumeration indicating the connection status of the BaseReader.
  - addListener
```
public void addListener(IReaderEventListener listener)
```
    Adds a listener to the instance of the BaseReader class. Events are only triggered to the last listener added.
    
    Parameters:
    
    listener - An instance of the IReaderEventListener interface to add to the BaseReader class.
  - removeListener
```
public void removeListener(IReaderEventListener listener)
```
    Removes a listener from the instance of the BaseReader class.
    
    Parameters:
    
    listener - An instance of the IReaderEventListener interface to remove from the BaseReader class.
  - clearListener
```
public void clearListener()
```
    Removes all listeners from the instance of the BaseReader class.
  - getTransport
```
public com.unitech.lib.transport.BaseTransport getTransport()
```
    Returns an instance of the BaseTransport class that connects an instance of the BaseReader class to the Device.
    
    Returns:
    
    An instance of the BaseTransport class that defines a connection with a Device.
  - getProtocol
```
public com.unitech.lib.protocol.BaseProtocol getProtocol()
```
    Returns an instance of the BaseProtocol class that defines the protocol used by the Device.
    
    Returns:
    
    An instance of the BaseProtocol class that defines the protocol used by the Device.
  - getBaseEngine
```
public BaseEngine getBaseEngine()
```
    Returns an instance of the BaseEngine class that defines the engine used by the Device.
    
    Returns:
    
    An instance of the BaseEngine class that defines the engine used by the Device.
  - getCheckBatteryInterval
```
public int getCheckBatteryInterval()
```
    Returns the interval for checking the battery status.
    
    Returns:
    
    The interval for checking the battery status, in milliseconds.
  - setCheckBatteryInterval
```
public void setCheckBatteryInterval(int checkBatteryInterval)
```
    Sets the interval for checking the battery status.
    
    Parameters:
    
    checkBatteryInterval - The interval for checking the battery status, in milliseconds.
  - triggerBatteryStateChanged
```
protected void triggerBatteryStateChanged(BaseReader reader,
                                          BatteryState batteryState,
                                          java.lang.Object params)
```
  - triggerBatteryPercentageChanged
```
protected void triggerBatteryPercentageChanged(BaseReader reader,
                                               byte batteryPercentage,
                                               boolean charging,
                                               java.lang.Object params)
```
  - triggerBarcodeEvent
```
protected void triggerBarcodeEvent(BaseReader reader,
                                   BarcodeID id,
                                   byte[] data,
                                   java.lang.Object params)
```
  - triggerNotificationEvent
```
protected void triggerNotificationEvent(BaseReader reader,
                                        NotificationID id,
                                        java.lang.Object params)
```
  - triggerConnectStateChanged
```
protected void triggerConnectStateChanged(BaseReader reader,
                                          ConnectState state,
                                          java.lang.Object params)
```
  - resetError
```
public void resetError()
```
    Use only within the SDK.
  - checkError
```
public void checkError()
```
    Use only within the SDK.
  - checkError
```
public void checkError(boolean resetTime)
```
    Use only within the SDK.
    
    Parameters:
    
    resetTime - If true, the last time is reset.
  - alive
```
protected void alive()
```
    Use only within the SDK.
  - onTransportConnectStateChanged
```
public void onTransportConnectStateChanged(ConnectState state,
                                           java.lang.Object params)
```
    Description copied from interface: com.unitech.lib.event.ITransportEventListener
    
    Called when the connection state changes.
    
    Specified by:
    
    onTransportConnectStateChanged in interface com.unitech.lib.event.ITransportEventListener
    
    Parameters:
    
    state - The new connection state.
    
    params - Any additional parameters associated with the event.
  - initReader
```
protected abstract boolean initReader()
```

Class BaseReader

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TAG

_id

DEFAULT_BATTERY_CHECK_INTERVAL

RETRY_COUNT

_baseTransport

_baseDevice

_baseEngine

_serialNumber

_firmwareVersion

_failCount

_lastTime

_triggerDisconnect

_isKeepAliveThreadAlive

_keepAliveThread

_keepAliveRunnable

Constructor Detail

BaseReader

Method Detail

destroy

connect

disconnect

getDeviceType

getDeviceName

getSerialNumber

getVersion

getAddress

getConnectType

getConnectState

addListener

removeListener

clearListener

getTransport

getProtocol

getBaseEngine

getCheckBatteryInterval

setCheckBatteryInterval

triggerBatteryStateChanged

triggerBatteryPercentageChanged

triggerBarcodeEvent

triggerNotificationEvent

triggerConnectStateChanged

resetError

checkError

checkError

alive

onTransportConnectStateChanged

initReader