Enumerations

All enumerations used across the RIK API. Select a language tab to see the enum definition and member names for that language.

---

ProtocolType

Communication protocol for reader connections.

C++

Namespace: RikCommon | Underlying type: uint8_t

Value	Hex	Description
PROTOCOL_TYPE_INVALID	0x00	Invalid / unset
PROTOCOL_TYPE_FEATURE_REPORT	0x01	USB HID Feature Report
PROTOCOL_TYPE_SERIAL_BINARY	0x03	Serial binary protocol
PROTOCOL_TYPE_UNKNOWN	0xFF	Unknown protocol

C#

Namespace: rfIDEAS.ReaderIntegrationKit.Enum | Underlying type: byte

public enum ProtocolType : byte
{
    Invalid = 0x00,
    FeatureReport = 0x01,
    SerialBinary = 0x03,
    Unknown = 0xFF
}

Value	Hex	Description
ProtocolType.Invalid	0x00	Invalid / unset
ProtocolType.FeatureReport	0x01	USB HID Feature Report
ProtocolType.SerialBinary	0x03	Serial binary protocol
ProtocolType.Unknown	0xFF	Unknown protocol

Python

Module: reader_integration_kit.enum | Base class: IntEnum

class ProtocolType(IntEnum):
    INVALID = 0x00
    FEATURE_REPORT = 0x01
    SERIAL_BINARY = 0x03
    UNKNOWN = 0xFF

Value	Hex	Description
ProtocolType.INVALID	0x00	Invalid / unset
ProtocolType.FEATURE_REPORT	0x01	USB HID Feature Report
ProtocolType.SERIAL_BINARY	0x03	Serial binary protocol
ProtocolType.UNKNOWN	0xFF	Unknown protocol

note

Most USB-connected rf IDEAS readers use FeatureReport. Use SerialBinary only for RS-232 serial connections.

---

BeepDuration

Beep duration options for the reader beeper.

C++

Namespace: RikProtocol | Underlying type: uint8_t

Value	Int	Description
BEEP_DURATION_SHORT	0	Short beep (~100ms)
BEEP_DURATION_LONG	1	Long beep (~500ms)

C#

Namespace: rfIDEAS.ReaderIntegrationKit.Enum | Underlying type: byte

public enum BeepDuration : byte
{
    BeepDurationShort = 0,
    BeepDurationLong = 1,
}

Value	Int	Description
BeepDuration.BeepDurationShort	0	Short beep (~100ms)
BeepDuration.BeepDurationLong	1	Long beep (~500ms)

Python

Module: reader_integration_kit.enum | Base class: IntEnum

class BeepDuration(IntEnum):
    BEEP_DURATION_SHORT = 0
    BEEP_DURATION_LONG = 1

Value	Int	Description
BeepDuration.BEEP_DURATION_SHORT	0	Short beep (~100ms)
BeepDuration.BEEP_DURATION_LONG	1	Long beep (~500ms)

---

BeepVolume

Volume levels for the reader beeper.

C++

Namespace: RikProtocol | Underlying type: uint8_t

Value	Int	Description
BEEP_VOLUME_OFF	0	Beeper disabled
BEEP_VOLUME_LOW	1	Low volume
BEEP_VOLUME_MEDIUM	2	Medium volume
BEEP_VOLUME_HIGH	3	High volume
BEEP_VOLUME_UNKNOWN	255	Unknown / unread

C#

Namespace: rfIDEAS.ReaderIntegrationKit.Enum | Underlying type: int

public enum BeepVolume
{
    Off = 0,
    Low = 1,
    Medium = 2,
    High = 3,
    Unknown = 255
}

Value	Int	Description
BeepVolume.Off	0	Beeper disabled
BeepVolume.Low	1	Low volume
BeepVolume.Medium	2	Medium volume
BeepVolume.High	3	High volume
BeepVolume.Unknown	255	Unknown / unread

Python

Module: reader_integration_kit.enum | Base class: IntEnum

class BeepVolume(IntEnum):
    BEEP_VOLUME_OFF = 0
    BEEP_VOLUME_LOW = 1
    BEEP_VOLUME_MEDIUM = 2
    BEEP_VOLUME_HIGH = 3
    BEEP_VOLUME_UNKNOWN = 255

