Skip to content

Commit 0186fb5

Browse files
author
Bobby Chan
committed
Updated to new Arduino library structure
Updating repo to fit [Arduino library specifications](https://github.com/arduino/Arduino/wiki/Arduino-IDE-1.5:-Library-specification): - update ".../examples" path - update ".../src path" for .cpp and .h files - remove "FPS_GT511C3" path - add "libraries.properties" update "keywords.txt" path -Adding "library.json file" for PlatformIO
1 parent 6d5c031 commit 0186fb5

File tree

10 files changed

+29
-3
lines changed

10 files changed

+29
-3
lines changed

README.md

+7-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Fingerprint_Scanner-TTL
2-
=======================
1+
Fingerprint Scanner-TTL
2+
====================================
33

44
<table class="table table-hover table-striped table-bordered">
55
<tr align="center">
@@ -18,10 +18,14 @@ This is a great fingerprint module from ADH-Tech that communicates over 3.3V TTL
1818

1919
Repository Contents
2020
-------------------
21-
* **/FPS_GT511C3** - Arduino library and example code to interface with the sensor.
21+
* **/examples** - Example code to interface with the sensor.
22+
* **/src** - Source files for the library (.cpp, .h).
23+
* **keywords.txt** - Keywords from this library that will be highlighted in the Arduino IDE.
24+
* **library.properties** - General library properties for the Arduino package manager.
2225

2326
Documentation
2427
----------------
28+
* [Installing an Arduino Library Guide](https://learn.sparkfun.com/tutorials/installing-an-arduino-library) - Basic information on how to install an Arduino library.
2529
* [Fingerprint Scanner (GT-521Fxx) Hookup Guide](https://learn.sparkfun.com/tutorials/fingerprint-scanner-gt-521fxx-hookup-guide) - Hookup guide to connect to the GT-521F32 and GT-521F52.
2630
* _[Fingerprint Scanner Hookup Guide (RETIRED)](https://learn.sparkfun.com/tutorials/fingerprint-scanner-hookup-guide) - Hookup guide to connect to the GT-511C3 and GT-511C1R._
2731

File renamed without changes.

libraries.properties

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
name=Fingerprint Scanner TTL
2+
version=1.1.0
3+
author=Josh Hawley
4+
maintainer=SparkFun Electronics
5+
sentence=Arduino examples for ADH-Tech's Fingerprint Scanners.
6+
paragraph=This is a great fingerprint module from ADH-Tech that communicates over 3.3V TTL Serial so you can easily embed it into your next project. This repository contains Arduino example code to work with it. This code has been tested with GT-521F32, GT-521F52, GT-511C3, and GT-511C1R.
7+
category=Sensors
8+
url=https://github.com/sparkfun/Fingerprint_Scanner-TTL
9+
architectures=*

library.json

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
{
2+
"name": "Fingerprint Scanner TTL",
3+
"keywords": "sensor",
4+
"description": "Arduino examples for ADH-Tech's Fingerprint Scanners. This is a great fingerprint module from ADH-Tech that communicates over 3.3V TTL Serial so you can easily embed it into your next project. This repository contains Arduino example code to work with it. This code has been tested with GT-521F32, GT-521F52, GT-511C3, and GT-511C1R.",
5+
"repository":
6+
{
7+
"type": "git",
8+
"url": "https://github.com/sparkfun/Fingerprint_Scanner-TTL.git"
9+
},
10+
"version": "1.1.0",
11+
"frameworks": "arduino",
12+
"platforms": "atmelavr"
13+
}
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)