npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

nfc-serial-reader

v0.0.1

Published

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

Downloads

312

Readme

NFC Serial Reader

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

Installation

To install run:

pnpm add nfc-serial-reader

or

npm install nfc-serial-reader

or

yarn add 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 "nfc-serial-reader";

const connected = await 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 "nfc-serial-reader";

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

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

  • cardType: The type of the card, this is either "TAG" and "WORKER". These are the only two supported card types, if the card type is not one of these two values, then the card type is returned as "UNKNOWN".
  • cardId: The ID of the card which is an integer value.

This returns a function that can be called to remove the listener.

disconnectNFCSerialReader

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

import { disconnectNFCSerialReader } from "nfc-serial-reader";

const disconnected = await disconnectNFCSerialReader();

listSerialPorts

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

import { listSerialPorts } from "nfc-serial-reader";

const ports = await 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 "nfc-serial-reader";

const baudRates = listBaudRates();