Reference
Library
- Arduino IDE
- Download and install the ID809 Library. (About how to install the library?)
Communication Protocol Description
- Communication Interface: UART
API Description
/**
* @brief Test whether the module is properly connected
* @return true or false
*/
bool isConnected();
/**
* @brief Detect whether the module is touched by a finger
* @return 1(Yes) or 0(No)
*/
uint8_t detectFinger();
/**
* @brief Get the first registrable ID number
* @return Registrable ID number or ERR_ID809
*/
uint8_t getEmptyID();
/**
* @brief Check whether the ID has been registered
* @return 0(Registered), 1(Not Registered) or ERR_ID809
*/
uint8_t getStatusID(uint8_t ID);
/**
* @brief Get the number of registered users
* @return Number of registered users or ERR_ID809
*/
uint8_t getEnrollCount();
/**
* @brief Get the list of registered users
* @return 0(succeed) or ERR_ID809
*/
uint8_t getEnrolledIDList(uint8_t* list);
/**
* @brief Capture fingerprint
* @return 0(succeed) or ERR_ID809
*/
uint8_t collectionFingerprint(uint16_t timeout);
/**
* @brief Save fingerprint
* @param Fingerprint ID
* @return 0(succeed) or ERR_ID809
*/
uint8_t storeFingerprint(uint8_t ID);
/**
* @brief Delete fingerprint
* @param Finerprint ID or DELALL(delete all)
* @return 0(succeed) or ERR_ID809
*/
uint8_t delFingerprint(uint8_t ID);
/**
* @brief Match the fingerprint with all fingerprints
* @return Successfully matched fingerprint, 0(Finerprint matching failed) or ERR_ID809
*/
uint8_t search();
/**
* @brief Match the fingerprint with a designated fingerprint
* @return Successfully matched fingerprint ID, 0(Finerprint matching failed) or ERR_ID809
*/
uint8_t verify(uint8_t ID);
/**
* @brief Get error information
* @return Text description of error information
*/
String getErrorDescription();
/*Set module baud rate, available range:
e9600bps e19200bps e38400bps e57600bps e115200bps
1 2 3 4 5
*/
fingerprint.setBaudrate(fingerprint.e115200bps);
Other Supplementary Information
Was this article helpful?
