core-nfc

Read and write NFC tags using CoreNFC. Use when scanning NDEF tags, reading ISO7816/ISO15693/FeliCa/MIFARE tags, writing NDEF messages, handling NFC session lifecycle, configuring NFC entitlements, or implementing background tag reading in iOS apps.

By dpearson2699 · 3,166 installs

npx skills add dpearson2699/swift-ios-skills --skill core-nfc

Source repository · Upstream listing

CoreNFC Read and write NFC tags on iPhone using the CoreNFC framework. Covers NDEF reader sessions, tag reader sessions, NDEF message construction, entitlements, and background tag reading. Contents [Setup]( setup) [NDEF Reader Session]( ndef reader session) [Tag Reader Session]( tag reader session) [Writing NDEF Messages]( writing ndef messages) [NDEF Payload Types]( ndef payload types) [Background Tag Reading]( background tag reading) [Common Mistakes]( common mistakes) [Review Checklist]( review checklist) [References]( references) Setup Project Configuration 1. Add the Near Field Communication Tag Reading capability in Xcode 2. Add NFCReaderUsageDescription to Info.plist with a user facing reason string 3. Add the com.apple.developer.nfc.readersession.formats entitlement with the current TAG value; do not add legacy NDEF 4. For ISO 7816 tags, add supported application identifiers to com.apple.developer.nfc.readersession.iso7816.select identifiers in Info.plist 5. For FeliCa tags, add supported system codes to com.apple.developer.nfc.readersession.felica.systemcodes ; do not use wildcard system codes Device Requirements NFC reading requires iPhone 7 or later. Always check for reader session availability before creating NFC UI or sessions. Use the concrete reader session type you are about to create. Key Types Type Role NFCNDEFReaderSession Scans for NDEF formatted tags NFCTagReaderSession Scans for ISO7816, ISO15693, FeliCa, MIFARE tags NFCNDEFMessage Collection of NDEF payload records NFCNDEFPayload Single record within an NDEF message NFCNDEFTag Protocol for interacting with an NDEF capable tag NDEF Reader Session Use NFCNDEFReaderSession to read NDEF formatted data from tags. This is the simplest path for reading standard tag content like URLs, text, and MIME data. Reading with Tag Connection For read write operations, use the tag detection delegate method to connect to individual tags: Tag Reader Session Use NFCTagReaderSession when you need direct access to the native tag protocol (ISO 7816, ISO 15693, FeliCa, or MIFARE). Polling option Tags .iso14443 ISO 7816 compatible and MIFARE .iso15693 ISO 15693 .iso18092 FeliCa Do not use this session for payment related AIDs. Load [nfc patterns.md](references/nfc patterns.md) for protocol specific connection, APDU, command, and response handling. Writing NDEF Messages Write NDEF data to a connected tag. Always check readWrite status first. NDEF Payload Types Creating Common Payloads Parsing Payload Content Load [Parsing NDEF Payload Content](references/nfc patterns.md parsing ndef payload content) for the complete type name format switch and multi record handling. Background Tag Reading On iPhone XS and later, iOS can read NFC tags in the background without opening your app. The NDEF message must contain a URI record ( typeNameFormat == .nfcWellKnown , type U ). If there are multiple URI records, the system uses the first one. For app specific routing, write a universal link to the tag and configure the Associated Domains capability for that domain. Background tag reading also supports specific system URL schemes such as web, email, SMS, telephone, FaceTime, Maps, and HomeKit setup. It does not support custom URL schemes, and the system does not route by bundle ID or arbitrary NDEF content type. When a user taps a compatible tag, iOS displays a notification that opens your app. Handle the tag data via NSUserActivity : Common Mistakes DON'T: Use stale or missing NFC entitlements Without the com.apple.developer.nfc.readersession.formats entitlement, reader sessions cannot access NFC hardware. Use the current TAG value for Core NFC reader sessions; do not copy older examples that add NDEF . DON'T: Ignore session invalidation errors The session invalidates for multiple reasons. Distinguishing user cancellation from real errors prevents false error alerts. DON'T: Hold a strong reference to a stale session Once a session is invalidated, it cannot be restarted. Nil out your reference and create a new session for the next scan. Review Checklist [ ] NFC capability added in Signing & Capabilities [ ] NFCReaderUsageDescription set in Info.plist [ ] com.apple.developer.nfc.readersession.formats entitlement uses TAG , not legacy NDEF [ ] NFCNDEFReaderSession.readingAvailable or NFCTagReaderSession.readingAvailable checked before creating sessions [ ] Session delegate set before calling begin() [ ] Session reference set to nil after invalidation [ ] didInvalidateWithError distinguishes user cancellation from actual errors [ ] NDEF status queried before write operations [ ] Tag capacity checked before writing large messages [ ] ISO 7816 application identifiers listed in Info.plist if using NFCTagReaderSession [ ] FeliCa system codes listed in Info.plist when polling .iso18092 [ ] Background tag reading uses a URI NDEF record and universal links or supported system URL schemes [ ] Custom URL schemes, bundle IDs, or arbitrary NDEF content types are not used for background routing [ ] Payment related AIDs are routed away from NFCTagReaderSession [ ] Only one reader session active at a time References Extended patterns (ISO 7816 commands, multi tag scanning, NDEF locking): [references/nfc patterns.md](references/nfc patterns.md) [Core NFC framework](https://sosumi.ai/documentation/corenfc) [NFCNDEFReaderSession](https://sosumi.ai/documentation/corenfc/nfcndefreadersession) [NFCTagReaderSession](https://sosumi.ai/documentation/corenfc/nfctagreadersession) [NFCNDEFMessage](https://sosumi.ai/documentation/corenfc/nfcndefmessage) [NFCNDEFPayload](https://sosumi.ai/documentation/corenfc/nfcndefpayload) [NFCNDEFTag](https://sosumi.ai/documentation/corenfc/nfcndeftag) [NFCNDEFReaderSessionDelegate](https://sosumi.ai/documentation/corenfc/nfcndefreadersessiondelegate) [NFCTagReaderSessionDelegate](https://sosumi.ai/documentation/corenfc/nfctagreadersessiondelegate) [Building an NFC Tag Reader App](https://sosumi.ai/documentation/corenfc/building an nfc tag reader app) [Adding Support for Background Tag Reading](https://sosumi.ai/documentation/corenfc/adding support for background tag reading) [Near Field Communication Tag Reader Session Formats Entitlement](https://sosumi.ai/documentation/bundleresources/entitlements/com.apple.developer.nfc.readersession.formats) [ISO7816 application identifiers for NFC Tag Reader Session](https://sosumi.ai/documentation/bundleresources/entitlements/com.apple.developer.nfc.readersession.iso7816.select identifiers) [ISO18092 system codes for NFC Tag Reader Session](https://sosumi.ai/documentation/bundleresources/entitlements/com.apple.developer.nfc.readersession.felica.systemcodes)