RFCardReaderDevice (CloudPOSSDK)

All Superinterfaces:

Device, TimeConstants
```
public interface RFCardReaderDevice
extends Device, TimeConstants
```
The RFCardReaderDevice interface defines APIs for RFCard reader operations. This interface is used for handling various RF card communication modes and operations in POS systems.
To obtain an instance of this interface:
```
 RFCardReaderDevice rfCardReaderDevice =
         (RFCardReaderDevice) POSTerminal.getInstance().getDevice("com.cloudpos.device.rfcardreader");
 
```
Access to the device requires the following permission in your app manifest:
```
 <uses-permission android:name="android.permission.CLOUDPOS_CONTACTLESS_CARD"/>
 
```
See Also:

Device

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`MODE_AUTO` Automatically detects the communication mode based on the environment.
`static int`	`MODE_FELICA` Proximity communication mode supporting FeliCa® technology.
`static int`	`MODE_ISO14443_TYPE_A` Proximity communication mode (PCD) compliant with ISO/IEC 14443 Type A.
`static int`	`MODE_ISO14443_TYPE_B` Proximity communication mode (PCD) compliant with ISO/IEC 14443 Type B.
`static int`	`MODE_ISO15693` Vicinity communication mode (VCD) compliant with ISO/IEC 15693.
`static int`	`MODE_MIFARE` Proximity communication mode supporting MIFARE® technology.
`static int`	`MODE_NFC_ACTIVE` NFC active communication mode compliant with ISO/IEC 18092 (NFCIP-1).
`static int`	`MODE_NFC_PASSIVE` NFC passive communication mode compliant with ISO/IEC 18092 (NFCIP-1).
`static int`	`PARAM_NB_SLOT` Parameter indicating the number of slots to use for anti-collision.
`static int`	`PARAM_SPEED` Parameter indicating the speed rate to be used during the initialization phase.
`static int`	`RATE_106K` 106 kbps speed rate for use with PARAM_SPEED.
`static int`	`RATE_1667K` 1667 kbps speed rate, for active mode only, used with PARAM_SPEED.
`static int`	`RATE_212K` 212 kbps speed rate for use with PARAM_SPEED.
`static int`	`RATE_3390K` 3390 kbps speed rate, for active mode only, used with PARAM_SPEED.
`static int`	`RATE_424K` 424 kbps speed rate for use with PARAM_SPEED.
`static int`	`RATE_6670K` 6670 kbps speed rate, for active mode only, used with PARAM_SPEED.
`static int`	`RATE_848K` 848 kbps speed rate, for active mode only, used with PARAM_SPEED.

Fields inherited from interface com.cloudpos.TimeConstants
FOREVER, IMMEDIATE, MilliSECOND, SECOND

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`disableLowPowerCardDetect()` Disables low power card detection mode.
`boolean`	`enableLowPowerCardDetect()` Enables low power card detection mode.
`int[]`	`getCardTypeValue()` Retrieves the card type value as determined by the kernel.
`int`	`getMode()` Retrieves the current communication mode of the device.
`int`	`getSpeed()` Gets the current baud rate.
`void`	`listenForCardAbsent(OperationListener listener, int timeout)` Asynchronously listens for the removal of a card from the terminal.
`void`	`listenForCardPresent(OperationListener listener, int timeout)` Initiates the RF card reader to detect contactless cards using the selected communication mode.
`void`	`open(int logicalID, int mode)` Opens the device with a specified communication mode.
`int`	`sendControlCommand(int cmdID, byte[] byteArrayCmdData)` Sends a specific control command to the device.
`void`	`setSpeed(int value)` Sets the baud rate used during the initialization phase.
`RFCardReaderOperationResult`	`waitForCardAbsent(int timeout)` Synchronously waits for a card to be removed from the terminal within a specified timeout.
`RFCardReaderOperationResult`	`waitForCardPresent(int timeout)` Waits synchronously for a contactless card to be present within a specified timeout period.

Methods inherited from interface com.cloudpos.Device
cancelRequest, close, getFailCount, getUsageCount, open

