RFCardInterface

java.lang.Object
- com.cloudpos.jniinterface.RFCardInterface

public class RFCardInterface
extends java.lang.Object

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class RFCardInterface.NotifyEvent

Nested Classes
Modifier and Type	Class and Description
`static class`	`RFCardInterface.NotifyEvent`

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CONTACTLESS_CARD_EVENT_COMM_ERROR`
`static int`	`CONTACTLESS_CARD_EVENT_FOUND_CARD`
`static int`	`CONTACTLESS_CARD_EVENT_TIME_OUT`
`static int`	`CONTACTLESS_CARD_EVENT_USER_CANCEL`
`static int`	`CONTACTLESS_CARD_MODE_AUTO`
`static int`	`CONTACTLESS_CARD_MODE_TYPE_A`
`static int`	`CONTACTLESS_CARD_MODE_TYPE_B`
`static int`	`CONTACTLESS_CARD_MODE_TYPE_C`
`static int`	`EVENT_NONE`
`static boolean`	`isCallBackCalled`
`static RFCardInterface.NotifyEvent`	`notifyEvent`
`static java.lang.Object`	`object` 初始化的参数
`static int`	`RC500_COMMON_CMD_GET_READER_VERSION`
`static int`	`RC500_COMMON_CMD_RF_CONTROL`

Constructor Summary

Constructors
Constructor and Description

RFCardInterface()

Constructors
Constructor and Description
`RFCardInterface()`

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static int`	`attach(byte[] byteArrayATR)` Attach the target before transmitting apdu command In this process, the target(card) is activated and return ATR.
`static void`	`callBack(int nEvent, byte[] nData)` Call back method, called by driver.
`static void`	`clear()` clear the notify event from callback.
`static int`	`close()` Close the contactless card reader.
`static int`	`decrement(int nSectorIndex, int nBlockIndex, int value)` Decrement value to a block, using it with the API : hal_contactless_card_mc_restore and hal_contactless_card_mc_transfer
`static int`	`detach()` Detach the target.
`static int`	`increment(int nSectorIndex, int nBlockIndex, int value)` Increment value to a block, using it with the API : hal_contactless_card_mc_restore and hal_contactless_card_mc_transfer
`static boolean`	`isOpened()` Contactless card reader is Opened return Boolean
`static void`	`notifyCancel()`
`static int`	`open()` Open the contactless card reader.
`static int`	`queryInfo(int[] pHasMoreCards, int[] pCardType)` Query the number and type of cards on the contactless card reader.
`static int`	`read(int nSectorIndex, int nBlockIndex, byte[] pDataBuffer, int nDataBufferLength)` Read data only for MiFare one card.
`static int`	`readValue(int nSectorIndex, int nBlockIndex, byte[] pValue, int nValueBufLength, byte[] pAddrData)` Read value from a block
`static int`	`restore(int nSectorIndex, int nBlockIndex)` Read the value to the temporary from the block
`static int`	`searchBegin(int nCardMode, int nFlagSearchAll, int nTimeout_MS)` 语义代表通知非接设备开始寻卡， Start searching the contactless1 card If you set the nCardMode is auto, reader will try to activate card in type A, type B and type successively; If you set the nCardMode is type A, type B, or type C, reader only try to activate card in the specified way.
`static int`	`searchEnd()` Stop the process of searching card.
`static int`	`sendControlCommand(int nCmdID, byte[] byteArrayCmdData, int nDataLength)` Send control command.
`static int`	`touch()` Deprecated. Check whether this is a card on the rfcard reader return value : == 0 : no card >0 : find a card <0 : error code
`static int`	`transfer(int nSectorIndex, int nBlockIndex)` Save the value to the block from temporary buffer
`static int`	`transmit_level3(byte[] byteArrayAPDU, int nAPDULength, byte[] byteArrayResponse, int nOptionValue)` Transmit command of level 3 and get the response
`static int`	`transmit(byte[] byteArrayAPDU, int nAPDULength, byte[] byteArrayResponse)` Transmit APDU command and get the response
`static int`	`verify(int nSectorIndex, int nPinType, byte[] strPin, int nPinLength)` Verify pin for MiFare one card, and do authentication for ultralight C card.
`static void`	`waitForCardPresent(int nCardMode, int nFlagSearchAll, int nTimeout_MS)`
`static int`	`write(int nSectorIndex, int nBlockIndex, byte[] pData, int nDataLength)` Write data only for MiFare one card.
`static int`	`writeValue(int nSectorIndex, int nBlockIndex, int pValue, int nValueLength, byte pAddrData)` Write value to a block.

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

