reader-integration-kit-linux-armhf 1.4.0__py3-none-any.whl

reader_integration_kit/__init__.py

@@ -0,0 +1,12 @@
+from reader_integration_kit.facade import (
+    AbstractReader,
+    Reader, 
+    ReaderHandle
+)
+
+__all__ = [
+    'AbstractReader',
+    'Reader', 
+    'ReaderHandle'
+]
+

reader_integration_kit/enum/__init__.py

@@ -0,0 +1,28 @@
+from reader_integration_kit.enum.beep_duration import BeepDuration
+from reader_integration_kit.enum.beep_volume import BeepVolume
+from reader_integration_kit.enum.ble_data_type import BleDataType
+from reader_integration_kit.enum.checkpoint_type import CheckpointType
+from reader_integration_kit.enum.led_color import LedColor
+from reader_integration_kit.enum.protocol_type import ProtocolType
+from reader_integration_kit.enum.reader_module_id import ReaderModuleId
+from reader_integration_kit.enum.reader_module_state import ReaderModuleState
+from reader_integration_kit.enum.proximity_card_type import ProximityCardType
+from reader_integration_kit.enum.serial_port_baud_rate import SerialPortBaudRate
+from reader_integration_kit.enum.serial_port_data_bits import SerialPortDataBits
+from reader_integration_kit.enum.serial_port_flow_control import SerialPortFlowControl
+from reader_integration_kit.enum.serial_port_parity import SerialPortParity
+from reader_integration_kit.enum.serial_port_stop_bits import SerialPortStopBits
+from reader_integration_kit.enum.data_conversion_type import DataConversionType
+from reader_integration_kit.enum.field_definition_type import FieldDefinitionType
+from reader_integration_kit.enum.blob_type import BlobType
+from reader_integration_kit.enum.transparent_mode_state import TransparentModeState
+from reader_integration_kit.enum.transparent_mode_status import TransparentModeStatus
+
+__all__ = [
+    'BeepDuration', 'BeepVolume', 'BleDataType', 'CheckpointType', 'LedColor', 'ProtocolType',
+    'ProximityCardType', 'ReaderModuleId', 'ReaderModuleState',
+    'SerialPortBaudRate', 'SerialPortDataBits', 'SerialPortFlowControl',
+    'SerialPortParity', 'SerialPortStopBits', 'DataConversionType',
+    'FieldDefinitionType', 'BlobType',  'TransparentModeState',
+    'TransparentModeStatus'
+]

reader_integration_kit/enum/beep_duration.py

@@ -0,0 +1,12 @@
+import enum
+from ctypes import c_uint8
+
+
+class BeepDuration(enum.IntEnum):
+    BEEP_DURATION_SHORT = 0
+    BEEP_DURATION_LONG = 1
+
+    @classmethod
+    def from_param(cls, obj):
+        return c_uint8(obj.value if isinstance(obj, cls) else obj)
+

reader_integration_kit/enum/beep_volume.py

@@ -0,0 +1,15 @@
+import enum
+from ctypes import c_uint8
+
+
+class BeepVolume(enum.IntEnum):
+    BEEP_VOLUME_OFF = 0
+    BEEP_VOLUME_LOW = 1
+    BEEP_VOLUME_MEDIUM = 2
+    BEEP_VOLUME_HIGH = 3
+    BEEP_VOLUME_UNKNOWN = 255
+
+    @classmethod
+    def from_param(cls, obj):
+        return c_uint8(obj.value if isinstance(obj, cls) else obj)
+

reader_integration_kit/enum/ble_data_type.py

@@ -0,0 +1,12 @@
+import enum
+from ctypes import c_uint8
+
+
+class BleDataType(enum.IntEnum):
+    DATA = 1
+    KEY = 2
+    UNENCRYPTED_KEY = 3
+
+    @classmethod
+    def from_param(cls, obj):
+        return c_uint8(obj.value if isinstance(obj, cls) else obj)

reader_integration_kit/enum/blob_type.py

