You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+32-3Lines changed: 32 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ The [SparkFun Fingerprint Sensor - FPC2534 Pro]() is a small, highly capable and
16
16
17
17
## Functionality
18
18
19
-
The SparkFun Fingerprint Sensor - FPC2534 Pro is accessible via a variety of interfaces, including I2Cand UART, which are supported by this library.
19
+
The SparkFun Fingerprint Sensor - FPC2534 Pro is accessible via a variety of interfaces, including I2C, UART and SPI, which are supported by this library.
20
20
21
21
This library provides a message-based, easy to use interface that enables fingerprint biometric authentication and simple finger-based navigation. Specifically, the FPC2534AP provides:
22
22
@@ -74,11 +74,11 @@ While this methodology is unique to the when compared to other libraries, it f
74
74
75
75
### Using the Library
76
76
77
-
The first step to using the library is selected the method used to communicate with the device. The library supports I2C on select platforms, or UART (a Serial interface in Arduino). Once selected, and device connected as outlined in the hookup guide for the SparkFun Fingerprint Sensor - FPC2534 Pro. The type of connection depends on the method used to communicate with the device.
77
+
The first step to using the library is selected the method used to communicate with the device. The library supports I2C on select platforms, UART (a Serial interface in Arduino) or SPI. Once selected, and device connected as outlined in the hookup guide for the SparkFun Fingerprint Sensor - FPC2534 Pro. The type of connection depends on the method used to communicate with the device.
78
78
79
79
#### Getting Started
80
80
81
-
How the sensor is initialized is dependent on the communication method being utilized. The following sections outline how to use setup and initialize the I2Cor UART interfaces to the device. Once setup, the operation of the device is communication method independent.
81
+
How the sensor is initialized is dependent on the communication method being utilized. The following sections outline how to use setup and initialize the I2C, UART or SPI interfaces to the device. Once setup, the operation of the device is communication method independent.
82
82
83
83
##### Using I2C (Qwiic)
84
84
@@ -164,6 +164,33 @@ An example of calling the begin method:
164
164
165
165
At this point, the sensor is ready for normal operation.
166
166
167
+
##### Using SPI
168
+
169
+
When using SPI to communicate with the fingerprint sensor, the class named `SfeFPC2534SPI` is used. An example of how to declare the sensor object is as follows:
170
+
171
+
```c++
172
+
// Declare our sensor object
173
+
SfeFPC2534I2C mySensor;
174
+
```
175
+
176
+
To initialize the device, the following is needed:
177
+
178
+
- The SPI bus to use - if using a the simple begin function, the default bus is used.
179
+
- The Settings for the SPI connection - if using a the simple begin function, default settings are used.
180
+
- The CS PIN for the SPI connection
181
+
- The Pin number the IRQ of the device is connected to. This IRQ is used by the sensor to indicated data is available for reading from the device.
182
+
183
+
An example of calling the simple begin method:
184
+
185
+
```c++
186
+
bool status = mySensor.begin(myCSPin, interruptPin );
187
+
```
188
+
189
+
At this point, the sensor is ready for normal operation.
190
+
191
+
> [!NOTE]
192
+
> In the provided examples, the FPC2534 sensor is reset after the ```begin``` method is called, to ensure the senors is in a startup state.
193
+
167
194
#### General Operation
168
195
169
196
The operational pattern for the SparkFun FPC2543 Fingerprint sensor library is outlined in the following diagram:
@@ -244,6 +271,7 @@ To further understand how to use Navigation mode, review the Navigation examples
244
271
245
272
-[Navigation using I2C](examples/Example01_NavigationI2C/Example01_NavigationI2C.ino)
246
273
-[Navigation using Serial](examples/Example03_NavigationUART/Example03_NavigationUART.ino)
274
+
-[Navigation using SPI](examples/Example05_NavigationSPI/Example05_NavigationSPI.ino)
247
275
248
276
#### Enroll a Fingerprint
249
277
@@ -270,6 +298,7 @@ To further understand how to use the Enroll mode in your application, review the
270
298
271
299
-[Enroll and Identify using I2C](examples/Example02_EnrollI2C/Example02_EnrollI2C.ino)
272
300
-[Enroll and Identify using Serial](examples/Example04_EnrollUART/Example04_EnrollUART.ino)
301
+
-[Enroll and Identify using SPI](examples/Example06_EnrollSPI/Example06_EnrollSPI.ino)
0 commit comments