M5Unit-FINGER 0.0.2 git rev:9f22200
Loading...
Searching...
No Matches
m5::unit::UnitFPC1020A Class Reference

For FPC1020A. More...

#include <unit_FPC1xxx.hpp>

Inheritance diagram for m5::unit::UnitFPC1020A:
m5::unit::UnitFPC1XXX

Public Member Functions

virtual bool begin () override
 Begin communication with the unit.
 
virtual uint16_t resolutionWidth () const override
 Gets the width of resolution.
 
virtual uint16_t resolutionHeight () const override
 Gets the height of resolution.
 
virtual uint16_t minimumUserID () const override
 Get the minimum user ID.
 
virtual uint16_t maximumUserID () const override
 Get the maximum user ID.
 
- Public Member Functions inherited from m5::unit::UnitFPC1XXX
bool readSerialNumber (uint32_t &no)
 Read the serial number (24 bits)
 
bool readVersion (char str[9])
 Read the version string.
 
bool sleep (void)
 Go to deep sleep.
 
config_t config ()
 Gets the configuration.
 
void config (const config_t &cfg)
 Set the configuration.
 
uint16_t imageWidth (const bool raw) const
 Get the image width.
 
uint16_t imageHeight (const bool raw) const
 Get the resolution height.
 
bool readRegistrationMode (fpc1xxx::Mode &mode)
 Read the registration mode.
 
bool writeRegistrationMode (const fpc1xxx::Mode mode)
 Write the registration mode.
 
bool readComparisonLevel (uint8_t &lv)
 Read the comparison level.
 
bool writeComparisonLevel (const uint8_t lv)
 Write the comparison level.
 
bool writeBaudRate (const fpc1xxx::BaudRate baud)
 Write the baud rate.
 
bool readTimeout (uint8_t &timeout)
 Read the timeout.
 
bool writeTimeout (const uint8_t timeout)
 Write the timeout.
 
bool readRegisteredUserCount (uint16_t &count)
 Read the number of registered users.
 
bool readUser (uint8_t &permission, const uint16_t user_id)
 Read the user permission.
 
bool readAllUser (std::vector< fpc1xxx::User > &v)
 Get the all user data.
 
bool readUserCharacteristic (uint8_t characteristic[193], const uint16_t user_id)
 Read the user characteristic data.
 
bool findAvailableUserID (uint16_t &user_id, const uint16_t low=0, const uint16_t high=0)
 Find the unregistered user id in specific range.
 
bool deleteUser (const uint16_t user_id)
 Delete user data.
 
bool deleteAllUsers ()
 Delete all user data.
 
bool registerFinger (const uint16_t user_id, const uint8_t permission, const uint8_t step=4)
 Register finger.
 
bool verifyFinger (bool &match, const uint16_t user_id)
 Verify specific user finger (1:1)
 
bool identifyFinger (uint16_t &user_id, uint8_t &permission)
 Identify finger (1:N)
 
bool scanCharacteristic (uint8_t characteristic[193])
 Scan characteristic.
 
virtual bool captureImage (std::vector< uint8_t > &img, const bool raw=false)
 Capture finger image.
 
bool registerCharacteristic (const uint16_t user_id, const uint8_t permission, const uint8_t characteristic[193])
 Register characteristic.
 
bool verifyCharacteristic (bool &match, const uint16_t user_id, const uint8_t characteristic[193])
 Verify specific user characteristic (1:1)
 
bool identifyCharacteristic (uint16_t &user_id, const uint8_t characteristic[193])
 Identify characteristic (1:N)
 
bool compareCharacteristic (bool &match, const uint8_t characteristic[193])
 Compare characteristic.
 

Static Public Attributes

static constexpr uint16_t RESOLUTION_WIDTH {160}
 
static constexpr uint16_t RESOLUTION_HEIGHT {160}
 
static constexpr uint16_t MINIMUM_USER_ID {1}
 
static constexpr uint16_t MAXIMUM_USER_ID {150}
 
- Static Public Attributes inherited from m5::unit::UnitFPC1XXX
static constexpr uint16_t RESOLUTION_WIDTH {0}
 
static constexpr uint16_t RESOLUTION_HEIGHT {0}
 
static constexpr uint16_t MINIMUM_USER_ID {0}
 
static constexpr uint16_t MAXIMUM_USER_ID {0}
 

Additional Inherited Members

- Public Types inherited from m5::unit::UnitFPC1XXX
using Frame = std::array<uint8_t, 8>
 
using VariableFrame = std::vector<uint8_t>
 
- Protected Member Functions inherited from m5::unit::UnitFPC1XXX
bool is_valid_user_id (const uint16_t user_id) const
 
bool transceive_command (Frame &res, const uint8_t cmd, const uint8_t p1=0, const uint8_t p2=0, const uint8_t p3=0)
 
bool capture_image (std::vector< uint8_t > &img, const bool full=false)
 

Detailed Description

For FPC1020A.

Resolution DPI Support capture full image?
160 x 160 504 dpi OK

Member Function Documentation

◆ begin()

bool m5::unit::UnitFPC1020A::begin ( )
overridevirtual

Begin communication with the unit.

Reimplemented from m5::unit::UnitFPC1XXX.

◆ maximumUserID()

virtual uint16_t m5::unit::UnitFPC1020A::maximumUserID ( ) const
inlineoverridevirtual

Get the maximum user ID.

Reimplemented from m5::unit::UnitFPC1XXX.

◆ minimumUserID()

virtual uint16_t m5::unit::UnitFPC1020A::minimumUserID ( ) const
inlineoverridevirtual

Get the minimum user ID.

Reimplemented from m5::unit::UnitFPC1XXX.

◆ resolutionHeight()

virtual uint16_t m5::unit::UnitFPC1020A::resolutionHeight ( ) const
inlineoverridevirtual

Gets the height of resolution.

Reimplemented from m5::unit::UnitFPC1XXX.

◆ resolutionWidth()

virtual uint16_t m5::unit::UnitFPC1020A::resolutionWidth ( ) const
inlineoverridevirtual

Gets the width of resolution.

Reimplemented from m5::unit::UnitFPC1XXX.