@@ -0,0 +1,27 @@
+import enum
+from ctypes import c_uint8
+
+class BlobType(enum.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
+
+    @classmethod
+    def from_param(cls, obj):
+        return c_uint8(obj.value if isinstance(obj, cls) else obj)

reader_integration_kit/enum/checkpoint_type.py

@@ -0,0 +1,13 @@
+import enum
+from ctypes import c_uint8
+
+
+class CheckpointType(enum.IntEnum):
+    UNDEFINED = 0
+    FACTORY_DEFAULTS = 1
+    USER_SETTINGS = 2
+    RESERVED = 0xFF
+
+    @classmethod
+    def from_param(cls, obj):
+        return c_uint8(obj.value if isinstance(obj, cls) else obj)

reader_integration_kit/enum/data_conversion_type.py

@@ -0,0 +1,12 @@
+import enum
+from ctypes import c_uint8
+
+class DataConversionType(enum.IntEnum):
+    DECIMAL = 0
+    ASCII = 1
+    HEXADECIMAL = 2
+    OCTAL = 3
+
+    @classmethod
+    def from_param(cls, obj):
+        return c_uint8(obj.value if isinstance(obj, cls) else obj)

reader_integration_kit/enum/field_definition_type.py

@@ -0,0 +1,14 @@
+import enum
+from ctypes import c_uint8
+
+class FieldDefinitionType(enum.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
+
+    @classmethod
+    def from_param(cls, obj):
+        return c_uint8(obj.value if isinstance(obj, cls) else obj)

reader_integration_kit/enum/led_color.py

@@ -0,0 +1,15 @@
+import enum
+from ctypes import c_uint8
+
+
+class LedColor(enum.IntEnum):
+    INVALID = 0
+    OFF = 1
+    RED = 2
+    GREEN = 3
+    AMBER = 4
+    UNKNOWN = 0xff
+
+    @classmethod
+    def from_param(cls, obj):
+        return c_uint8(obj.value if isinstance(obj, cls) else obj)

reader_integration_kit/enum/protocol_type.py

@@ -0,0 +1,14 @@
+import enum
+from ctypes import c_uint8
+
+
+class ProtocolType(enum.IntEnum):
+    INVALID = 0x00
+    FEATURE_REPORT = 0x01
+    SERIAL_BINARY = 0x03
+    UNKNOWN = 0xFF
+
+    @classmethod
+    def from_param(cls, obj):
+        return c_uint8(obj.value if isinstance(obj, cls) else obj)
+

reader_integration_kit/enum/proximity_card_type.py

@@ -0,0 +1,166 @@
+"""
+ProximityCardType enum for representing card types supported by readers.
+"""
+from enum import IntEnum
+
+
+class ProximityCardType(IntEnum):
+    """
+    Proximity card types supported by readers.
+    Each value represents a 16-bit card type code as returned by the reader firmware.
+    """
+    OFF = 0x0000
+    
+    # HID 13.56 MHz Cards
+    HID_ICLASS_ID = 0x0100
+    HID_SEOS = 0x0101
+    HID_APPLE_WALLET = 0x0102
+    
+    # MIFARE Secure File Data
+    MIFARE_CLASSIC_SECURE_FILE_DATA = 0x0301
+    MIFARE_DESFIRE_SECURE_FILE_DATA = 0x0201
+    MIFARE_DESFIRE_CSN_PLUS_SECURE_FILE = 0x0202
+    MIFARE_DESFIRE_SECURE_FILE_DATA_NESTLE = 0x0203
+    MIFARE_PLUS_SECURE_FILE_DATA = 0x0601
+    MIFARE_ULTRALIGHT_SECURE_FILE_DATA = 0x0501
+    MIFARE_2GO = 0x030E
+    ECP_2_0 = 0x030D
+    ALLEGION_HCE = 0x0206
+    
+    # Gematik & PIV
+    GEMATIK_ICCSN = 0x0401
+    
+    # FeliCa
+    FELICA_DATA_STANDARD = 0x0701
+    FELICA_DATA_LITE = 0x0702
+    
+    # LEGIC
+    LEGIC_NEON = 0x0801
+    LEGIC_NEON_BLE = 0x0802
+    
+    # FIDO2/U2F
+    FIDO2_U2F = 0x6F00
+    
+    # RDR-758x Equivalents
+    RDR_758X_EQUIVALENT = 0x6F01
+    RDR_758X_EXPANDED_CSN = 0x6F02
+    RDR_758X_EXPANDED_FOR_LEGIC = 0x6F03
+    
+    # PIV
+    PIV_UNIQUE_CARD_HOLDER_IDENTIFIER = 0x7702
+    FICAM = 0x7701
+    
+    # LEGIC CSN
+    LEGIC_RF_STANDARD_PRIME_CSN = 0x7901
+    LEGIC_STAMP = 0x7803
+    
+    # CEPAS
+    CEPAS = 0x7A01
+    
+    # ISO 14443B
+    ISO_14443B_CSN = 0x7B01
+    ISO_14443B_SRX_CSN = 0x7B02
+    
+    # FeliCa CSN
+    FELICA_CSN = 0x7C02
+    
+    # HID iCLASS CSN
+    HID_ICLASS_CSN = 0x7D01
+    
+    # I-Code & ISO 15693
+    I_CODE_CSN = 0x7E01
+    ETAG_CSN = 0x7E31
+    ISO_15693_CSN = 0x7E21
+    MY_D_CSN = 0x7E11
+    TAG_IT_CSN = 0x7E41
+    LEGIC_ADVANT_15693_CSN = 0x7E51
+    
+    # DESFire, MIFARE, Topaz, I-tag, LEGIC
+    DESFIRE_CSN = 0x7F01
+    TOPAZ_CSN = 0x7F02
+    MIFARE_32_DOWNLOADER = 0x7F06
+    MIFARE_48_DOWNLOADER = 0x7F07
+    MIFARE_56_DOWNLOADER = 0x7F08
+    MIFARE_32_ATS8600 = 0x7F09
+    MIFARE_48_ATS8600 = 0x7F0A
+    MIFARE_56_ATS8600 = 0x7F0B
+    I_TAG_CSN = 0x7F11
+    ISO_14443A_CSN = 0x7F21
+    LEGIC_ADVANT_14443A_CSN = 0x7F31
+    MIFARE_CSN = 0x7F41
+    MIFARE_ULTRALIGHT_CSN = 0x7F51
+    
+    # TCOS
+    TCOS = 0x7801
+    
+    # Bluetooth/Mobile
+    ORANGE_PACK_ID = 0x8001
+    MOBILE_CREDENTIAL = 0x8101
+    BLE_BEACON = 0x8201
+    SAFETRUST = 0x8401
+    HID_MOBILE_ACCESS = 0x8501
+    PSIA_PKOC = 0x8601
+    WAVELYNX_MY_PASS_ID = 0x8701
+    WAVELYNX_NFC_WALLET_PLUS_LEAF = 0x030F
+    WAVELYNX_NFC_WALLET = 0x0309
+    
+    # 125 kHz Cards
+    NEDAP = 0xE301
+    ID_TECK = 0xE401
+    ID_TECK_ALTERNATE = 0xE402
+    ID_TECK_LEGACY_PLUS = 0xE403
+    CDVI = 0xE912
+    PARADOX = 0xE902
+    POSTECH = 0xE922
+    KERI = 0xEA01
+    KERI_PSC1_26_BIT = 0xEA02
+    KERI_NXT_UID = 0xEA01
+    FARPOINTE_DATA_PYRAMID_PSC1_26_BIT = 0xEA22
+    PYRAMID_PSC1_26_BIT = 0xEA12
+    PYRAMID_UID = 0xEA11
+    FARPOINTE_DATA_PYRAMID_UID = 0xEA21
+    SECURA_KEY_01 = 0xEC01
+    RADIO_KEY_02 = 0xEB02
+    INDALA_ASP_PLUS = 0xED02
+    INDALA_ASP_PLUS_CUSTOM = 0xED05
+    HID_PROX = 0xEF04
+    HID_PROX_UID = 0xEF01
+    READY_KEY_PRO_UID = 0xF004
+    DIMPNA = 0xF101
+    HI_TAG_2 = 0xF201
+    HI_TAG_2_ALTERNATE = 0xF204
+    HI_TAG_2_ATS8600 = 0xF205
+    HI_TAG_2_DOWNLOADER = 0xF206
+    HI_TAG_1_AND_S = 0xF302
+    HI_TAG_1_AND_S_ALTERNATE = 0xF304
+    DEISTER = 0xF401
+    G_PROX_II_UID_RDR_6G8X = 0xF502
+    G_PROX_II_UID = 0xF503
+    G_PROX_II_ID = 0xF504
+    CARDAX = 0xF602
+    RUSSWIN = 0xF612
+    NEXWATCH_HONEYWELL = 0xF712
+    NEX_KEY_QUADRAKEY_KEY_MATE_2_SMART_KEY = 0xF722
+    NEX_KEY_QUADRAKEY_KEY_MATE_2_SMART_KEY_NEX_WATCH = 0xF702
+    KERI_UID_RDR_6K8X = 0xF802
+    KERI_UID = 0xF801
+    IO_PROX_KANTECH = 0xF902
+    IO_PROX_KANTECH_ALTERNATE = 0xF903
+    AWID = 0xFA02
+    ISONAS = 0xFA03
+    EM410X = 0xFB01
+    EM410X_ALTERNATE = 0xFB02
+    EM410X_WITH_CHECKSUM = 0xFB03
+    DIGITAG = 0xFB11
+    ROSSLARE = 0xFB21
+    CASI_RUSCO = 0xFC02
+    URMET = 0xFC03
+    INDALA_ASP_26_BIT = 0xFD02
+    INDALA_ASP_UID = 0xFD01
+    INDALA_ASP_CUSTOM = 0xFD04
+    INDALA_ECR_CUSTOM = 0xFD05
+    LF_COMPOSITE = 0xDE01
+    COTAG = 0xDF01
+    
+    # Unknown/Invalid
+    UNKNOWN = 0xFFFF

reader_integration_kit/enum/reader_module_id.py

@@ -0,0 +1,13 @@
+import enum
+from ctypes import c_uint8
+
+
+class ReaderModuleId(enum.IntEnum):
+    INVALID = 0x00
+    LOW_FREQUENCY_RADIO = 0x01
+    HIGH_FREQUENCY_RADIO = 0x02
+    BLE_RADIO = 0x03
+
+    @classmethod
+    def from_param(cls, obj):
+        return c_uint8(obj.value if isinstance(obj, cls) else obj)

reader_integration_kit/enum/reader_module_state.py

@@ -0,0 +1,12 @@
+import enum
+from ctypes import c_uint32
+
+
+class ReaderModuleState(enum.IntEnum):
+    INVALID = 0x00
+    POWER_OFF = 0x00000080
+    POWER_ON_NORMAL = 0x00000081
+
+    @classmethod
+    def from_param(cls, obj):
+        return c_uint32(obj)

reader_integration_kit/enum/serial_port_baud_rate.py

@@ -0,0 +1,15 @@
+from enum import IntEnum
+
+
+class SerialPortBaudRate(IntEnum):
+    INVALID = 0
+    BAUD_9600 = 9600
+    BAUD_14400 = 14400
+    BAUD_32400 = 32400
+    BAUD_19200 = 19200
+    BAUD_57600 = 57600
+    BAUD_115200 = 115200
+    BAUD_230400 = 230400
+    BAUD_576000 = 576000
+    BAUD_921600 = 921600
+

reader_integration_kit/enum/serial_port_data_bits.py

@@ -0,0 +1,10 @@
+from enum import IntEnum
+
+
+class SerialPortDataBits(IntEnum):
+    INVALID = 0
+    DATA_BITS_5 = 1
+    DATA_BITS_6 = 2
+    DATA_BITS_7 = 3
+    DATA_BITS_8 = 4
+

reader_integration_kit/enum/serial_port_flow_control.py

@@ -0,0 +1,11 @@
+from enum import 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
+

reader_integration_kit/enum/serial_port_parity.py

@@ -0,0 +1,10 @@
+from enum import IntEnum
+
+
+class SerialPortParity(IntEnum):
+    NONE = 0
+    ODD = 1
+    EVEN = 2
+    MARK = 3
+    SPACE = 4
+

reader_integration_kit/enum/serial_port_stop_bits.py

@@ -0,0 +1,9 @@
+from enum import IntEnum
+
+
+class SerialPortStopBits(IntEnum):
+    NONE = 0
+    ONE = 1
+    TWO = 2
+    ONE_POINT_FIVE = 3
+

reader_integration_kit/enum/transparent_mode_state.py

@@ -0,0 +1,11 @@
+import enum
+from ctypes import c_uint8
+
+
+class TransparentModeState(enum.IntEnum):
+    DISABLED = 0
+    ENABLED = 1
+
+    @classmethod
+    def from_param(cls, obj):
+        return c_uint8(obj.value if isinstance(obj, cls) else obj)

reader_integration_kit/enum/transparent_mode_status.py

@@ -0,0 +1,11 @@
+import enum
+from ctypes import c_uint8
+
+
+class TransparentModeStatus(enum.IntEnum):
+    NOT_READY = 0
+    READY = 1
+
+    @classmethod
+    def from_param(cls, obj):
+        return c_uint8(obj.value if isinstance(obj, cls) else obj)

reader_integration_kit/errors/__init__.py

@@ -0,0 +1,4 @@
+from reader_integration_kit.errors.reader_exception import ReaderException
+
+__all__ = ['ReaderException']
+

reader_integration_kit/errors/reader_exception.py

@@ -0,0 +1,58 @@
+from reader_integration_kit.structures.rik_result import RikResult
+
+
+class ReaderException(Exception):
+    """Exception class for Reader layer errors."""
+    
+    def __init__(self, result: RikResult):
+        self._has_exception = result.has_exception
+        self._exception_type = result.exception_type
+        self._message = result.message
+        self._function_name = result.function_name
+        self._line_number = result.line_number
+        self._file_name = result.file_name
+        self._has_protocol_exception = result.has_protocol_exception
+        self._protocol_exception_type = result.protocol_exception_type
+        self._protocol_message = result.protocol_message
+        self._protocol_file_name = result.protocol_file_name
+        self._protocol_line_number = result.protocol_line_number
+        self._protocol_function_name = result.protocol_function_name
+        
+        # Build the main message
+        msg = f"Reader Exception: {self._exception_type}"
+        if self._message:
+            msg += f" - {self._message}"
+        if self._has_protocol_exception:
+            msg += f" [Protocol Exception: {self._protocol_exception_type}"
+            if self._protocol_message:
+                msg += f" - {self._protocol_message}"
+            msg += "]"
+        
+        super().__init__(msg)
+        self.message = msg
+
+    def __str__(self):
+        return self.message
+
+    @property
+    def has_protocol_exception(self) -> bool:
+        """Check if this exception includes protocol exception information."""
+        return self._has_protocol_exception
+
+    @property
+    def protocol_exception_type(self) -> str:
+        """Get protocol exception type (only valid if has_protocol_exception is True)."""
+        return self._protocol_exception_type
+
+    @property
+    def protocol_message(self) -> str:
+        """Get protocol exception message (only valid if has_protocol_exception is True)."""
+        return self._protocol_message
+
+    @classmethod
+    def raise_if_error(cls, result: RikResult) -> RikResult:
+        """Raise an exception if the result indicates an error."""
+        if result.has_exception:
+            raise ReaderException(result)
+        return result
+