4 #ifndef __BRP_BALTECH_API_TYPEDEFS_H__ 5 #define __BRP_BALTECH_API_TYPEDEFS_H__ 10 #if UINT_MAX < 0xFFFFFFFF 11 #error "baltech_api requires unsigned with a size of >=32bits" 14 #define BRP_BALTECH_API_VERSION "D-40001" 852 #ifdef BALTECH_SDK_INTERNAL 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 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 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 973 #ifdef BALTECH_SDK_INTERNAL 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 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 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 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 1660 #ifdef BALTECH_SDK_INTERNAL 1674 unsigned BlockSecData;
1675 } brp_Iso15_ReadBlock_Data_Entry;
1676 #endif // BALTECH_SDK_INTERNAL 1728 #ifdef BALTECH_SDK_INTERNAL 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 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 2125 #ifdef BALTECH_SDK_INTERNAL 2138 } brp_Sys_SetRegister_RegisterAssignments_Entry;
2139 #endif // BALTECH_SDK_INTERNAL 2175 #ifdef BALTECH_SDK_INTERNAL 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 2243 #ifdef BALTECH_SDK_INTERNAL 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 2279 brp_UsbHost_SetupPipes_Type Type;
2284 } brp_UsbHost_SetupPipes_Pipes_Entry;
2285 #endif // BALTECH_SDK_INTERNAL 2591 #ifdef BALTECH_SDK_INTERNAL 2599 brp_DHWCtrl_PortConfig_Mode_OutputLow = 0,
2603 brp_DHWCtrl_PortConfig_Mode_OutputHigh = 1,
2607 brp_DHWCtrl_PortConfig_Mode_InputTristate = 2,
2611 brp_DHWCtrl_PortConfig_Mode_InputPullup = 3,
2612 brp_DHWCtrl_PortConfig_Mode_undefined = -1
2613 } brp_DHWCtrl_PortConfig_Mode;
2614 #endif // BALTECH_SDK_INTERNAL 2615 #ifdef BALTECH_SDK_INTERNAL 2623 brp_DHWCtrl_DispColor_Color_White = 0,
2627 brp_DHWCtrl_DispColor_Color_Black = 255,
2628 brp_DHWCtrl_DispColor_Color_undefined = -1
2629 } brp_DHWCtrl_DispColor_Color;
2630 #endif // BALTECH_SDK_INTERNAL 2631 #ifdef BALTECH_SDK_INTERNAL 2639 brp_DHWCtrl_GetReaderChipType_ChipType_RC500 = 1,
2643 brp_DHWCtrl_GetReaderChipType_ChipType_RC632 = 4,
2647 brp_DHWCtrl_GetReaderChipType_ChipType_RC663 = 5,
2651 brp_DHWCtrl_GetReaderChipType_ChipType_PN512 = 33,
2652 brp_DHWCtrl_GetReaderChipType_ChipType_undefined = -1
2653 } brp_DHWCtrl_GetReaderChipType_ChipType;
2654 #endif // BALTECH_SDK_INTERNAL 2655 #ifdef BALTECH_SDK_INTERNAL 2663 brp_DHWCtrl_GetSamType_ChipType_TDA8007C2 = 1,
2667 brp_DHWCtrl_GetSamType_ChipType_TDA8007C3 = 2,
2668 brp_DHWCtrl_GetSamType_ChipType_undefined = -1
2669 } brp_DHWCtrl_GetSamType_ChipType;
2670 #endif // BALTECH_SDK_INTERNAL 2671 #ifdef BALTECH_SDK_INTERNAL 2679 brp_DHWCtrl_HfAcquire_ModuleId_No = 0,
2683 brp_DHWCtrl_HfAcquire_ModuleId_RC = 1,
2687 brp_DHWCtrl_HfAcquire_ModuleId_Legic = 3,
2691 brp_DHWCtrl_HfAcquire_ModuleId_PN = 17,
2695 brp_DHWCtrl_HfAcquire_ModuleId_LegicAdvant = 19,
2699 brp_DHWCtrl_HfAcquire_ModuleId_RC125 = 24,
2703 brp_DHWCtrl_HfAcquire_ModuleId_PN2 = 26,
2707 brp_DHWCtrl_HfAcquire_ModuleId_RC663 = 34,
2711 brp_DHWCtrl_HfAcquire_ModuleId_HTRC110 = 36,
2712 brp_DHWCtrl_HfAcquire_ModuleId_undefined = -1
2713 } brp_DHWCtrl_HfAcquire_ModuleId;
2714 #endif // BALTECH_SDK_INTERNAL 2715 #ifdef BALTECH_SDK_INTERNAL 2723 brp_DHWCtrl_AesWrapKey_WrappedKeyNr_WrapNone = 0,
2727 brp_DHWCtrl_AesWrapKey_WrappedKeyNr_WrapDHUK = 1,
2728 brp_DHWCtrl_AesWrapKey_WrappedKeyNr_undefined = -1
2729 } brp_DHWCtrl_AesWrapKey_WrappedKeyNr;
2730 #endif // BALTECH_SDK_INTERNAL 2731 #ifdef BALTECH_SDK_INTERNAL 2739 brp_DHWCtrl_AesEncrypt_WrappedKeyNr_WrapNone = 0,
2743 brp_DHWCtrl_AesEncrypt_WrappedKeyNr_WrapDHUK = 1,
2744 brp_DHWCtrl_AesEncrypt_WrappedKeyNr_undefined = -1
2745 } brp_DHWCtrl_AesEncrypt_WrappedKeyNr;
2746 #endif // BALTECH_SDK_INTERNAL 2747 #ifdef BALTECH_SDK_INTERNAL 2755 brp_DHWCtrl_AesDecrypt_WrappedKeyNr_WrapNone = 0,
2759 brp_DHWCtrl_AesDecrypt_WrappedKeyNr_WrapDHUK = 1,
2760 brp_DHWCtrl_AesDecrypt_WrappedKeyNr_undefined = -1
2761 } brp_DHWCtrl_AesDecrypt_WrappedKeyNr;
2762 #endif // BALTECH_SDK_INTERNAL 3358 #ifdef BALTECH_SDK_INTERNAL 3362 typedef unsigned brp_Time;
3363 #endif // BALTECH_SDK_INTERNAL 3364 #ifdef BALTECH_SDK_INTERNAL 3433 } brp_IoPortBitmask;
3434 #endif // BALTECH_SDK_INTERNAL The reader supports ISO 15693 cards as documented here.
Custom Virtual LED (VLED) port.
bool VhlWrite
Has to be cleared to deny writing cards via VHL.
Refers to a general purpose I/O.
unsigned ReadKeyNo
ReadKeyNo , i.e.
ISO 14443-4 Type A; this card type is capable of transferring application protocol data units (APDU) ...
bool Hitag1S
HITAG 1 or S.
brp_Desfire_WriteData_Mode
Communication settings linked to the file.
brp_Iso78_OpenSam_LID
Logical SAM-ID (LID)
Custom Virtual LED (VLED) port.
brp_VHL_Setup_MifareHasMadId
The reader supports Keri Systems cards as documented here.
Use this value to select an NXP MIFARE SAM AV2 or AV3.
References keys which are defined in respective VHL files: AES keys in MifarePlusAesKeyList Mifare ke...
SAM AV1 mode (1 encryption round for Tripple DES keys).
The reader supports Mobile Card Emulation (MCE).
brp_IoPort SwitchIoPort
I/O pins of the reader that can be controlled by the user.
The reader supports the emulation of ISO14443-4 compatible cards.
bool CorruptFirmware
The reader firmware is corrupted.
size_t ApduCommand_len
Length of ApduCommand (in bytes).
bool BcdToBin
Converts a BCD Number (must only contain nibbles 0-9, not A-F) to a binary number.
For every of these filter bits, a specific data conversion mechanism is specified.
Custom Virtual LED (VLED) port.
Accept only BEC/BEC2/BF3 files or ConfigCards that are encrypted with a matching customer key...
brp_MessageType
Event that triggered the message.
More accurate info: The reader supports reading the PCN of HID iCLASS SR cards as documented here...
unsigned RgbColor2
This field is only available in case of a pulse signal.
bool IncompleteFirmware
Due to an aborted upload, the firmware on the reader is incomplete and not fully functional.
File is specified by DF name.
The reader supports MIFARE Plus EV0 cards in Security Level 3 using AES authentication as documented ...
brp_VHL_Setup_FileSpecifier
The method to select the file.
bool AdvantAddressMode
Use Advant address mode.
DESFire native mode (default communication mode).
brp_KeyAccessRights_DiversificationMode DiversificationMode
brp_Iso14b_Attrib_EOF_
End Of Frame (EOF) flag for sending data to reader.
The reader supports ISO 14443 Type A cards as documented here.
bool TTF
Low level card type / programmable decoder.
This is a Shortcut for DisablePort GreenLed (requires only one byte intead of 2). ...
brp_Iso14b_Request_FWI
Frame Waiting time Integer (FWI).
Custom Virtual LED (VLED) port.
brp_Mif_ChangeValueBackup_Mode
Access mode.
bool Khz125Part1
Scans for the following 125kHz cards: EM4205, EM4305, EM4100, EM4102, EM4450, Farpointe Pyramid...
unsigned GreatestBlockedFwVersionMajor
Binary that specifies the major number of the greatest non-blocked fw version.
bool Iso15693
Scans for ISO-15693-compatible cards, e.g.
Refers to a general purpose I/O.
unsigned GreatestBlockedFwVersionBuild
Binary that specifies the build number of the greatest non-blocked fw version.
unsigned SmallestBlockedFwVersionMajor
Binary that specifies the major number of the smallest blocked fw version.
brp_VHL_Setup_Iso15HasBlockSize
bool Hitag2M
HITAG 2 Manchester.
brp_Mif_AuthUser_AuthMode
Authentication Mode.
Custom Virtual LED (VLED) port.
brp_Desfire_Authenticate_KeyDivMode
Specifies diversification algorithm.
The reader has an RGB LED that is fully customizable.
The reader supports MIFARE DESFire EV3 cards as documented here.
bool SwapNibbles
Swap the higher nibble (bits 5-7) of each byte with the lower nibble (bits 0-3).
The reader supports QuadraKey cards as documented here.
References keys within the CryptoKey memory.
Access rights and key info.
The reader supports EM 4205 cards as documented here.
unsigned IsoFileId
ISO file ID.
The reader will boot in Autoread mode and scan for cards, no matter if its configuration contains an ...
brp_DivisorInteger
Divisor Send/Receive Integer (DSI/DRI)
Custom Virtual LED (VLED) port.
unsigned Version
Key version.
bool KeyB
The key assigned to this sector/block shall be applied as key B.
brp_buf RecvBlock
Contains the actual data read from a block.
brp_ProtocolID
A list of all protocols.
unsigned AppId
Application ID - range from 0x00000000 to 0x00FFFFFF.
Complete the BEC transfer, but don't reboot.
Refers to a general purpose I/O.
Custom Virtual LED (VLED) port.
ISO-15693-compliant label.
The reader supports ST SRIX cards as documented here.
The reader supports firmware/configuration upload via BEC2 files.
brp_VirtualLedDefinition_Mode Mode
This byte is required to enable additional fields for the characterization of the desired LED behavio...
uid_len(1) and card type(1).
Abstract card type for reading MIFARE DESFire cards using a special VHL implementation for LEGIC read...
size_t WriteBlock_len
Length of WriteBlock (in bytes).
bool IoPortWrite
Has to be cleared to deny write access to io ports.
Resolvable private random address.
iCLASS via proprietary ISO 14443 Type B protocol derivate (Level 2 compatible)
The reader supports EM 4100 cards as documented here.
The reader supports OSDP specification version 2.17.
Custom Virtual LED (VLED) port.
unsigned SmallestBlockedFwVersionMinor
Binary that specifies the minor number of the smallest blocked fw version.
SAM AV1 mode (2 encryption rounds for Tripple DES keys).
SAM AV1 mode only for DES keys - two encryption rounds.
The reader supports EM 4450 cards as documented here.
bool CRC16bit
Use 16-bit CRC.
Custom Virtual LED (VLED) port.
brp_VHL_Setup_LegicAdrMode
Specifies the addressing mode.
bool IsPulse
If true , this virtual LED definition describes a pulse signal that continuously fades between 2 RGB ...
SAM AV1 compatible mode (AES, 3K3DES, 3DES: 2 encryption rounds).
The reader supports Farpointe Pyramid cards as documented here.
bool Synced
If this flag is set, data must be sent and received at equal bit rates.
brp_buf WriteBlock
Content that shall be written to blocks starting at BlockId
Due to an aborted upload, the firmware on the reader is incomplete and not fully functional.
brp_Mif_AuthE2_AuthMode
Authentication Mode.
brp_buf PUPI
Pseudo-Unique PICC Identifier (PUPI).
BRP protocol over RS-232/UART.
brp_MifarePlusKeyMemoryType
This value references a key memory type within the reader.
The hardware limits the HF baud rate to 424 kbps.
This is a Shortcut for RepeatLoop 1 which is actually a dummy operation, as the repeat block is was a...
The reader has a red LED.
The hardware limits the HF baud rate to 106 kbps.
bool Hitag2B
HITAG 2 Biphase.
bool FirmwareVersionBlockedLegacy
The loaded firmware version is blacklisted.
The reader can read the UID of a PicoPass card.
brp_VHL_Setup_HasMifareKey
Jumps back to the corresponding StartLoop a specified number of repetitions.
Fire the corresponding "OnSetXxxx" event if the corresponding input port's state is set...
brp_RunSequenceCmd_CmdCode CmdCode
SAM AV1 mode only for DES keys - two encryption rounds).
The reader supports Mifare Ultralight cards as documented The reader supports Mifare Ultralight cards...
Handle Bytes in Least significant bit first order.
brp_Desfire_SetFraming_CommMode
Defines 14443-4 communication mode to DESFire card.
The reader can read the UID of an ISO 14443 Type A card.
Enable/disable/toggle the blue LED (if available).
bool SupportsWriteNoResponse
brp_buf AppData
Application data field.
ISO 7816 compatible framing.
bool HWoptions
A hardware options error occurred, device out of order.
bool Pack
Merges two Bytes at a time to a single one by removing the leading nibble (which has to be 0) of each...
Do never fire the corresponding event (no matter what the corresponding input port's state is) ...
SAM AV2 mode (AES according NXP: AN 10922).
bool HidProx32
HID Prox32.
brp_buf UID
Unique ID of label.
brp_Iso15_SetMode_Mode
Communication mode for label addressing.
bool SysReset
Has to be cleared to deny allow reboot/powerdown of system.
bool ConfigurationInconsistent
The reader configuration is corrupted.
brp_Iso14b_Attrib_SOF
Start Of Frame (SOF) flag for sending data to reader.
brp_Iso14L4_SetupAPDU_FSCI
Frame Size proximity Card Integer (FSCI).
Refers to a general purpose I/O.
bool Bluetooth
The Bluetooth chip of the reader is defective, device out of order.
brp_VHL_Setup_Iso14HasApduTimeout
unsigned Value
Value of counter (Baltech internal use)
brp_FileType
Filetypes supported by VHL.
brp_Iso14b_Request_TimeSlots
Number of time slots which should be used for requesting PICCs.
brp_Sys_CfgLoadFinish_FinalizeAction
Defines the reader's behaviour on error/success.
unsigned WriteKeyIdx
Index of the write key on the reader If omitted and WriteKeyNo is equal to ReadKeyNo ...
bool Rf13MHzLegacy
The 13.56 MHz RFID interface of the reader is defective, device out of order.
The customer key and the Config Security Code have to match for this BEC/BEC2/BF3 file or ConfigCard ...
SAM AV1 mode (3DES: 1 encryption round).
Bluetooth MCE; Mobile Card Emulation over Bluetooth.
This byte defines how a Legic segment shall be accessed.
Fire the corresponding "OnClearXxxx" event if the corresponding input port's state is cleared...
bool Recv424
When this flag is set, the PICC can receive data with a bit rate of up to 424 kbit/s.
brp_Mif_ChangeValue_Mode
Access mode.
bool VhlFormat
Has to be cleared to deny formattings cards via VHL.
This word defines the CRC address according to the addressing mode selected in SegmentIdentificationA...
Select the file by DF name.
Decrements a value block by the given value and stores the result in the Transfer Buffer...
Key diversification according to NXP AN10922.
brp_Ultralight_AuthE2_DivMode
Specifies diversification algorithm.
brp_buf IsoDfName
ISO DF filename (optional, 0..16 bytes)
The reader supports Jewel cards as documented here.
bool BatteryManagement
The battery management system of the reader is defective, device out of order.
Combined Decrement and Transfer.
bool FactorySettings
An error occurred during a factory reset, leaving the reader without any settings instead of restorin...
Useful if a lot of operations need to be performed with the same label since the UID is not transferr...
unsigned BlockAddress
Block address of the sector that is switched to the targeted security level.
Enable/disable/toggle the beeper (if available).
The reader has a green LED.
unsigned DivIdx
Index for data converter rule: Possible values:
bool NewerReaderChipFirmware
The reader chip has not accepted the reader chip firmware included in the latest firmware update...
Accept any kind of BEC/BEC2/BF3 files or ConfigCards, even unencrypted ones.
size_t NFCID_len
Length of NFCID (in bytes).
brp_VHL_Setup_Iso15HasFirstBlock
brp_Iso14b_Request_FSCI FSCI
Frame Size proximity Card Integer (FSCI).
bool ConfigRead
Has to be cleared to deny read access to configuration keys/values.
unsigned ADC
Application Data Coding supported by the PICC.
brp_Mif_ValueSL3_Cmd
Selects a value operation.
brp_Desfire_AuthExtKey_CryptoMode
Sets the encryption algorithm.
The reader supports 125 kHz cards.
If execution of the sequence was aborted, jump to this label and run the following commands until End...
Custom Virtual LED (VLED) port.
BRP protocol over RS485 connection.
bool GuiAccess
Has to be cleared to deny access to keypad/lcd.
bool ExtendedAccess
Has to be cleared to deny allow access to the extended reader partition.
Fire the corresponding event always (no matter what the corresponding input port's state is) ...
bool HidProx
HID Proximity.
Custom Virtual LED (VLED) port.
brp_KeyAccessRights_KeySettings KeySettings
Access rights and key info.
The initial and final port state is disabled/inactive/low.
This is a autoread protocol that sends the ID read by autoread mode without any protocol overhead...
brp_BlePeriph_IsConnected_AddressType
Remote device address type.
brp_VHL_Setup_LegicHasEnStamp
bool WiFi
The WiFi chip of the reader is defective, device out of order.
The hardware limits the HF baud rate to 212 kbps.
The customer key and the Config Security Code have to match for this BEC/BEC2/BF3 file or ConfigCard ...
bool Rf13MHz
The 13.56 MHz RFID interface for ISO 14443/ISO 15693 card systems is defective, device out of order...
brp_Desfire_ChangeExtKey_MasterKeyType
These bits must only be set if the card's Master Key is changed.
A SAM AV3 card is inserted.
brp_Desfire_ChangeKey_NewKeyDivMode
Specifies diversification algorithm.
unsigned Param
This field represents a time (either in milliseconds or seconds).
bool VhlRead
Has to be cleared to deny reading cards via VHL.
MIFARE Classic (1k and 4k variants)
iCLASS via standard-compliant ISO 14443 Type B protocol (Level 3 compatible)
bool Ethernet
The Ethernet interface of the reader is defective, device out of order.
unsigned FileSize
**Only needed to runVHL.Format .
brp_Felica_GenericCmd_FastBaud
Baudrate PCD-PICC.
bool BinToBcd
Converts a binary Number to a BCD encoded number.
size_t RecvBlock_len
Length of RecvBlock (in bytes).
A bitmask containing the physical LEDs you want to switch.
bool Keyboard
The keyboard of the reader is defective, device out of order.
Custom Virtual LED (VLED) port.
Low-level card type/programmable decoder.
brp_AutoRunCommand_RunMode
brp_RunSequenceCmd_CmdCode
bool RequireContinuousIv
Initialvector of CBC encryption is not reset between commands.
bool FlashFileSystemWrite
Has to be cleared to deny write access to flash file system.
This bitmask can be combined with a reference to a key index in the readers keylist and specifies mor...
bool IClassIso14B
Can be used instead of iCLASS to increase scanning speed.
unsigned GreatestBlockedFwVersionMinor
Binary that specifies the minor number of the greatest non-blocked fw version.
bool HfLowlevelAccess
Has to be cleared to deny allow to access HF via low level commands.
The reader supports SecuraKey cards as documented here.
bool IsDivInfo
The value for diversification data can be found in Project/DiversificationData.
The reader returned a log message.
unsigned Page
Project crypto memory page (range 0..0x0F)
The reader supports Hitag 2 Manchester cards as documented here.
size_t IsoDfName_len
Length of IsoDfName (in bytes).
bool BinToAscii
Convert Binarydata to ASCII by converting the ASCII characters 0x00-0x09 to 0x30-0x39 and 0x0A-0x0F t...
bool AutoreadAccess
Has to be cleared to deny control autoread task.
Use this value to select a SAM different from those named above.
The firmware can be updated via a serial interface (RS-232/UART or virtual COM port).
Infineon my-d proximity (SLE55); this is a legacy value that is no longer returned since firmware ver...
The reader supports PKI-encrypted communication with the host.
unsigned Size
Specifies the size of the characteristic in bytes.
This word defines the start address according to the addressing mode selected in SegmentIdentificatio...
bool Recv848
When this flag is set, the PICC can receive data with a bit rate of up to 848 kbit/s.
The reader supports 13.56 MHz cards.
Custom Virtual LED (VLED) port.
File is specified by 2 byte FID.
unsigned Length
Length of byte sequence within the DESFire file to map into the VHL file.
MIFARE native mode (default communication mode).
bool Unpack
Splits the high and the low nibble of each byte into two separate bytes, where the high nibble is set...
brp_buf ApduCommand
APDU command by which to select the file.
brp_Iso14b_Attrib_TR0
PICC's minimum delay before responding after the end of a command sent by PCD.
unsigned ChangeKeyIdx
**Only needed to runVHL.Format .
An HID SAM card is inserted.
Non-resolvable private random address.
brp_Mif_VirtualCardSelect_FciType
Type of File Control Information returned.
bool Recv212
When this flag is set, the PICC can receive data with a bit rate of up to 212 kbit/s.
bool SetAccessConditionMask2
Has to be cleared to deny set ac 2.
Retrieve the state of the custom input 1.
unsigned RgbColor
This is the color of the VLED port in the RGB color space (0x00RRGGBB).
unsigned ID
ID of statistics counter (Baltech internal use)
bool HidIndalaSecure
Indala ASP+.
unsigned SectorKeyIdx
Crypto Memory Index (SAM or CryptoMemory) of the sector key.
Copies the value block content to the TransferBuffer.
Use this value to select an HID SE Processor (also known as iClass SAM).
Transfers the content of the Transfer Buffer to the specified address.
bool VhlExchangeapdu
Has to be cleared to deny running VHL APDU Exchange.
A card or a phone with an active Mobile ID app was presented to the reader.
FIPS201 Personal Identity Verification (PIV)
The tamper alarm was activated.
brp_VHL_Setup_LegicHasAdrMode
bool AsciiToBin
Convert ASCII to Binarydata by converting the ASCII characters 0x30-0x39 to 0x00-0x09 and 0x41-0x49 (...
The reader can be used as Bluetooth Peripheral.
bool FactoryReset
Has to be cleared to deny resetting system to factory settings.
bool Bf2Upload
Has to be cleared to deny allow to upload firmware.
Custom Virtual LED (VLED) port.
brp_Desfire_ReadData_Mode
Communication settings linked to the file.
bool IClass
Scans for iCLASS and iCLASS SR cards.
USB devices will register as keyboard if this value is active.
brp_CryptoAlgorithm
This byte defines the crypto algorithm that shall be used when working with the key that is following...
This is a second Autoread protocol that sends the ID read by Autoread mode without any protocol overh...
The reader supports ISO 14443 Type B cards as documented here.
Selects all available protocols.
A SAM AV2 card is inserted.
The reader supports Hitag 1 and Hitag S cards as documented here.
Generic ISO 14443-3 Type A without ISO 7816-4 support.
The reader supports AES-encrypted communication with the host.
brp_Parity
Specifies the Parity-bit mode which is used for RS-232/UART protocols.
brp_VHL_Setup_FileSpecifier FileSpecifier
The method to select the file.
To only read the application data of the segment, use this mode.
Specifies a minimum of security requirements, when working in this security level.
References keys which are stored in reader chip memory: 32 keys (index 0..31) are available...
bool UnexpectedRebootsLegacy
At least 1 unexpected reboot has occurred.
bool EM4205
EM4205/EM4305.
The reader supports ISO 14443-4 cards as documented here.
size_t Path_len
Length of Path (in bytes).
The reader supports Indala FlexSecur cards as documented here.
Select the file using an APDU command.
The reader supports FeliCa cards as documented here.
The reader can read the UID of an ISO 15693 card.
The reader has a SAM slot.
brp_Ultralight_AuthUser_CryptoMode
Sets the encryption algorithm.
Complete the BEC transfer and do an implicit reboot.
brp_Iso14b_Attrib_TR1
Minimum delay between subcarrier modulation start and beginning of data transmission.
brp_VHL_Setup_HasDesfireFileDesc
Commit will be performed when writing to address 0xFFFF.
LEGIC advant ISO 14443 Type A.
brp_Mif_SetFraming_CommMode
Defines 14443-4 communication mode for MIFARE Plus EV1 cards.
Handle Bytes in Most significant bit first order.
Same as Enabled ; however, the reader will stop Autoread mode as soon as it has detected (and read) a...
bool RTC
The real-time clock is defective, device out of order.
bool HostToHostAccess
Has to be cleared to deny access to commands that allow host-to-host communication.
The reader will boot in Autoread mode only if its configuration contains at least 1 Autoread RFID int...
brp_buf NFCID
ID of label.
bool SingleLed
Single LED of the reader.
bool CryptoAccess
Has to be cleared to deny allow access to the encryption unit.
unsigned IsoFid
**Only needed to runVHL.Format .
brp_Iso14b_Attrib_FSDI
Frame Size proximity coupling Device Integer (FSDI) value.
To read the segment stamp , use this mode.
bool RtcWrite
Has to be cleared to deny write access to RTC.
brp_Iso14b_Request_SFGI
Start-up Frame Guard time Integer (SFGI).
brp_VHL_Setup_Iso15HasBlockCount
Enable/disable/toggle the green LED (if available).
The reader supports Mobile ID as documented here.
Combined Increment and Transfer.
bool ConfCardPresented
You've run a VHL.Select command with AcceptConfCard set to true after presenting a ConfigCard to the ...
brp_IoPort
I/O pins of the reader that can be controlled by the user.
The reader has a blue LED.
brp_Felica_Request_FastBaud
Baudrate PCD-PICC.
Open Supervised Standard Protocol.
brp_Iso14b_Request_SFGI SFGI
Start-up Frame Guard time Integer (SFGI).
The reader supports MIFARE DESFire EV2 cards as documented here.
brp_KeyAccessRights_DiversificationMode
SAM AV1 mode for all key types / one encryption round for DES keys.
Enable the port ID stored in the Field Param.
configures the pins which are usually used by the Wiegand / RawSerial /...
bool Hid
Standard Prox license:
bool Reverse
Swap the first byte with the last one, the second one with the next to last one and so on...
Increments a value block by the given value and stores the result in the Transfer Buffer...
Do not run Autoread at all.
Enable/disable/toggle the relay (if available).
bool HidOnlyForSE
SE Prox license:
unsigned brp_DesfireKeyIdx
Commit will be performed automatically.
bool Display
The display of the reader is defective, device out of order.
brp_buf Name
The name of the DF to be selected (1..16 bytes)
Refers to a general purpose I/O.
For Ultralight-C authentication, a Tripple DES key has to be specified.
Wait exactly the amount of seconds specified in Param before going on.
bool EM4100
EM4100/EM4102.
brp_VHL_Setup_Iso15OptionFlag
Option flag value for read/write operations.
Cancel the BEC transfer and undo all configuration changes since brp_Sys_CfgLoadPrepare().
The following label commands are sent without an UID (broadcast).
This is a ShortCut for RepeatLoop 2.
ISO 14443-4 Type A compliant with ISO7816-4; this is a legacy value that is no longer returned since ...
brp_Desfire_AuthExtKey_SecureMessaging
Sets the secure messaging mode.
bool ConfigReset
Has to be cleared to deny reset configuration keys/while configuration.
The reader supports G-Prox cards as documented here.
Retrieve the state of the custom input 0.
The reader can read the UID of a FeliCa card.
LEGIC advant (ISO 14443 Type A/ISO 15693); this is a legacy value - it has been replaced by LEGICAdva...
bool ContainsTransitionTime
If true , this virtual LED definition contains an individual transition time, which is applied to thi...
Enable/disable/toggle the red LED (if available).
bool EnableCRC
CRC check is enabled for this fragment.
General info: The reader supports reading the PCN of HID iCLASS cards as documented here...
bool Send848
When this flag is set, the PICC can send data with a bit rate of up to 848 kbit/s.
SAM AV1 mode for all key types / one encryption round for DES keys.
The user has pressed a certain function key, e.g.
unsigned DSFID
DSFID of label, only available, if DSFID bit in Mode has been set.
For Ultralight-EV1 password diversification (NXP AN12694), an AES key has to be specified.
Use this value only if the reader has 2 SAM slots, and both SAMs are different from those named above...
bool Send212
When this flag is set, the PICC can send data with a bit rate of up to 212 kbit/s.
Chip Card Interface Device (CCID).
Abstract card type for reading SIO Elements.
Wait exactly the amount of ms specified in the field Param before going on.
brp_VHL_Setup_Iso15HasOptionFlag
LEGIC prime; this is a legacy value - it has been replaced by LEGICPrime.
This is a Shortcut for WaitMs 100.
bool ExtSamAccess
Has to be cleared to deny access to SAM over 7816-3 commands ( Iso78 command group) ...
bool IsDivInfoVhl
The value for diversification data can be found in VhlCfg/File/DesfireDiversificationData.
brp_buf Path
A list of one or more 16-bit file IDs.
The customer key and the Config Security Code have to match for this BEC/BEC2/BF3 file or ConfigCard ...
Activates only the LEDs on the left side.
ISO 7816 compatible framing (only MIFARE Plus EV1)
uid_len(1), card type(1) and memory size(1).
brp_FireEventAtPowerup
In Autoread mode this values are specifing the states that shall be assumed for input ports before re...
Disable the port ID of the Field Param.
Retrieve the state of the tamper alarm.
The reader supports inter-industry ISO 14443-4 cards as documented here.
ISO 14443-3 Type B without ISO 7816-4 support.
brp_Mif_AuthE2Extended_AuthLevel
Desired authentication level.
bool Configuration
The reader configuration is corrupted.
bool Secure
The key assigned to this sector shall not be taken from the VHL file.
The reader can switch a relay.
brp_Mif_AuthUserExtended_AuthLevel
Desired authentication level.
unsigned Idx
Project crypto memory index within page (range 0x80..0xBF)
Default settings (Actual behavior is usage-dependent).
bool ConfigWrite
Has to be cleared to deny write access to configuration keys/values.
bool SetKey3
Has to be cleared to deny set security key 3.
brp_Alignment
This is the desired data alignment.
A previously presented card has been removed.
bool SetAccessConditionMask0
Has to be cleared to deny set ac 0.
bool SetAccessConditionMask1
Has to be cleared to deny set ac 1.
brp_VHL_Setup_Iso14HasFileLen
unsigned FileNo
The DESFire file number to access.
bool Send424
When this flag is set, the PICC can send data with a bit rate of up to 424 kbit/s.
unsigned TransitionTime
This field defines the transition time which is applied whenever this virtual LED is enabled...
The reader supports Hitag 2 Biphase cards as documented here.
Select the file by path, i.e.
bool RequireEncrypted
Commands are transferred encrypted.
brp_Iso14b_Request_ProtType ProtType
When this bit is set, the PICC supports ISO14443-4.
BRP protocol over HID (Human Interface Device) Protocol.
bool Rf125kHz
The 125 kHz RFID interface of the reader is defective, device out of order.
bool ContainsPhysicalLedSelection
If true , this virtual LED definition contains the field PhysicalLedSelection.
brp_AuthReqUpload
Specifies the authentication level the BEC/BEC2/BF3 file or ConfigCard has to fulfill to be accepted...
brp_TemplateBitorder
This is the bit order for the CutNibbles command.
brp_VHL_Setup_DesfireHasAppId
bool Khz125Part2
Scans for the following 125kHz cards: SecuraKey, G-Prox, Indala ASP+, Cotag, Idteck.
Refers to a general purpose I/O.
unsigned ReadKeyIdx
Index of the read key on the reader.
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.
bool CID
If this flag is set, the PPIC supports CID.
brp_Iso14b_Request_FSCI
Frame Size proximity Card Integer (FSCI).
bool Rf13MHzLegic
The 13.56 Mhz RFID interface for LEGIC cards is defective, device out of order.
bool RightLed
LED(s) on the right side of the reader.
brp_Iso14b_Request_ProtType
When this bit is set, the PICC supports ISO14443-4.
bool RequireMac
A Cryptographic Signature is attached to every command.
This is a ShortCut for EnablePort GreenLed , if GreenLed is enabled otherwise DisablePort GreenLed...
Refers to a general purpose I/O.
The initial and final port state is enabled/active/high.
brp_Desfire_ChangeKey_CurKeyDivMode
Specifies diversification algorithm.
The reader supports MIFARE Plus EV1 cards in Security Level 3 using AES authentication as documented ...
This is a ShortCut for EnablePort GreenLed (requires only one byte intead of 2).
brp_VirtualLedDefinition_PhysicalLedSelection PhysicalLedSelection
This field defines which physical LEDs are to be activated when the corresponding VLED port is enable...
SAM AV2 mode (AES according to NXP: AN 10922).
The reader supports Cotag cards as documented here.
The reader supports HID ioProx tags as documented here.
unsigned char * brp_buf
represents a pointer to a protocol data buffer.
brp_DesfireFileDescription_FileCommunicationSecurity FileCommunicationSecurity
Communication settings that define if data is to be MAC'ed or encrypted before it's transmitted to th...
bool ExtendedLED
The RGB LED features of the reader are defective.
This byte is required to enable additional fields for the characterization of the desired LED behavio...
The reader supports Bluetooth Low Energy (BLE).
bool RequireSessionKey
3-pass authentication and sessionkey generation
brp_Baudrate
The Baudrate specifies the performance of an RS-232/UART based interface in bits per second...
The reader supports MIFARE DESFire EV1 cards as documented here.
File is specified by APDU Select command that has to be executed to activate a file.
This is a autoread protocol that sends the ID read by autoread mode via Wiegand protocol.
The reader can read the UID of an ISO 14443 Type B card.
brp_Iso14a_RequestATS_FSDI
Frame Size proximity coupling Device Integer (FSDI) value.
brp_Desfire_ExecCommand_CryptoMode
Type of encryption.
More accurate info: The reader supports reading the PCN of HID iCLASS SE and Seos cards as documented...
bool Dataflash
The data flash chip is defective, device out of order.
bool Pyramid
Farpointe Pyramid.
The reader supports Indala cards as documented here.
The reader supports MIFARE Classic cards and MIFARE Plus cards in Security Level 1 using MIFARE CRYPT...
The reader supports HID AWID tags as documented here.
bool NAD
If this flag is set, the PPIC supports NAD.
char * Parameter
The length of this block depends on the length of the command.
The reader supports IDTECK cards as documented here.
brp_Iso14b_Request_FWI FWI
Frame Waiting time Integer (FWI).
size_t Name_len
Length of Name (in bytes).
Refers to a general purpose I/O.
Custom Virtual LED (VLED) port.
bool IoPortRead
Has to be cleared to deny read access to io ports.
bool HidIndala
Indala ASP.
unsigned RepeatCnt
The number of repetitions of the code block between the matching tLoop this atLoop mand...
brp_AutoRunCommand_RunMode RunMode
bool SetKey2
Has to be cleared to deny set security key 2.
bool FirmwareVersionBlocked
The loaded firmware version is blacklisted.
bool LeftLed
LED(s) on the left side of the reader.
References keys within a SAM, only available on SAM based readers: key index from 0x00 to 0x7F...
MIFARE Plus L2 (2k and 4k variants)
The reader supports LEGIC cards as documented here.
bool VhlSelect
Has to be cleared to deny detection of cards via VHL.
brp_buf CharacteristicUUID
Specifies the UUID (16 or 128 bits) of the BLE characteristic.
bool FlashFileSystemRead
Has to be cleared to deny read access to flash file system.
unsigned FirmwareID
BCD number that specifies a firmware ID.
Every Feature in this list can be disabled by not setting the corresponding bit.
brp_VHL_Setup_MifareHasAsKeyA
bool SetKey1
Has to be cleared to deny set security key 1.
The reader supports PicoPass cards as documented here.
bool BleLicRequired
BLE license required.
brp_Desfire_Authenticate_SecureMessaging
Sets the secure messaging mode.
A PIN was entered via the reader's keyboard.
The tamper alarm was deactivated.
brp_DesfireFileDescription_FileCommunicationSecurity
Communication settings that define if data is to be MAC'ed or encrypted before it's transmitted to th...
The following label commands are sent including the UID given in UID.
unsigned WriteKeyNo
WriteKeyNo , i.e.
unsigned SmallestBlockedFwVersionBuild
Binary that specifies the build number of the smallest blocked fw version.
Activates only the LEDs on the right side.
The reader supports HID Prox32 tags as documented here.
The debug interface may be used to look into the readers internals via a Terminal.
brp_DesfireFileDescription_FileType FileType
Type of file to read.
Custom Virtual LED (VLED) port.
The reader supports HID Prox tags as documented here.
Indicates that the reader is connected to an IF Converter that connects to a server via Ethernet as H...
The reader has an RGB LED that is customizable to a limited extend.
ISO 14443-4 Type B with ISO 7816-4 support.
unsigned Offset
Number of the first byte in the DESFire file to map into the VHL file.
brp_VirtualLedDefinition_PhysicalLedSelection
This field defines which physical LEDs are to be activated when the corresponding VLED port is enable...
bool Tamper
The tamper alarm is defective.
MIFARE DESFire (2k, 4k, and 8k variants)
size_t CharacteristicUUID_len
Length of CharacteristicUUID (in bytes).
The reader has a tamper alarm.
brp_DesfireFileDescription_FileType
Type of file to read.
BRP protocol over TCP/IP.
unsigned AccessRightsLowByte
**Only needed to runVHL.Format .
bool StampSearch
Use Stamp search to identify the desired segment.
The reader supports the Bluetooth Host Controller Interface (HCI).
brp_Iso14L4_SetupAPDU_FWI
Frame Waiting time Integer (FWI).