Grow-R503-Fingerprint


NameGrow-R503-Fingerprint JSON
Version 0.0.3 PyPI version JSON
download
home_pagehttps://github.com/rshcs/Grow-R503-Finger-Print
SummaryPure python library for R503 fingerprint reader
upload_time2023-09-28 14:21:55
maintainer
docs_urlNone
authorRoshanCS
requires_python>=3.6
license
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ![python](https://img.shields.io/badge/Python-3776AB.svg?style=for-the-badge&logo=Python&logoColor=white)

![licence_mit](https://img.shields.io/badge/python-3.6+-blue)
![licence_mit](https://img.shields.io/badge/licence-MIT-orange)
![commits](https://img.shields.io/github/last-commit/rshcs/Grow-R503-Finger-Print)


# GROW R503 Fingerprint 

![Fingerprint_sensor](https://i.ibb.co/Z2rnD0K/seonsor.jpg)

---

### Features

* Written in pure python.
* Provides all the manufacturer specified operations of the module.
* Can be connected with a computer directly with a USB to TTL converter. (Do not need a microcontroller)
* Can be used for testing the functionality of the module or creating direct applications without involving a microcontroller.

---

### Interfacing
#### Wiring connections:

|Sensor Side|RS232 Converter|
|---|---|
|Red (power)|3.3v Power|
|White (touch induction power)|3.3v power|
|Black (Ground)|Ground (0v)|
|Maroon or Green or Brown (Rx)|Tx|
|Yellow  (Tx)|Rx|
|Blue (Wakeup)|Not connected|

![Connections](https://i.ibb.co/SyXvZ2G/connections.png)
(Ref: Datasheet)

* **Make sure to use 3.3v power supply unless you have the 5v version of the sensor.**

* If you use a separate 3.3v power supply other than the RS232 converters power then make sure to connect grounds together (common ground).

* The line order is according to the colors, even though the note says it's not.

--- 

#### Usb to TTL
![rs232_usb](https://i.ibb.co/nmkbvb3/usb-to-rs232.png)
* This module can be used to interface with the module since it provides 5v to 3.3v conversion for both logic level and power.
* However, make sure to switch jumper position to the 3.3v and connect 3.3v power pin of the converter.

---

### Installation

* Run `pip install pyserial` on terminal.

* Download **r503.py** file.

### Basic usage overview

---
#### Registering a fingerprint

    from r503 import R503

    fp = R503(port=5)
    fp.manual_enroll(location=8)

* you have to place the finger 4 (changeable) times on the sensor during the process

Terminal output:

![Fingerprint registering](https://i.ibb.co/ssRx1hG/fingerprint-registering.png)

---

#### Search a Fingerprint from the stored data

    from r503 import R503
    from time import sleep
    
    fp = R503(port=5)
    
    print('Place your finger on the sensor..')
    sleep(3) # Not required to add this line
    print(fp.search())

Terminal output:

![Fingerprint matching status](https://i.ibb.co/y8z0Gdf/fp-location.png)

* first value = success if 0
* second value = stored location of the memory
* third value = match score

---

Number of fingerprints in the memory

    from r503 import R503
    
    fp = R503(port=5)
    print('Num of templates: ', fp.read_valid_template_num())

Terminal output:

![Number of templates](https://i.ibb.co/wsRSQg8/num-of-temps.png)

---
#### Read fingerprint stored locations

    from r503 import R503
    
    fp = R503(port=5)
    print(fp.read_index_table())

Terminal output:

![Fingerprint stored locations](https://i.ibb.co/drXhRRB/temp-locations.png)

---

#### Aura LED Control

    from r503 import R503
    
    fp = R503(port=5)
    fp.led_control(ctrl=3, color=5)

Output: LED keeps on with a specific color according to the number

---
#### Read Product Information

    from r503 import R503
    
    fp = R503(port=5)

    for k, v in fp.read_prod_info_decode().items():
        print(k, ': ', v)

Terminal output:

![Info](https://i.ibb.co/3WjyGnP/info.png)

---

For Linux users: if a permission error occurs while opening the serial port, run the following command:

`sudo chmod a+rw /dev/ttyUSB{your device port number}`

Etc:

`sudo chmod a+rw /dev/ttyUSB0`


            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/rshcs/Grow-R503-Finger-Print",
    "name": "Grow-R503-Fingerprint",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": "",
    "keywords": "",
    "author": "RoshanCS",
    "author_email": "roshan.cs790@gmail.com",
    "download_url": "",
    "platform": null,
    "description": "![python](https://img.shields.io/badge/Python-3776AB.svg?style=for-the-badge&logo=Python&logoColor=white)\r\n\r\n![licence_mit](https://img.shields.io/badge/python-3.6+-blue)\r\n![licence_mit](https://img.shields.io/badge/licence-MIT-orange)\r\n![commits](https://img.shields.io/github/last-commit/rshcs/Grow-R503-Finger-Print)\r\n\r\n\r\n# GROW R503 Fingerprint \r\n\r\n![Fingerprint_sensor](https://i.ibb.co/Z2rnD0K/seonsor.jpg)\r\n\r\n---\r\n\r\n### Features\r\n\r\n* Written in pure python.\r\n* Provides all the manufacturer specified operations of the module.\r\n* Can be connected with a computer directly with a USB to TTL converter. (Do not need a microcontroller)\r\n* Can be used for testing the functionality of the module or creating direct applications without involving a microcontroller.\r\n\r\n---\r\n\r\n### Interfacing\r\n#### Wiring connections:\r\n\r\n|Sensor Side|RS232 Converter|\r\n|---|---|\r\n|Red (power)|3.3v Power|\r\n|White (touch induction power)|3.3v power|\r\n|Black (Ground)|Ground (0v)|\r\n|Maroon or Green or Brown (Rx)|Tx|\r\n|Yellow  (Tx)|Rx|\r\n|Blue (Wakeup)|Not connected|\r\n\r\n![Connections](https://i.ibb.co/SyXvZ2G/connections.png)\r\n(Ref: Datasheet)\r\n\r\n* **Make sure to use 3.3v power supply unless you have the 5v version of the sensor.**\r\n\r\n* If you use a separate 3.3v power supply other than the RS232 converters power then make sure to connect grounds together (common ground).\r\n\r\n* The line order is according to the colors, even though the note says it's not.\r\n\r\n--- \r\n\r\n#### Usb to TTL\r\n![rs232_usb](https://i.ibb.co/nmkbvb3/usb-to-rs232.png)\r\n* This module can be used to interface with the module since it provides 5v to 3.3v conversion for both logic level and power.\r\n* However, make sure to switch jumper position to the 3.3v and connect 3.3v power pin of the converter.\r\n\r\n---\r\n\r\n### Installation\r\n\r\n* Run `pip install pyserial` on terminal.\r\n\r\n* Download **r503.py** file.\r\n\r\n### Basic usage overview\r\n\r\n---\r\n#### Registering a fingerprint\r\n\r\n    from r503 import R503\r\n\r\n    fp = R503(port=5)\r\n    fp.manual_enroll(location=8)\r\n\r\n* you have to place the finger 4 (changeable) times on the sensor during the process\r\n\r\nTerminal output:\r\n\r\n![Fingerprint registering](https://i.ibb.co/ssRx1hG/fingerprint-registering.png)\r\n\r\n---\r\n\r\n#### Search a Fingerprint from the stored data\r\n\r\n    from r503 import R503\r\n    from time import sleep\r\n    \r\n    fp = R503(port=5)\r\n    \r\n    print('Place your finger on the sensor..')\r\n    sleep(3) # Not required to add this line\r\n    print(fp.search())\r\n\r\nTerminal output:\r\n\r\n![Fingerprint matching status](https://i.ibb.co/y8z0Gdf/fp-location.png)\r\n\r\n* first value = success if 0\r\n* second value = stored location of the memory\r\n* third value = match score\r\n\r\n---\r\n\r\nNumber of fingerprints in the memory\r\n\r\n    from r503 import R503\r\n    \r\n    fp = R503(port=5)\r\n    print('Num of templates: ', fp.read_valid_template_num())\r\n\r\nTerminal output:\r\n\r\n![Number of templates](https://i.ibb.co/wsRSQg8/num-of-temps.png)\r\n\r\n---\r\n#### Read fingerprint stored locations\r\n\r\n    from r503 import R503\r\n    \r\n    fp = R503(port=5)\r\n    print(fp.read_index_table())\r\n\r\nTerminal output:\r\n\r\n![Fingerprint stored locations](https://i.ibb.co/drXhRRB/temp-locations.png)\r\n\r\n---\r\n\r\n#### Aura LED Control\r\n\r\n    from r503 import R503\r\n    \r\n    fp = R503(port=5)\r\n    fp.led_control(ctrl=3, color=5)\r\n\r\nOutput: LED keeps on with a specific color according to the number\r\n\r\n---\r\n#### Read Product Information\r\n\r\n    from r503 import R503\r\n    \r\n    fp = R503(port=5)\r\n\r\n    for k, v in fp.read_prod_info_decode().items():\r\n        print(k, ': ', v)\r\n\r\nTerminal output:\r\n\r\n![Info](https://i.ibb.co/3WjyGnP/info.png)\r\n\r\n---\r\n\r\nFor Linux users: if a permission error occurs while opening the serial port, run the following command:\r\n\r\n`sudo chmod a+rw /dev/ttyUSB{your device port number}`\r\n\r\nEtc:\r\n\r\n`sudo chmod a+rw /dev/ttyUSB0`\r\n\r\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Pure python library for R503 fingerprint reader",
    "version": "0.0.3",
    "project_urls": {
        "Bug Tracker": "https://github.com/rshcs/Grow-R503-Finger-Print/issues",
        "Homepage": "https://github.com/rshcs/Grow-R503-Finger-Print"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "147a1449b84a049c138c06922b72d904b10a11feb941dd705ec1937f666b9557",
                "md5": "3b4e47ffe55f0bbc8bcf092c3564c777",
                "sha256": "b9b2706baaf1334411a787840be9c7f1db255098dbcc3913ffb8230a0ea5d8b5"
            },
            "downloads": -1,
            "filename": "Grow_R503_Fingerprint-0.0.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "3b4e47ffe55f0bbc8bcf092c3564c777",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 3758,
            "upload_time": "2023-09-28T14:21:55",
            "upload_time_iso_8601": "2023-09-28T14:21:55.556633Z",
            "url": "https://files.pythonhosted.org/packages/14/7a/1449b84a049c138c06922b72d904b10a11feb941dd705ec1937f666b9557/Grow_R503_Fingerprint-0.0.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-09-28 14:21:55",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "rshcs",
    "github_project": "Grow-R503-Finger-Print",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "grow-r503-fingerprint"
}
        
Elapsed time: 0.30848s