- Field Detail
  - MODE_AUTO
```
static final int MODE_AUTO
```
    Automatically detects the communication mode based on the environment.
    
    See Also:
    
    Constant Field Values
  - MODE_NFC_PASSIVE
```
static final int MODE_NFC_PASSIVE
```
    NFC passive communication mode compliant with ISO/IEC 18092 (NFCIP-1).
    
    See Also:
    
    Constant Field Values
  - MODE_NFC_ACTIVE
```
static final int MODE_NFC_ACTIVE
```
    NFC active communication mode compliant with ISO/IEC 18092 (NFCIP-1).
    
    See Also:
    
    Constant Field Values
  - MODE_ISO14443_TYPE_A
```
static final int MODE_ISO14443_TYPE_A
```
    Proximity communication mode (PCD) compliant with ISO/IEC 14443 Type A.
    
    See Also:
    
    Constant Field Values
  - MODE_ISO14443_TYPE_B
```
static final int MODE_ISO14443_TYPE_B
```
    Proximity communication mode (PCD) compliant with ISO/IEC 14443 Type B.
    
    See Also:
    
    Constant Field Values
  - MODE_ISO15693
```
static final int MODE_ISO15693
```
    Vicinity communication mode (VCD) compliant with ISO/IEC 15693.
    
    See Also:
    
    Constant Field Values
  - MODE_MIFARE
```
static final int MODE_MIFARE
```
    Proximity communication mode supporting MIFARE® technology.
    
    See Also:
    
    Constant Field Values
  - MODE_FELICA
```
static final int MODE_FELICA
```
    Proximity communication mode supporting FeliCa® technology.
    
    See Also:
    
    Constant Field Values
  - PARAM_SPEED
```
static final int PARAM_SPEED
```
    Parameter indicating the speed rate to be used during the initialization phase.
    
    See Also:
    
    Constant Field Values
  - PARAM_NB_SLOT
```
static final int PARAM_NB_SLOT
```
    Parameter indicating the number of slots to use for anti-collision.
    
    See Also:
    
    Constant Field Values
  - RATE_106K
```
static final int RATE_106K
```
    106 kbps speed rate for use with PARAM_SPEED.
    
    See Also:
    
    Constant Field Values
  - RATE_212K
```
static final int RATE_212K
```
    212 kbps speed rate for use with PARAM_SPEED.
    
    See Also:
    
    Constant Field Values
  - RATE_424K
```
static final int RATE_424K
```
    424 kbps speed rate for use with PARAM_SPEED.
    
    See Also:
    
    Constant Field Values
  - RATE_848K
```
static final int RATE_848K
```
    848 kbps speed rate, for active mode only, used with PARAM_SPEED.
    
    See Also:
    
    Constant Field Values
  - RATE_1667K
```
static final int RATE_1667K
```
    1667 kbps speed rate, for active mode only, used with PARAM_SPEED.
    
    See Also:
    
    Constant Field Values
  - RATE_3390K
```
static final int RATE_3390K
```
    3390 kbps speed rate, for active mode only, used with PARAM_SPEED.
    
    See Also:
    
    Constant Field Values
  - RATE_6670K
```
static final int RATE_6670K
```
    6670 kbps speed rate, for active mode only, used with PARAM_SPEED.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - open
```
void open(int logicalID,
          int mode)
   throws DeviceException
```
    Opens the device with a specified communication mode. Resets the initiator state if previously opened.
    
    Parameters:
    
    logicalID - Logical ID of the device to open.
    
    mode - Communication mode to use.
    
    Throws:
    
    DeviceException - for standard device errors as outlined in DeviceException.
  - getMode
```
int getMode()
     throws DeviceException
```
    Retrieves the current communication mode of the device.
    
    Returns:
    
    Integer indicating the current device mode:
    
    MODE_AUTO
    MODE_NFC_PASSIVE
    MODE_NFC_ACTIVE
    MODE_ISO14443_TYPE_A
    MODE_ISO14443_TYPE_B
    MODE_ISO15693
    MODE_MIFARE
    MODE_FELICA
    
    Throws:
    
    DeviceException - for standard device errors as outlined in DeviceException.
  - setSpeed
