Latest 0.1.0
Homepage https://github.com/thomi137/TICoreNFCExtensions
License MIT
Platforms ios 11.0
Authors

CI Status
Version
License
Platform

Motivation

As of iOS 11, Apple opened up their NFC hardware so developers can make their apps read NFC Tags that carry payloads compliant to the NDEF specification. When reading through the CoreNFC docs however, it seems clear that this is a framework in its making (it does not allow writing, e.g., nor can you make your phone react to a tag when as would be the case with Android; you have to have a dedicated app).

Usage

How to enable NFC

First of all, there is a capability called Near Field Communication Tag Reading in your project file, which you should turn on. You can then set a string that pops up whenever you tell your app to scan a tag in your info.plist. The string to look for is Privacy - NFC Scan Usage Description.

Starting an NFC Session

In the ViewController (or module) handling scanning, just import CoreNFC and you’re ready. In a trial app, just make your View Controller a NFCNDEFReaderSessionDelegate and add the two methods coming with it. The thing is that whenever you want to scan a tag, you need to create a NFCNDEFReaderSession (have a look at the example project. It’s basically how they do it in the docs. We suggest you trigger it via an UI interaction, since a modal will pop up telling you to touch the tag with your device. Have a look at the docs for details of how to set this up.

in your func readerSession(_ session: NFCNDEFReaderSession, didDetectNDEFs messages: [NFCNDEFMessage]) -> (), you receive an array of NFCNDEFMessages. The elements basically themselves contain arrays of NFCNDEFPayloads, which this pod extends (further wrapping planned… Hey! It’s a beta and this is my weekend!). This pod basically adds an additional

public var parsedPayload: TINFCNDEFType

to the NFCNDEFPayload class. It is basically a representation of the payload according to it’s NDEF Type Name Format. Again, see here for details. The TINFNDEFType is defined as:

public protocol TINFCNDEFType : CustomStringConvertible {
    var encodedPayload: String? { get }
    var locale: String? { get }
    var encoding: String.Encoding? { get }
}

which give you more accessible information about the payload than the CoreNFC framework does at the moment (implementations handle, e.g. encoding, url prefixing and locale matching, information that the core framework delivers in raw bytes…). To use this just do:

func readerSession(_ session: NFCNDEFReaderSession, didDetectNDEFs messages: [NFCNDEFMessage]){
  var type: String = "Unknown"
  var text: String = "No Text"      
  for message:NFCNDEFMessage in messages {          
    message.records.forEach({ (record) in
      NSLog("Record Type: (record.parsedPayload)")
      text = record.parsedPayload.encodedPayload!
      type = record.typeString
     })
     ...          
   }
}

Or whatever fits your need. You can easily inspect your payload further and act on whatever information is in the string representation.

Limitations

As of now, binary MIME types (such as image/jpeg) should not be handled with this pod. We will consider incorporating this but see no need given the limited capacity of a NFC tag (and again: weekend). Vcards, geo address URIs, and other well known URIs as by the NFC Record Type Format Specification will work just fine.

Example Project

To run the example project, clone the repo, and run pod install from the Example directory first.

Requirements

This Wrapper uses CoreNFC. CoreNFC requires iOS 11 so the wrapper or the example application won’t work on older version of iOS. Furthermore, as by the Specification, all NFC enabled Apps will only work on iPhones 7 and 7 Plus or newer.

Installation

TICoreNFCExtensions is available through CocoaPods. To install
it, simply add the following line to your Podfile:

pod 'TICoreNFCExtensions'

Author

Thomas Prosser, thomIT GmbH, [email protected]
Please feel free to submit pull requests.

License

TICoreNFCExtensions is available under the MIT license. See the LICENSE file for more info.

Latest podspec

{
    "name": "TICoreNFCExtensions",
    "version": "0.1.0",
    "summary": "Small wrapper around the new CoreNFC framework of iOS11",
    "description": "As of iOS11, Apple included the CoreNFC Framework to read NFC Tags/Chips.nThis wrapper extends the NFCNDEFPayload class to make it more convenient",
    "homepage": "https://github.com/thomi137/TICoreNFCExtensions",
    "license": {
        "type": "MIT",
        "file": "LICENSE"
    },
    "authors": {
        "Thomas Prosser": "[email protected]"
    },
    "source": {
        "git": "https://github.com/thomi137/TICoreNFCExtensions.git",
        "tag": "0.1.0"
    },
    "platforms": {
        "ios": "11.0"
    },
    "source_files": "TICoreNFCExtensions/Classes/**/*",
    "pushed_with_swift_version": "4.0"
}

Pin It on Pinterest

Share This