Keyple Interop Local Reader NFC Mobile Library
Overview
| |
|---|
| Description | The Keyple Interop Local Reader NFC Mobile Library is a Kotlin Multiplatform adapter that provides an implementation of the LocalReader SPI required by the Keyple Interop JSON API Client Library, specifically designed for mobile NFC readers.
It enables non-Keyple applications to interact with the built-in NFC readers of Android and iOS devices, making it possible to perform smart card communication in compliance with the Keyple interop model. This library is optimized for mobile platforms and serves as a bridge between the application logic and the device’s native NFC capabilities, facilitating seamless integration without requiring a full Keyple stack. |
| Intended Audience | Developers creating non-Keyple client applications. |
| Compatible OS | Android, iOS. |
Implementations
| |
|---|
| Latest Version | 0.1.6 |
| Changelog | List of changes and new features introduced in each release. |
| GitHub | Source code repository and issue tracker for the Java project. |
| User Guide | Step-by-step guide to learn how to build a non-Keyple client. |
| API Reference | Complete documentation of all classes and methods in the Java API. |
| UML Class Diagram | UML diagram showing the structure and relationships between classes. |
| Maven Central | Official Maven Central page to include the Java component in your project. |
Here is a summary table describing the purpose and usage of each target module generated by this Kotlin Multiplatform
library, including the root (no-suffix) module and platform-specific variants:
| Artifact ID | Format | Purpose | Main Use Case |
|---|
keyple-interop-localreader-nfcmobile-kmp-lib | .jar | Common code shared across all platforms | Used by multiplatform consumers to pull platform variants |
keyple-interop-localreader-nfcmobile-kmp-lib-jvm | .jar | Non-Android JVM applications | Used in backend apps, desktop apps, or CLI |
keyple-interop-localreader-nfcmobile-kmp-lib-android | .aar | Production Android apps | Integrated into final APK/AAB builds |
keyple-interop-localreader-nfcmobile-kmp-lib-iosarm64 | .klib | Real iOS devices (ARM64 architecture) | Required for running the app on physical iPhones |
keyple-interop-localreader-nfcmobile-kmp-lib-iossimulatorarm64 | .klib | iOS Simulator on Apple Silicon Macs (ARM64) | Used for development/testing on simulators on M1/M2 Macs |
keyple-interop-localreader-nfcmobile-kmp-lib-iosx64 | .klib | iOS Simulator on Intel-based Macs (x86_64) | Used for development/testing on simulators on Intel Macs |
| iOS artifact | TBD | iOS applications | Integrated directly into final iOS apps |
- The root module serves as the entry point for consumers. When you add
implementation("[root-lib]"), Gradle
automatically selects the correct variant (jvm, android, etc.) based on the target platform. - The platform-specific modules (android, jvm, etc.) contain compiled code that can be executed or packaged directly.
Last updated on 2025-10-21