```
void setSpeed(int value)
       throws DeviceException
```
    Sets the baud rate used during the initialization phase.
    
    Parameters:
    
    value - Baud rate value.
    
    Throws:
    
    DeviceException - for standard device errors as outlined in DeviceException.
  - getSpeed
```
int getSpeed()
      throws DeviceException
```
    Gets the current baud rate.
    
    Returns:
    
    Current baud rate.
    
    Throws:
    
    DeviceException - for standard device errors as outlined in DeviceException.
  - getCardTypeValue
```
int[] getCardTypeValue()
                throws DeviceException
```
    Retrieves the card type value as determined by the kernel.
    
    Returns:
    
    Array of integers representing the card type:
    
    CONTACTLESS_CARD_TYPE_A_CPU 0x0000
    CONTACTLESS_CARD_TYPE_B_CPU 0x0100
    CONTACTLESS_CARD_TYPE_A_CLASSIC_MINI 0x0001
    CONTACTLESS_CARD_TYPE_A_CLASSIC_1K 0x0002
    CONTACTLESS_CARD_TYPE_A_CLASSIC_4K 0x0003
    CONTACTLESS_CARD_TYPE_A_UL_64 0x0004
    CONTACTLESS_CARD_TYPE_A_UL_192 0x0005
    CONTACTLESS_CARD_TYPE_A_MP_2K_SL1 0x0006
    CONTACTLESS_CARD_TYPE_A_MP_4K_SL1 0x0007
    CONTACTLESS_CARD_TYPE_A_MP_2K_SL2 0x0008
    CONTACTLESS_CARD_TYPE_A_MP_4K_SL2 0x0009
    CONTACTLESS_CARD_UNKNOWN 0x00FF.
    
    Throws:
    
    DeviceException - for standard device errors as outlined in DeviceException.
  - listenForCardPresent
```
void listenForCardPresent(OperationListener listener,
                          int timeout)
                   throws DeviceException
```
    Initiates the RF card reader to detect contactless cards using the selected communication mode.
    This method is asynchronous. The handleResult() method will be invoked once at least one card is detected in the reader's field.
    - Supports only a single card; multiple cards will result in an ERR_MULTI_CARD error.
    - Utilizes the baud rate settings from setSpeed(), if set. Otherwise, it defaults to standard behavior for the chosen communication mode.
    - Information about a successfully detected card can be obtained using getCard().
    - The device must be capable of handling cancelRequest() to abort the operation if needed.
    - If a timeout occurs, the operation result will include ERR_TIMEOUT, and no card information will be available.
    Parameters:
    
    listener - Listener to handle operation results.
    
    timeout - Maximum time allowed for scanning, in milliseconds.
    
    Throws:
    
    DeviceException - for standard device errors as documented in DeviceException.
  - waitForCardPresent
```
RFCardReaderOperationResult waitForCardPresent(int timeout)
                                        throws DeviceException
```
    Waits synchronously for a contactless card to be present within a specified timeout period.
    This method is the synchronous version of listenForCardPresent(OperationListener,int), designed to detect the presence of a card within the given timeframe.
    
    Parameters:
    
    timeout - Maximum time allowed for scanning in milliseconds. The method will wait for a card to be detected within this time.
    
    Returns:
    
    RFCardReaderOperationResult containing the details of the detected card. Returns null if no card is detected within the timeout period.
    
    Throws:
    
    DeviceException - for standard device errors as outlined in DeviceException.
  - listenForCardAbsent
