Skip to content

Commit 1958d8d

Browse files
committed
add note about limited i2c support
1 parent 2c9ea0f commit 1958d8d

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Arduino Library for the SparkFun Fingerprint Sensor - FPC2534 Pro
1212
[![Compile Test](https://github.com/sparkfun/SparkFun_FPC2534_Arduino_Library/actions/workflows/test-compile-sketch.yml/badge.svg)](https://github.com/sparkfun/SparkFun_FPC2534_Arduino_Library/actions/workflows/test-compile-sketch.yml)
1313
![GitHub issues](https://img.shields.io/github/issues/sparkfun/SparkFun_FPC2534_Arduino_Library)
1414

15-
The [SparkFun Fingerprint Sensor - FPC2534 Pro](https://www.sparkfun.com/sparkfun-fingerprint-sensor-fpc2534-qwiic.html) is a small, highly capable and robust fingerprint sensor that can easily be integrated into virtually any application. Based off the AllKey Biometric System family from Fingerprints Cards (FPC), the FPC2534AP delivers incredible functionality in a small, compact formfactor.
15+
The [SparkFun Fingerprint Sensor - FPC2534 Pro](https://www.sparkfun.com/sparkfun-fingerprint-sensor-fpc2534-qwiic.html) is a small, highly capable and robust fingerprint sensor that can easily be integrated into virtually any application. Based off the AllKey Biometric System family from Fingerprints Cards (FPC), the FPC2534AP delivers incredible functionality in a small, compact form factor.
1616

1717
## Functionality
1818

@@ -26,6 +26,9 @@ This library provides a message-based, easy to use interface that enables finger
2626
- Trackpad like functionality for simple, finger-based navigation
2727
- Application integration via a variety of communication methods
2828

29+
> [!NOTE]
30+
> The structure of the I2C transactions implemented by the FPC2434 sensor are not directly supported by the Arduino Wire/I2C library. To support the I2C interface to the FPC2434, this library implements *helper* functions that handle the FPC2434 I2C transactions. These implementations are only supported on RP2 and ESP32 systems.
31+
2932
### Functionality not Supported by the Library
3033

3134
Features that the FPC2534 supports, but are not currently implemented by this library include:

0 commit comments

Comments
 (0)