Package Exports

nfc-pcsc

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (nfc-pcsc) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

nfc-pcsc

A simple wrapper around pokusew/node-pcsclite to work easier with NFC tags.

Built-in support for reading card UIDs and reading tags emulated with Android HCE.

NOTE: Reading tag UID and methods for writing and reading tag content depend on NFC reader commands support. It is tested to work with ARC122 USB reader but it can work with others too.
When detecting tags does not work see Alternative usage.

Installing

Using npm

npm install nfc-pcsc --save

Usage

If you want see it in action, clone this repository, install dependencies with npm and run npm run test.
git clone https://github.com/pokusew/nfc-pcsc.git
npm install
npm run test

import NFC from 'nfc-pcsc';

const nfc = new NFC(); // optionally you can pass logger

nfc.on('reader', reader => {

    console.log(`${reader.reader.name}  device attached`);

    // needed for reading tags emulated with Android HCE
    // custom AID, change according to your Android for tag emulation
    // see https://developer.android.com/guide/topics/connectivity/nfc/hce.html
    reader.aid = 'F222222222';

    reader.on('card', card => {

        // card is object containig folowing data
        // [always] String type: TAG_ISO_14443_3 (standard nfc tags like Mifare) or TAG_ISO_14443_4 (Android HCE and others)
        // [only TAG_ISO_14443_3] String uid: tag uid
        // [only TAG_ISO_14443_4] Buffer data: raw data from select APDU response

        console.log(`${reader.reader.name}  card detected`, card);

    });

    reader.on('error', err => {
        console.log(`${reader.reader.name}  an error occurred`, err);
    });

    reader.on('end', () => {
        console.log(`${reader.reader.name}  device removed`);
    });

});

nfc.on('error', err => {
    console.log('an error occurred', err);
});

Alternative usage

You can disable auto processing of tags and process them yourself. It may be useful when you are using other than ARC122 USB reader.

import NFC from 'nfc-pcsc';

const nfc = new NFC(); // optionally you can pass logger

nfc.on('reader', reader => {

    // disable auto processing
    reader.autoProcessing = false;

    console.log(`${reader.reader.name}  device attached`);

    // needed for reading tags emulated with Android HCE
    // custom AID, change according to your Android for tag emulation
    // see https://developer.android.com/guide/topics/connectivity/nfc/hce.html
    reader.aid = 'F222222222';

    reader.on('card', card => {
        
        // card is object containig folowing data
           // String standard: TAG_ISO_14443_3 (standard nfc tags like Mifare) or TAG_ISO_14443_4 (Android HCE and others)
        // Buffer atr
        // Number protocol
        
        console.log(`${reader.reader.name}  card inserted`, card);
        
        // you can use reader.transmit to send commands and retrieve data
        // see https://github.com/pokusew/nfc-pcsc/blob/master/src/Reader.js#L224
        
    });

    reader.on('error', err => {
        console.log(`${reader.reader.name}  an error occurred`, err);
    });

    reader.on('end', () => {
        console.log(`${reader.reader.name}  device removed`);
    });

});

nfc.on('error', err => {
    console.log('an error occurred', err);
});

LICENSE

The nfc node module, documentation, tests, and build scripts are licensed under the MIT license:

Copyright Martin Endler

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.