```
void listenForCardAbsent(OperationListener listener,
                         int timeout)
                  throws DeviceException
```
    Asynchronously listens for the removal of a card from the terminal.
    This method triggers a callback when a card is removed or if no card is present initially. It is designed to continuously monitor the card presence.
    
    Key Points:
    - Results are provided via the specified OperationListener.
    - Successful removal is indicated by SUCCESS.
    - Supports cancelRequest() for operation abortion on timeouts.
    - Timeouts result in ERR_TIMEOUT, with no card data available.
    Parameters:
    
    listener - The listener that handles operation results.
    
    timeout - The maximum waiting time, in milliseconds.
    
    Throws:
    
    DeviceException - Standard errors as documented in DeviceException.
  - waitForCardAbsent
```
RFCardReaderOperationResult waitForCardAbsent(int timeout)
                                       throws DeviceException
```
    Synchronously waits for a card to be removed from the terminal within a specified timeout.
    This method is the synchronous equivalent of listenForCardAbsent(OperationListener,int), offering a direct return of the operation result.
    
    Key Points:
    - Returns a RFCardReaderOperationResult indicating the operation outcome.
    - On timeouts, the result is null, indicating no card data available.
    Parameters:
    
    timeout - The maximum waiting time for card removal, in milliseconds.
    
    Returns:
    
    RFCardReaderOperationResult containing the operation result.
    
    Throws:
    
    DeviceException - Standard errors as documented in DeviceException.
  - sendControlCommand
```
int sendControlCommand(int cmdID,
                       byte[] byteArrayCmdData)
                throws DeviceException
```
    Sends a specific control command to the device.
    This method allows the sending of control commands, identified by a command ID, along with associated data.
    
    Key Details:
    - cmdID: The identifier of the command. It is recommended to set this to 0x80.
    - byteArrayCmdData: The data associated with the command. Supports commands from 0x00 to 0x07. Set to NULL if there is no data.
      
      0x00: Sends all bits of the last data byte.
      
      0x01-0x07: Sends the least significant bit (LSB) of the last byte as per the given value.
      
      The last 3 bits define the number of bits of the last data byte to be sent.
    Note: Bits are omitted at the end of the byte. For example, a data byte of B2h (sent LSB first) with TxLastBits = 011b (3h) will send 010b (LSB first), with TxLastBits = 110b (6h) will send 010011b (LSB first).
    Parameters:
    
    cmdID - The ID of the command to be sent.
    
    byteArrayCmdData - The data associated with the command.
    
    Returns:
    
    An integer result of the command execution.
    
    Throws:
    
    DeviceException - Standard errors as documented in DeviceException.
  - enableLowPowerCardDetect
```
boolean enableLowPowerCardDetect()
                          throws DeviceException
```
    Enables low power card detection mode. This mode is useful for reducing power consumption when detecting cards. It should be called after the device is opened and remains effective for the duration of the open-close session.
    
    Returns:
    
    true if the operation is successful, false otherwise.
    
    Throws:
    
    DeviceException - for standard errors as documented in DeviceException.
  - disableLowPowerCardDetect
```
boolean disableLowPowerCardDetect()
                           throws DeviceException
```
    Disables low power card detection mode. This should be called after the device is opened and remains effective for the duration of the open-close session. Use this method to revert to normal power consumption mode for card detection.
    
    Returns:
    
    true if the operation is successful, false otherwise.
    
    Throws:
    
    DeviceException - for standard errors as documented in DeviceException.

Interface RFCardReaderDevice

Field Summary

Fields inherited from interface com.cloudpos.TimeConstants

Method Summary

Methods inherited from interface com.cloudpos.Device

Field Detail

MODE_AUTO

MODE_NFC_PASSIVE

MODE_NFC_ACTIVE

MODE_ISO14443_TYPE_A

MODE_ISO14443_TYPE_B

MODE_ISO15693

MODE_MIFARE

MODE_FELICA

PARAM_SPEED

PARAM_NB_SLOT

RATE_106K

RATE_212K

RATE_424K

RATE_848K

RATE_1667K

RATE_3390K

RATE_6670K

Method Detail

open

getMode

setSpeed

getSpeed

getCardTypeValue

listenForCardPresent

waitForCardPresent

listenForCardAbsent

waitForCardAbsent

sendControlCommand

enableLowPowerCardDetect

disableLowPowerCardDetect