Skip to content

Commit 21a5fc6

Browse files
committed
sequence for nav mode added
1 parent 821bc01 commit 21a5fc6

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
@@ -181,3 +181,26 @@ The operational pattern for the SparkFun FPC2543 Fingerprint sensor library is o
181181
- The user takes the desired application action in the callback function.
182182
183183
The loop sequence of operation - make a request, check for messages and respond via callback functions continue during the operation of the sensor.
184+
185+
#### Navigation Mode
186+
187+
One of the operating modes of FPC2534 is *Navigation Mode*. Enabled by calling the ```startNavigationMode()``` on the library, the FPC2534 acts like a small touch pad/joystick when in Navigation Mode. It should be noted, the ```startNavigationMode()``` method also takes a parameter that sets the oriengation of the sensor. This is used when determining event type (up, down, left, right).
188+
189+
Events from this mode are communicated to the callback function assigned in the ```on_navigation``` field of the callback function structure that is passed to the library. The following events are supported:
190+
191+
- Swipe left
192+
- Swipe right
193+
- Swipe up
194+
- Swipe down
195+
- Press - a quick press and remove of a finger from the sensor
196+
- Long press - triggered after the finger stays pressed on the sensor for a "long time" (~1 second)
197+
198+
The operation of this mode is outlined in the following diagram:
199+
200+
![Navigation Mode](docs/images/sfe-fpc2543-op-nav.png)
201+
202+
1) Standard setup, with a ```on_navigation()``` callback function provided
203+
2) Once the sensor is running, start navigation mode. The sensor will interpret finger movements as navigation events and send messages when events are detected.
204+
3) Loop mode is entered
205+
4) Messages from the sensor are processed
206+
5) When a navigation event message is identified, the message is parsed and the corresponding navigation event sent to the supplied ```on_navigation()``` callback function.

docs/images/sfe-fpc2543-op-nav.png

43.6 KB
Loading

0 commit comments

Comments
 (0)