Inqnuam / adafruit-fingerprint

Adafruit Fingerprint Sensor controller

Introduction

Control Adafruit fingerprint sensor through serial port.
Works with both NodeJS ABI and ElectronJS ABI.
Linux, macOS and Windows supported.

Install

npm i https://github.com/Inqnuam/adafruit-fingerprint

Hardware Requirements

• FT232 USB to TTL UART converter
• Adafruit Fingerprint Sensor

Hardware Wiring

Sensor > USB Converter
red - 3V3
yellow - RXD
white - TXD
black - GND

Usage

Hardware used in this example

• DSD TECH USB to TTL Adaptator
• DollaTek Adafruit Fingerprint Sensor

//import { Fingerprint } from "adafruit-fingerprint"
const Fingerprint = require("adafruit-fingerprint").Fingerprint

// change devicePath with a real device path or use serialNumber option
const devicePath = "/dev/tty.usbserial-B60M4YN" // or something like "COM3" on Windows

const sensorOptions = {
    // init with sensor serial port path
    serialPort: devicePath,
    // serialNumber: "xxxxxx",
    baudRate: 57600,
    // ...
}

const finger = new Fingerprint(sensorOptions)
finger.on("ready", async (s) => {
    console.log("✅ Fingerprint Sensor is ready")

    // get count of registered fingerprints
    const totalTemplates = await finger.getTemplateCount()
    console.log("Total fingerprints:", totalTemplates)
})

finger.on("port-error", (err) => {
    console.log(err)
})
finger.on("port-close", (err) => {
    console.log(err)
})