Update notices and warning

Matrixchung · Jan 5, 2023 · fd5a145 · fd5a145
1 parent fdf56b7
commit fd5a145
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 3 deletions.
diff --git a/library.properties b/library.properties
@@ -2,7 +2,7 @@ name=SFM-V1.7
 version=1.0.1
 author=Matrixchung <[email protected]>
 maintainer=Matrixchung <[email protected]>
-sentence=Interfacing to the SFM-V1.7 Fingerprint Sensor
+sentence=Interfacing to the SFM-V1.7 Fingerprint Sensor for ESP32 platform
 paragraph=Enables full control for SFM-V1.7, a fingerprint sensor which is famous in Chinese market
 category=Sensors
 url=https://github.com/Matrixchung/SFM-V1.7

diff --git a/readme.md b/readme.md
@@ -1,5 +1,11 @@
-# SFM-V1.7 Fingerprint Driver for Arduino
+# SFM-V1.7 Fingerprint Driver for ESP32-Arduino
 
 * Provides support for "SFM-V1.7" Fingerprint module.
 
-* See examples and source code for more detailed information.
+* See examples and source code for more detailed information.
+
+## Notice
+
+* If your MCU's GPIO port can't provide heavy current, I suggest connecting the SFM_VCC (Fingerprint VCC, green wire) directly to the 3.3V VIN without controlling the touch recognition part's power state, which does make a little bit more power consumption.
+
+* The module works at 3.3V electricity level, which means connecting it directly to the 5V GPIO port may result in malfunction and/or circuit damage.