Value	Int	Description
BeepVolume.BEEP_VOLUME_OFF	0	Beeper disabled
BeepVolume.BEEP_VOLUME_LOW	1	Low volume
BeepVolume.BEEP_VOLUME_MEDIUM	2	Medium volume
BeepVolume.BEEP_VOLUME_HIGH	3	High volume
BeepVolume.BEEP_VOLUME_UNKNOWN	255	Unknown / unread

---

LedColor

LED color states.

C++

Namespace: Rik | Underlying type: unsigned char

Value	Int	Description
Invalid	0	Invalid state
Off	1	LED off
Red	2	Red
Green	3	Green
Amber	4	Amber
Unknown	0xFF	Unknown state

C#

Namespace: rfIDEAS.ReaderIntegrationKit.Enum | Underlying type: byte

public enum LedColor : byte
{
    Invalid = 0,
    Off = 1,
    Red = 2,
    Green = 3,
    Amber = 4,
    Unknown = 0xFF
}

Value	Int	Description
LedColor.Invalid	0	Invalid state
LedColor.Off	1	LED off
LedColor.Red	2	Red
LedColor.Green	3	Green
LedColor.Amber	4	Amber
LedColor.Unknown	0xFF	Unknown state

Python

Module: reader_integration_kit.enum | Base class: IntEnum

class LedColor(IntEnum):
    INVALID = 0
    OFF = 1
    RED = 2
    GREEN = 3
    AMBER = 4
    UNKNOWN = 0xFF

Value	Int	Description
LedColor.INVALID	0	Invalid state
LedColor.OFF	1	LED off
LedColor.RED	2	Red
LedColor.GREEN	3	Green
LedColor.AMBER	4	Amber
LedColor.UNKNOWN	0xFF	Unknown state

---

ReaderModuleId

Identifies a hardware module within a reader.

C++

Namespace: RikProtocol | Underlying type: uint8_t

Value	Hex	Description
Invalid	0x00	Invalid
LowFrequencyRadio	0x01	125 kHz radio module
HighFrequencyRadio	0x02	13.56 MHz radio module
BleRadio	0x03	Bluetooth Low Energy radio

C#

Namespace: rfIDEAS.ReaderIntegrationKit.Enum | Underlying type: byte

public enum ReaderModuleId : byte
{
    Invalid = 0x00,
    LowFrequencyRadio = 0x01,
    HighFrequencyRadio = 0x02,
    BleRadio = 0x03
}

Value	Hex	Description
ReaderModuleId.Invalid	0x00	Invalid
ReaderModuleId.LowFrequencyRadio	0x01	125 kHz radio module
ReaderModuleId.HighFrequencyRadio	0x02	13.56 MHz radio module
ReaderModuleId.BleRadio	0x03	Bluetooth Low Energy radio

Python

Module: reader_integration_kit.enum | Base class: IntEnum

class ReaderModuleId(IntEnum):
    INVALID = 0x00
    LOW_FREQUENCY_RADIO = 0x01
    HIGH_FREQUENCY_RADIO = 0x02
    BLE_RADIO = 0x03

Value	Hex	Description
ReaderModuleId.INVALID	0x00	Invalid
ReaderModuleId.LOW_FREQUENCY_RADIO	0x01	125 kHz radio module
ReaderModuleId.HIGH_FREQUENCY_RADIO	0x02	13.56 MHz radio module
ReaderModuleId.BLE_RADIO	0x03	Bluetooth Low Energy radio

---

ReaderModuleState

Power state of a reader module.

C++

Namespace: RikProtocol | Underlying type: uint32_t

Value	Hex	Description
Invalid	0x00	Invalid state
PowerOff	0x80	Module powered off
PowerOnNormal	0x81	Module powered on, normal operation

C#

Namespace: rfIDEAS.ReaderIntegrationKit.Enum | Underlying type: uint

public enum ReaderModuleState : uint
{
    Invalid = 0x00,
    PowerOff = 0x00000080,
    PowerOnNormal = 0x00000081
}

Value	Hex	Description
ReaderModuleState.Invalid	0x00	Invalid state
ReaderModuleState.PowerOff	0x80	Module powered off
ReaderModuleState.PowerOnNormal	0x81	Module powered on, normal operation

Python

Module: reader_integration_kit.enum | Base class: IntEnum

class ReaderModuleState(IntEnum):
    INVALID = 0x00
    POWER_OFF = 0x00000080
    POWER_ON_NORMAL = 0x00000081

