BALTECH SDK wrapper functions reference
typedefs.h
Go to the documentation of this file.
1 
4 #ifndef __BRP_BALTECH_API_TYPEDEFS_H__
5 #define __BRP_BALTECH_API_TYPEDEFS_H__
6 
7 #include "brp_lib.h"
8 
9 #include <limits.h>
10 #if UINT_MAX < 0xFFFFFFFF
11 #error "baltech_api requires unsigned with a size of >=32bits"
12 #endif
13 
14 #define BRP_BALTECH_API_VERSION "D-40000"
15 
18 typedef enum {
38 typedef struct {
42  bool IsVersion;
46  bool IsDivInfo;
54  bool DenyFormat;
58  bool DenyWrite;
62  bool DenyRead;
67 typedef enum {
81 typedef enum {
493 typedef enum {
513 typedef enum {
531 typedef struct {
539  bool IsPulse;
549 typedef enum {
567 typedef struct {
605  unsigned Size;
610 typedef enum {
632 typedef enum {
650 typedef enum {
668 typedef enum {
690 typedef enum {
708 typedef enum {
730 typedef enum {
748 typedef enum {
766 typedef enum {
784 typedef enum {
802 typedef enum {
820 typedef enum {
834 typedef struct {
838  unsigned AppId;
842  unsigned IsoFileId;
852 #ifdef BALTECH_SDK_INTERNAL
853 
856 typedef enum {
860  brp_EM_DecodeCfg_RxMod_Unknown = 0,
864  brp_EM_DecodeCfg_RxMod_Manchester = 16,
868  brp_EM_DecodeCfg_RxMod_Biphase = 32,
872  brp_EM_DecodeCfg_RxMod_NRZ = 48,
873  brp_EM_DecodeCfg_RxMod_undefined = -1
874 } brp_EM_DecodeCfg_RxMod;
875 #endif // BALTECH_SDK_INTERNAL
876 #ifdef BALTECH_SDK_INTERNAL
877 
880 typedef enum {
884  brp_Eth_GetTcpConnectionStatus_Status_NotConnected = 0,
888  brp_Eth_GetTcpConnectionStatus_Status_ConnectionTrialRunning = 1,
892  brp_Eth_GetTcpConnectionStatus_Status_Connected = 2,
893  brp_Eth_GetTcpConnectionStatus_Status_undefined = -1
894 } brp_Eth_GetTcpConnectionStatus_Status;
895 #endif // BALTECH_SDK_INTERNAL
896 #ifdef BALTECH_SDK_INTERNAL
897 
900 typedef enum {
904  brp_Eth_OpenTcpConnection_ConnectionReason_Powerup = 1,
908  brp_Eth_OpenTcpConnection_ConnectionReason_LinkChange = 2,
912  brp_Eth_OpenTcpConnection_ConnectionReason_SessionkeyTimeout = 4,
916  brp_Eth_OpenTcpConnection_ConnectionReason_Message = 8,
920  brp_Eth_OpenTcpConnection_ConnectionReason_UdpIntrospection = 16,
924  brp_Eth_OpenTcpConnection_ConnectionReason_Reset = 32,
928  brp_Eth_OpenTcpConnection_ConnectionReason_FailedConnectionTrials = 32768,
929  brp_Eth_OpenTcpConnection_ConnectionReason_undefined = -1
930 } brp_Eth_OpenTcpConnection_ConnectionReason;
931 #endif // BALTECH_SDK_INTERNAL
932 
935 typedef enum {
949 typedef enum {
963 typedef struct {
971  size_t NFCID_len;
973 #ifdef BALTECH_SDK_INTERNAL
974 
977 typedef enum {
981  brp_Hitag_Request_TagType_HitagS = 0,
985  brp_Hitag_Request_TagType_Hitag1 = 1,
989  brp_Hitag_Request_TagType_Hitag2Manchester = 2,
993  brp_Hitag_Request_TagType_Hitag2Biphase = 3,
994  brp_Hitag_Request_TagType_undefined = -1
995 } brp_Hitag_Request_TagType;
996 #endif // BALTECH_SDK_INTERNAL
997 #ifdef BALTECH_SDK_INTERNAL
998 
1001 typedef enum {
1005  brp_Hitag_Request_Mode_StdHtg12S = 0,
1009  brp_Hitag_Request_Mode_AdvHtg1S = 1,
1013  brp_Hitag_Request_Mode_FAdvHS = 2,
1014  brp_Hitag_Request_Mode_undefined = -1
1015 } brp_Hitag_Request_Mode;
1016 #endif // BALTECH_SDK_INTERNAL
1017 #ifdef BALTECH_SDK_INTERNAL
1018 
1021 typedef enum {
1025  brp_Hitag_Select_SelMode_Select = 0,
1029  brp_Hitag_Select_SelMode_Quiet = 1,
1033  brp_Hitag_Select_SelMode_AuthPwd = 2,
1037  brp_Hitag_Select_SelMode_H2AuthOnlyPwd = 3,
1038  brp_Hitag_Select_SelMode_undefined = -1
1039 } brp_Hitag_Select_SelMode;
1040 #endif // BALTECH_SDK_INTERNAL
1041 #ifdef BALTECH_SDK_INTERNAL
1042 
1045 typedef enum {
1049  brp_Iso14a_RequestLegacy_UIDSize_SingleSize = 0,
1053  brp_Iso14a_RequestLegacy_UIDSize_DoubleSize = 1,
1057  brp_Iso14a_RequestLegacy_UIDSize_TripleSize = 2,
1058  brp_Iso14a_RequestLegacy_UIDSize_undefined = -1
1059 } brp_Iso14a_RequestLegacy_UIDSize;
1060 #endif // BALTECH_SDK_INTERNAL
1061 
1066 typedef enum {
1108 typedef enum {
1134 typedef enum {
1176 typedef enum {
1194 typedef enum {
1264 typedef enum {
1330 typedef struct {
1344  bool Synced;
1348  bool Send848;
1352  bool Send424;
1356  bool Send212;
1360  bool Recv848;
1364  bool Recv424;
1368  bool Recv212;
1391  unsigned ADC;
1395  bool NAD;
1399  bool CID;
1412 typedef enum {
1430 typedef enum {
1448 typedef enum {
1462 typedef enum {
1478 typedef enum {
1520 typedef enum {
1566 typedef enum {
1632 typedef struct {
1640  unsigned DSFID;
1645 typedef enum {
1660 #ifdef BALTECH_SDK_INTERNAL
1661 
1664 typedef struct {
1670  brp_buf BlockData;
1674  unsigned BlockSecData;
1675 } brp_Iso15_ReadBlock_Data_Entry;
1676 #endif // BALTECH_SDK_INTERNAL
1677 
1680 typedef struct {
1693 typedef struct {
1706 typedef enum {
1728 #ifdef BALTECH_SDK_INTERNAL
1729 
1732 typedef enum {
1736  brp_Main_Bf2Upload_ResultCode_Success = 0,
1740  brp_Main_Bf2Upload_ResultCode_InvalidChecksum = 1,
1744  brp_Main_Bf2Upload_ResultCode_ProgrammingTimeout = 2,
1748  brp_Main_Bf2Upload_ResultCode_VerifyTimeout = 3,
1752  brp_Main_Bf2Upload_ResultCode_UnsupportedCodeType = 4,
1756  brp_Main_Bf2Upload_ResultCode_ProtocolError = 5,
1760  brp_Main_Bf2Upload_ResultCode_SecuredByConfigSecurityCode = 6,
1761  brp_Main_Bf2Upload_ResultCode_undefined = -1
1762 } brp_Main_Bf2Upload_ResultCode;
1763 #endif // BALTECH_SDK_INTERNAL
1764 #ifdef BALTECH_SDK_INTERNAL
1765 
1768 typedef enum {
1772  brp_Mce_Enable_Mode_Disable = 0,
1776  brp_Mce_Enable_Mode_Enable = 1,
1777  brp_Mce_Enable_Mode_undefined = -1
1778 } brp_Mce_Enable_Mode;
1779 #endif // BALTECH_SDK_INTERNAL
1780 
1783 typedef enum {
1797 typedef enum {
1811 typedef enum {
1829 typedef enum {
1847 typedef enum {
1865 typedef enum {
1883 typedef enum {
1913 typedef enum {
1931 typedef struct {
1935  unsigned BlockAddress;
1942  unsigned SectorKeyIdx;
1947 typedef enum {
1961 typedef enum {
1975 typedef struct {
2016  bool WiFi;
2022  bool Tamper;
2034  bool Keyboard;
2046  bool Display;
2058  bool Ethernet;
2070  bool Rf125kHz;
2076  bool Rf13MHz;
2102  bool RTC;
2125 #ifdef BALTECH_SDK_INTERNAL
2126 
2129 typedef struct {
2133  unsigned ID;
2137  unsigned Value;
2138 } brp_Sys_SetRegister_RegisterAssignments_Entry;
2139 #endif // BALTECH_SDK_INTERNAL
2140 
2143 typedef struct {
2147  unsigned ID;
2151  unsigned Value;
2156 typedef enum {
2175 #ifdef BALTECH_SDK_INTERNAL
2176 
2179 typedef enum {
2183  brp_TTF_ReadByteStream_RxMod_Manchester = 16,
2187  brp_TTF_ReadByteStream_RxMod_Biphase = 32,
2191  brp_TTF_ReadByteStream_RxMod_Ind = 48,
2195  brp_TTF_ReadByteStream_RxMod_HIDP = 80,
2199  brp_TTF_ReadByteStream_RxMod_PSK = 96,
2203  brp_TTF_ReadByteStream_RxMod_SMPL = 112,
2204  brp_TTF_ReadByteStream_RxMod_undefined = -1
2205 } brp_TTF_ReadByteStream_RxMod;
2206 #endif // BALTECH_SDK_INTERNAL
2207 
2210 typedef enum {
2232 typedef enum {
2243 #ifdef BALTECH_SDK_INTERNAL
2244 
2247 typedef enum {
2251  brp_UsbHost_SetupPipes_Type_Control = 0,
2255  brp_UsbHost_SetupPipes_Type_Interrupt = 1,
2259  brp_UsbHost_SetupPipes_Type_Bulk = 2,
2263  brp_UsbHost_SetupPipes_Type_Isochronous = 3,
2264  brp_UsbHost_SetupPipes_Type_undefined = -1
2265 } brp_UsbHost_SetupPipes_Type;
2266 #endif // BALTECH_SDK_INTERNAL
2267 #ifdef BALTECH_SDK_INTERNAL
2268 
2271 typedef struct {
2275  unsigned No;
2279  brp_UsbHost_SetupPipes_Type Type;
2283  unsigned FrameSize;
2284 } brp_UsbHost_SetupPipes_Pipes_Entry;
2285 #endif // BALTECH_SDK_INTERNAL
2286 
2289 typedef enum {
2303 typedef enum {
2317 typedef enum {
2331 typedef enum {
2345 typedef enum {
2359 typedef enum {
2373 typedef enum {
2387 typedef enum {
2401 typedef enum {
2417 typedef enum {
2453 typedef enum {
2467 typedef enum {
2481 typedef enum {
2495 typedef enum {
2513 typedef enum {
2527 typedef enum {
2547 typedef struct {
2559  size_t Name_len;
2567  size_t Path_len;
2580 typedef enum {
2594 typedef enum {
2605 #ifdef BALTECH_SDK_INTERNAL
2606 
2609 typedef enum {
2613  brp_DHWCtrl_PortConfig_Mode_OutputLow = 0,
2617  brp_DHWCtrl_PortConfig_Mode_OutputHigh = 1,
2621  brp_DHWCtrl_PortConfig_Mode_InputTristate = 2,
2625  brp_DHWCtrl_PortConfig_Mode_InputPullup = 3,
2626  brp_DHWCtrl_PortConfig_Mode_undefined = -1
2627 } brp_DHWCtrl_PortConfig_Mode;
2628 #endif // BALTECH_SDK_INTERNAL
2629 #ifdef BALTECH_SDK_INTERNAL
2630 
2633 typedef enum {
2637  brp_DHWCtrl_DispColor_Color_White = 0,
2641  brp_DHWCtrl_DispColor_Color_Black = 255,
2642  brp_DHWCtrl_DispColor_Color_undefined = -1
2643 } brp_DHWCtrl_DispColor_Color;
2644 #endif // BALTECH_SDK_INTERNAL
2645 #ifdef BALTECH_SDK_INTERNAL
2646 
2649 typedef enum {
2653  brp_DHWCtrl_GetReaderChipType_ChipType_RC500 = 1,
2657  brp_DHWCtrl_GetReaderChipType_ChipType_RC632 = 4,
2661  brp_DHWCtrl_GetReaderChipType_ChipType_RC663 = 5,
2665  brp_DHWCtrl_GetReaderChipType_ChipType_PN512 = 33,
2666  brp_DHWCtrl_GetReaderChipType_ChipType_undefined = -1
2667 } brp_DHWCtrl_GetReaderChipType_ChipType;
2668 #endif // BALTECH_SDK_INTERNAL
2669 #ifdef BALTECH_SDK_INTERNAL
2670 
2673 typedef enum {
2677  brp_DHWCtrl_GetSamType_ChipType_TDA8007C2 = 1,
2681  brp_DHWCtrl_GetSamType_ChipType_TDA8007C3 = 2,
2682  brp_DHWCtrl_GetSamType_ChipType_undefined = -1
2683 } brp_DHWCtrl_GetSamType_ChipType;
2684 #endif // BALTECH_SDK_INTERNAL
2685 #ifdef BALTECH_SDK_INTERNAL
2686 
2689 typedef enum {
2693  brp_DHWCtrl_HfAcquire_ModuleId_No = 0,
2697  brp_DHWCtrl_HfAcquire_ModuleId_RC = 1,
2701  brp_DHWCtrl_HfAcquire_ModuleId_Legic = 3,
2705  brp_DHWCtrl_HfAcquire_ModuleId_PN = 17,
2709  brp_DHWCtrl_HfAcquire_ModuleId_LegicAdvant = 19,
2713  brp_DHWCtrl_HfAcquire_ModuleId_RC125 = 24,
2717  brp_DHWCtrl_HfAcquire_ModuleId_PN2 = 26,
2721  brp_DHWCtrl_HfAcquire_ModuleId_RC663 = 34,
2725  brp_DHWCtrl_HfAcquire_ModuleId_HTRC110 = 36,
2726  brp_DHWCtrl_HfAcquire_ModuleId_undefined = -1
2727 } brp_DHWCtrl_HfAcquire_ModuleId;
2728 #endif // BALTECH_SDK_INTERNAL
2729 #ifdef BALTECH_SDK_INTERNAL
2730 
2733 typedef enum {
2737  brp_DHWCtrl_AesWrapKey_WrappedKeyNr_WrapNone = 0,
2741  brp_DHWCtrl_AesWrapKey_WrappedKeyNr_WrapDHUK = 1,
2742  brp_DHWCtrl_AesWrapKey_WrappedKeyNr_undefined = -1
2743 } brp_DHWCtrl_AesWrapKey_WrappedKeyNr;
2744 #endif // BALTECH_SDK_INTERNAL
2745 #ifdef BALTECH_SDK_INTERNAL
2746 
2749 typedef enum {
2753  brp_DHWCtrl_AesEncrypt_WrappedKeyNr_WrapNone = 0,
2757  brp_DHWCtrl_AesEncrypt_WrappedKeyNr_WrapDHUK = 1,
2758  brp_DHWCtrl_AesEncrypt_WrappedKeyNr_undefined = -1
2759 } brp_DHWCtrl_AesEncrypt_WrappedKeyNr;
2760 #endif // BALTECH_SDK_INTERNAL
2761 #ifdef BALTECH_SDK_INTERNAL
2762 
2765 typedef enum {
2769  brp_DHWCtrl_AesDecrypt_WrappedKeyNr_WrapNone = 0,
2773  brp_DHWCtrl_AesDecrypt_WrappedKeyNr_WrapDHUK = 1,
2774  brp_DHWCtrl_AesDecrypt_WrappedKeyNr_undefined = -1
2775 } brp_DHWCtrl_AesDecrypt_WrappedKeyNr;
2776 #endif // BALTECH_SDK_INTERNAL
2777 
2780 typedef struct {
2784  bool TTF;
2788  bool Hitag2B;
2792  bool Hitag2M;
2796  bool Hitag1S;
2804  bool HidProx;
2808  bool HidAwid;
2820  bool Keri;
2828  bool Pyramid;
2832  bool EM4450;
2836  bool EM4100;
2840  bool EM4205;
2845 typedef struct {
2849  bool Idteck;
2853  bool Cotag;
2861  bool GProx;
2873 typedef unsigned brp_DesfireKeyIdx;
2877 typedef enum {
2891 } brp_FileType;
2909 typedef struct {
2924 typedef struct {
2935 typedef struct {
2939  bool CRC16bit;
2944 typedef struct {
2948  bool Secure;
2952  bool KeyB;
2957 typedef enum {
2985 typedef enum {
2999 typedef enum {
3009 } brp_Alignment;
3015 typedef struct {
3025  bool BcdToBin;
3033  bool Unpack;
3043  bool BinToBcd;
3051  bool Pack;
3059  bool Reverse;
3064 typedef struct {
3072  unsigned DeviceCode;
3076  unsigned CommandCode;
3087 typedef enum {
3175 } brp_ProtocolID;
3179 typedef enum {
3213 } brp_MessageType;
3217 typedef enum {
3287 typedef struct {
3297  unsigned Version;
3307  unsigned DivIdx;
3312 typedef struct {
3316  unsigned Page;
3320  unsigned Idx;
3325 typedef enum {
3353 typedef enum {
3372 #ifdef BALTECH_SDK_INTERNAL
3373 
3376 typedef unsigned brp_Time;
3377 #endif // BALTECH_SDK_INTERNAL
3378 #ifdef BALTECH_SDK_INTERNAL
3379 
3382 typedef struct {
3386  bool Gpio7;
3390  bool Gpio6;
3394  bool Gpio5;
3398  bool Gpio4;
3402  bool Gpio3;
3406  bool Gpio2;
3410  bool Gpio1;
3414  bool Gpio0;
3418  bool TamperAlarm;
3422  bool BlueLed;
3426  bool Input1;
3430  bool Input0;
3434  bool Relay;
3438  bool Beeper;
3442  bool RedLed;
3446  bool GreenLed;
3447 } brp_IoPortBitmask;
3448 #endif // BALTECH_SDK_INTERNAL
3449 
3452 typedef enum {
3764 } brp_FeatureID;
3768 typedef struct {
3774  bool LeftLed;
3780  bool RightLed;
3787 } brp_LedBitMask;
3791 typedef enum {
3805 } brp_Parity;
3811 typedef enum {
3873 } brp_Baudrate;
3877 typedef enum {
4007 } brp_IoPort;
4011 typedef struct {
4019  unsigned RepeatCnt;
4023  unsigned Param;
4032 typedef enum {
4054 typedef enum {
4248 } brp_CardType;
4252 typedef struct {
4268  bool Srix;
4276  bool Felica;
4282  bool IClass;
4296  bool Iso15693;
4305 typedef struct {
4309  unsigned FileNo;
4325  unsigned ReadKeyNo;
4331  unsigned WriteKeyNo;
4335  unsigned Offset;
4339  unsigned Length;
4347  unsigned ReadKeyIdx;
4356  unsigned WriteKeyIdx;
4372  unsigned ChangeKeyIdx;
4378  unsigned FileSize;
4384  unsigned IsoFid;
4389 typedef enum {
4419 typedef enum {
4448 typedef struct {
4480  bool RtcWrite;
4492  bool VhlWrite;
4496  bool VhlRead;
4536  bool SysReset;
4552  bool SetKey3;
4556  bool SetKey2;
4560  bool SetKey1;
4569 typedef struct {
4590 typedef struct {
4594  unsigned FirmwareID;
4623 typedef struct {
4631  unsigned RgbColor;
4639  unsigned RgbColor2;
4643  unsigned TransitionTime;
4648 typedef struct {
4656  bool Ble;
4679  bool Hid;
4681 #endif
4682 
The reader supports ISO 15693 cards as documented here.
Definition: typedefs.h:3500
Custom Virtual LED (VLED) port.
Definition: typedefs.h:3957
bool VhlWrite
Has to be cleared to deny writing cards via VHL.
Definition: typedefs.h:4492
Refers to a general purpose I/O.
Definition: typedefs.h:3917
unsigned ReadKeyNo
ReadKeyNo , i.e.
Definition: typedefs.h:4325
Keylength: 16 byte.
Definition: typedefs.h:3341
ISO 14443-4 Type A; this card type is capable of transferring application protocol data units (APDU) ...
Definition: typedefs.h:4086
bool Hitag1S
HITAG 1 or S.
Definition: typedefs.h:2796
bool SupportsNotify
Definition: typedefs.h:583
brp_Desfire_WriteData_Mode
Communication settings linked to the file.
Definition: typedefs.h:748
brp_Iso78_OpenSam_LID
Logical SAM-ID (LID)
Definition: typedefs.h:1706
Custom Virtual LED (VLED) port.
Definition: typedefs.h:4005
brp_VHL_Setup_MifareHasMadId
Definition: typedefs.h:2345
The reader supports Keri Systems cards as documented here.
Definition: typedefs.h:3604
Use this value to select an NXP MIFARE SAM AV2 or AV3.
Definition: typedefs.h:1710
References keys which are defined in respective VHL files: AES keys in MifarePlusAesKeyList Mifare ke...
Definition: typedefs.h:2979
brp_CardType
Definition: typedefs.h:4054
SAM AV1 mode (1 encryption round for Tripple DES keys).
Definition: typedefs.h:2218
The reader supports Mobile Card Emulation (MCE).
Definition: typedefs.h:3754
brp_IoPort SwitchIoPort
I/O pins of the reader that can be controlled by the user.
Definition: typedefs.h:4027
bool SupportsWrite
Definition: typedefs.h:587
The reader supports the emulation of ISO14443-4 compatible cards.
Definition: typedefs.h:3710
EM 4100/EM 4102.
Definition: typedefs.h:4146
License bit mask.
Definition: typedefs.h:4648
AES SL1 authentication.
Definition: typedefs.h:1851
bool CorruptFirmware
The reader firmware is corrupted.
Definition: typedefs.h:2118
size_t ApduCommand_len
Length of ApduCommand (in bytes).
Definition: typedefs.h:2575
bool BcdToBin
Converts a BCD Number (must only contain nibbles 0-9, not A-F) to a binary number.
Definition: typedefs.h:3025
For every of these filter bits, a specific data conversion mechanism is specified.
Definition: typedefs.h:3015
Custom Virtual LED (VLED) port.
Definition: typedefs.h:3981
Accept only BEC/BEC2/BF3 files or ConfigCards that are encrypted with a matching customer key...
Definition: typedefs.h:4401
brp_MessageType
Event that triggered the message.
Definition: typedefs.h:3179
More accurate info: The reader supports reading the PCN of HID iCLASS SR cards as documented here...
Definition: typedefs.h:3698
unsigned RgbColor2
This field is only available in case of a pulse signal.
Definition: typedefs.h:4639
bool IncompleteFirmware
Due to an aborted upload, the firmware on the reader is incomplete and not fully functional.
Definition: typedefs.h:2123
File is specified by DF name.
Definition: typedefs.h:2881
iCLASS via ISO 15693
Definition: typedefs.h:4134
The reader supports MIFARE Plus EV0 cards in Security Level 3 using AES authentication as documented ...
Definition: typedefs.h:3544
brp_VHL_Setup_FileSpecifier
The method to select the file.
Definition: typedefs.h:2527
bool AdvantAddressMode
Use Advant address mode.
Definition: typedefs.h:2913
DESFire native mode (default communication mode).
Definition: typedefs.h:824
brp_KeyAccessRights_DiversificationMode DiversificationMode
Definition: typedefs.h:3301
brp_Iso14b_Attrib_EOF_
End Of Frame (EOF) flag for sending data to reader.
Definition: typedefs.h:1448
The reader supports ISO 14443 Type A cards as documented here.
Definition: typedefs.h:3480
bool TTF
Low level card type / programmable decoder.
Definition: typedefs.h:2784
This is a Shortcut for DisablePort GreenLed (requires only one byte intead of 2). ...
Definition: typedefs.h:139
brp_UI_Sense_PortState
Definition: typedefs.h:2303
brp_Iso14b_Request_FWI
Frame Waiting time Integer (FWI).
Definition: typedefs.h:1194
Keylength: 8 byte.
Definition: typedefs.h:3329
Custom Virtual LED (VLED) port.
Definition: typedefs.h:3989
brp_Mif_ChangeValueBackup_Mode
Access mode.
Definition: typedefs.h:1829
bool Khz125Part1
Scans for the following 125kHz cards: EM4205, EM4305, EM4100, EM4102, EM4450, Farpointe Pyramid...
Definition: typedefs.h:4272
unsigned GreatestBlockedFwVersionMajor
Binary that specifies the major number of the greatest non-blocked fw version.
Definition: typedefs.h:4610
bool Iso15693
Scans for ISO-15693-compatible cards, e.g.
Definition: typedefs.h:4296
Refers to a general purpose I/O.
Definition: typedefs.h:3941
unsigned GreatestBlockedFwVersionBuild
Binary that specifies the build number of the greatest non-blocked fw version.
Definition: typedefs.h:4618
unsigned SmallestBlockedFwVersionMajor
Binary that specifies the major number of the smallest blocked fw version.
Definition: typedefs.h:4598
brp_VHL_Setup_Iso15HasBlockSize
Definition: typedefs.h:2513
bool Hitag2M
HITAG 2 Manchester.
Definition: typedefs.h:2792
brp_Mif_AuthUser_AuthMode
Authentication Mode.
Definition: typedefs.h:1797
Custom Virtual LED (VLED) port.
Definition: typedefs.h:3985
brp_Desfire_Authenticate_KeyDivMode
Specifies diversification algorithm.
Definition: typedefs.h:668
The reader has an RGB LED that is fully customizable.
Definition: typedefs.h:3734
The reader supports MIFARE DESFire EV3 cards as documented here.
Definition: typedefs.h:3746
bool SwapNibbles
Swap the higher nibble (bits 5-7) of each byte with the lower nibble (bits 0-3).
Definition: typedefs.h:3047
The reader supports QuadraKey cards as documented here.
Definition: typedefs.h:3612
References keys within the CryptoKey memory.
Definition: typedefs.h:2962
Access rights and key info.
Definition: typedefs.h:38
See description above.
Definition: typedefs.h:4058
The reader supports EM 4205 cards as documented here.
Definition: typedefs.h:3568
unsigned IsoFileId
ISO file ID.
Definition: typedefs.h:842
The reader will boot in Autoread mode and scan for cards, no matter if its configuration contains an ...
Definition: typedefs.h:4434
LBus protocol.
Definition: typedefs.h:3153
brp_DivisorInteger
Divisor Send/Receive Integer (DSI/DRI)
Definition: typedefs.h:3353
Custom Virtual LED (VLED) port.
Definition: typedefs.h:3965
unsigned Version
Key version.
Definition: typedefs.h:3297
bool KeyB
The key assigned to this sector/block shall be applied as key B.
Definition: typedefs.h:2952
brp_buf RecvBlock
Contains the actual data read from a block.
Definition: typedefs.h:1697
brp_ProtocolID
A list of all protocols.
Definition: typedefs.h:3087
unsigned AppId
Application ID - range from 0x00000000 to 0x00FFFFFF.
Definition: typedefs.h:838
Complete the BEC transfer, but don&#39;t reboot.
Definition: typedefs.h:2166
Refers to a general purpose I/O.
Definition: typedefs.h:3925
Custom Virtual LED (VLED) port.
Definition: typedefs.h:3953
ISO-15693-compliant label.
Definition: typedefs.h:4110
The reader supports ST SRIX cards as documented here.
Definition: typedefs.h:3552
The reader supports firmware/configuration upload via BEC2 files.
Definition: typedefs.h:3742
brp_VirtualLedDefinition_Mode Mode
This byte is required to enable additional fields for the characterization of the desired LED behavio...
Definition: typedefs.h:4627
Abstract card type for reading MIFARE DESFire cards using a special VHL implementation for LEGIC read...
Definition: typedefs.h:4246
size_t WriteBlock_len
Length of WriteBlock (in bytes).
Definition: typedefs.h:1688
bool IoPortWrite
Has to be cleared to deny write access to io ports.
Definition: typedefs.h:4516
Resolvable private random address.
Definition: typedefs.h:622
iCLASS via proprietary ISO 14443 Type B protocol derivate (Level 2 compatible)
Definition: typedefs.h:4130
The reader supports EM 4100 cards as documented here.
Definition: typedefs.h:3572
The reader supports OSDP specification version 2.17.
Definition: typedefs.h:3726
Custom Virtual LED (VLED) port.
Definition: typedefs.h:3977
brp_AutoReadMode
Definition: typedefs.h:4419
unsigned SmallestBlockedFwVersionMinor
Binary that specifies the minor number of the smallest blocked fw version.
Definition: typedefs.h:4602
SAM AV1 mode (2 encryption rounds for Tripple DES keys).
Definition: typedefs.h:2222
SAM AV1 mode only for DES keys - two encryption rounds.
Definition: typedefs.h:792
The reader supports EM 4450 cards as documented here.
Definition: typedefs.h:3576
bool CRC16bit
Use 16-bit CRC.
Definition: typedefs.h:2939
Custom Virtual LED (VLED) port.
Definition: typedefs.h:3973
brp_VHL_Setup_LegicAdrMode
Specifies the addressing mode.
Definition: typedefs.h:2417
bool IsPulse
If true , this virtual LED definition describes a pulse signal that continuously fades between 2 RGB ...
Definition: typedefs.h:539
SAM AV1 compatible mode (AES, 3K3DES, 3DES: 2 encryption rounds).
Definition: typedefs.h:680
brp_MobileId_Enable_Mode
Definition: typedefs.h:1961
The reader supports Farpointe Pyramid cards as documented here.
Definition: typedefs.h:3580
bool Synced
If this flag is set, data must be sent and received at equal bit rates.
Definition: typedefs.h:1344
brp_buf WriteBlock
Content that shall be written to blocks starting at BlockId
Definition: typedefs.h:1684
Due to an aborted upload, the firmware on the reader is incomplete and not fully functional.
Definition: typedefs.h:3678
brp_Mif_AuthE2_AuthMode
Authentication Mode.
Definition: typedefs.h:1783
Parity is used.
Definition: typedefs.h:3799
brp_buf PUPI
Pseudo-Unique PICC Identifier (PUPI).
Definition: typedefs.h:1334
BRP protocol over RS-232/UART.
Definition: typedefs.h:3095
brp_MifarePlusKeyMemoryType
This value references a key memory type within the reader.
Definition: typedefs.h:2957
The hardware limits the HF baud rate to 424 kbps.
Definition: typedefs.h:3672
This is a Shortcut for RepeatLoop 1 which is actually a dummy operation, as the repeat block is was a...
Definition: typedefs.h:179
The reader has a red LED.
Definition: typedefs.h:3460
The hardware limits the HF baud rate to 106 kbps.
Definition: typedefs.h:3660
bool Hitag2B
HITAG 2 Biphase.
Definition: typedefs.h:2788
bool FirmwareVersionBlockedLegacy
The loaded firmware version is blacklisted.
Definition: typedefs.h:2040
The reader can read the UID of a PicoPass card.
Definition: typedefs.h:3646
brp_VHL_Setup_HasMifareKey
Definition: typedefs.h:2317
Jumps back to the corresponding StartLoop a specified number of repetitions.
Definition: typedefs.h:93
Fire the corresponding "OnSetXxxx" event if the corresponding input port&#39;s state is set...
Definition: typedefs.h:4044
brp_RunSequenceCmd_CmdCode CmdCode
Definition: typedefs.h:4015
SAM AV1 mode only for DES keys - two encryption rounds).
Definition: typedefs.h:810
The reader supports Mifare Ultralight cards as documented The reader supports Mifare Ultralight cards...
Definition: typedefs.h:3706
Handle Bytes in Least significant bit first order.
Definition: typedefs.h:2989
brp_Desfire_SetFraming_CommMode
Defines 14443-4 communication mode to DESFire card.
Definition: typedefs.h:820
The reader can read the UID of an ISO 14443 Type A card.
Definition: typedefs.h:3486
Enable/disable/toggle the blue LED (if available).
Definition: typedefs.h:3905
bool SupportsWriteNoResponse
Definition: typedefs.h:591
Authenticate with Key B.
Definition: typedefs.h:1791
brp_buf AppData
Application data field.
Definition: typedefs.h:1340
MIFARE Plus L3.
Definition: typedefs.h:4098
bool HWoptions
A hardware options error occurred, device out of order.
Definition: typedefs.h:2096
bool Pack
Merges two Bytes at a time to a single one by removing the leading nibble (which has to be 0) of each...
Definition: typedefs.h:3051
The port is disabled/inactive/low.
Definition: typedefs.h:2311
Do never fire the corresponding event (no matter what the corresponding input port&#39;s state is) ...
Definition: typedefs.h:4036
brp_UI_Toggle_Polarity
Definition: typedefs.h:2289
SAM AV2 mode (AES according NXP: AN 10922).
Definition: typedefs.h:684
bool VariableSize
Definition: typedefs.h:599
bool HidProx32
HID Prox32.
Definition: typedefs.h:2824
brp_buf UID
Unique ID of label.
Definition: typedefs.h:1636
brp_Iso15_SetMode_Mode
Communication mode for label addressing.
Definition: typedefs.h:1645
bool SysReset
Has to be cleared to deny allow reboot/powerdown of system.
Definition: typedefs.h:4536
bool ConfigurationInconsistent
The reader configuration is corrupted.
Definition: typedefs.h:2000
brp_Iso14b_Attrib_SOF
Start Of Frame (SOF) flag for sending data to reader.
Definition: typedefs.h:1462
Increment the value.
Definition: typedefs.h:1819
brp_Iso14L4_SetupAPDU_FSCI
Frame Size proximity Card Integer (FSCI).
Definition: typedefs.h:1520
Definition: typedefs.h:834
Refers to a general purpose I/O.
Definition: typedefs.h:3929
bool Bluetooth
The Bluetooth chip of the reader is defective, device out of order.
Definition: typedefs.h:2010
brp_VHL_Setup_Iso14HasApduTimeout
Definition: typedefs.h:2594
unsigned Value
Value of counter (Baltech internal use)
Definition: typedefs.h:2151
brp_FileType
Filetypes supported by VHL.
Definition: typedefs.h:2877
brp_Iso14b_Request_TimeSlots
Number of time slots which should be used for requesting PICCs.
Definition: typedefs.h:1108
brp_Sys_CfgLoadFinish_FinalizeAction
Defines the reader&#39;s behaviour on error/success.
Definition: typedefs.h:2156
unsigned WriteKeyIdx
Index of the write key on the reader If omitted and WriteKeyNo is equal to ReadKeyNo ...
Definition: typedefs.h:4356
bool Rf13MHzLegacy
The 13.56 MHz RFID interface of the reader is defective, device out of order.
Definition: typedefs.h:2090
The customer key and the Config Security Code have to match for this BEC/BEC2/BF3 file or ConfigCard ...
Definition: typedefs.h:4409
SAM AV1 mode (3DES: 1 encryption round).
Definition: typedefs.h:676
Bluetooth MCE; Mobile Card Emulation over Bluetooth.
Definition: typedefs.h:4226
This byte defines how a Legic segment shall be accessed.
Definition: typedefs.h:2909
Fire the corresponding "OnClearXxxx" event if the corresponding input port&#39;s state is cleared...
Definition: typedefs.h:4040
bool Recv424
When this flag is set, the PICC can receive data with a bit rate of up to 424 kbit/s.
Definition: typedefs.h:1364
brp_Mif_ChangeValue_Mode
Access mode.
Definition: typedefs.h:1811
bool VhlFormat
Has to be cleared to deny formattings cards via VHL.
Definition: typedefs.h:4488
This word defines the CRC address according to the addressing mode selected in SegmentIdentificationA...
Definition: typedefs.h:2935
Select the file by DF name.
Definition: typedefs.h:2531
Decrements a value block by the given value and stores the result in the Transfer Buffer...
Definition: typedefs.h:1891
Key diversification according to NXP AN10922.
Definition: typedefs.h:75
brp_Ultralight_AuthE2_DivMode
Specifies diversification algorithm.
Definition: typedefs.h:2210
brp_buf IsoDfName
ISO DF filename (optional, 0..16 bytes)
Definition: typedefs.h:846
No Parity is used.
Definition: typedefs.h:3795
The reader supports Jewel cards as documented here.
Definition: typedefs.h:3556
bool BatteryManagement
The battery management system of the reader is defective, device out of order.
Definition: typedefs.h:2028
Combined Decrement and Transfer.
Definition: typedefs.h:1903
bool FactorySettings
An error occurred during a factory reset, leaving the reader without any settings instead of restorin...
Definition: typedefs.h:1993
Useful if a lot of operations need to be performed with the same label since the UID is not transferr...
Definition: typedefs.h:1657
unsigned BlockAddress
Block address of the sector that is switched to the targeted security level.
Definition: typedefs.h:1935
Enable/disable/toggle the beeper (if available).
Definition: typedefs.h:3889
The reader has a green LED.
Definition: typedefs.h:3456
unsigned DivIdx
Index for data converter rule: Possible values:
Definition: typedefs.h:3307
bool NewerReaderChipFirmware
The reader chip has not accepted the reader chip firmware included in the latest firmware update...
Definition: typedefs.h:1983
Accept any kind of BEC/BEC2/BF3 files or ConfigCards, even unencrypted ones.
Definition: typedefs.h:4397
size_t NFCID_len
Length of NFCID (in bytes).
Definition: typedefs.h:971
brp_VHL_Setup_Iso15HasFirstBlock
Definition: typedefs.h:2453
brp_Iso14b_Request_FSCI FSCI
Frame Size proximity Card Integer (FSCI).
Definition: typedefs.h:1372
bool ConfigRead
Has to be cleared to deny read access to configuration keys/values.
Definition: typedefs.h:4532
unsigned ADC
Application Data Coding supported by the PICC.
Definition: typedefs.h:1391
brp_Mif_ValueSL3_Cmd
Selects a value operation.
Definition: typedefs.h:1883
brp_Desfire_AuthExtKey_CryptoMode
Sets the encryption algorithm.
Definition: typedefs.h:708
The reader supports 125 kHz cards.
Definition: typedefs.h:3476
If execution of the sequence was aborted, jump to this label and run the following commands until End...
Definition: typedefs.h:115
Custom Virtual LED (VLED) port.
Definition: typedefs.h:3993
BRP protocol over RS485 connection.
Definition: typedefs.h:3099
bool GuiAccess
Has to be cleared to deny access to keypad/lcd.
Definition: typedefs.h:4512
bool ExtendedAccess
Has to be cleared to deny allow access to the extended reader partition.
Definition: typedefs.h:4468
Fire the corresponding event always (no matter what the corresponding input port&#39;s state is) ...
Definition: typedefs.h:4048
brp_buf Parameter
The length of this block depends on the length of the command.
Definition: typedefs.h:3080
bool HidProx
HID Proximity.
Definition: typedefs.h:2804
Definition: typedefs.h:2143
Align to the right.
Definition: typedefs.h:3003
Custom Virtual LED (VLED) port.
Definition: typedefs.h:3997
brp_KeyAccessRights_KeySettings KeySettings
Access rights and key info.
Definition: typedefs.h:3293
The initial and final port state is disabled/inactive/low.
Definition: typedefs.h:2293
This is a autoread protocol that sends the ID read by autoread mode without any protocol overhead...
Definition: typedefs.h:3115
brp_BlePeriph_IsConnected_AddressType
Remote device address type.
Definition: typedefs.h:610
brp_VHL_Setup_LegicHasEnStamp
Definition: typedefs.h:2387
bool WiFi
The WiFi chip of the reader is defective, device out of order.
Definition: typedefs.h:2016
bool Ble
BLE license.
Definition: typedefs.h:4656
Restore/load the value.
Definition: typedefs.h:1823
Mobile ID is enabled.
Definition: typedefs.h:1965
The hardware limits the HF baud rate to 212 kbps.
Definition: typedefs.h:3666
Decrement the value.
Definition: typedefs.h:1815
The customer key and the Config Security Code have to match for this BEC/BEC2/BF3 file or ConfigCard ...
Definition: typedefs.h:4413
Restore/load the value.
Definition: typedefs.h:1841
bool Rf13MHz
The 13.56 MHz RFID interface for ISO 14443/ISO 15693 card systems is defective, device out of order...
Definition: typedefs.h:2076
brp_Desfire_ChangeExtKey_MasterKeyType
These bits must only be set if the card&#39;s Master Key is changed.
Definition: typedefs.h:766
A SAM AV3 card is inserted.
Definition: typedefs.h:3722
brp_Desfire_ChangeKey_NewKeyDivMode
Specifies diversification algorithm.
Definition: typedefs.h:784
unsigned Param
This field represents a time (either in milliseconds or seconds).
Definition: typedefs.h:4023
bool VhlRead
Has to be cleared to deny reading cards via VHL.
Definition: typedefs.h:4496
MIFARE Classic (1k and 4k variants)
Definition: typedefs.h:4062
iCLASS via standard-compliant ISO 14443 Type B protocol (Level 3 compatible)
Definition: typedefs.h:4126
bool Ethernet
The Ethernet interface of the reader is defective, device out of order.
Definition: typedefs.h:2058
unsigned FileSize
**Only needed to run VHL.Format .
Definition: typedefs.h:4378
brp_Felica_GenericCmd_FastBaud
Baudrate PCD-PICC.
Definition: typedefs.h:935
bool BinToBcd
Converts a binary Number to a BCD encoded number.
Definition: typedefs.h:3043
size_t RecvBlock_len
Length of RecvBlock (in bytes).
Definition: typedefs.h:1701
A bitmask containing the physical LEDs you want to switch.
Definition: typedefs.h:3768
bool Keyboard
The keyboard of the reader is defective, device out of order.
Definition: typedefs.h:2034
Custom Virtual LED (VLED) port.
Definition: typedefs.h:4001
Low-level card type/programmable decoder.
Definition: typedefs.h:4198
brp_AutoRunCommand_RunMode
Definition: typedefs.h:18
brp_RunSequenceCmd_CmdCode
Definition: typedefs.h:81
bool RequireContinuousIv
Initialvector of CBC encryption is not reset between commands.
Definition: typedefs.h:4573
bool FlashFileSystemWrite
Has to be cleared to deny write access to flash file system.
Definition: typedefs.h:4472
This bitmask can be combined with a reference to a key index in the readers keylist and specifies mor...
Definition: typedefs.h:2944
HITAG 2 Biphase.
Definition: typedefs.h:4194
bool IClassIso14B
Can be used instead of iCLASS to increase scanning speed.
Definition: typedefs.h:4288
unsigned GreatestBlockedFwVersionMinor
Binary that specifies the minor number of the greatest non-blocked fw version.
Definition: typedefs.h:4614
bool HfLowlevelAccess
Has to be cleared to deny allow to access HF via low level commands.
Definition: typedefs.h:4508
The reader supports SecuraKey cards as documented here.
Definition: typedefs.h:3616
bool IsDivInfo
The value for diversification data can be found in Project/DiversificationData.
Definition: typedefs.h:46
The reader returned a log message.
Definition: typedefs.h:3211
unsigned Page
Project crypto memory page (range 0..0x0F)
Definition: typedefs.h:3316
The reader supports Hitag 2 Manchester cards as documented here.
Definition: typedefs.h:3628
size_t IsoDfName_len
Length of IsoDfName (in bytes).
Definition: typedefs.h:850
bool BinToAscii
Convert Binarydata to ASCII by converting the ASCII characters 0x00-0x09 to 0x30-0x39 and 0x0A-0x0F t...
Definition: typedefs.h:3029
bool AutoreadAccess
Has to be cleared to deny control autoread task.
Definition: typedefs.h:4456
Use this value to select a SAM different from those named above.
Definition: typedefs.h:1718
The firmware can be updated via a serial interface (RS-232/UART or virtual COM port).
Definition: typedefs.h:3682
Infineon my-d proximity (SLE55); this is a legacy value that is no longer returned since firmware ver...
Definition: typedefs.h:4082
The reader supports PKI-encrypted communication with the host.
Definition: typedefs.h:3690
unsigned Size
Specifies the size of the characteristic in bytes.
Definition: typedefs.h:605
This word defines the start address according to the addressing mode selected in SegmentIdentificatio...
Definition: typedefs.h:2924
bool Recv848
When this flag is set, the PICC can receive data with a bit rate of up to 848 kbit/s.
Definition: typedefs.h:1360
The reader supports 13.56 MHz cards.
Definition: typedefs.h:3472
Custom Virtual LED (VLED) port.
Definition: typedefs.h:3969
The port is enabled/active/high.
Definition: typedefs.h:2307
File is specified by 2 byte FID.
Definition: typedefs.h:2885
unsigned Length
Length of byte sequence within the DESFire file to map into the VHL file.
Definition: typedefs.h:4339
MIFARE native mode (default communication mode).
Definition: typedefs.h:1951
bool Unpack
Splits the high and the low nibble of each byte into two separate bytes, where the high nibble is set...
Definition: typedefs.h:3033
brp_buf ApduCommand
APDU command by which to select the file.
Definition: typedefs.h:2571
brp_Iso14b_Attrib_TR0
PICC&#39;s minimum delay before responding after the end of a command sent by PCD.
Definition: typedefs.h:1412
unsigned ChangeKeyIdx
**Only needed to run VHL.Format .
Definition: typedefs.h:4372
An HID SAM card is inserted.
Definition: typedefs.h:3532
Non-resolvable private random address.
Definition: typedefs.h:626
brp_Mif_VirtualCardSelect_FciType
Type of File Control Information returned.
Definition: typedefs.h:1913
bool Recv212
When this flag is set, the PICC can receive data with a bit rate of up to 212 kbit/s.
Definition: typedefs.h:1368
bool SetAccessConditionMask2
Has to be cleared to deny set ac 2.
Definition: typedefs.h:4540
bool SecuraKey
SecuraKey.
Definition: typedefs.h:2865
Retrieve the state of the custom input 1.
Definition: typedefs.h:3901
unsigned CommandCode
Definition: typedefs.h:3076
unsigned RgbColor
This is the color of the VLED port in the RGB color space (0x00RRGGBB).
Definition: typedefs.h:4631
unsigned ID
ID of statistics counter (Baltech internal use)
Definition: typedefs.h:2147
LEGIC advant ISO 15693.
Definition: typedefs.h:4114
bool HidIndalaSecure
Indala ASP+.
Definition: typedefs.h:2857
Keylength: 16 byte.
Definition: typedefs.h:3333
unsigned SectorKeyIdx
Crypto Memory Index (SAM or CryptoMemory) of the sector key.
Definition: typedefs.h:1942
Copies the value block content to the TransferBuffer.
Definition: typedefs.h:1907
Use this value to select an HID SE Processor (also known as iClass SAM).
Definition: typedefs.h:1714
Transfers the content of the Transfer Buffer to the specified address.
Definition: typedefs.h:1895
bool VhlExchangeapdu
Has to be cleared to deny running VHL APDU Exchange.
Definition: typedefs.h:4484
Authenticate with Key B.
Definition: typedefs.h:1805
HITAG 1 or S.
Definition: typedefs.h:4186
A card or a phone with an active Mobile ID app was presented to the reader.
Definition: typedefs.h:3183
HID Indala ASP+.
Definition: typedefs.h:4214
FIPS201 Personal Identity Verification (PIV)
Definition: typedefs.h:4242
The tamper alarm was activated.
Definition: typedefs.h:3187
brp_VHL_Setup_LegicHasAdrMode
Definition: typedefs.h:2401
bool AsciiToBin
Convert ASCII to Binarydata by converting the ASCII characters 0x30-0x39 to 0x00-0x09 and 0x41-0x49 (...
Definition: typedefs.h:3055
The reader can be used as Bluetooth Peripheral.
Definition: typedefs.h:3762
bool FactoryReset
Has to be cleared to deny resetting system to factory settings.
Definition: typedefs.h:4564
bool Bf2Upload
Has to be cleared to deny allow to upload firmware.
Definition: typedefs.h:4464
Custom Virtual LED (VLED) port.
Definition: typedefs.h:3949
brp_Desfire_ReadData_Mode
Communication settings linked to the file.
Definition: typedefs.h:730
bool IClass
Scans for iCLASS and iCLASS SR cards.
Definition: typedefs.h:4282
USB devices will register as keyboard if this value is active.
Definition: typedefs.h:3123
brp_CryptoAlgorithm
This byte defines the crypto algorithm that shall be used when working with the key that is following...
Definition: typedefs.h:3325
This is a second Autoread protocol that sends the ID read by Autoread mode without any protocol overh...
Definition: typedefs.h:3161
The reader supports ISO 14443 Type B cards as documented here.
Definition: typedefs.h:3490
Selects all available protocols.
Definition: typedefs.h:3091
Definition: typedefs.h:1632
unsigned DeviceCode
Definition: typedefs.h:3072
A SAM AV2 card is inserted.
Definition: typedefs.h:3528
The reader supports Hitag 1 and Hitag S cards as documented here.
Definition: typedefs.h:3624
Generic ISO 14443-3 Type A without ISO 7816-4 support.
Definition: typedefs.h:4066
The reader supports AES-encrypted communication with the host.
Definition: typedefs.h:3686
brp_Parity
Specifies the Parity-bit mode which is used for RS-232/UART protocols.
Definition: typedefs.h:3791
brp_VHL_Setup_FileSpecifier FileSpecifier
The method to select the file.
Definition: typedefs.h:2551
To only read the application data of the segment, use this mode.
Definition: typedefs.h:2447
Specifies a minimum of security requirements, when working in this security level.
Definition: typedefs.h:4569
References keys which are stored in reader chip memory: 32 keys (index 0..31) are available...
Definition: typedefs.h:2973
bool UnexpectedRebootsLegacy
At least 1 unexpected reboot has occurred.
Definition: typedefs.h:1989
bool EM4205
EM4205/EM4305.
Definition: typedefs.h:2840
HID Indala ASP.
Definition: typedefs.h:4170
The reader supports ISO 14443-4 cards as documented here.
Definition: typedefs.h:3560
size_t Path_len
Length of Path (in bytes).
Definition: typedefs.h:2567
The reader supports Indala FlexSecur cards as documented here.
Definition: typedefs.h:3608
Parity is used.
Definition: typedefs.h:3803
Select the file using an APDU command.
Definition: typedefs.h:2541
The reader supports FeliCa cards as documented here.
Definition: typedefs.h:3510
The reader can read the UID of an ISO 15693 card.
Definition: typedefs.h:3506
The reader has a SAM slot.
Definition: typedefs.h:3524
brp_Ultralight_AuthUser_CryptoMode
Sets the encryption algorithm.
Definition: typedefs.h:2232
Complete the BEC transfer and do an implicit reboot.
Definition: typedefs.h:2172
brp_Iso14b_Attrib_TR1
Minimum delay between subcarrier modulation start and beginning of data transmission.
Definition: typedefs.h:1430
brp_VHL_Setup_HasDesfireFileDesc
Definition: typedefs.h:2373
Commit will be performed when writing to address 0xFFFF.
Definition: typedefs.h:525
LEGIC advant ISO 14443 Type A.
Definition: typedefs.h:4094
brp_Mif_SetFraming_CommMode
Defines 14443-4 communication mode for MIFARE Plus EV1 cards.
Definition: typedefs.h:1947
Handle Bytes in Most significant bit first order.
Definition: typedefs.h:2993
Same as Enabled ; however, the reader will stop Autoread mode as soon as it has detected (and read) a...
Definition: typedefs.h:4438
bool RTC
The real-time clock is defective, device out of order.
Definition: typedefs.h:2102
bool HostToHostAccess
Has to be cleared to deny access to commands that allow host-to-host communication.
Definition: typedefs.h:4452
The reader will boot in Autoread mode only if its configuration contains at least 1 Autoread RFID int...
Definition: typedefs.h:4442
brp_buf NFCID
ID of label.
Definition: typedefs.h:967
bool SingleLed
Single LED of the reader.
Definition: typedefs.h:3786
bool CryptoAccess
Has to be cleared to deny allow access to the encryption unit.
Definition: typedefs.h:4460
unsigned IsoFid
**Only needed to run VHL.Format .
Definition: typedefs.h:4384
bool Quadrakey
QuadraKey.
Definition: typedefs.h:2816
HID Proximity.
Definition: typedefs.h:4178
brp_Iso14b_Attrib_FSDI
Frame Size proximity coupling Device Integer (FSDI) value.
Definition: typedefs.h:1478
To read the segment stamp , use this mode.
Definition: typedefs.h:2423
bool RtcWrite
Has to be cleared to deny write access to RTC.
Definition: typedefs.h:4480
brp_Iso14b_Request_SFGI
Start-up Frame Guard time Integer (SFGI).
Definition: typedefs.h:1264
brp_VHL_Setup_Iso15HasBlockCount
Definition: typedefs.h:2467
Enable/disable/toggle the green LED (if available).
Definition: typedefs.h:3881
The reader supports Mobile ID as documented here.
Definition: typedefs.h:3750
Combined Increment and Transfer.
Definition: typedefs.h:1899
brp_FeatureID
Definition: typedefs.h:3452
bool ConfCardPresented
You&#39;ve run a VHL.Select command with AcceptConfCard set to true after presenting a ConfigCard to the ...
Definition: typedefs.h:2052
brp_IoPort
I/O pins of the reader that can be controlled by the user.
Definition: typedefs.h:3877
The reader has a blue LED.
Definition: typedefs.h:3636
brp_Felica_Request_FastBaud
Baudrate PCD-PICC.
Definition: typedefs.h:949
Open Supervised Standard Protocol.
Definition: typedefs.h:3165
brp_Iso14b_Request_SFGI SFGI
Start-up Frame Guard time Integer (SFGI).
Definition: typedefs.h:1407
The reader supports MIFARE DESFire EV2 cards as documented here.
Definition: typedefs.h:3714
brp_KeyAccessRights_DiversificationMode
Definition: typedefs.h:67
SAM AV1 mode for all key types / one encryption round for DES keys.
Definition: typedefs.h:806
Enable the port ID stored in the Field Param.
Definition: typedefs.h:85
configures the pins which are usually used by the Wiegand / RawSerial /...
Definition: typedefs.h:3133
HITAG 2 Manchester.
Definition: typedefs.h:4190
bool Hid
Standard Prox license:
Definition: typedefs.h:4679
bool Reverse
Swap the first byte with the last one, the second one with the next to last one and so on...
Definition: typedefs.h:3059
brp_MaxBaudrateIso14443
Definition: typedefs.h:3217
Increments a value block by the given value and stores the result in the Transfer Buffer...
Definition: typedefs.h:1887
Do not run Autoread at all.
Definition: typedefs.h:4423
Enable/disable/toggle the relay (if available).
Definition: typedefs.h:3893
bool HidOnlyForSE
SE Prox license:
Definition: typedefs.h:4671
unsigned brp_DesfireKeyIdx
Definition: typedefs.h:2873
Commit will be performed automatically.
Definition: typedefs.h:521
bool Display
The display of the reader is defective, device out of order.
Definition: typedefs.h:2046
brp_buf Name
The name of the DF to be selected (1..16 bytes)
Definition: typedefs.h:2555
Definition: typedefs.h:1931
Align to the left.
Definition: typedefs.h:3007
Refers to a general purpose I/O.
Definition: typedefs.h:3933
For Ultralight-C authentication, a Tripple DES key has to be specified.
Definition: typedefs.h:2236
Wait exactly the amount of seconds specified in Param before going on.
Definition: typedefs.h:101
bool EM4100
EM4100/EM4102.
Definition: typedefs.h:2836
brp_VHL_Setup_Iso15OptionFlag
Option flag value for read/write operations.
Definition: typedefs.h:2495
Cancel the BEC transfer and undo all configuration changes since Sys.CfgLoadPrepare.
Definition: typedefs.h:2160
The following label commands are sent without an UID (broadcast).
Definition: typedefs.h:1649
This is a ShortCut for RepeatLoop 2.
Definition: typedefs.h:183
ISO 14443-4 Type A compliant with ISO7816-4; this is a legacy value that is no longer returned since ...
Definition: typedefs.h:4070
brp_Desfire_AuthExtKey_SecureMessaging
Sets the secure messaging mode.
Definition: typedefs.h:690
bool ConfigReset
Has to be cleared to deny reset configuration keys/while configuration.
Definition: typedefs.h:4524
The reader supports G-Prox cards as documented here.
Definition: typedefs.h:3620
Retrieve the state of the custom input 0.
Definition: typedefs.h:3897
The reader can read the UID of a FeliCa card.
Definition: typedefs.h:3516
LEGIC advant (ISO 14443 Type A/ISO 15693); this is a legacy value - it has been replaced by LEGICAdva...
Definition: typedefs.h:4106
bool ContainsTransitionTime
If true , this virtual LED definition contains an individual transition time, which is applied to thi...
Definition: typedefs.h:535
Enable/disable/toggle the red LED (if available).
Definition: typedefs.h:3885
bool EnableCRC
CRC check is enabled for this fragment.
Definition: typedefs.h:2928
Fido 2.1.
Definition: typedefs.h:4238
General info: The reader supports reading the PCN of HID iCLASS cards as documented here...
Definition: typedefs.h:3694
bool Send848
When this flag is set, the PICC can send data with a bit rate of up to 848 kbit/s.
Definition: typedefs.h:1348
SAM AV1 mode for all key types / one encryption round for DES keys.
Definition: typedefs.h:788
The user has pressed a certain function key, e.g.
Definition: typedefs.h:3205
unsigned DSFID
DSFID of label, only available, if DSFID bit in Mode has been set.
Definition: typedefs.h:1640
For Ultralight-EV1 password diversification (NXP AN12694), an AES key has to be specified.
Definition: typedefs.h:2240
Use this value only if the reader has 2 SAM slots, and both SAMs are different from those named above...
Definition: typedefs.h:1725
bool Send212
When this flag is set, the PICC can send data with a bit rate of up to 212 kbit/s.
Definition: typedefs.h:1356
Definition: typedefs.h:1680
Chip Card Interface Device (CCID).
Definition: typedefs.h:3157
Abstract card type for reading SIO Elements.
Definition: typedefs.h:4234
Wait exactly the amount of ms specified in the field Param before going on.
Definition: typedefs.h:97
brp_VHL_Setup_Iso15HasOptionFlag
Definition: typedefs.h:2481
LEGIC prime; this is a legacy value - it has been replaced by LEGICPrime.
Definition: typedefs.h:4102
This is a Shortcut for WaitMs 100.
Definition: typedefs.h:239
bool ExtSamAccess
Has to be cleared to deny access to SAM over 7816-3 commands ( Iso78 command group) ...
Definition: typedefs.h:4504
bool IsDivInfoVhl
The value for diversification data can be found in VhlCfg/File/DesfireDiversificationData.
Definition: typedefs.h:50
brp_buf Path
A list of one or more 16-bit file IDs.
Definition: typedefs.h:2563
The customer key and the Config Security Code have to match for this BEC/BEC2/BF3 file or ConfigCard ...
Definition: typedefs.h:4405
Activates only the LEDs on the left side.
Definition: typedefs.h:557
ISO 7816 compatible framing (only MIFARE Plus EV1)
Definition: typedefs.h:1955
bool SupportsRead
Definition: typedefs.h:595
uid_len(1), card type(1) and memory size(1).
Definition: typedefs.h:1925
brp_FireEventAtPowerup
In Autoread mode this values are specifing the states that shall be assumed for input ports before re...
Definition: typedefs.h:4032
Disable the port ID of the Field Param.
Definition: typedefs.h:89
Retrieve the state of the tamper alarm.
Definition: typedefs.h:3909
The reader supports inter-industry ISO 14443-4 cards as documented here.
Definition: typedefs.h:3564
ISO 14443-3 Type B without ISO 7816-4 support.
Definition: typedefs.h:4118
brp_Mif_AuthE2Extended_AuthLevel
Desired authentication level.
Definition: typedefs.h:1847
bool Configuration
The reader configuration is corrupted.
Definition: typedefs.h:2113
bool Secure
The key assigned to this sector shall not be taken from the VHL file.
Definition: typedefs.h:2948
The reader can switch a relay.
Definition: typedefs.h:3468
Definition: typedefs.h:567
brp_Mif_AuthUserExtended_AuthLevel
Desired authentication level.
Definition: typedefs.h:1865
unsigned Idx
Project crypto memory index within page (range 0x80..0xBF)
Definition: typedefs.h:3320
Default settings (Actual behavior is usage-dependent).
Definition: typedefs.h:4393
bool ConfigWrite
Has to be cleared to deny write access to configuration keys/values.
Definition: typedefs.h:4528
bool SetKey3
Has to be cleared to deny set security key 3.
Definition: typedefs.h:4552
Farpointe Pyramid.
Definition: typedefs.h:4154
EM 4205/EM 4305.
Definition: typedefs.h:4142
brp_Alignment
This is the desired data alignment.
Definition: typedefs.h:2999
A previously presented card has been removed.
Definition: typedefs.h:3201
bool SetAccessConditionMask0
Has to be cleared to deny set ac 0.
Definition: typedefs.h:4548
bool SetAccessConditionMask1
Has to be cleared to deny set ac 1.
Definition: typedefs.h:4544
brp_VHL_Setup_Iso14HasFileLen
Definition: typedefs.h:2580
unsigned FileNo
The DESFire file number to access.
Definition: typedefs.h:4309
bool Send424
When this flag is set, the PICC can send data with a bit rate of up to 424 kbit/s.
Definition: typedefs.h:1352
Authenticate with Key A.
Definition: typedefs.h:1787
Authenticate with Key A.
Definition: typedefs.h:1801
unsigned TransitionTime
This field defines the transition time which is applied whenever this virtual LED is enabled...
Definition: typedefs.h:4643
The reader supports Hitag 2 Biphase cards as documented here.
Definition: typedefs.h:3632
Select the file by path, i.e.
Definition: typedefs.h:2537
bool RequireEncrypted
Commands are transferred encrypted.
Definition: typedefs.h:4577
brp_Iso14b_Request_ProtType ProtType
When this bit is set, the PICC supports ISO14443-4.
Definition: typedefs.h:1376
Definition: typedefs.h:1693
BRP protocol over HID (Human Interface Device) Protocol.
Definition: typedefs.h:3103
bool Rf125kHz
The 125 kHz RFID interface of the reader is defective, device out of order.
Definition: typedefs.h:2070
bool ContainsPhysicalLedSelection
If true , this virtual LED definition contains the field PhysicalLedSelection.
Definition: typedefs.h:544
brp_AuthReqUpload
Specifies the authentication level the BEC/BEC2/BF3 file or ConfigCard has to fulfill to be accepted...
Definition: typedefs.h:4389
brp_TemplateBitorder
This is the bit order for the CutNibbles command.
Definition: typedefs.h:2985
The reader has a beeper.
Definition: typedefs.h:3464
brp_VHL_Setup_DesfireHasAppId
Definition: typedefs.h:2359
bool Khz125Part2
Scans for the following 125kHz cards: SecuraKey, G-Prox, Indala ASP+, Cotag, Idteck.
Definition: typedefs.h:4264
Refers to a general purpose I/O.
Definition: typedefs.h:3921
MIFARE Ultralight.
Definition: typedefs.h:4074
unsigned ReadKeyIdx
Index of the read key on the reader.
Definition: typedefs.h:4347
A single include header file, that includes all header files necessary for the BRP library...
bool Iso14443A
Scans for ISO 14443 Type A compatible cards, e.g.
Definition: typedefs.h:4300
bool CID
If this flag is set, the PPIC supports CID.
Definition: typedefs.h:1399
BLE HCI Protocol.
Definition: typedefs.h:3169
brp_Iso14b_Request_FSCI
Frame Size proximity Card Integer (FSCI).
Definition: typedefs.h:1134
bool Rf13MHzLegic
The 13.56 Mhz RFID interface for LEGIC cards is defective, device out of order.
Definition: typedefs.h:2082
bool RightLed
LED(s) on the right side of the reader.
Definition: typedefs.h:3780
brp_Iso14b_Request_ProtType
When this bit is set, the PICC supports ISO14443-4.
Definition: typedefs.h:1176
bool RequireMac
A Cryptographic Signature is attached to every command.
Definition: typedefs.h:4581
This is a ShortCut for EnablePort GreenLed , if GreenLed is enabled otherwise DisablePort GreenLed...
Definition: typedefs.h:159
Refers to a general purpose I/O.
Definition: typedefs.h:3937
bool SupportsIndicate
Definition: typedefs.h:579
The initial and final port state is enabled/active/high.
Definition: typedefs.h:2297
brp_Desfire_ChangeKey_CurKeyDivMode
Specifies diversification algorithm.
Definition: typedefs.h:802
The reader supports MIFARE Plus EV1 cards in Security Level 3 using AES authentication as documented ...
Definition: typedefs.h:3718
This is a ShortCut for EnablePort GreenLed (requires only one byte intead of 2).
Definition: typedefs.h:119
brp_VirtualLedDefinition_PhysicalLedSelection PhysicalLedSelection
This field defines which physical LEDs are to be activated when the corresponding VLED port is enable...
Definition: typedefs.h:4635
SAM AV2 mode (AES according to NXP: AN 10922).
Definition: typedefs.h:2226
The reader supports Cotag cards as documented here.
Definition: typedefs.h:3640
The reader supports HID ioProx tags as documented here.
Definition: typedefs.h:3596
unsigned char * brp_buf
represents a pointer to a protocol data buffer.
Definition: common.h:61
brp_DesfireFileDescription_FileCommunicationSecurity FileCommunicationSecurity
Communication settings that define if data is to be MAC&#39;ed or encrypted before it&#39;s transmitted to th...
Definition: typedefs.h:4313
AES SL3 authentication.
Definition: typedefs.h:1855
bool ExtendedLED
The RGB LED features of the reader are defective.
Definition: typedefs.h:2064
This byte is required to enable additional fields for the characterization of the desired LED behavio...
Definition: typedefs.h:531
The reader supports Bluetooth Low Energy (BLE).
Definition: typedefs.h:3730
bool RequireSessionKey
3-pass authentication and sessionkey generation
Definition: typedefs.h:4585
brp_Baudrate
The Baudrate specifies the performance of an RS-232/UART based interface in bits per second...
Definition: typedefs.h:3811
The reader supports MIFARE DESFire EV1 cards as documented here.
Definition: typedefs.h:3548
File is specified by APDU Select command that has to be executed to activate a file.
Definition: typedefs.h:2889
This is a autoread protocol that sends the ID read by autoread mode via Wiegand protocol.
Definition: typedefs.h:3119
The reader can read the UID of an ISO 14443 Type B card.
Definition: typedefs.h:3496
brp_Iso14a_RequestATS_FSDI
Frame Size proximity coupling Device Integer (FSDI) value.
Definition: typedefs.h:1066
brp_Desfire_ExecCommand_CryptoMode
Type of encryption.
Definition: typedefs.h:632
More accurate info: The reader supports reading the PCN of HID iCLASS SE and Seos cards as documented...
Definition: typedefs.h:3702
bool Dataflash
The data flash chip is defective, device out of order.
Definition: typedefs.h:2108
bool Pyramid
Farpointe Pyramid.
Definition: typedefs.h:2828
The reader supports Indala cards as documented here.
Definition: typedefs.h:3600
The reader supports MIFARE Classic cards and MIFARE Plus cards in Security Level 1 using MIFARE CRYPT...
Definition: typedefs.h:3540
The reader supports HID AWID tags as documented here.
Definition: typedefs.h:3588
bool NAD
If this flag is set, the PPIC supports NAD.
Definition: typedefs.h:1395
The reader supports IDTECK cards as documented here.
Definition: typedefs.h:3650
brp_Iso14b_Request_FWI FWI
Frame Waiting time Integer (FWI).
Definition: typedefs.h:1384
size_t Name_len
Length of Name (in bytes).
Definition: typedefs.h:2559
Refers to a general purpose I/O.
Definition: typedefs.h:3913
Custom Virtual LED (VLED) port.
Definition: typedefs.h:3961
Definition: typedefs.h:2547
bool IoPortRead
Has to be cleared to deny read access to io ports.
Definition: typedefs.h:4520
bool HidIndala
Indala ASP.
Definition: typedefs.h:2812
unsigned RepeatCnt
The number of repetitions of the code block between the matching tLoop this atLoop mand...
Definition: typedefs.h:4019
Definition: typedefs.h:1330
brp_AutoRunCommand_RunMode RunMode
Definition: typedefs.h:3068
Definition: typedefs.h:963
bool SetKey2
Has to be cleared to deny set security key 2.
Definition: typedefs.h:4556
bool FirmwareVersionBlocked
The loaded firmware version is blacklisted.
Definition: typedefs.h:2004
bool LeftLed
LED(s) on the left side of the reader.
Definition: typedefs.h:3774
References keys within a SAM, only available on SAM based readers: key index from 0x00 to 0x7F...
Definition: typedefs.h:2967
MIFARE Plus L2 (2k and 4k variants)
Definition: typedefs.h:4090
The reader supports LEGIC cards as documented here.
Definition: typedefs.h:3520
bool VhlSelect
Has to be cleared to deny detection of cards via VHL.
Definition: typedefs.h:4500
brp_buf CharacteristicUUID
Specifies the UUID (16 or 128 bits) of the BLE characteristic.
Definition: typedefs.h:571
bool FlashFileSystemRead
Has to be cleared to deny read access to flash file system.
Definition: typedefs.h:4476
unsigned FirmwareID
BCD number that specifies a firmware ID.
Definition: typedefs.h:4594
Every Feature in this list can be disabled by not setting the corresponding bit.
Definition: typedefs.h:4448
brp_VHL_Setup_MifareHasAsKeyA
Definition: typedefs.h:2331
bool SetKey1
Has to be cleared to deny set security key 1.
Definition: typedefs.h:4560
The reader supports PicoPass cards as documented here.
Definition: typedefs.h:3536
bool BleLicRequired
BLE license required.
Definition: typedefs.h:4662
brp_Desfire_Authenticate_SecureMessaging
Sets the secure messaging mode.
Definition: typedefs.h:650
Mobile ID is disabled.
Definition: typedefs.h:1969
A PIN was entered via the reader&#39;s keyboard.
Definition: typedefs.h:3195
The tamper alarm was deactivated.
Definition: typedefs.h:3191
brp_DesfireFileDescription_FileCommunicationSecurity
Communication settings that define if data is to be MAC&#39;ed or encrypted before it&#39;s transmitted to th...
Definition: typedefs.h:493
The following label commands are sent including the UID given in UID.
Definition: typedefs.h:1653
unsigned WriteKeyNo
WriteKeyNo , i.e.
Definition: typedefs.h:4331
unsigned SmallestBlockedFwVersionBuild
Binary that specifies the build number of the smallest blocked fw version.
Definition: typedefs.h:4606
Activates only the LEDs on the right side.
Definition: typedefs.h:553
The reader supports HID Prox32 tags as documented here.
Definition: typedefs.h:3584
The debug interface may be used to look into the readers internals via a Terminal.
Definition: typedefs.h:3111
brp_DesfireFileDescription_FileType FileType
Type of file to read.
Definition: typedefs.h:4319
Custom Virtual LED (VLED) port.
Definition: typedefs.h:3945
The reader supports HID Prox tags as documented here.
Definition: typedefs.h:3592
Indicates that the reader is connected to an IF Converter that connects to a server via Ethernet as H...
Definition: typedefs.h:3173
The reader has an RGB LED that is customizable to a limited extend.
Definition: typedefs.h:3738
ISO 14443-4 Type B with ISO 7816-4 support.
Definition: typedefs.h:4122
unsigned Offset
Number of the first byte in the DESFire file to map into the VHL file.
Definition: typedefs.h:4335
brp_VirtualLedDefinition_PhysicalLedSelection
This field defines which physical LEDs are to be activated when the corresponding VLED port is enable...
Definition: typedefs.h:549
bool Tamper
The tamper alarm is defective.
Definition: typedefs.h:2022
MIFARE DESFire (2k, 4k, and 8k variants)
Definition: typedefs.h:4078
size_t CharacteristicUUID_len
Length of CharacteristicUUID (in bytes).
Definition: typedefs.h:575
The reader has a tamper alarm.
Definition: typedefs.h:3654
brp_DesfireFileDescription_FileType
Type of file to read.
Definition: typedefs.h:513
BRP protocol over TCP/IP.
Definition: typedefs.h:3107
unsigned AccessRightsLowByte
**Only needed to run VHL.Format .
Definition: typedefs.h:4362
bool StampSearch
Use Stamp search to identify the desired segment.
Definition: typedefs.h:2917
The reader supports the Bluetooth Host Controller Interface (HCI).
Definition: typedefs.h:3758
brp_Iso14L4_SetupAPDU_FWI
Frame Waiting time Integer (FWI).
Definition: typedefs.h:1566