XDK API  3.6.0
Documentation
Files | Data Structures | Typedefs | Enumerations | Functions
FingerPrint

Virtual FingerPrint Sensor based on BMM150. More...

+ Collaboration diagram for FingerPrint:

Files

file  BCDS_FingerPrint.h
 

Data Structures

struct  FingerPrint_MonitorData_S
 

Typedefs

typedef void * FingerPrint_HandlePtr_T
 
typedef struct
FingerPrint_MonitorData_S 
FingerPrint_Monitor_Data_T
 
typedef struct
FingerPrint_MonitorData_S
FingerPrint_Monitor_DataPtr_T
 
typedef enum FingerPrint_Number_E FingerPrint_Number_T
 
typedef float FingerPrint_Output_DataType_T
 
typedef enum
FingerPrint_StorageState_E 
FingerPrint_StorageState_T
 
typedef uint8_t FingerPrint_StorageStatus_T
 
typedef uint8_t * FingerPrint_StorageStatusPtr_T
 

Enumerations

enum  FingerPrint_Number_E
 
enum  FingerPrint_StorageState_E
 

Functions

Retcode_T FingerPrint_checkStoredValue (FingerPrint_Number_T fingerPrintNum, FingerPrint_StorageStatusPtr_T fingerPrintValueStatus)
 Reads current FingerPrint reference values from FingerPrint sensor. More...
 
Retcode_T FingerPrint_deInit (void)
 API to Deinitialise the FingerPrint module. More...
 
Retcode_T FingerPrint_init (FingerPrint_HandlePtr_T handle)
 Initializes the FingerPrint sensor. More...
 
Retcode_T FingerPrint_monitoring (FingerPrint_Monitor_DataPtr_T fingerPrintResult)
 Monitors whether the measured data matches with stored FingerPrint values from FingerPrint sensor. More...
 
Retcode_T FingerPrint_resetValue (FingerPrint_Number_T fingerPrintNum)
 Clears the reference value for the selected FingerPrint. More...
 
Retcode_T FingerPrint_setValue (FingerPrint_Number_T fingerPrintNum)
 Sets the reference value for the selected FingerPrint. More...
 

Detailed Description

Limitations of FingerPrint:
Other virtual sensors cannot be used while using virtual sensor FingerPrint.


Data Structure Documentation

struct FingerPrint_MonitorData_S

Data structure for FingerPrint monitoring output data

Data Fields

FingerPrint_Output_DataType_T fpAngleMatching
 
FingerPrint_Output_DataType_T fpDistanceMatching
 

Field Documentation

holds FingerPrint angle monitoring output. When matchinAngle < 1: measurement is not matching with FingerPrint reference value

FingerPrint_Output_DataType_T fpDistanceMatching

holds FingerPrint distance monitoring output When matchingDistance = 0: measurement is 100% not matching FingerPrint reference value

Typedef Documentation

typedef void* FingerPrint_HandlePtr_T

Defines the handle for FingerPrint sensor

Data type used for reading FingerPrint output data

typedef uint8_t FingerPrint_StorageStatus_T

Data type for FingerPrint storage status

typedef uint8_t * FingerPrint_StorageStatusPtr_T

Enumeration Type Documentation

Enum values to represent the different FingerPrint reference values

Enumerator
FINGERPRINT_REF_VAL_1 

Specifies FingerPrint 1 to be recorded

FINGERPRINT_REF_VAL_2 

Specifies FingerPrint 2 to be recorded

FINGERPRINT_REF_VAL_3 

Specifies FingerPrint 3 to be recorded

FINGERPRINT_REF_MAX 

Specifies maximum number of recordable FingerPrint

Enum values that represent finger print storage status

Enumerator
FINGERPRINT_EMPTY 

FingerPrint empty

FINGERPRINT_RECORDED 

FingerPrint recorded

Function Documentation

