NFC Serial Reader

This module allows reading NFC tags using a serial connection to an RFID reader.

Installation

To install run:

pnpm add @wimetrix/nfc-serial-reader

or

npm install @wimetrix/nfc-serial-reader

or

yarn add @wimetrix/nfc-serial-reader

Usage

NFC serial reader module provides the following API:

connectNFCSerialReader

This connects to the NFC reader on the given serial port and specified baud rate, starts reading in the background and returns a boolean indicating if the connection was successful.

import { connectNFCSerialReader } from "@wimetrix/nfc-serial-reader";

const connected = connectNFCSerialReader("/dev/ttyS0", 9600);

addNFCReadListener

Note: This function should be called after connectNFCSerialReader has been called.

This adds a listener to the NFC reader, the listener will be called every time a new tag is read.

import { addNFCReadListener } from "@wimetrix/nfc-serial-reader";

const subscription = addNFCReadListener((card) => {
	console.log(`Card Type: ${card.cardType}`);
	console.log(`Card ID: ${card.cardId}`);
});

// To remove the listener:
subscription.remove();

The payload of the listener is an object with the following properties:

• cardType: The type of the card, either "TAG" or "WORKER". If the card type is not one of these two values, it is returned as "UNKNOWN".
• cardId: The ID of the card as a string.

disconnectNFCSerialReader

This disconnects the NFC reader, stops reading and returns a boolean indicating if the disconnection was successful.

import { disconnectNFCSerialReader } from "@wimetrix/nfc-serial-reader";

const disconnected = disconnectNFCSerialReader();

listSerialPorts

This returns a list of available serial ports on the device (the options that can be passed to connectNFCSerialReader).

import { listSerialPorts } from "@wimetrix/nfc-serial-reader";

const ports = listSerialPorts();

listBaudRates

This returns a list of available baud rates that can be passed to connectNFCSerialReader. The baud rates are hardcoded to the following values: [9600, 19200, 38400, 57600, 115200].

import { listBaudRates } from "@wimetrix/nfc-serial-reader";

const baudRates = listBaudRates();