Skip to main content

A Python wrapper for the rfIDEAS Reader Integration Kit library

Project description

Reader Integration Kit - Python Binding

A Python wrapper for the rf IDEAS Reader Integration Kit native library. This package enables Python applications to communicate with rf IDEAS readers using a high-level reader interface.

Supported Platforms

This package is distributed as platform-specific builds:

Platform Package Name
Linux (x86_64) reader-integration-kit-linux-x86-64
Windows (x86_64) reader-integration-kit-windows-x86-64

Installation

Install the package for your platform using pip:

Linux:

pip install reader-integration-kit-linux-x86-64

Windows:

pip install reader-integration-kit-windows-x86-64

Note: You must install the package that matches your operating system. There is no universal package that covers all platforms.

Prerequisites

  • Python 3.6 or later
  • An rf IDEAS reader (e.g., WaveID) connected to your system
  • On Linux, appropriate udev rules may be required for USB reader access

Usage

Import the reader_integration_kit module and create an instance of Reader. The facade uses handles to manage reader instances, allowing you to interact with multiple readers concurrently.

WaveID Reader Example

import reader_integration_kit.facade as reader
from reader_integration_kit.structures import ReaderDefinition, DeviceId, SerialPortSettings
from reader_integration_kit.enum import ProtocolType, BeepDuration, BeepVolume

# Create a reader definition for WaveID
reader_def = ReaderDefinition(
    DeviceId=DeviceId(VendorId=0x0c27, ProductId=0x3bfa),
    ProtocolType=ProtocolType.FEATURE_REPORT,
    SerialPortSettings=SerialPortSettings()
)

# Create a WaveID reader instance
with reader.Reader(reader_def, retry_count=3) as waveid:
    # Initialize the reader
    waveid.init()

    # Get reader metadata (populated lazily on first access)
    metadata_dict = waveid.get_metadata()
    print(f"Part Number: {metadata_dict.get('PartNumber', 'N/A')}")

    # Force refresh metadata from device
    metadata_dict = waveid.get_metadata(force_refresh=True)

    # Beep the reader
    waveid.beep(2, BeepDuration.BEEP_DURATION_SHORT)

    # Get beeper volume
    volume = waveid.get_beeper_volume()
    print(f"Beeper Volume: {volume}")

    # Set beeper volume
    waveid.set_beeper_volume(BeepVolume.BEEP_VOLUME_HIGH)

Note: The Reader class manages reader handles internally. Each instance corresponds to a single reader handle. You can create multiple Reader instances to interact with multiple readers simultaneously. Resources are automatically released when exiting the context manager (with statement) or when the object is garbage collected.

Documentation

For integration guides and complete API reference, see the rf IDEAS Documentation.

License

This package is proprietary software distributed by rf IDEAS, Inc. Use of this package is subject to the End-User License Agreement (EULA) included with the package. See the included rfIDEAS_EULA.txt for full terms and conditions.


Copyright rf IDEAS, Inc. All rights reserved.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file reader_integration_kit_linux_aarch64-1.4.0.tar.gz.

File metadata

File hashes

Hashes for reader_integration_kit_linux_aarch64-1.4.0.tar.gz
Algorithm Hash digest
SHA256 82d1a00e8f9dee09fd7c3d030aa3a5c972ac4fb37f5fe36a48e186f6156bcba3
MD5 0addb96bbda1c2bf4d922643c4b4a652
BLAKE2b-256 e42d6c76210066e8215f3583c2722933baac6975a7b3f65465e18b0135e8bd56

See more details on using hashes here.

File details

Details for the file reader_integration_kit_linux_aarch64-1.4.0-py3-none-any.whl.

File metadata

File hashes

Hashes for reader_integration_kit_linux_aarch64-1.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2afb4b245cede3d9e5974c5365f73bb88d9a6bb88f9f1e3d0df2889c675101b9
MD5 1aab5f3078d1ba6bb298032154cdb4db
BLAKE2b-256 0c5a61d43a9c0e8e33df4e720fee0bd2acd7f20dc5666ed88e144e147c6b4493

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page