Fingerprint project CLI tool - Unlock your device using Biometrics

Overview

This project involves creating a biometric security system that utilises an Arduino and a fingerprint scanner to unlock a PC or Mac. The system captures and verifies fingerprints, allowing authorised users to access their computers.

video.mp4

Requirements (Hardware)

Arduino Board - As we are going to use the Keyboard library, you must have one of the following devices in this list.
To purchase the exact one I have, click here.
Fingerprint Scanner Module - purchase from here.
Jumper Wires - purchase from here.
LED button - purchase from here.
PCB/Breadboard - purchase from here.
Solder Iron - purchase from here.
Solder - purchase from here.
Resistor - purchase from here.

Software Requirements

Python - You must have Python installed on your computer. You can download it from here.
Arduino CLI - To use the tools in this project, you must have the Arduino CLI installed.

For Mac users, you can install it by running the following command in your terminal:
```
brew install arduino-cli
```
Make sure you have Homebrew installed. If not, you can install it by running the following command in your terminal:
```
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
```
For Windows and Linux users, you can install it from here.
Keyboard Library - You can install the keyboard library by running the following command in your terminal:
```
arduino-cli lib install "Keyboard"
```
Adafruit Fingerprint Sensor Library - You can install the Adafruit Fingerprint Sensor Library by running the following command in your terminal:
```
arduino-cli lib install "Adafruit Fingerprint Sensor Library"
```

Project Setup Software

Download the project files

git clone https://github.com/MinasFakhori/fingerprint

Navigate to the python project directory
```
cd fingerprint/app
```

Make a virtual environment and activate it

python -m venv venv
source venv/bin/activate

Install the required packages
```
pip install -r requirements.txt
```

Usage

Note: You must have the Arduino connected to your computer and the fingerprint scanner connected to the Arduino. You can find the wiring diagram in the diagrams directory.

Go to the app directory
```
cd fingerprint/app
```
Configure project
```
python3.9 app.py project-config
```
Configure pinout (optional) If you don't know the pinout you can run the following command
```
python3.9 app.py pinout-config ----show-pins
```
If you wish to change the pinout run the following command
```
python3.9 app.py pinout-config
```
Add a fingerprint You can add a fingerprint by running the following command:
```
python3.9 app.py add-fingerprint
```
Activate the fingerprint scanner You can activate the fingerprint scanner by running the following command:
```
python3.9 app.py activate-fingerprint
```

Troubleshooting

If you encounter issues during setup or usage, consider the following:

Double-check hardware connections. Make sure the Arduino supports the Keyboard library. Review the wiring diagram for any errors. Restart the Arduino and the computer. If you are still experiencing issues, please open an issue on the project's GitHub page.