- Field Detail
  - CONTACTLESS_CARD_MODE_AUTO
```
public static int CONTACTLESS_CARD_MODE_AUTO
```
  - CONTACTLESS_CARD_MODE_TYPE_A
```
public static int CONTACTLESS_CARD_MODE_TYPE_A
```
  - CONTACTLESS_CARD_MODE_TYPE_B
```
public static int CONTACTLESS_CARD_MODE_TYPE_B
```
  - CONTACTLESS_CARD_MODE_TYPE_C
```
public static int CONTACTLESS_CARD_MODE_TYPE_C
```
  - RC500_COMMON_CMD_GET_READER_VERSION
```
public static int RC500_COMMON_CMD_GET_READER_VERSION
```
  - RC500_COMMON_CMD_RF_CONTROL
```
public static int RC500_COMMON_CMD_RF_CONTROL
```
  - CONTACTLESS_CARD_EVENT_FOUND_CARD
```
public static final int CONTACTLESS_CARD_EVENT_FOUND_CARD
```
    See Also:
    
    Constant Field Values
  - CONTACTLESS_CARD_EVENT_TIME_OUT
```
public static final int CONTACTLESS_CARD_EVENT_TIME_OUT
```
    See Also:
    
    Constant Field Values
  - CONTACTLESS_CARD_EVENT_COMM_ERROR
```
public static final int CONTACTLESS_CARD_EVENT_COMM_ERROR
```
    See Also:
    
    Constant Field Values
  - CONTACTLESS_CARD_EVENT_USER_CANCEL
```
public static final int CONTACTLESS_CARD_EVENT_USER_CANCEL
```
    See Also:
    
    Constant Field Values
  - EVENT_NONE
```
public static final int EVENT_NONE
```
    See Also:
    
    Constant Field Values
  - object
```
public static java.lang.Object object
```
    初始化的参数
  - notifyEvent
```
public static RFCardInterface.NotifyEvent notifyEvent
```
  - isCallBackCalled
```
public static boolean isCallBackCalled
```
- Constructor Detail
  - RFCardInterface
```
public RFCardInterface()
```
- Method Detail
  - open
```
public static int open()
```
    Open the contactless card reader.
    
    Returns:
    
    value == 0, error ; value != 0 , correct handle
  - isOpened
```
public static boolean isOpened()
```
    Contactless card reader is Opened return Boolean
    
    Returns:
    
    value == true, reader has opened ; value != 0 , reader not open.
  - close
```
public static int close()
```
    Close the contactless card reader.
    
    Returns:
    
    value >= 0, success ; value < 0, error code
  - searchBegin
```
public static int searchBegin(int nCardMode,
                              int nFlagSearchAll,
                              int nTimeout_MS)
```
    语义代表通知非接设备开始寻卡， Start searching the contactless1 card If you set the nCardMode is auto, reader will try to activate card in type A, type B and type successively; If you set the nCardMode is type A, type B, or type C, reader only try to activate card in the specified way.
    
    Parameters:
    
    nCardMode - : handle of this card reader possible value : CONTACTLESS_CARD_MODE_AUTO = 0 CONTACTLESS_CARD_MODE_TYPE_A = 1; CONTACTLESS_CARD_MODE_TYPE_B = 2; CONTACTLESS_CARD_MODE_TYPE_C = 3;
    
    nFlagSearchAll - : 0 : signal user if we find one card in the field, 1 : signal user only we find all card in the field。
    
    nTimeout_MS - : time out in milliseconds. if nTimeout_MS is less then zero, the searching process is infinite.
    
    Returns:
    
    value >= 0, success in starting the process; value < 0, error code
  - searchEnd
```
public static int searchEnd()
```
    Stop the process of searching card.
    
    Returns:
    
    :value >= 0, success in starting the process; value < 0, error code
  - attach