Retcode_T FingerPrint_checkStoredValue ( FingerPrint_Number_T  fingerPrintNum,
FingerPrint_StorageStatusPtr_T  fingerPrintValueStatus 
)
Parameters
[in]fingerPrintNuminput parameter for which finger print stored value has to be checked.
[out]fingerPrintValueStatusoutput parameter in which finger print value will be written to, from within function
Return values
RETCODE_OKFingerPrint sensor initialization success.
RETCODE_FAILUREIn case of invalid fingerPrintNum.
Note
The return value consist of (First 1 MSByte represents Package ID, Next Byte represents Severity and Last 2 LSBytes represents error code).
Pass the return value of this function to #BCDS_getUserErrorCode() API to know the user type return code present in #BCDS_SensorErrorType.h.
Retcode_T FingerPrint_deInit ( void  )
Return values
RETCODE_OKFingerPrint sensor De-initialization success.
RETCODE_FAILUREFingerPrint sensor De-initialization failure.
Warning
This API needs to be called when we require to stop the FingerPrint Gyroscope data reading.
Note
The return value consist of (First 1 MSByte represents Package ID, Next Byte represents Severity and Last 2 LSBytes represents error code).
Pass the return value of this function to #BCDS_getUserErrorCode() API to know the user type return code present in #BCDS_SensorErrorType.h.
Retcode_T FingerPrint_init ( FingerPrint_HandlePtr_T  handle)
Parameters
[in]FingerPrint_HandlePtr_Tthe handle to the FingerPrint object that should be initialized
Return values
RETCODE_OKFingerPrint sensor initialization success.
RETCODE_INVALID_PARAMIn case of invalid sensor handle.
Warning
This function needs to be called before calling any other function of the FingerPrint sensor api.
Note
The return value consist of (First 1 MSByte represents Package ID, Next Byte represents Severity and Last 2 LSBytes represents error code).
Pass the return value of this function to #BCDS_getUserErrorCode() API to know the user type return code present in #BCDS_SensorErrorType.h.
Retcode_T FingerPrint_monitoring ( FingerPrint_Monitor_DataPtr_T  fingerPrintResult)
Parameters
[out]fingerPrintResultoutput parameter in which the finger print monitored value will be written to, from within the function
Return values
RETCODE_OKFingerPrint sensor initialization success.
RETCODE_FAILUREIn case of invalid fingerPrintResult.
Note
The return value consist of (First 1 MSByte represents Package ID, Next Byte represents Severity and Last 2 LSBytes represents error code).
Pass the return value of this function to #BCDS_getUserErrorCode() API to know the user type return code present in #BCDS_SensorErrorType.h.
Retcode_T FingerPrint_resetValue ( FingerPrint_Number_T  fingerPrintNum)
Parameters
[in]fingerPrintNumreference value that is used to clear finger print
Return values
RETCODE_OKFingerPrint sensor initialization success.
RETCODE_FAILUREIn case of invalid fingerPrintNum.
Note
The return value consist of (First 1 MSByte represents Package ID, Next Byte represents Severity and Last 2 LSBytes represents error code).
Pass the return value of this function to #BCDS_getUserErrorCode() API to know the user type return code present in #BCDS_SensorErrorType.h.
Retcode_T FingerPrint_setValue ( FingerPrint_Number_T  fingerPrintNum)
Parameters
[in]fingerPrintNumreference value that is set for the finger print sensor
Return values
RETCODE_OKFingerPrint sensor initialization success.
RETCODE_FAILUREIn case of invalid fingerPrintNum.
Note
The return value consist of (First 1 MSByte represents Package ID, Next Byte represents Severity and Last 2 LSBytes represents error code).
Pass the return value of this function to #BCDS_getUserErrorCode() API to know the user type return code present in #BCDS_SensorErrorType.h.

All rights reserved. The use is subject to the XDK SDK EULA by Bosch Connected Devices and Solutions GmbH.
This documentation file has been automatically generated on Thu Mar 14 2019 19:12:51 by doxygen 1.8.8