CVReader SDK

CVReader SDK is software development kit worked with CV3XXX, CV5XXX and CV6XXX product series for second
development. It includes API, Host Demo, user manual, USB driver and program example. It’s developed by C++builder
developing tool on Windows Operating system and GCC developing tool on Linux OS, compatible to VC,VB/VB.NET,JAVA,
C++,C#.NET, DELPHI etc.

Features
SDK is available with some special benefits for customer’s development
Stronger and powerful informative API to save your time and cost for development (See "CVReader API reference
directory" in Appendix for details)
Examples for good reference and understanding, using developing tools like Delphi, C++ Builder, C#.NET,
VC,VB/VB.NET etc.
Comprehensive platform to provide flexibility by customer side:
Operating System: Linux and Windows. Support Win 98,Win ME, Win 2000, Win 2003, Win 2003 x64, Win XP, Win
XP x64, Win Vista, Win Vista x64, Win 2008, Win 2008 x64, Win 2008 R2 x64, Win 7, Win 7 x64, Win8
Host Demo, a software testing tool to ease and simply development
One SDK for all our readers (CV3XXX, CV5XXX, CV6XXX) to avoid development cost for product upgrade
Selective SDK

CVReader SDK ISO14443A/B, Mifare, ISO15693

CVReader Finger SDK ISO14443A/B, Mifare, ISO15693, Fingerprint
CVReader_DESFire_Finger SDK ISO14443A/B, Mifare, ISO15693, Mifare Plus, Desfire EV1 and Fingerprint

Appendix of CVReader API Reference Directory

CVReader API Reference Directory

1 INTRODUCTION 14

1.1 Corresponding reader 14

1.2 serial port communication introduction 14

1.2.1 CV_SetCommunicationType(byte aType) 14
1.2.2 SearchAndOpenUSBPorts (void) 14
1.2.3 SearchUSBReadersCallBack(TOnSearchUSBReaders aOnSearchUSBReaders) 14
1.2.4 UsingUSBPort(int iUSBPort) 15
1.2.5 CloseUSBPorts(void) 15
1.2.6 CV_UDPRun(int SvrPort) 15
1.2.7 CV_UDPStop() 15
1.2.8 CV_SetRemoteIPPort(unsigned char *ip,int port) 15
1.2.9 important notice 16
1.2.10 Single serial port working mode 17
1.2.11 Multi serial port working mode. 17

2 API FUNCTIONS 19
CiVinTec Global Co., Limited Version 1.04 / May 6, 2013 / Page 1/11
Tel: +86-755-86117608 Fax: +86-755-86117428 Web: www.civintec.com
 2.1 Configuration, I/O commands 19
2.1.1 Int GetVersionAPI( char *VersionAPI ) 19
2.1.2 int OpenComm(char *Com, int Baudrate)//.. single serial port working mode19
2.1.3 int CloseComm ( Void ) 19
2.1.4 int SetExtPort(int DeviceAddress,unsigned char Ports) 19
2.1.5 int GetPort ( int DeviceAddress, unsigned char *status ) 20
2.1.6 int ActiveLED ( int DeviceAddress, unsigned char NumLED, unsigned char ontime, ussigned
char cycle) 20
2.1.7 int SetLED ( int DeviceAddress, unsigned char LEDState ) 21
2.1.8 int ActiveBuzzer ( int DeviceAddress, unsigned char mode, unsigned char *pattern) 21
2.1.9 int RF_Field ( int DeviceAddress, unsigned char time ) 22
2.1.10 int SetWiegandStatus(int DeviceAddress,unsigned char status) 22
2.1.11 int ActiveWiegandMode(int DeviceAddress,unsigned char status) 23
2.1.12 int CreateCommPort(int SerialNUM,unsigned char *CommID,int Baudrate ) //..multi serial
port working mode [note]:the function will only available on serial port communication(232
communication) 23
2.1.13 int ReaderC_EXT(int DeviceAddress,byte iTime)[Controlling Relay if reader have] 25

2.2 Auto-Read mode APIs 25

Note: before you call the following APIs, reader must works in wiegant mode, or reader will not
read card automatically. You can chose only one method to support auto-read mode: calling API
ReadOriginalData() by yourself or the following APIs. 25
2.2.1 int SetOnAutoRead(TOnAutoRead aEventFun) 25
2.2.2 int AutoRead_Run() 25
2.2.3 int AutoRead_Stop() 25
2.2.4 int IsAutoRead () 26

2.3 ISO14443-A Command 27

2.3.1 int MF_Request ( int DeviceAddress, unsigned char mode, unsigned char *ATQ) 27
2.3.2 int MF_Anticoll ( int DeviceAddress, unsigned char *UID, unsigned char &Collision) 27
2.3.3 int MF_Anticoll2 ( int DeviceAddress, unsigned char *UID, unsigned char &Collision) 28
2.3.4 int MF_Anticoll3 ( int DeviceAddress, unsigned char *UID, unsigned char &Collision) 28
2.3.5 int MF_Select( int Device Address, unsigned char *UID) 28
2.3.6 int MF_Select2( int Device Address, unsigned char *UID) 29
2.3.7 int MF_Select3( int Device Address, unsigned char *UID) 29
2.3.8 int MF_Halt( int Device Address, unsigned char mode) 30
2.3.9 int SLE_Generic(int DeviceAddress,unsigned char CRC_Flag,unsigned char
&length,unsigned char *buffer) 30
2.3.10 int SLE_GenericEx (int DeviceAddress,unsigned char CRC_Flag,unsigned char
TimeOut,unsigned char &length,unsigned char *buffer) 30

2.4 Mifare function 32

2.4.1 int MF_Auth(int DeviceAddress, unsigned char KeyAB, unsigned char *snr, unsigned char
add_blk) 32
2.4.2 int MF_Read ( int DeviceAddress,unsigned char add_blk, unsigned char num_blk, unsigned
char *buffer); 32

CiVinTec Global Co., Limited Version 1.04 / May 6, 2013 / Page 2/11
Tel: +86-755-86117608 Fax: +86-755-86117428 Web: www.civintec.com
 2.4.3 int MF_Write(int DeviceAddress,unsigned char add_blk, unsigned char num_blk, unsigned char
*buffer) 32
2.4.4 int MF_Transfer(int DeviceAddress, unsigned char add_blk ) 33
2.4.5 int MF_Increment( int DeviceAddress, unsigned char add_blk, int value ) 33
2.4.6 int MF_Decrement( int DeviceAddress, unsigned char add_blk, int value )33
2.4.7 int MF_Restore(int DeviceAddress, unsigned char add_blk ) 34
2.4.8 int MF_InitValue( int DeviceAddress, unsigned char add_blk, int value )34
2.4.9 int MF_ReadValue(int DeviceAddress, unsigned char add_blk, int *value ) 34
2.4.10 int MF_LoadKey(int DeviceAddress, unsigned char *Key) 34
2.4.1 int MF_StoreKeyToEE(int DeviceAddress, unsigned char KeyAB, unsigned char Sector,
unsigned char *Key) 35
2.4.2 int MF_LoadKeyFromEF(int DeviceAddress, unsigned char KeyAB, unsigned char Sector)
35

2.3.4 Mifare High Level Functions 36

2.4.3 int MF_HLRead ( int DeviceAddress, unsigned char mode, unsigned char add_blk, unsigned
char num_blk, unsigned char *snr, unsigned char *buffer); 36
2.4.4 int MF_HLWrite ( int DeviceAddress, unsigned char mode, unsigned char add_blk, unsigned
char num_blk, unsigned char *snr, unsigned char *buffer); 36
2.4.5 int MF_HLInitVal ( int DeviceAddress, unsigned char mode, unsigned char sect_num, unsigned
char *snr, int value); 37
2.4.6 int MF_HLInc ( int DeviceAddress, unsigned char mode, unsigned char sect_num, unsigned
char *snr, int *value) 38
2.4.7 int MF_HLDec ( int DeviceAddress, unsigned char mode, unsigned char sect_num, unsigned
char *snr, int *value) 38
2.4.8 int MF_HLRequest ( int DeviceAddress, unsigned char mode, int &length, unsigned char *UID)
39

2.5 ISO14443 B Commands 40

2.5.1 int Generic_B(int DeviceAddress,unsigned char &length, unsigned char *buffer) ; 40
2.5.2 int Generic_BEx (int DeviceAddress,unsigned char CRC_Flag,unsigned char TimeOut,
unsigned char &length,unsigned char *buffer); 40

2.6 ISO-15693 Interface Commands 41

2.6.1 int CMD_ISO15693_Generic(int DeviceAddress,unsigned char length,unsigned char
*databuffer) 41
2.6.2 int CMD_ISO15693_Inventory(int DeviceAddress,unsigned char flags,unsigned char
AFI,unsigned char masklengh ,unsigned char *maskvalue,unsigned char*databuffer 41
2.6.3 int CMD_ISO15693_Stay_Quiet(int DeviceAddress,unsigned char flags,unsigned char *UID)
42
2.6.4 int __stdcall CMD_ISO15693_Read(int DeviceAddress,unsigned char flags,unsigned char
irstblock, unsigned char Number,unsigned char*UID,unsigned char*databuffer) 42
2.6.5 Int CMD_ISO15693_Write(int DeviceAddress,unsigned char flags,unsigned char Firstblock,
unsigned char Number,unsigned char*UID,unsigned char*databuffer) 43
2.6.6 Int CMD_ISO15693_Lock_Block(int DeviceAddress,unsigned char flags,unsigned char
block,unsigned char*UID) 43
2.6.7 int CMD_ISO15693_Select(int DeviceAddress,unsigned char flags,unsigned char*UID) 44

CiVinTec Global Co., Limited Version 1.04 / May 6, 2013 / Page 3/11
Tel: +86-755-86117608 Fax: +86-755-86117428 Web: www.civintec.com
 2.6.8 int CMD_ISO15693_Reset_To_Ready(int DeviceAddress,unsigned char flags,unsigned
char*UID) 44
2.6.9 int CMD_ISO15693_Write_AFI(int DeviceAddress,unsigned char flags, unsigned char AFI,
unsigned char*UID) 45
2.6.10 int CMD_ISO15693_Lock_AFI(int DeviceAddress,unsigned char flags,unsigned char*UID)
45
2.6.11 Int CMD_ISO15693_Write_DSFID(int DeviceAddress,unsigned char flags,unsigned char
DSFID,unsigned char*UID) 46
2.6.12 int CMD_ISO15693_Lock_DSFID(int DeviceAddress,unsigned char flags,unsigned
char*UID) 46
2.6.13 Int CMD_ISO15693_GET_System_Information(int DeviceAddress,unsigned char
flags,unsigned char*UID,unsigned char *databuffer) 47
2.6.14 int CMD_ISO15693_GetMultipleBlockSecurity(int DeviceAddress,unsigned char
flags,unsigned char Firstblock,unsigned char Number,unsigned char *UID,unsigned char *databuffer) 47
2.6.15 int CMD_Myd_read(int DeviceAddress,unsigned char flags,unsigned char block,unsigned
char*UID,unsigned char*databuffer) 48
2.6.16 int CMD_Myd_write(int DeviceAddress,unsigned char flags,unsigned char block,unsigned
char*UID,unsigned char*databuffer) 48
2.6.17 int CMD_ISO15693_Inventory16(int DeviceAddress,unsigned char Flags, unsigned char
AFI,int *CardNum,unsigned char*Buffer) 49

2.7 Misc. Commands 51

2.7.1 int SetFirmwareBaudrate(int DeviceAddress, unsigned char Baudrate) 51
2.7.2 int SetDeviceAddress ( int DeviceAddress, unsigned char &newAddress 51
2.7.3 int GetVersionlNum (int DeviceAddress, char *VersionNUM) 52
2.7.4 int GetSerialNum (int DeviceAddress, int &CurrentAddress, char *SerialNUM) 52
2.7.5 int GetUserInfo (int DeviceAddress, char *UserInfo) 52
2.7.6 int SetUserInfo (int DeviceAddress, char *UserInfo) 53
2.7.7 int SetWiegandStatus(int DeviceAddress,unsigned char status) 53
2.7.8 int ActiveWiegandMode(int DeviceAddress,unsigned char status) 53
2.7.9 int WiegandMode (int DeviceAddress,unsigned char*data) 54
2.7.10 int LcdDisplayLogo(int DeviceAddress,unsigned char*data); 55
2.7.11 int LcdDisplay(int DeviceAddress,unsigned char address,unsigned char length, char
*Dstring); 55
2.7.12 GetKey(int DeviceAddress,unsigned char *keybuffer); 55
2.7.13 int ReadChar(unsigned char *byte) 56
2.7.14 int ReadOriginalData (unsigned long iTimeOut, unsigned long iReadLength, unsigned char
*pDataBur, unsigned long *iSuccessLen) 56

2.8 UltraLight Card Commands 56

2.8.1 REQA command use ISO14443A REQA command 56
2.8.2 WAKE-UP command use ISO14443A WAKE-UP command 56
2.8.3 HALT command use ISO14443A HALT command 56
2.8.4 int MF_UL_AnticollL1(int DeviceAddress,unsigned char *UID_Part1,unsigned char *BCC1)
56
2.8.5 int MF_UL_SelectL1( int DeviceAddress,unsigned char *UID_Part1,unsigned char BCC1)
57

CiVinTec Global Co., Limited Version 1.04 / May 6, 2013 / Page 4/11
Tel: +86-755-86117608 Fax: +86-755-86117428 Web: www.civintec.com
 2.8.6 int MF_UL_AnticollL2(int DeviceAddress,unsigned char *UID_Part2,unsigned char *BCC2)
57
2.8.7 int MF_UL_SelectL2( int DeviceAddress,unsigned char *UID_Part2,unsigned char BCC2)
57
2.8.8 int MF_UL_Read(int DeviceAddress,int StartPage , unsigned char *FromData_16Bytes) 57
2.8.9 int MF_UL_Write(int DeviceAddress,int PageNum , unsigned char *ToData_4Bytes) 57

2.9 DESFire EV1 Card Commands 58

The DESFire EV1 Card are: MF31CD40, MF31CD21, MF31CD41, MF31CD8158
Some of the following APIs are invalid to MF31CD40, will be indicated. 58
2.9.1 REQA command use ISO14443A REQA command 58
2.9.2 WAKE-UP command use ISO14443A WAKE-UP command 58
2.9.3 int MF_DF_AnticollL1 (int DeviceAddress,unsigned char *UID_Part1,unsigned char *BCC1)
58
2.9.4 int MF_DF_SelectL1( int DeviceAddress,unsigned char *UID_Part1,unsigned char BCC1)
58
2.9.5 int MF_DF_AnticollL2(int DeviceAddress,unsigned char *UID_Part2,unsigned char *BCC2)
58
2.9.6 int MF_DF_SelectL2( int DeviceAddress,unsigned char *UID_Part2,unsigned char BCC2)
59
2.9.7 MF_DF_RATS(int DeviceAddress,byte FSDI=8,byte CID=0) 59
2.9.8 MF_DF_RATSEx(int DeviceAddress,unsigned char CID,unsigned char FSDI,unsigned char
*ATS) 59
2.9.9 MF_DF_PPS(int DeviceAddress,byte CID=0,byte DSI=0,byte DRI=0 ) 60
2.9.10 MF_DF_Authenticate(int DeviceAddress, unsigned char KeyNo, unsigned char *Key) 60
The API has no CID parameter, it will operate on the current active card, for other information, please
refer to its alternative API MF_DF_AuthenticateEx(), 60
2.9.11 MF_DF_AuthenticateEx(int DeviceAddress, unsigned char CID, unsigned char KeyNo,
unsigned char *Key) 60
2.9.12 MF_DF_AuthenticateISO(int DeviceAddress, unsigned char CID, unsigned char KeyNo,
unsigned char *Key) 61
2.9.13 MF_DF_AuthenticateAES(int DeviceAddress, unsigned char CID, unsigned char KeyNo,
unsigned char *Key) 62
2.9.14 MF_DF_ChangeKeySettings(int DeviceAddress,byte MasterKeySettings=0x0F) 63
The API has no CID parameter, it will operate on the current active card, for other information, please
refer to its alternative API MF_DF_ChangeKeySettingsEx (), 63
2.9.15 MF_DF_ChangeKeySettingsEx(int DeviceAddress,unsigned char CID,unsigned char
MasterKeySettings=0x0F) 63
2.9.16 MF_DF_GetKeySettings(int DeviceAddress,byte *MasterKeySettings,byte *MaxKey ) 65
The API has no CID parameter, it will operate on the current active card, for other information, please
refer to its alternative API MF_DF_GetKeySettingsEx (), 65
2.9.17 MF_DF_GetKeySettingsEx(int DeviceAddress,unsigned char CID,unsigned char
*MasterKeySettings,unsigned char *MaxKey,unsigned char *CryptoType ) 65
2.9.18 MF_DF_ChangeKey(int DeviceAddress,byte KeyNo, byte *new_Key, byte *old_Key) 66
2.9.19 MF_DF_ChangeKeyEx(int DeviceAddress,unsigned char CID,unsigned char KeyNo, unsigned
char AuthenticateType,unsigned char KeyVersion, unsigned char *new_Key ,unsigned char *old_Key) 66
2.9.20 MF_DF_GetKeyVersion(int DeviceAddress,byte KeyNo,byte *KeyVersion)66

CiVinTec Global Co., Limited Version 1.04 / May 6, 2013 / Page 5/11
Tel: +86-755-86117608 Fax: +86-755-86117428 Web: www.civintec.com
 2.9.21 MF_DF_GetKeyVersionEx(int DeviceAddress,unsigned char CID,unsigned char
KeyNo,unsigned char *KeyVersion) 67
2.9.22 MF_DF_CreateApplication(int DeviceAddress,int AID, byte MasterKeySettings=0x0F, byte
NumOfKeys=0x0E) 67
2.9.23 MF_DF_CreateApplicationEx(int DeviceAddress,unsigned char CID,int AID,unsigned char
MasterKeySettings, unsigned char NumOfKeys,unsigned char CryptoMethod) 67
2.9.24 MF_DF_DeleteApplication(int DeviceAddress,int AID); 68
2.9.25 MF_DF_DeleteApplicationEx(int DeviceAddress,unsigned char CID,int AID) 68
2.9.26 MF_DF_GetApplicationIDs(int DeviceAddress,int AIDs27[]) 68
2.9.27 MF_DF_GetApplicationIDsEx(int DeviceAddress,unsigned char CID,int AIDs27[]) 68
2.9.28 MF_DF_SelectApplication(int DeviceAddress,int AID) 69
2.9.29 MF_DF_SelectApplicationEx(int DeviceAddress, unsigned char CID, int AID) 69
2.9.30 MF_DF_FormatPICC(int DeviceAddress) 69
2.9.31 MF_DF_FormatPICCEx(int DeviceAddress, unsigned char CID) 69
2.9.32 MF_DF_GetVersion(int DeviceAddress, unsigned char VerInfo[28]) 70
2.9.33 MF_DF_GetVersionEx(int DeviceAddress, unsigned char CID,unsigned char VerInfo[28])
70
2.9.34 MF_DF_GetFreeMem(int DeviceAddress,unsigned char CID,unsigned long *pFreeMemSize)
71
2.9.35 MF_DF_GetCardUID(int DeviceAddress,unsigned char CID,unsigned char *UID) 71
2.9.36 MF_DF_SetConfiguration(int DeviceAddress,unsigned char CID,unsigned char
ConfigurationType, unsigned char *pConfigurationData,unsigned char ConfigurationDataLength) 71
2.9.37 MF_DF_GetFileIDs(int DeviceAddress,int FileIDs[16]) 72
2.9.38 MF_DF_GetFileIDsEx(int DeviceAddress,unsigned char CID,unsigned char
*FileIDs,unsigned char *FileNumber) 72
2.9.39 MF_DF_GetFileSettings(int DeviceAddress, unsigned char FileNo, unsigned char
FileSettings[]) 72
2.9.40 MF_DF_GetFileSettingsEx(int DeviceAddress,unsigned char CID,unsigned char
FileNo,unsigned char FileSettings[]) 72
2.9.41 MF_DF_ChangeFileSettings(int DeviceAddress, unsigned char FileNo, unsigned char
CommSet,unsigned short AccessRights, int Is_Rights_Free) 74
2.9.42 MF_DF_ChangeFileSettingsEx(int DeviceAddress,unsigned char CID,unsigned char FileNo,
unsigned char CommSet,unsigned short AccessRights,int Is_Rights_Free) 74
2.9.43 MF_DF_CreateStdDataFile(int DeviceAddress, unsigned char FileNo, unsigned char
CommSet, unsigned short AccessRights, int FileSize) 75
2.9.44 MF_DF_CreateStdDataFileEx(int DeviceAddress,unsigned char CID,unsigned char
FileNo,unsigned char CommSet, unsigned short AccessRights,int FileSize) 75
2.9.45 MF_DF_CreateBackupDataFile(int DeviceAddress, unsigned char FileNo, unsigned char
CommSet, unsigned short AccessRights, int FileSize) 76
2.9.46 MF_DF_CreateBackupDataFileEx(int DeviceAddress,unsigned char CID,unsigned char
FileNo,unsigned char CommSet,unsigned short AccessRights,int FileSize) 76
2.9.47 MF_DF_CreateValueFile(int DeviceAddress,byte FileNo, unsigned char CommSet,unsigned
short AccessRights, int LowerLimit,int UpperLimit,int Value, unsigned char LimitedCreditEnabled) 76
2.9.48 MF_DF_CreateValueFileEx(int DeviceAddress,unsigned char CID,unsigned char
FileNo,unsigned char CommSet,unsigned short AccessRights,int LowerLimit,int UpperLimit,int Value,unsigned
char LimitedCreditEnabled) 77

CiVinTec Global Co., Limited Version 1.04 / May 6, 2013 / Page 6/11
Tel: +86-755-86117608 Fax: +86-755-86117428 Web: www.civintec.com
 2.9.49 MF_DF_CreateLinearRecordFile(int DeviceAddress,byte FileNo, unsigned char
CommSet,unsigned short AccessRights, int RecordSize, int MaxNumRecords) 77
2.9.50 MF_DF_CreateLinearRecordFileEx(int DeviceAddress,unsigned char CID,unsigned char
FileNo,unsigned char CommSet,unsigned short AccessRights,int RecordSize,int MaxNumRecords) 77
2.9.51 MF_DF_CreateCyclicRecordFile(int DeviceAddress,byte FileNo, unsigned char
CommSet,unsigned short AccessRights, int RecordSize, int MaxNumRecords) 78
2.9.52 MF_DF_CreateCyclicRecordFileEx(int DeviceAddress,unsigned char CID,unsigned char
FileNo,unsigned char CommSet,unsigned short AccessRights,int RecordSize,int MaxNumRecords) 78
2.9.53 MF_DF_DeleteFile(int DeviceAddress, unsigned char FileNo) 79
2.9.54 MF_DF_DeleteFileEx(int DeviceAddress,unsigned char CID,unsigned char FileNo)79
2.9.55 MF_DF_ReadData(int DeviceAddress,byte FileNo, int Offset, int Length, unsigned char
CommSet, unsigned char DataRead[255],int &ReadLen) 79
2.9.56 MF_DF_ReadDataEx(int DeviceAddress,unsigned char CID,unsigned char FileNo,int
Offset,int Length,unsigned char CommSet,unsigned char *DataRead,int &ReadLen) 79
2.9.57 MF_DF_WriteData(int DeviceAddress, unsigned char FileNo, int Offset,int Length, unsigned
char CommSet, byte *DataToWrite) 80
2.9.58 MF_DF_WriteDataEx(int DeviceAddress,unsigned char CID,unsigned char FileNo,int
Offset,int Length, unsigned char CommSet,unsigned char *DataToWrite) 80
2.9.59 MF_DF_GetValue(int DeviceAddress, unsigned char FileNo, unsigned char CommSet, int
*Value) 81
2.9.60 MF_DF_GetValueEx(int DeviceAddress,unsigned char CID,unsigned char FileNo,unsigned
char CommSet,int *Value) 81
2.9.61 MF_DF_Credit(int DeviceAddress, byte FileNo, unsigned char CommSet, const int incValue)
81
2.9.62 MF_DF_CreditEx(int DeviceAddress,unsigned char CID,unsigned char FileNo,unsigned char
CommSet,const unsigned long incValue) 81
2.9.63 MF_DF_Debit(int DeviceAddress, unsigned char FileNo,byte CommSet,const int decValue)
82
2.9.64 MF_DF_DebitEx(int DeviceAddress,unsigned char CID,unsigned char FileNo,unsigned char
CommSet,const unsigned long decValue) 82
2.9.65 MF_DF_LimitedCredit(int DeviceAddress, unsigned char FileNo, byte CommSet, const int
incValue) 83
2.9.66 MF_DF_LimitedCreditEx(int DeviceAddress,unsigned char CID,unsigned char
FileNo,unsigned char CommSet,const unsigned long incValue) 83
2.9.67 MF_DF_WriteRecord(int DeviceAddress, unsigned char FileNo,int Offset, int Length,
unsigned char CommSet, unsigned char *DataToWrite) 83
2.9.68 MF_DF_WriteRecordEx(int DeviceAddress,unsigned char CID,unsigned char FileNo,int
Offset,int Length,unsigned char CommSet,unsigned char *DataToWrite) 84
2.9.69 MF_DF_ReadRecords(int DeviceAddress,unsigned char FileNo,int Offset,int
RecNumberToRead,int RecSize,unsigned char CommSet,unsigned char *DataRead,int &ReadLen) 84
2.9.70 MF_DF_ReadRecordsEx(int DeviceAddress,unsigned char CID,unsigned char FileNo,int
Offset,int RecNumberToRead,int RecSize,unsigned char CommSet,unsigned char *DataRead,int &ReadLen) 84
2.9.71 MF_DF_ClearRecordFile(int DeviceAddress, unsigned char FileNo) 85
2.9.72 MF_DF_ClearRecordFileEx(int DeviceAddress,unsigned char CID,unsigned char FileNo)
85
2.9.73 MF_DF_CommitTransaction(int DeviceAddress) 86
2.9.74 MF_DF_CommitTransactionEx(int DeviceAddress,unsigned char CID) 86
CiVinTec Global Co., Limited Version 1.04 / May 6, 2013 / Page 7/11
Tel: +86-755-86117608 Fax: +86-755-86117428 Web: www.civintec.com
 2.9.75 MF_DF_AbortTransaction(int DeviceAddress) 86
2.9.76 MF_DF_AbortTransactionEx(int DeviceAddress,unsigned char CID) 86
2.9.77 MF_DF_SaveDESFire4Key(int DeviceAddress, int Index, int KeyNo,unsigned char Key[16])
87
2.9.78 MF_DF_SaveDESFire4ParameterForRead (int DeviceAddress, int AppNo, int FileNo, int
Offset, int ReadLen, int KeyIndex) 87
2.9.79 MF_DF_ReadDESFire4UID(int DeviceAddress,unsigned char DESFireUID[7]) 87
2.9.80 MF_DF_ReadDESFire4File (int DeviceAddress, int AppNo, int FileNo, int Offset, int
ReadLen, int KeyIndex, int &FileType, int &Value, unsigned char *DataBuf, int &ReturnLen)87
2.9.81 MF_DF_DESELECT(int DeviceAddress) 88
2.9.82 MF_DF_DESELECTEx(int DeviceAddress,unsigned char CID) 88

2.10 DESFire EV1 Card Commands 88

The following APIs is valid for CV3XXXA, CV5X2A-X-XX 88
2.10.1 REQA command use ISO14443A REQA command 88
2.10.2 WAKE-UP command use ISO14443A WAKE-UP command 88
2.10.3 Anticoll command use ISO14443A MF_Anticoll command 89
2.10.4 Select command use ISO14443A MF_Select command 89
2.10.5 Anticol2 command use ISO14443A MF_Anticol2 command 89
2.10.6 SelectL2 command use ISO14443A MF_Selectl2 command 89
2.10.7 RATS(int DeviceAddress,unsigned char CID,unsigned char FSDI,unsigned char
*ATS,unsigned int *ATSLen) 89
2.10.8 PPS(int DeviceAddress,unsigned char CID, unsigned char DSI, unsigned char DRI) 89
2.10.9 DESELECT(int DeviceAddress,unsigned char CID) 90
2.10.10 MF_DFEV1_Authenticate(int DeviceAddress,unsigned char CID,unsigned char
CryptoType,unsigned char KeyNo, unsigned char *Key) 90
2.10.11 MF_DFEV1_ChangeKeySettings(int DeviceAddress,unsigned char CID,unsigned char
MasterKeySettings) 91
2.10.12 MF_DFEV1_ChangeKeySettings(int DeviceAddress,unsigned char CID,unsigned char
MasterKeySettings) 93
2.10.13 MF_DFEV1_ChangeKey(int DeviceAddress,unsigned char CID,unsigned char KeyNo,
unsigned char CryptoType, unsigned char KeyVersion, unsigned char *NewKey, unsigned char *OldKey) 93
2.10.14 MF_DFEV1_GetKeyVersion(int DeviceAddress,unsigned char CID, unsigned char
KeyNo,unsigned char *KeyVersion) 94
2.10.15 MF_DFEV1_CreateApplication(int DeviceAddress,unsigned char CID, int AID,unsigned
char MasterKeySettings, unsigned char KeyNum, unsigned char CryptoType) 94
2.10.16 MF_DFEV1_DeleteApplication(int DeviceAddress,unsigned char CID, int AID) 95
2.10.17 MF_DFEV1_GetApplicationIDs(int DeviceAddress,unsigned char CID, int *AIDs, int
*AIDNum) 95
2.10.18 MF_DFEV1_SelectApplication(int DeviceAddress,unsigned char CID, int AID) 95
2.10.19 MF_DFEV1_FormatPICC(int DeviceAddress,unsigned char CID) 96
2.10.20 MF_DFEV1_GetVersion(int DeviceAddress,unsigned char CID, unsigned char
*VersionInfo,unsigned int *VersionInfoLen) 96
2.10.21 MF_DFEV1_GetFreeMem(int DeviceAddress,unsigned char CID, int *RemainMemSize)
97
2.10.22 MF_DFEV1_GetCardUID(int DeviceAddress,unsigned char CID, unsigned char
*UID,unsigned int *UIDLen) 97

CiVinTec Global Co., Limited Version 1.04 / May 6, 2013 / Page 8/11
Tel: +86-755-86117608 Fax: +86-755-86117428 Web: www.civintec.com
 2.10.23 MF_DFEV1_SetConfiguration(int DeviceAddress,unsigned char CID, unsigned char
ConfigType, unsigned char *ConfigData,unsigned int ConfigDataLen) 97
2.10.24 MF_DFEV1_GetFileIDs(int DeviceAddress,unsigned char CID, unsigned char
*FileIDs,unsigned int *FileIDsLen) 98
2.10.25 MF_DFEV1_GetFileSettings(int DeviceAddress,unsigned char CID,unsigned char FileID,
unsigned char *FileSettings) 98
2.10.26 MF_DFEV1_ChangeFileSettings(int DeviceAddress,unsigned char CID,unsigned char
FileID,unsigned char CmtSet,unsigned short AccessRights,bool Is_Rights_Free) 100
2.10.27 MF_DFEV1_CreateDataFile(int DeviceAddress,unsigned char CID,unsigned char
FileID,unsigned char FileType, unsigned char CmtSet,unsigned short AccRights,unsigned int CreateSize) 101
2.10.28 MF_DFEV1_CreateValueFile(int DeviceAddress,unsigned char CID,unsigned char
FileID,unsigned char CmtSet, unsigned short AccRights,unsigned int LLimit,unsigned int ULimit,unsigned int
InitVal,unsigned char LimitCredit) 101
2.10.29 MF_DFEV1_CreateRecordFile(int DeviceAddress,unsigned char CID,unsigned char
FileID,unsigned char FileType,unsigned char CmtSet, unsigned short AccRights,unsigned int
SingleRecordSize,unsigned int RecordNumber) 102
2.10.30 MF_DFEV1_DeleteFile(int DeviceAddress,unsigned char CID, unsigned char FileID) 102
2.10.31 MF_DFEV1_ReadData(int DeviceAddress,unsigned char CID,unsigned char FileID,unsigned
char CmtSet, unsigned int Offset,unsigned int ReadLength,unsigned char *ReturnData,unsigned int
*ReturnDataLen) 103
2.10.32 MF_DFEV1_WriteData(int DeviceAddress,unsigned char CID,unsigned char
FileID,unsigned char CmtSet, unsigned int Offset,unsigned int WriteDataLength,unsigned char *WriteData) 103
2.10.33 MF_DFEV1_GetValue(int DeviceAddress,unsigned char CID, unsigned char FileID,unsigned
char CmtSet, int *RetValue) 104
2.10.34 MF_DFEV1_Credit(int DeviceAddress,unsigned char CID, unsigned char FileID, unsigned
char CmtSet,unsigned int IncValue) 104
2.10.35 F_DFEV1_Debit(int DeviceAddress,unsigned char CID, unsigned char FileID, unsigned char
CmtSet,unsigned int DecValue) 105
2.10.36 MF_DFEV1_LimitedCredit(int DeviceAddress,unsigned char CID, unsigned char FileID,
unsigned char CmtSet,unsigned int IncValue) 106
2.10.37 MF_DFEV1_WriteRecord(int DeviceAddress,unsigned char CID,unsigned char
FileID,unsigned char CmtSet, unsigned int Offset,unsigned int RecordLength,unsigned char *RecordData) 106
2.10.38 MF_DFEV1_ReadRecord(int DeviceAddress,unsigned char CID,unsigned char
FileID,unsigned char CmtSet, unsigned int Offset,unsigned int ReadNumber,unsigned int RecSize,unsigned char
*ReturnData,unsigned int *ReturnDataLen) 107
2.10.39 MF_DFEV1_ClearRecordFile(int DeviceAddress,unsigned char CID,unsigned char FileID)
107
2.10.40 MF_DFEV1_CommitTransaction(int DeviceAddress,unsigned char CID)108
2.10.41 MF_DFEV1_AbortTransaction(int DeviceAddress,unsigned char CID) 108
2.10.42 MF_DFEV1_KeySetting(int DeviceAddress,unsigned char KeyNo,unsigned char
CryptoType,unsigned char *Key) 109
2.10.43 MF_DFEV1_FileSetting(int DeviceAddress,int AID,unsigned char KeyNo,unsigned char
FileID,unsigned char FileType, unsigned char CmtSet,unsigned int Offset,unsigned int Length,unsigned int
RecSize) 109
2.10.44 MF_DFEV1HL_Read(int DeviceAddress,unsigned char CID,int AID,unsigned char
KeyIndex, unsigned char FileID,unsigned char FileType,unsigned char CmtSet,unsigned int Offset,unsigned int
Length, unsigned int RecSize,unsigned char *Data,unsigned int *ReadLen) 109
CiVinTec Global Co., Limited Version 1.04 / May 6, 2013 / Page 9/11
Tel: +86-755-86117608 Fax: +86-755-86117428 Web: www.civintec.com
 2.10.45 MF_DFEV1HL_Write(int DeviceAddress,unsigned char CID,int AID,unsigned char
KeyIndex, 110
unsigned char FileID,unsigned char FileType,unsigned char CmtSet,unsigned int Offset,unsigned int
Length, unsigned char *Data) 110
2.10.46 MF_DFEV1HL_ClearReads (int DeviceAddress,unsigned char CID,int AID,unsigned char
KeyIndex, unsigned char FileID) 110
2.10.47 MF_DFEV1HL_GetValue(int DeviceAddress,unsigned char CID,int AID,unsigned char
KeyIndex, unsigned char FileID,unsigned char CmtSet, int *RetValue) 111
2.10.48 MF_DFEV1HL_Credit(int DeviceAddress,unsigned char CID,int AID,unsigned char
KeyIndex, unsigned char FileID,unsigned char CmtSet, unsigned int IncValue,bool IsLimited)111
2.10.49 MF_DFEV1HL_Debit(int DeviceAddress,unsigned char CID, int AID,unsigned char
KeyIndex, unsigned char FileID,unsigned char CmtSet, unsigned int DecValue) 111

2.11 Fingerprint Commands 112

2.11.1 CV64GetMessage(unsigned long MsgID,char *MsgStr) 112
2.11.2 CV64SetMsgCallBack(CV64X0_MSGCALLBACK_TYPE MsgCallBack)112
2.11.3 CV64Enroll(int DeviceAddress, unsigned char *pTemplate, unsigned long &pTemplateLength,
unsigned long dwTimeOut=10000) 112
2.11.4 CV64Verify (int DeviceAddress, unsigned char *pTemplate, unsigned long
&pTemplateLength, unsigned long dwTimeOut=10000) 113

2.12 Mifare Plus Card Commands 113

2.12.1 REQA command use ISO14443A REQA command 113
2.12.2 WAKE-UP command use ISO14443A WAKE-UP command 113
2.12.3 int MF_PS_AnticollL1(int DeviceAddress,unsigned char *UID_Part1,unsigned char *BCC1)
113
2.12.4 int MF_PS_SelectL1(int DeviceAddress,unsigned char *UID_Part1,unsigned char BCC1)
113
2.12.5 int MF_PS_AnticollL2(int DeviceAddress,unsigned char *UID_Part2,unsigned char *BCC2)
114
2.12.6 int MF_PS_SelectL2( int DeviceAddress,unsigned char *UID_Part2,unsigned char BCC2)
114
2.12.7 MF_PS_RATSEx(int DeviceAddress,unsigned char CID,unsigned char FSDI,unsigned char
*ATS) 114
2.12.8 MF_FS_PPS(int DeviceAddress,byte CID=0,byte DSI=0,byte DRI=0 ) 114
2.12.9 MF_PS_DESELECTEx(int DeviceAddress,unsigned char CID) 115
2.12.10 MF_PS_WritePerso(int DeviceAddress,unsigned char CID,unsigned short BNr,unsigned char
*Data) 115
2.12.11 MF_PS_CommitPerso(int DeviceAddress,unsigned char CID) 116
2.12.12 MF_PS_SL1AESAuth(int DeviceAddress,unsigned char *AESKey) 116
2.12.13 MF_PS_SL2AESAuth(int DeviceAddress,unsigned short BNr,unsigned char
*AESKey,unsigned char *MFKey,unsigned char *MFSessionKey) 117
2.12.14 MF_PS_FirstAuth(int DeviceAddress,unsigned char CID,unsigned short BNr,unsigned char
*AESKey) 117
2.12.15 MF_PS_FollowAuth(int DeviceAddress,unsigned char CID,bool IsPlusX,unsigned short
BNr,unsigned char *AESKey) 117
2.12.16 MF_PS_SL3ResetAuth(int DeviceAddress,unsigned char CID) 118

CiVinTec Global Co., Limited Version 1.04 / May 6, 2013 / Page 10/11
Tel: +86-755-86117608 Fax: +86-755-86117428 Web: www.civintec.com
 2.12.17 MF_PS_SL3Read(int DeviceAddress,unsigned char CID,bool IsPlusX,unsigned short
BNr,unsigned char BlockNum,bool MACC,bool Plaintext,bool MACR,unsigned char *DataRead,unsigned char
*DataReadLen) 118
2.12.18 MF_PS_SL3Write(int DeviceAddress,unsigned char CID,bool IsPlusX,unsigned short
BNr,bool Plaintext,bool MACR,unsigned char *DataToWrite,unsigned char DataToWriteLen)119
2.12.19 MF_PS_SL3InitValue(int DeviceAddress,unsigned char CID,unsigned short BNr,bool
Plaintext,bool MACR,int Value) 119
2.12.20 MF_PS_SL3ReadValue(int DeviceAddress,unsigned char CID,unsigned short BNr,bool
MACC,bool Plaintext,bool MACR,int *Value) 119
2.12.21 MF_PS_SL3Increment(int DeviceAddress,unsigned char CID,unsigned short BNr,bool
MACR,unsigned long Value) 120
2.12.22 MF_PS_SL3Decrement(int DeviceAddress,unsigned char CID,unsigned short BNr,bool
MACR,unsigned long Value) 120
2.12.23 MF_PS_SL3Transfer(int DeviceAddress,unsigned char CID,unsigned short BNr,bool
MACR) 121
2.12.24 MF_PS_SL3Restore(int DeviceAddress,unsigned char CID,unsigned short BNr,bool MACR)
121
2.12.25 MF_PS_SL3IncAndTrans(int DeviceAddress,unsigned char CID,unsigned short
BNr,unsigned short BNr2,bool MACR,unsigned long Value) 121
2.12.26 MF_PS_SL3DecAndTrans(int DeviceAddress,unsigned char CID,unsigned short
BNr,unsigned short BNr2,bool MACR,unsigned long Value) 122

CiVinTec Global Co., Limited Version 1.04 / May 6, 2013 / Page 11/11
Tel: +86-755-86117608 Fax: +86-755-86117428 Web: www.civintec.com