Value	Hex	Description
ReaderModuleState.INVALID	0x00	Invalid state
ReaderModuleState.POWER_OFF	0x80	Module powered off
ReaderModuleState.POWER_ON_NORMAL	0x81	Module powered on, normal operation

---

BleDataType

Type of BLE data payload.

C++

Namespace: RikCommon | Underlying type: uint8_t

Value	Int	Description
Data	1	Standard data
Key	2	Encrypted key
UnencryptedKey	3	Unencrypted key

C#

Namespace: rfIDEAS.ReaderIntegrationKit.Enum | Underlying type: byte

public enum BleDataType : byte
{
    Data = 1,
    Key = 2,
    UnencryptedKey = 3
}

Value	Int	Description
BleDataType.Data	1	Standard data
BleDataType.Key	2	Encrypted key
BleDataType.UnencryptedKey	3	Unencrypted key

Python

Module: reader_integration_kit.enum | Base class: IntEnum

class BleDataType(IntEnum):
    DATA = 1
    KEY = 2
    UNENCRYPTED_KEY = 3

Value	Int	Description
BleDataType.DATA	1	Standard data
BleDataType.KEY	2	Encrypted key
BleDataType.UNENCRYPTED_KEY	3	Unencrypted key

---

CheckpointType

Configuration checkpoint types for save/restore operations.

note

This enum is available in C++ only. It is not exposed through the C# or Python facades.

Namespace: Rik | Underlying type: unsigned char

Value	Int	Description
Undefined	0	Undefined
FactoryDefaults	1	Factory default settings
UserSettings	2	User-saved settings

---

ReaderCapability

Capabilities that a reader may support.

note

This enum is available in C++ only. It is not exposed through the C# or Python facades.

Namespace: Rik | Underlying type: uint16_t

Value	Int	Description
READER_CAPABILITY_UNKNOWN	0	Unknown capability
READER_CAPABILITY_BEEPER	1	Audible beeper
READER_CAPABILITY_TRANSPARENT_MODE	2	Direct LEGIC chip communication bypassing rf IDEAS firmware
READER_CAPABILITY_SMART_CARD	3	Smart card support
READER_CAPABILITY_BLUETOOTH	4	Bluetooth connectivity
READER_CAPABILITY_HID_MOBILE	5	HID Mobile Access
READER_CAPABILITY_FINGERPRINT	6	Fingerprint biometric
READER_CAPABILITY_HID_SE	7	HID Secure Element
READER_CAPABILITY_NXP_SE	8	NXP Secure Element
READER_CAPABILITY_FELICA	9	FeliCa card support
READER_CAPABILITY_LEGIC	10	LEGIC card support
READER_CAPABILITY_QUEUED_CARD_DATA	11	Queued card data support
READER_CAPABILITY_EXTENDED_CONFIGURATION	12	Extended configuration support
READER_CAPABILITY_CARD_ANALYZER	13	Card analyzer support
READER_CAPABILITY_MIFARE_WRITER	14	MIFARE write support
READER_CAPABILITY_MODULE_CONTROL	15	Module power control
READER_CAPABILITY_FIRMWARE_UPGRADE	16	Firmware upgrade support
READER_CAPABILITY_COPY_CONFIGURATION	17	Copy configuration between slots
READER_CAPABILITY_BAUD_RATE	18	Configurable baud rate
READER_CAPABILITY_LUID	19	Logical Unit ID support
READER_CAPABILITY_LED_CONFIGURATION	20	LED configuration support
READER_CAPABILITY_CONFIGURATION_BLOCK_5	21	Configuration block 5 support
READER_CAPABILITY_SYSTEM_UPTIME	22	System uptime reporting
READER_CAPABILITY_KEYSTROKING	23	Keystroking output mode
READER_CAPABILITY_CONFIGURABLE	24	Reader is configurable

---

TransparentModeState

Indicates whether transparent mode is currently enabled or disabled on the reader.

C++

Namespace: RikProtocol | Underlying type: unsigned char

Value	Int	Description
DISABLED	0	Transparent mode is disabled
ENABLED	1	Transparent mode is enabled

C#

Namespace: rfIDEAS.ReaderIntegrationKit.Enum | Underlying type: byte

public enum TransparentModeState : byte
{
    Disabled = 0,
    Enabled = 1
}

