nfc_io 1.0.2+1

  • Readme
  • Changelog
  • Example
  • Installing
  • 81

Flutter NFC Reader #

NFC

A new flutter plugin to help developers looking to use internal hardware inside Android devices (For now, iOS coming soon) for reading NFC tags.

It starts a reading session that keeps scanning tags until it is manually turned off. You can trigger the stop event manually using a dedicated function.

Supported NFC Format #

PlatformSupported Tags/Cards
AndroidNDEF:,A, B, F, V, BARCODE, MIFARE
iOS (Coming Soon)NDEF: NFC TYPE 1, 2, 3, 4, 5

Installation #

Add to pubspec.yaml:

dependencies:
  nfc_io:
    git:
      url: git@github.com:agent306/nfc_io.git
      ref: master

and then run the shell command

flutter packages get

import the plugin to your project:

import 'package:nfc_io/nfc_io.dart';

How to use #

Android setup #

Add these two lines to your AndroidManifest.xml on the top

<uses-permission android:name="android.permission.NFC" />
<uses-feature android:name="android.hardware.nfc"/>

iOS setup #

Coming soon...

Read NFC #

This function will return a stream, the read session will be kept open until otherwise closed. The stream will return a NfcData model whenever an NFC tag/card is detected. This model contains:

FieldDescription
idId of the tag
contentContent of the tag (Blank if not an NDEF)
errorIf any error occurs, null otherwise
statusEither none, reading, read, stopped or error
Future<void> startNFC() async {
    StreamSubscription _subscription = NfcIo.startReading.listen((NfcData data) {
        print(data);
    });
}

Stop NFC #

Future<void> stopNFC() async {
    if (_subscription != null) {
        _subscription.cancel();
        NfcData result = await NfcIo.stopReading;
        print(result);
    }
}

For better details look at the demo app.

Getting Started #

This project is a starting point for a Flutter plug-in package, a specialized package that includes platform-specific implementation code for Android and/or iOS.

For help getting started with Flutter, view our online documentation, which offers tutorials, samples, guidance on mobile development, and a full API reference.

1.0.2+1 #

  • Updated the read me to include supported tag/cards

1.0.2 #

  • Updated kotlin version on plugin library

1.0.1 #

  • Updated kotlin version

0.0.1 #

  • Updated read me
  • Migrated to Android X

0.0.1 #

  • Intial Release.

example/README.md

Flutter NFC Reader Example #

Read NFC #

This function will return a stream, the read session will be kept open until otherwise closed. The stream will return a NfcData model whenever an NFC tag/card is detected. This model contains:

FieldDescription
idId of the tag
contentContent of the tag (Blank if not an NDEF)
errorIf any error occurs, null otherwise
statusEither none, reading, read, stopped or error
Future<void> startNFC() async {
    StreamSubscription _subscription = NfcIo.startReading.listen((NfcData data) {
        print(data);
    });
}

Stop NFC #

Future<void> stopNFC() async {
    if (_subscription != null) {
        _subscription.cancel();
        NfcData result = await NfcIo.stopReading;
        print(result);
    }
}

Getting Started #

This project is a starting point for a Flutter application.

A few resources to get you started if this is your first Flutter project:

For help getting started with Flutter, view our online documentation, which offers tutorials, samples, guidance on mobile development, and a full API reference.

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  nfc_io: ^1.0.2+1

2. Install it

You can install packages from the command line:

with Flutter:


$ flutter pub get

Alternatively, your editor might support flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:nfc_io/nfc_io.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
62
Health:
Code health derived from static analysis. [more]
99
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
100
Overall:
Weighted score of the above. [more]
81
Learn more about scoring.

We analyzed this package on Oct 22, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.5.1
  • pana: 0.12.21
  • Flutter: 1.9.1+hotfix.4

Platforms

Detected platforms: Flutter

References Flutter, and has no conflicting libraries.

Health issues and suggestions

Document public APIs. (-1 points)

23 out of 23 API elements have no dartdoc comment.Providing good documentation for libraries, classes, functions, and other API elements improves code readability and helps developers find and use your API.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.1.0 <3.0.0
flutter 0.0.0
Transitive dependencies
collection 1.14.11 1.14.12
meta 1.1.7
sky_engine 0.0.99
typed_data 1.1.6
vector_math 2.0.8
Dev dependencies
flutter_test