```
public static int attach(byte[] byteArrayATR)
```
    Attach the target before transmitting apdu command In this process, the target(card) is activated and return ATR.
    
    Parameters:
    
    byteArrayATR: - ATR buffer, if you set it null, you can not get the data.
    
    Returns:
    
    value >= 0, success in starting the process and return length of ATR; value < 0, error code
  - detach
```
public static int detach()
```
    Detach the target. If you want to send APDU again, you should attach it.
    
    Returns:
    
    value >= 0, success in starting the process; value < 0, error code
  - transmit
```
public static int transmit(byte[] byteArrayAPDU,
                           int nAPDULength,
                           byte[] byteArrayResponse)
```
    Transmit APDU command and get the response
    
    Parameters:
    
    byteArrayAPDU - : command of APDU。
    
    nAPDULength - : length of command of APDU。
    
    byteArrayResponse - : response of command of APDU。
    
    Returns:
    
    value >= 0, success in starting the process; value < 0, error code
  - transmit_level3
```
public static int transmit_level3(byte[] byteArrayAPDU,
                                  int nAPDULength,
                                  byte[] byteArrayResponse,
                                  int nOptionValue)
```
    Transmit command of level 3 and get the response
    
    Parameters:
    
    byteArrayAPDU - : command of APDU。
    
    nAPDULength - : length of command of APDU.
    
    byteArrayResponse - : response of command of APDU。
    
    nOptionValue - : reserved for future, must be set to zero。
    
    Returns:
    
    value >= 0, success in starting the process; value < 0, error code
  - sendControlCommand
```
public static int sendControlCommand(int nCmdID,
                                     byte[] byteArrayCmdData,
                                     int nDataLength)
```
    Send control command.
    
    Parameters:
    
    nCmdID - : id of command.
    
    byteArrayCmdData - : data associated with command, if no data, you can set it NULL.
    
    nDataLength - : data length of command.
    
    Returns:
    
    value >= 0, success in starting the process; value < 0, error code
  - verify
```
public static int verify(int nSectorIndex,
                         int nPinType,
                         byte[] strPin,
                         int nPinLength)
```
    Verify pin for MiFare one card, and do authentication for ultralight C card.
    
    Parameters:
    
    nSectorIndex - : sector index.
    
    nPinType - : 0 : Key A 1 : Key B 2 : TDEA type (for ultralight C).
    
    strPin - : password of this pin.
    
    nPinLength - : length of password.
    
    Returns:
    
    value >= 0 : success; value < 0, error code.
  - read
```
public static int read(int nSectorIndex,
                       int nBlockIndex,
                       byte[] pDataBuffer,
                       int nDataBufferLength)
```
    Read data only for MiFare one card.
    
    Parameters:
    
    nSectorIndex - : sector index。
    
    nBlockIndex - : block index。
    
    pDataBuffer - : data buffer。
    
    nDataBufferLength - : buffer length return value.
    
    Returns:
    
    value >= 0 : success; value < 0, error code.'
  - write
```
public static int write(int nSectorIndex,
                        int nBlockIndex,
                        byte[] pData,
                        int nDataLength)
```
    Write data only for MiFare one card.
    
    Parameters:
    
    nSectorIndex - : sector index.
    
    nBlockIndex - : block index.
    
    pData - : data.
    
    nDataLength - : data length.
    
    Returns:
    
    value >= 0 : success; value < 0, error code.
  - queryInfo
```
public static int queryInfo(int[] pHasMoreCards,
                            int[] pCardType)
```
    Query the number and type of cards on the contactless card reader.
    
    Parameters:
    
    nHandle - : handle of this card reader
    
    pHasMoreCards - : 0 : only one PICC in the field 0x0A : more cards in the field(type A) 0x0B : more cards in the field(type B) 0xAB : more cards in the field(type A and type B)
    
    pCardType - : 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.
    
    Returns:
    
    value >= 0 : success; value < 0, error code.
  - readValue
```
public static int readValue(int nSectorIndex,
                            int nBlockIndex,
                            byte[] pValue,
                            int nValueBufLength,
                            byte[] pAddrData)
```
    Read value from a block
    
    Returns:
    
    value >= 0 : success; value < 0, error code.
  - writeValue