Value	Int	Description
TransparentModeState.Disabled	0	Transparent mode is disabled
TransparentModeState.Enabled	1	Transparent mode is enabled

Python

Module: reader_integration_kit.enum | Base class: IntEnum

class TransparentModeState(IntEnum):
    DISABLED = 0
    ENABLED = 1

Value	Int	Description
TransparentModeState.DISABLED	0	Transparent mode is disabled
TransparentModeState.ENABLED	1	Transparent mode is enabled

---

TransparentModeStatus

Indicates whether the reader is ready for transparent mode communication.

C++

Namespace: RikProtocol | Underlying type: unsigned char

Value	Int	Description
NOT_READY	0	Reader is not ready for transparent communication
READY	1	Reader is ready for transparent communication

C#

Namespace: rfIDEAS.ReaderIntegrationKit.Enum | Underlying type: byte

public enum TransparentModeStatus : byte
{
    NotReady = 0,
    Ready = 1
}

Value	Int	Description
TransparentModeStatus.NotReady	0	Reader is not ready for transparent communication
TransparentModeStatus.Ready	1	Reader is ready for transparent communication

Python

Module: reader_integration_kit.enum | Base class: IntEnum

class TransparentModeStatus(IntEnum):
    NOT_READY = 0
    READY = 1

Value	Int	Description
TransparentModeStatus.NOT_READY	0	Reader is not ready for transparent communication
TransparentModeStatus.READY	1	Reader is ready for transparent communication

---

QueuedIdFlagParameters

Flags for clearing queued ID state.

note

This enum is available in C++ and C# only. It is not exposed through the Python facade.

C++

Namespace: RikProtocol | Underlying type: uint8_t

Value	Int	Description
ClearNone	0	Clear nothing
ClearEvents	1	Clear queued events
ClearLockouts	2	Clear lockouts

C#

Namespace: rfIDEAS.ReaderIntegrationKit.Enum | Underlying type: int

public enum QueuedIdFlagParameters
{
    ClearNone = 0x00,
    ClearEvents = 0x01,
    ClearLockouts = 0x02,
}

Value	Int	Description
QueuedIdFlagParameters.ClearNone	0	Clear nothing
QueuedIdFlagParameters.ClearEvents	1	Clear queued events
QueuedIdFlagParameters.ClearLockouts	2	Clear lockouts

---

GetCardDataSizeParameters

Card-read size for GetCardData / OnCredentialPresented. The default is READ_32_BYTES / Read32Bytes.

C++

Namespace: RikProtocol | Underlying type: unsigned char

enum GetCardDataSizeParameters : unsigned char
{
    UNDEFINED = 0x00,
    READ_8_BYTES = 0x01,
    READ_32_BYTES = 0x02
};

Value	Hex	Description
UNDEFINED	0x00	Invalid / unset — do not pass
READ_8_BYTES	0x01	8-byte read
READ_32_BYTES	0x02	32-byte read (default)

C#

Namespace: rfIDEAS.ReaderIntegrationKit.Enum | Underlying type: byte

public enum GetCardDataSizeParameters : byte
{
    Undefined = 0x00,
    Read8Bytes = 0x01,
    Read32Bytes = 0x02
}

Value	Hex	Description
GetCardDataSizeParameters.Undefined	0x00	Invalid / unset — do not pass
GetCardDataSizeParameters.Read8Bytes	0x01	8-byte read
GetCardDataSizeParameters.Read32Bytes	0x02	32-byte read (default)

Python

Module: reader_integration_kit.enum | Base class: IntEnum

class GetCardDataSizeParameters(IntEnum):
    UNDEFINED = 0x00
    READ_8_BYTES = 0x01
    READ_32_BYTES = 0x02

Value	Hex	Description
GetCardDataSizeParameters.UNDEFINED	0x00	Invalid / unset — do not pass
GetCardDataSizeParameters.READ_8_BYTES	0x01	8-byte read
GetCardDataSizeParameters.READ_32_BYTES	0x02	32-byte read (default)

warning

UNDEFINED / Undefined is invalid and must not be passed to GetCardData, OnCredentialPresented, or the C ABI equivalents.

---

ProductLineType

Product line identification for rf IDEAS readers.

note

This enum is available in C++ only. It is not exposed through the C# or Python facades.

