Skip to content

Commit 096fc2a

Browse files
committed
add section on the *enroll mode* of the sensor and using it with the library
1 parent 8975c25 commit 096fc2a

File tree

2 files changed

+23
-0
lines changed

2 files changed

+23
-0
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -209,3 +209,26 @@ To further understand how to use Navigation mode, review the Navigaton examples
209209
210210
- [Navigation using I2C](examples/Example01_NavigationI2C/Example01_NavigationI2C.ino)
211211
- [Navigatoin using Seria](examples/Example03_NavigationUART/Example03_NavigationUART.ino)
212+
213+
#### Enroll a Fingerprint
214+
215+
Before the fingerprint sensor can validate a finger, that finger is enrolled into the sensor as a template. This operation is performed using an *Enroll Mode* of the sensor.
216+
217+
To enter the *Enroll Mode*, the ```requestEnroll()``` method is called in the library. Once in Enroll Mode, the user places and removes the desired finger from the sensor, and the sensor report back the number samples remaining/progress to the library. The library then calls the ```on_enroll()``` callback method as the process progresses. once the value of the remaining scans reaches zero, the process is complete.
218+
219+
This process is outlined in the following diagram:
220+
221+
![Fingerprint Enrollment](docs/images/sfe-fpc2543-op-enroll.png)
222+
223+
1) Stardard setup, with a ```on_enroll()``` callback function provided to the library.
224+
2) Once the sensor is operational, the ```requestEnroll()``` method is called to start the enrollment process
225+
3) A standard *loop*()* application pattern/method is started.
226+
4) The method ```processNextResponse()``` is called on the library to get updates from the sensor.
227+
5) The library identifies and parse an enrollment status message from the sensor
228+
6) The registered ```on_eroll()``` callback method is called, with the number of samples remaining.
229+
- If the number is equal to zero, the process is complete and the fingerprint is enrolled/registered with the sensor.
230+
231+
To further understand how to use the Enroll mode in your application, review the Enroll and Identify examples provided with this library:
232+
233+
- [Enroll and Identify using I2C](examples/Example02_EnrollI2C/Example02_EnrollI2C.ino)
234+
- [Enroll and Identify using Serial](examples/Example04_EnrollUART/Example04_EnrollUART.ino)
48.6 KB
Loading

0 commit comments

Comments
 (0)