```
public static int writeValue(int nSectorIndex,
                             int nBlockIndex,
                             int pValue,
                             int nValueLength,
                             byte pAddrData)
```
    Write value to a block.
    
    Parameters:
    
    nSectorIndex - : sector index.
    
    nBlockIndex - : block index.
    
    pValue - : data for saving value. LSB, 4bytes.
    
    nValueBufLength - : must be 4.
    
    pAddrData - : one byte, for saving a user data.
    
    Returns:
    
    value >= 0 : success; value < 0, error code.
  - increment
```
public static int increment(int nSectorIndex,
                            int nBlockIndex,
                            int value)
```
    Increment value to a block, using it with the API : hal_contactless_card_mc_restore and hal_contactless_card_mc_transfer
    
    Parameters:
    
    nSectorIndex - : sector index
    
    nBlockIndex - : block index
    
    pValue - : buffer for saving value. LSB, 4bytes
    
    Returns:
    
    value >= 0 : success; value < 0, error code.
  - decrement
```
public static int decrement(int nSectorIndex,
                            int nBlockIndex,
                            int value)
```
    Decrement value to a block, using it with the API : hal_contactless_card_mc_restore and hal_contactless_card_mc_transfer
    
    Parameters:
    
    nSectorIndex - : sector index
    
    nBlockIndex - : block index
    
    value - : buffer for saving value. LSB, 4bytes
    
    Returns:
    
    value >= 0 : success; value < 0, error code.
  - transfer
```
public static int transfer(int nSectorIndex,
                           int nBlockIndex)
```
    Save the value to the block from temporary buffer
    
    Parameters:
    
    nSectorIndex - : sector index
    
    nBlockIndex - : block index return value : >= 0.
    
    Returns:
    
    value >= 0 : success; value < 0, error code.
  - restore
```
public static int restore(int nSectorIndex,
                          int nBlockIndex)
```
    Read the value to the temporary from the block
    
    Parameters:
    
    nSectorIndex - : sector index。
    
    nBlockIndex - : block index return value : >= 0。
    
    Returns:
    
    value >= 0 : success; value < 0, error code.
  - touch
```
public static int touch()
```
    Deprecated. Check whether this is a card on the rfcard reader return value : == 0 : no card >0 : find a card <0 : error code
  - callBack
```
public static void callBack(int nEvent,
                            byte[] nData)
```
    Call back method, called by driver.
    
    Parameters:
    
    nEvent: - event id is CONTACTLESS_CARD_EVENT_FOUND_CARD;CONTACTLESS_CARD_EVENT_TIME_OUT;CONTACTLESS_CARD_EVENT_COMM_ERROR;CONTACTLESS_CARD_EVENT_USER_CANCEL;
    
    nData -
  - waitForCardPresent
```
public static void waitForCardPresent(int nCardMode,
                                      int nFlagSearchAll,
                                      int nTimeout_MS)
                               throws java.lang.InterruptedException
```
    Throws:
    
    java.lang.InterruptedException
  - notifyCancel
```
public static void notifyCancel()
```
  - clear
```
public static void clear()
```
    clear the notify event from callback.

Class RFCardInterface

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CONTACTLESS_CARD_MODE_AUTO

CONTACTLESS_CARD_MODE_TYPE_A

CONTACTLESS_CARD_MODE_TYPE_B

CONTACTLESS_CARD_MODE_TYPE_C

RC500_COMMON_CMD_GET_READER_VERSION

RC500_COMMON_CMD_RF_CONTROL

CONTACTLESS_CARD_EVENT_FOUND_CARD

CONTACTLESS_CARD_EVENT_TIME_OUT

CONTACTLESS_CARD_EVENT_COMM_ERROR

CONTACTLESS_CARD_EVENT_USER_CANCEL

EVENT_NONE

object

notifyEvent

isCallBackCalled

Constructor Detail

RFCardInterface

Method Detail

open

isOpened

close

searchBegin

searchEnd

attach

detach

transmit

transmit_level3

sendControlCommand

verify

read

write

queryInfo

readValue

writeValue

increment

decrement

transfer

restore

touch

callBack

waitForCardPresent

notifyCancel

clear