SparkFun Fingerprint Sensor - FPC2534 Pro  v0.9.9-3-g5d0d172
Library for the SparkFun Fingerprint Sensor - FPC2534 Pro
Loading...
Searching...
No Matches
SparkFun_FPC2534.h
Go to the documentation of this file.
1
20#pragma once
21
22#include "sfTk/sfDevFPC2534.h"
26#include <Arduino.h>
27
28// Make a Arduino friendly Address define
29#define SFE_FPC2534_I2C_ADDRESS kFPC2534DefaultAddress
30
31//--------------------------------------------------------------------------------------------
32// I2C version of the FPC2534 class
33//
35
37{
38 public:
40 {
41 }
52 bool begin(const uint8_t address = kFPC2534DefaultAddress, TwoWire &wirePort = Wire, const uint8_t i2cBusNumber = 0,
53 const uint32_t interruptPin = 255)
54 {
55
56 // Setup the I2C communication
57 if (!_commI2CBus.initialize(address, wirePort, i2cBusNumber, interruptPin))
58 return false;
59
60 // Okay, the bus is a go, lets initialize the base class
61
62 return sfDevFPC2534::initialize(_commI2CBus);
63 }
64
65 private:
66 sfDevFPC2534I2C _commI2CBus;
67};
68
69//--------------------------------------------------------------------------------------------
70// UART/Serial version of the FPC2534 class
71//
73{
74 public:
76 {
77 }
84 bool begin(HardwareSerial &theUART)
85 {
86
87 if (!_commUART.initialize(theUART))
88 return false;
89
90 // Okay, the bus is a go, lets initialize the base class
91
92 return sfDevFPC2534::initialize(_commUART);
93 }
94
95 private:
96 sfDevFPC2534UART _commUART;
97};
98
99//--------------------------------------------------------------------------------------------
100// SPI version of the FPC2534 class
101//
103
105{
106 public:
108 {
109 }
120 bool begin(SPIClass &spiPort, SPISettings &busSPISettings, const uint8_t csPin, const uint32_t interruptPin,
121 bool bInit = false)
122 {
123
124 // Setup the SPI communication
125 if (!_commSPIBus.initialize(spiPort, busSPISettings, csPin, interruptPin, bInit))
126 return false;
127
128 // Okay, the bus is a go, lets initialize the base class
129
130 return sfDevFPC2534::initialize(_commSPIBus);
131 }
132
141 bool begin(const uint8_t csPin, const uint32_t interruptPin, bool bInit = false)
142 {
143
144 // Setup the SPI communication
145 if (!_commSPIBus.initialize(csPin, interruptPin, bInit))
146 return false;
147
148 // Okay, the bus is a go, lets initialize the base class
149
150 return sfDevFPC2534::initialize(_commSPIBus);
151 }
152
153 private:
154 sfDevFPC2534SPI _commSPIBus;
155};
Definition: SparkFun_FPC2534.h:37
SfeFPC2534I2C()
Definition: SparkFun_FPC2534.h:39
bool begin(const uint8_t address=kFPC2534DefaultAddress, TwoWire &wirePort=Wire, const uint8_t i2cBusNumber=0, const uint32_t interruptPin=255)
Initialize the sensor using I2C communication.
Definition: SparkFun_FPC2534.h:52
Definition: SparkFun_FPC2534.h:105
bool begin(const uint8_t csPin, const uint32_t interruptPin, bool bInit=false)
Initialize the sensor using SPI communication.
Definition: SparkFun_FPC2534.h:141
SfeFPC2534SPI()
Definition: SparkFun_FPC2534.h:107
bool begin(SPIClass &spiPort, SPISettings &busSPISettings, const uint8_t csPin, const uint32_t interruptPin, bool bInit=false)
Initialize the sensor using SPI communication.
Definition: SparkFun_FPC2534.h:120
Definition: SparkFun_FPC2534.h:73
bool begin(HardwareSerial &theUART)
Initialize the sensor using UART communication.
Definition: SparkFun_FPC2534.h:84
SfeFPC2534UART()
Definition: SparkFun_FPC2534.h:75
Core class implementing FPC2534 functionality independent of communication protocol.
Definition: sfDevFPC2534.h:59
bool initialize(sfDevFPC2534IComm &comm)
initialize the library with a communication interface.
Definition: sfDevFPC2534.h:277
Definition: sfDevFPC2534I2C.h:38
bool initialize(uint8_t address, TwoWire &wirePort, uint8_t i2cBusNumber, uint32_t interruptPin)
Definition: sfDevFPC2534I2C.cpp:38
Definition: sfDevFPC2534SPI.h:23
bool initialize(SPIClass &spiPort, SPISettings &busSPISettings, uint8_t csPin, uint32_t interruptPin, bool bInit=false)
Definition: sfDevFPC2534SPI.cpp:23
Definition: sfDevFPC2534UART.h:23
bool initialize(HardwareSerial &theUART)
Definition: sfDevFPC2534UART.cpp:20
header file for the SparkFun FPC2534 core implementation. The core implements all logic and functiona...
const uint8_t kFPC2534DefaultAddress
Definition: sfDevFPC2534I2C.h:22