semvec/pypi-packages huggingface dataset:
adafruit-fingerprint 1.0.3
Interface with the adafruit fingerprint r305 module from upper computer over serial connection
License: MIT

# adafruit-fingerprint

[![Documentation Status](https://readthedocs.org/projects/adafruit-fingerprint/badge/?version=latest)](https://adafruit-fingerprint.readthedocs.io/en/latest/?badge=latest)
![PyPI Downloads](https://static.pepy.tech/badge/adafruit-fingerprint)

> This library enables you communicate and with the r305 Fingerprint Identification Module via serial connection with upper computer.

The library enables you to  to communicate with the r305 fingerprint module from upper computer (your laptop, a raspberry pi etc), rather than the arduino which it was built for by default. The module communicates via TTL, therefore, to communicate you need a ``USB - TTL converter`` connected to the module.

It provides a class that exposes methods you can call to perform serial read/write actions with the module, these methods are implemented according to the datasheet specification, which you can download from the repo [here].


## Installation

```sh
pip install adafruit-fingerprint
```

## Usage example

There is a section on the [docs - hardware section] with pictures and explanations on how to setup the hardware needed for these examples to work.

Visit the [Examples Codes] section on the [docs] to view all examples.


## Development setup

### Requirements
- Python3.x (x >= 6)
- pip
- hardware setup. See [docs - hardware section].

### Get started

```sh
pip install -r requirements.txt
```

### Running tests
```sh
python -m unittest discover tests
```

## Release History

* 1.0.0
  * Good enough for most use cases
* 1.0.2
  * Added link to github repository

## Meta

This package is heavily inspired by the [finger_sphinx] project, found during our search for a way to get the fingerprint template to upper computer, rather than have it stored in flash library. A very big kudos and acknowledgement to the owners.

> Faith Odonghanro – [@toritsejuFO](https://twitter.com/toritsejuFO) (twitter), [toritsejuFO](https://github.com/toritsejuFO/) (github)

> Nwanozie Promise – [@PNwanozie](https://twitter.com/PNwanozie) (twitter), [iotstudent](https://github.com/iotstudent/) (github)

> Adegoke Joshua – [@iAmCodedebugger](https://twitter.com/iAmCodedebugger) (twitter), [Ade-Joshe](https://github.com/Ade-Joshe/) (github)

Distributed under the MIT license. See ``LICENSE`` for more information.

## Github Repository

[Github Repository](https://github.com/cerebrohivetech/adafruit-fingerprint)

<!-- Markdown links -->
[finger_sphinx]: https://fingerprint-module-r305-python-and-mysql.readthedocs.io/en/latest/
[docs - hardware section]: https://adafruit-fingerprint.readthedocs.io/en/latest/hardware/index.html
[Examples Codes]: https://adafruit-fingerprint.readthedocs.io/en/latest/examples/index.html
[docs]: https://adafruit-fingerprint.readthedocs.io/en/latest/index.html
[here]: https://github.com/cerebrohivetech/adafruit-fingerprint/raw/master/finger-print-module.pdf