SkipNFC

This package provides rudimentary support for Android and iOS NFC interaction for Skip apps.

Setup

To include this framework in your project, add the following dependency to your Package.swift file:

let package = Package(
    name: "my-package",
    products: [
        .library(name: "MyProduct", targets: ["MyTarget"]),
    ],
    dependencies: [
        .package(url: "https://source.skip.dev/skip-nfc.git", "0.0.0"..<"2.0.0"),
    ],
    targets: [
        .target(name: "MyTarget", dependencies: [
            .product(name: "SkipNFC", package: "skip-nfc")
        ])
    ]
)

Usage

let nfcAdapter: NFCAdapter = NFCAdapter()
nfcAdapter.startScanning { message in
    print("received message: \(message)")
}
nfcAdapter.stopScanning()

Setup

Android

• Add android.permission.NFC to your AndroidManifest.xml.

iOS

• Add Near Field Communication Tag Reader Session Formats Entitlements to your entitlements.
• Add NFCReaderUsageDescription to your Darwin/Info.plist.
• Add com.apple.developer.nfc.readersession.iso7816.select-identifiers to your Darwin/Info.plist as needed.

For example:

<key>com.apple.developer.nfc.readersession.formats</key>
<array>
    <string>NDEF</string>
</array>
<key>NSNFCReaderUsageDescription</key>
<string>This app requires access to NFC to read and write data to NFC tags.</string>

Building

This project is a free Swift Package Manager module that uses the Skip plugin to transpile Swift into Kotlin.

Building the module requires that Skip be installed using Homebrew with brew install skiptools/skip/skip. This will also install the necessary build prerequisites: Kotlin, Gradle, and the Android build tools.

Testing

The module can be tested using the standard swift test command or by running the test target for the macOS destination in Xcode, which will run the Swift tests as well as the transpiled Kotlin JUnit tests in the Robolectric Android simulation environment.

Parity testing can be performed with skip test, which will output a table of the test results for both platforms.

License

This software is licensed under the GNU Lesser General Public License v3.0, with a linking exception to clarify that distribution to restricted environments (e.g., app stores) is permitted.