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++
C#
Python

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

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

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++
C#
Python

Namespace: RikProtocol | Underlying type: uint8_t

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

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

public enum BeepDuration : byte
{
    Short = 0,
    Long = 1,
}

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

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++
C#
Python

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

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

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++
C#
Python

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

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

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++
C#
Python

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

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

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++
C#
Python

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

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

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++
C#
Python

Namespace: RikCommon | Underlying type: uint8_t

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

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

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`	Transparent / pass-through card communication
`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

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.

Namespace: RikProtocol | Underlying type: uint8_t

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

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

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++
C#
Python

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

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
}

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++
C#
Python

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

Underlying type: byte

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

Base class: IntEnum

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

SerialPortDataBits

C++
C#
Python

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

Underlying type: byte

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

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++
C#
Python

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

Underlying type: byte

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

Base class: IntEnum

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

SerialPortFlowControl

C++
C#
Python

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

Underlying type: byte

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

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

ProtocolType​

BeepDuration​

BeepVolume​

LedColor​

ReaderModuleId​

ReaderModuleState​

BleDataType​

CheckpointType​

ReaderCapability​

QueuedIdFlagParameters​

ProductLineType​

Serial Port Enumerations​

SerialPortBaudRate​

SerialPortParity​

SerialPortDataBits​

SerialPortStopBits​

SerialPortFlowControl​

See Also​

ProtocolType

BeepDuration

BeepVolume

LedColor

ReaderModuleId

ReaderModuleState

BleDataType

CheckpointType

ReaderCapability

QueuedIdFlagParameters

ProductLineType

Serial Port Enumerations

SerialPortBaudRate

SerialPortParity

SerialPortDataBits

SerialPortStopBits

SerialPortFlowControl

See Also