Namespace: Rik | Underlying type: unsigned char

Value	Int	Description
ProductUnknown	0	Unknown product
ProductLineLoon	1	Loon product line
ProductLineWren	2	Wren product line
ProductLineIbis	3	Ibis product line
ProductLineFinch	4	Finch product line
ProductLineKiwi	5	Kiwi product line
ProductLineEagle	6	Eagle product line
ProductNotApplicable	0xFF	Not applicable

---

Serial Port Enumerations

All serial port enums are in namespace RikCommon (C++) / rfIDEAS.ReaderIntegrationKit.Enum (C#) / reader_integration_kit.enum (Python).

SerialPortBaudRate

C++

Underlying type: uint32_t

Value	Baud Rate
SERIAL_PORT_BAUD_9600	9600
SERIAL_PORT_BAUD_14400	14400
SERIAL_PORT_BAUD_19200	19200
SERIAL_PORT_BAUD_32400	32400
SERIAL_PORT_BAUD_57600	57600
SERIAL_PORT_BAUD_115200	115200
SERIAL_PORT_BAUD_230400	230400
SERIAL_PORT_BAUD_576000	576000
SERIAL_PORT_BAUD_921600	921600

C#

Underlying type: uint

public enum SerialPortBaudRate : uint
{
    Invalid = 0,
    Baud9600 = 9600,
    Baud14400 = 14400,
    Baud19200 = 19200,
    Baud32400 = 32400,
    Baud57600 = 57600,
    Baud115200 = 115200,
    Baud230400 = 230400,
    Baud576000 = 576000,
    Baud921600 = 921600
}

Python

Base class: IntEnum

class SerialPortBaudRate(IntEnum):
    INVALID = 0
    BAUD_9600 = 9600
    BAUD_14400 = 14400
    BAUD_19200 = 19200
    BAUD_32400 = 32400
    BAUD_57600 = 57600
    BAUD_115200 = 115200
    BAUD_230400 = 230400
    BAUD_576000 = 576000
    BAUD_921600 = 921600

SerialPortParity

C++

Underlying type: uint8_t

Value	Int	Description
None	0	No parity
Odd	1	Odd parity
Even	2	Even parity
Mark	3	Mark parity
Space	4	Space parity

C#

Underlying type: byte

public enum SerialPortParity : byte
{
    None = 0,
    Odd = 1,
    Even = 2,
    Mark = 3,
    Space = 4
}

Python

Base class: IntEnum

class SerialPortParity(IntEnum):
    NONE = 0
    ODD = 1
    EVEN = 2
    MARK = 3
    SPACE = 4

SerialPortDataBits

C++

Underlying type: uint8_t

Value	Int	Description
Five	1	5 data bits
Six	2	6 data bits
Seven	3	7 data bits
Eight	4	8 data bits

C#

Underlying type: byte

public enum SerialPortDataBits : byte
{
    Invalid = 0,
    Five = 1,
    Six = 2,
    Seven = 3,
    Eight = 4
}

Python

Base class: IntEnum

class SerialPortDataBits(IntEnum):
    INVALID = 0
    DATA_BITS_5 = 1
    DATA_BITS_6 = 2
    DATA_BITS_7 = 3
    DATA_BITS_8 = 4

SerialPortStopBits

C++

Underlying type: uint8_t

Value	Int	Description
None	0	No stop bits
One	1	1 stop bit
Two	2	2 stop bits
OnePointFive	3	1.5 stop bits

C#

Underlying type: byte

public enum SerialPortStopBits : byte
{
    None = 0,
    One = 1,
    Two = 2,
    OnePointFive = 3
}

Python

Base class: IntEnum

class SerialPortStopBits(IntEnum):
    NONE = 0
    ONE = 1
    TWO = 2
    ONE_POINT_FIVE = 3

SerialPortFlowControl

C++

Underlying type: uint8_t

Value	Int	Description
None	0	No flow control
XonXoff	1	Software (XON/XOFF)
RtsCts	2	Hardware (RTS/CTS)
XonXoffRtsCts	3	XON/XOFF + RTS/CTS
DtrDsr	4	Hardware (DTR/DSR)
XonXoffDtrDsr	5	XON/XOFF + DTR/DSR

C#

Underlying type: byte

public enum SerialPortFlowControl : byte
{
    None = 0,
    XonXoff = 1,
    RtsCts = 2,
    XonXoffRtsCts = 3,
    DtrDsr = 4,
    XonXoffDtrDsr = 5
}

Python

Base class: IntEnum

class SerialPortFlowControl(IntEnum):
    NO_FLOW_CONTROL = 0
    XON_XOFF = 1
    RTS_CTS = 2
    XON_XOFF_RTS_CTS = 3
    DTR_DSR = 4
    XON_XOFF_DTR_DSR = 5

---

DataConversionType

How an extended-configuration field is converted for output. Used by FieldEntry.ConversionType.

C++

Namespace: RikCommon | Underlying type: unsigned char

Value	Int	Description
DECIMAL	0	Decimal output
ASCII	1	ASCII output
HEXADECIMAL	2	Hexadecimal output
OCTAL	3	Octal output

C#

Namespace: rfIDEAS.ReaderIntegrationKit.Enum | Underlying type: byte

public enum DataConversionType : byte
{
    Decimal = 0,
    Ascii = 1,
    Hexadecimal = 2,
    Octal = 3
}

Value	Int	Description
DataConversionType.Decimal	0	Decimal output
DataConversionType.Ascii	1	ASCII output
DataConversionType.Hexadecimal	2	Hexadecimal output
DataConversionType.Octal	3	Octal output

Python

Module: reader_integration_kit.enum | Base class: IntEnum

class DataConversionType(IntEnum):
    DECIMAL = 0
    ASCII = 1
    HEXADECIMAL = 2
    OCTAL = 3

Value	Int	Description
DataConversionType.DECIMAL	0	Decimal output
DataConversionType.ASCII	1	ASCII output
DataConversionType.HEXADECIMAL	2	Hexadecimal output
DataConversionType.OCTAL	3	Octal output

---

FieldDefinitionType

Application-data field definition used by ApplicationData (C#/Python: ReaderData).

C++

Namespace: RikCommon | Underlying type: unsigned char

Value	Int	Description
USER_FIELDS	0	User-defined fields
FIPS201_64_BIT	1	FIPS 201 64-bit
FIPS201_64_BIT_REV	2	FIPS 201 64-bit reversed
FIPS201_75_BIT	3	FIPS 201 75-bit
FIPS201_200_BIT	4	FIPS 201 200-bit
FIPS201_245_BIT	5	FIPS 201 245-bit

C#

Namespace: rfIDEAS.ReaderIntegrationKit.Enum | Underlying type: byte

public enum FieldDefinitionType : byte
{
    UserFields = 0,
    Fips201_64_Bit = 1,
    Fips201_64_Bit_Rev = 2,
    Fips201_75_Bit = 3,
    Fips201_200_Bit = 4,
    Fips201_245_Bit = 5
}

Value	Int	Description
FieldDefinitionType.UserFields	0	User-defined fields
FieldDefinitionType.Fips201_64_Bit	1	FIPS 201 64-bit
FieldDefinitionType.Fips201_64_Bit_Rev	2	FIPS 201 64-bit reversed
FieldDefinitionType.Fips201_75_Bit	3	FIPS 201 75-bit
FieldDefinitionType.Fips201_200_Bit	4	FIPS 201 200-bit
FieldDefinitionType.Fips201_245_Bit	5	FIPS 201 245-bit

Python

Module: reader_integration_kit.enum | Base class: IntEnum

class FieldDefinitionType(IntEnum):
    USER_FIELDS = 0
    FIPS201_64_BIT = 1
    FIPS201_64_BIT_REV = 2
    FIPS201_75_BIT = 3
    FIPS201_200_BIT = 4
    FIPS201_245_BIT = 5

Value	Int	Description
FieldDefinitionType.USER_FIELDS	0	User-defined fields
FieldDefinitionType.FIPS201_64_BIT	1	FIPS 201 64-bit
FieldDefinitionType.FIPS201_64_BIT_REV	2	FIPS 201 64-bit reversed
FieldDefinitionType.FIPS201_75_BIT	3	FIPS 201 75-bit
FieldDefinitionType.FIPS201_200_BIT	4	FIPS 201 200-bit
FieldDefinitionType.FIPS201_245_BIT	5	FIPS 201 245-bit

---

BlobType

Identifies the payload type of a BlobHeader. Only named enumerators are defined; unused numeric values are omitted.

C++

Namespace: RikCommon | Underlying type: uint8_t

Value	Int	Description
LEGACY_KEY	1	Legacy key blob
MIFARE_FILE	2	MIFARE file blob
LEGIC_FILE	4	LEGIC file blob
LEGIC_KEY	5	LEGIC key blob
LEGIC_FILE_WITH_USER_KEY	6	LEGIC file with user key
MIFARE_KEY	7	MIFARE key blob
MIFARE_DESFIRE_FILE	8	MIFARE DESFire file blob
MIFARE_CLASSIC	9	MIFARE Classic blob
MIFARE_PLUS	10	MIFARE Plus blob
ECP_2_0	11	ECP 2.0 blob
MIFARE_ULTRALIGHT	14	MIFARE Ultralight blob
HOST_ENCRYPTION_KEY	15	Host encryption key blob
WAVELYNX_MYPASS_BLE	18	WaveLynx myPass BLE blob
FELICA_LITE_S	20	FeliCa Lite-S blob
FELICA_LITE	21	FeliCa Lite blob
FELICA_KEY	22	FeliCa key blob
FELICA_FILE	23	FeliCa file blob
ALLEGION_HCE	26	Allegion HCE blob
MIFARE_2GO	27	MIFARE 2GO blob

C#

Namespace: rfIDEAS.ReaderIntegrationKit.Enum | Underlying type: byte

public enum BlobType : byte
{
    LegacyKey = 1,
    MifareFile = 2,
    LegicFile = 4,
    LegicKey = 5,
    LegicFileWithUserKey = 6,
    MifareKey = 7,
    MifareDesfireFile = 8,
    MifareClassic = 9,
    MifarePlus = 10,
    Ecp20 = 11,
    MifareUltralight = 14,
    HostEncryptionKey = 15,
    WavelynxMyPassBle = 18,
    FelicaLiteS = 20,
    FelicaLite = 21,
    FelicaKey = 22,
    FelicaFile = 23,
    AllegionHce = 26,
    Mifare2Go = 27
}

Value	Int	Description
BlobType.LegacyKey	1	Legacy key blob
BlobType.MifareFile	2	MIFARE file blob
BlobType.LegicFile	4	LEGIC file blob
BlobType.LegicKey	5	LEGIC key blob
BlobType.LegicFileWithUserKey	6	LEGIC file with user key
BlobType.MifareKey	7	MIFARE key blob
BlobType.MifareDesfireFile	8	MIFARE DESFire file blob
BlobType.MifareClassic	9	MIFARE Classic blob
BlobType.MifarePlus	10	MIFARE Plus blob
BlobType.Ecp20	11	ECP 2.0 blob
BlobType.MifareUltralight	14	MIFARE Ultralight blob
BlobType.HostEncryptionKey	15	Host encryption key blob
BlobType.WavelynxMyPassBle	18	WaveLynx myPass BLE blob
BlobType.FelicaLiteS	20	FeliCa Lite-S blob
BlobType.FelicaLite	21	FeliCa Lite blob
BlobType.FelicaKey	22	FeliCa key blob
BlobType.FelicaFile	23	FeliCa file blob
BlobType.AllegionHce	26	Allegion HCE blob
BlobType.Mifare2Go	27	MIFARE 2GO blob

Python

Module: reader_integration_kit.enum | Base class: IntEnum

class BlobType(IntEnum):
    LEGACY_KEY = 1
    MIFARE_FILE = 2
    LEGIC_FILE = 4
    LEGIC_KEY = 5
    LEGIC_FILE_WITH_USER_KEY = 6
    MIFARE_KEY = 7
    MIFARE_DESFIRE_FILE = 8
    MIFARE_CLASSIC = 9
    MIFARE_PLUS = 10
    ECP_2_0 = 11
    MIFARE_ULTRALIGHT = 14
    HOST_ENCRYPTION_KEY = 15
    WAVELYNX_MYPASS_BLE = 18
    FELICA_LITE_S = 20
    FELICA_LITE = 21
    FELICA_KEY = 22
    FELICA_FILE = 23
    ALLEGION_HCE = 26
    MIFARE_2GO = 27

Value	Int	Description
BlobType.LEGACY_KEY	1	Legacy key blob
BlobType.MIFARE_FILE	2	MIFARE file blob
BlobType.LEGIC_FILE	4	LEGIC file blob
BlobType.LEGIC_KEY	5	LEGIC key blob
BlobType.LEGIC_FILE_WITH_USER_KEY	6	LEGIC file with user key
BlobType.MIFARE_KEY	7	MIFARE key blob
BlobType.MIFARE_DESFIRE_FILE	8	MIFARE DESFire file blob
BlobType.MIFARE_CLASSIC	9	MIFARE Classic blob
BlobType.MIFARE_PLUS	10	MIFARE Plus blob
BlobType.ECP_2_0	11	ECP 2.0 blob
BlobType.MIFARE_ULTRALIGHT	14	MIFARE Ultralight blob
BlobType.HOST_ENCRYPTION_KEY	15	Host encryption key blob
BlobType.WAVELYNX_MYPASS_BLE	18	WaveLynx myPass BLE blob
BlobType.FELICA_LITE_S	20	FeliCa Lite-S blob
BlobType.FELICA_LITE	21	FeliCa Lite blob
BlobType.FELICA_KEY	22	FeliCa key blob
BlobType.FELICA_FILE	23	FeliCa file blob
BlobType.ALLEGION_HCE	26	Allegion HCE blob
BlobType.MIFARE_2GO	27	MIFARE 2GO blob

---

CardCategory

Classifies a card type by its security and communication category.

C++

Namespace: RikCommon | Underlying type: uint8_t

Value	Int	Description
OFF	0	Category not applicable / disabled
SECURE	1	Secure credential (e.g., DESFire)
NON_SECURE	2	Non-secure credential (e.g., Prox)
BLUETOOTH	3	Bluetooth / mobile credential

C#

Namespace: rfIDEAS.ReaderIntegrationKit.Enum | Underlying type: byte

public enum CardCategory : byte
{
    Off = 0,
    Secure = 1,
    NonSecure = 2,
    Bluetooth = 3,
}

Value	Int	Description
CardCategory.Off	0	Category not applicable / disabled
CardCategory.Secure	1	Secure credential (e.g., DESFire)
CardCategory.NonSecure	2	Non-secure credential (e.g., Prox)
CardCategory.Bluetooth	3	Bluetooth / mobile credential

Python

Module: reader_integration_kit.enum | Base class: IntEnum

class CardCategory(IntEnum):
    OFF = 0
    SECURE = 1
    NON_SECURE = 2
    BLUETOOTH = 3

Value	Int	Description
CardCategory.OFF	0	Category not applicable / disabled
CardCategory.SECURE	1	Secure credential (e.g., DESFire)
CardCategory.NON_SECURE	2	Non-secure credential (e.g., Prox)
CardCategory.BLUETOOTH	3	Bluetooth / mobile credential

---

CardFrequency

Card RF frequency classification for a card type.

note

BLE / Ble is used for Bluetooth Low Energy / mobile credential RF and corresponds to the BLUETOOTH / Bluetooth CardCategory.

C++

Namespace: RikCommon | Underlying type: uint8_t

Value	Int	Description
NA	0	Frequency not applicable
BLE	1	Bluetooth Low Energy / mobile credential RF
HIGH	2	High frequency
LOW	3	Low frequency
DUAL	4	Dual frequency

C#

Namespace: rfIDEAS.ReaderIntegrationKit.Enum | Underlying type: byte

public enum CardFrequency : byte
{
    Na = 0,
    Ble = 1,
    High = 2,
    Low = 3,
    Dual = 4,
}

Value	Int	Description
CardFrequency.Na	0	Frequency not applicable
CardFrequency.Ble	1	Bluetooth Low Energy / mobile credential RF
CardFrequency.High	2	High frequency
CardFrequency.Low	3	Low frequency
CardFrequency.Dual	4	Dual frequency

Python

Module: reader_integration_kit.enum | Base class: IntEnum

class CardFrequency(IntEnum):
    NA = 0
    BLE = 1
    HIGH = 2
    LOW = 3
    DUAL = 4

Value	Int	Description
CardFrequency.NA	0	Frequency not applicable
CardFrequency.BLE	1	Bluetooth Low Energy / mobile credential RF
CardFrequency.HIGH	2	High frequency
CardFrequency.LOW	3	Low frequency
CardFrequency.DUAL	4	Dual frequency

---

See Also

• Structures
• Exceptions
• Common Library
• AbstractReader