as608 example driver modules More...

Collaboration diagram for as608 example driver function:

Macros
#define	AS608_ADVANCE_SEND_CONFIG 0
	as608 advance send command configure
#define	AS608_ADVANCE_DEFAULT_PORT AS608_BOOL_TRUE
	as608 advance example default definition
#define	AS608_ADVANCE_DEFAULT_BAUD_RATE 6
#define	AS608_ADVANCE_DEFAULT_LEVEL AS608_LEVEL_3
#define	AS608_ADVANCE_DEFAULT_PACKET_SIZE AS608_PACKET_SIZE_128_BYTES
#define	AS608_ADVANCE_DEFAULT_PASSWORD 0x00000000
#define	AS608_ADVANCE_DEFAULT_ADDRESS 0xFFFFFFFF
#define	AS608_ADVANCE_DEFAULT_FEATURE AS608_BUFFER_NUMBER_1
#define	AS608_ADVANCE_DEFAULT_TIMEOUT 10
#define	AS608_BASIC_SEND_CONFIG 0
	as608 basic send command configure
#define	AS608_BASIC_DEFAULT_PORT AS608_BOOL_TRUE
	as608 basic example default definition
#define	AS608_BASIC_DEFAULT_BAUD_RATE 6
#define	AS608_BASIC_DEFAULT_LEVEL AS608_LEVEL_3
#define	AS608_BASIC_DEFAULT_PACKET_SIZE AS608_PACKET_SIZE_128_BYTES
#define	AS608_BASIC_DEFAULT_PASSWORD 0x00000000
#define	AS608_BASIC_DEFAULT_ADDRESS 0xFFFFFFFF
#define	AS608_BASIC_DEFAULT_FEATURE AS608_BUFFER_NUMBER_1
#define	AS608_BASIC_DEFAULT_TIMEOUT 10

Functions
uint8_t	as608_advance_init (uint32_t addr)
	advance example init
uint8_t	as608_advance_deinit (void)
	advance example deinit
uint8_t	as608_advance_print_status (as608_status_t status)
	advance example print status
uint8_t	as608_advance_input_fingerprint (void(callback)(int8_t status, const char const fmt,...), uint16_t score, uint16_t page_number, as608_status_t *status)
	advance example input fingerprint
uint8_t	as608_advance_verify (uint16_t found_page, uint16_t score, as608_status_t *status)
	advance example verify
uint8_t	as608_advance_high_speed_verify (uint16_t found_page, uint16_t score, as608_status_t *status)
	advance example high speed verify
uint8_t	as608_advance_delete_fingerprint (uint16_t page_number, as608_status_t *status)
	advance example delete fingerprint
uint8_t	as608_advance_empty_fingerprint (as608_status_t *status)
	advance example empty fingerprint
uint8_t	as608_advance_write_notepad (uint8_t page_number, uint8_t data[32], as608_status_t *status)
	advance example write notepad
uint8_t	as608_advance_read_notepad (uint8_t page_number, uint8_t data[32], as608_status_t *status)
	advance example read notepad
uint8_t	as608_advance_random (uint32_t randn, as608_status_t status)
	advance example get random
uint8_t	as608_advance_flash_information (uint8_t output_buffer, uint16_t output_len, as608_status_t *status)
	advance example get flash information
uint8_t	as608_advance_params (as608_params_t params, as608_status_t status)
	advance example get params
uint8_t	as608_advance_enroll (uint16_t page_number, as608_status_t status)
	advance example enroll
uint8_t	as608_advance_identify (uint16_t page_number, uint16_t score, as608_status_t *status)
	advance example identify
uint8_t	as608_advance_upload_flash_feature (uint16_t page_number, uint8_t output_buffer, uint16_t output_len, as608_status_t *status)
	advance example upload flash feature
uint8_t	as608_advance_upload_image_feature (uint8_t output_buffer, uint16_t output_len, as608_status_t *status)
	advance example upload image feature
uint8_t	as608_advance_download_flash_feature (uint16_t page_number, uint8_t input_buffer, uint16_t input_len, as608_status_t status)
	advance example download flash feature
uint8_t	as608_advance_upload_image (uint8_t output_buffer, uint16_t output_len, as608_status_t *status)
	advance example upload image
uint8_t	as608_advance_download_image (uint16_t page_number, uint8_t input_buffer, uint16_t input_len, as608_status_t status)
	advance example download image
uint8_t	as608_basic_init (uint32_t addr)
	basic example init
uint8_t	as608_basic_deinit (void)
	basic example deinit
uint8_t	as608_basic_print_status (as608_status_t status)
	basic example print status
uint8_t	as608_basic_input_fingerprint (void(callback)(int8_t status, const char const fmt,...), uint16_t score, uint16_t page_number, as608_status_t *status)
	basic example input fingerprint
uint8_t	as608_basic_verify (uint16_t found_page, uint16_t score, as608_status_t *status)
	basic example verify
uint8_t	as608_basic_high_speed_verify (uint16_t found_page, uint16_t score, as608_status_t *status)
	basic example high speed verify
uint8_t	as608_basic_delete_fingerprint (uint16_t page_number, as608_status_t *status)
	basic example delete fingerprint
uint8_t	as608_basic_empty_fingerprint (as608_status_t *status)
	basic example empty fingerprint

Detailed Description

as608 example driver modules

Macro Definition Documentation

◆ AS608_ADVANCE_DEFAULT_ADDRESS

#define AS608_ADVANCE_DEFAULT_ADDRESS 0xFFFFFFFF

0xFFFFFFFF

Definition at line 66 of file driver_as608_advance.h.

◆ AS608_ADVANCE_DEFAULT_BAUD_RATE

#define AS608_ADVANCE_DEFAULT_BAUD_RATE 6

57600 bps

Definition at line 62 of file driver_as608_advance.h.

◆ AS608_ADVANCE_DEFAULT_FEATURE

#define AS608_ADVANCE_DEFAULT_FEATURE AS608_BUFFER_NUMBER_1

buffer number 1

Definition at line 67 of file driver_as608_advance.h.

◆ AS608_ADVANCE_DEFAULT_LEVEL

#define AS608_ADVANCE_DEFAULT_LEVEL AS608_LEVEL_3

level 3

Definition at line 63 of file driver_as608_advance.h.

◆ AS608_ADVANCE_DEFAULT_PACKET_SIZE

#define AS608_ADVANCE_DEFAULT_PACKET_SIZE AS608_PACKET_SIZE_128_BYTES

128 bytes

Definition at line 64 of file driver_as608_advance.h.

◆ AS608_ADVANCE_DEFAULT_PASSWORD

#define AS608_ADVANCE_DEFAULT_PASSWORD 0x00000000

0x00000000

Definition at line 65 of file driver_as608_advance.h.

◆ AS608_ADVANCE_DEFAULT_PORT

#define AS608_ADVANCE_DEFAULT_PORT AS608_BOOL_TRUE

as608 advance example default definition

enable

Definition at line 61 of file driver_as608_advance.h.

◆ AS608_ADVANCE_DEFAULT_TIMEOUT

#define AS608_ADVANCE_DEFAULT_TIMEOUT 10

10s

Definition at line 68 of file driver_as608_advance.h.

◆ AS608_ADVANCE_SEND_CONFIG

#define AS608_ADVANCE_SEND_CONFIG 0

as608 advance send command configure

don't send

Definition at line 55 of file driver_as608_advance.h.

◆ AS608_BASIC_DEFAULT_ADDRESS

#define AS608_BASIC_DEFAULT_ADDRESS 0xFFFFFFFF

0xFFFFFFFF

Definition at line 68 of file driver_as608_basic.h.

◆ AS608_BASIC_DEFAULT_BAUD_RATE

#define AS608_BASIC_DEFAULT_BAUD_RATE 6

57600 bps

Definition at line 64 of file driver_as608_basic.h.

◆ AS608_BASIC_DEFAULT_FEATURE

#define AS608_BASIC_DEFAULT_FEATURE AS608_BUFFER_NUMBER_1

buffer number 1

Definition at line 69 of file driver_as608_basic.h.

◆ AS608_BASIC_DEFAULT_LEVEL

#define AS608_BASIC_DEFAULT_LEVEL AS608_LEVEL_3

level 3

Definition at line 65 of file driver_as608_basic.h.

◆ AS608_BASIC_DEFAULT_PACKET_SIZE

#define AS608_BASIC_DEFAULT_PACKET_SIZE AS608_PACKET_SIZE_128_BYTES

128 bytes

Definition at line 66 of file driver_as608_basic.h.

◆ AS608_BASIC_DEFAULT_PASSWORD

#define AS608_BASIC_DEFAULT_PASSWORD 0x00000000

0x00000000

Definition at line 67 of file driver_as608_basic.h.

◆ AS608_BASIC_DEFAULT_PORT

#define AS608_BASIC_DEFAULT_PORT AS608_BOOL_TRUE

as608 basic example default definition

enable

Definition at line 63 of file driver_as608_basic.h.

◆ AS608_BASIC_DEFAULT_TIMEOUT

#define AS608_BASIC_DEFAULT_TIMEOUT 10

10s

Definition at line 70 of file driver_as608_basic.h.

◆ AS608_BASIC_SEND_CONFIG

#define AS608_BASIC_SEND_CONFIG 0

as608 basic send command configure

don't send

Definition at line 57 of file driver_as608_basic.h.

Function Documentation

◆ as608_advance_deinit()

uint8_t as608_advance_deinit ( void )

advance example deinit

Returns

status code

0 success
1 deinit failed

Note: none

Definition at line 930 of file driver_as608_advance.c.

Here is the call graph for this function:

◆ as608_advance_delete_fingerprint()

uint8_t as608_advance_delete_fingerprint	(	uint16_t	page_number,
		as608_status_t *	status )

advance example delete fingerprint

Parameters

[in]	page_number	page number
[out]	*status	pointer to a status buffer

Returns

status code

0 success
1 delete fingerprint failed

Note: none

Definition at line 542 of file driver_as608_advance.c.

Here is the call graph for this function:

◆ as608_advance_download_flash_feature()

uint8_t as608_advance_download_flash_feature	(	uint16_t	page_number,
		uint8_t *	input_buffer,
		uint16_t	input_len,
		as608_status_t *	status )

advance example download flash feature

Parameters

[in]	page_number	page number
[in]	*input_buffer	pointer to an input buffer
[in]	input_len	input length
[out]	*status	pointer to a status buffer

Returns

status code

0 success
1 download flash feature failed

Note: none

Definition at line 840 of file driver_as608_advance.c.

Here is the call graph for this function:

◆ as608_advance_download_image()

uint8_t as608_advance_download_image	(	uint16_t	page_number,
		uint8_t *	input_buffer,
		uint16_t	input_len,
		as608_status_t *	status )

advance example download image

Parameters

[in]	page_number	page number
[in]	*input_buffer	pointer to an input buffer
[in]	input_len	input length
[out]	*status	pointer to a status buffer

Returns

status code

0 success
1 download image failed

Note: none

Definition at line 909 of file driver_as608_advance.c.

Here is the call graph for this function:

◆ as608_advance_empty_fingerprint()

uint8_t as608_advance_empty_fingerprint ( as608_status_t * status )

advance example empty fingerprint

Parameters

[out] *status pointer to a status buffer

Returns

status code

0 success
1 empty fingerprint failed

Note: none

Definition at line 564 of file driver_as608_advance.c.

Here is the call graph for this function:

◆ as608_advance_enroll()

uint8_t as608_advance_enroll	(	uint16_t *	page_number,
		as608_status_t *	status )

advance example enroll

Parameters

[out]	*page_number	pointer to a page number buffer
[out]	*status	pointer to a status buffer

Returns

status code

0 success
1 enroll failed

Note: none

Definition at line 705 of file driver_as608_advance.c.

Here is the call graph for this function:

◆ as608_advance_flash_information()

uint8_t as608_advance_flash_information	(	uint8_t *	output_buffer,
		uint16_t *	output_len,
		as608_status_t *	status )

advance example get flash information

Parameters

[out]	*output_buffer	pointer to an output buffer
[in,out]	*output_len	pointer to an output length buffer
[out]	*status	pointer to a status buffer

Returns

status code

0 success
1 get flash information failed

Note: none

Definition at line 659 of file driver_as608_advance.c.

Here is the call graph for this function:

◆ as608_advance_high_speed_verify()

uint8_t as608_advance_high_speed_verify	(	uint16_t *	found_page,
		uint16_t *	score,
		as608_status_t *	status )

advance example high speed verify

Parameters

[out]	*found_page	pointer to a found page buffer
[out]	*score	pointer to a score buffer
[out]	*status	pointer to a status buffer

Returns

status code

0 success
1 high speed verify failed

Note: none

Definition at line 472 of file driver_as608_advance.c.

Here is the call graph for this function:

◆ as608_advance_identify()

uint8_t as608_advance_identify	(	uint16_t *	page_number,
		uint16_t *	score,
		as608_status_t *	status )

advance example identify

Parameters

[out]	*page_number	pointer to a page number buffer
[out]	*score	pointer to a score buffer
[out]	*status	pointer to a status buffer

Returns

status code

0 success
1 identify failed

Note: none

Definition at line 729 of file driver_as608_advance.c.

Here is the call graph for this function:

◆ as608_advance_init()

uint8_t as608_advance_init ( uint32_t addr )

advance example init

Parameters

[in] addr chip address

Returns

status code

0 success
1 init failed

Note: none

Definition at line 50 of file driver_as608_advance.c.

Here is the call graph for this function:

◆ as608_advance_input_fingerprint()

uint8_t as608_advance_input_fingerprint	(	void(*	callback )(int8_t status, const char *const fmt,...),
		uint16_t *	score,
		uint16_t *	page_number,
		as608_status_t *	status )

advance example input fingerprint

Parameters

[out]	*callback	pointer to a callback function
[out]	*score	pointer to a score buffer
[out]	*page_number	pointer to a page number buffer
[out]	*status	pointer to a status buffer

Returns

status code

0 success
1 input fingerprint failed
2 timeout

Note

callback status

-1 error
0 please put your finger on the sensor
1 please put your finger on the sensor again
2 generate feature success

Definition at line 214 of file driver_as608_advance.c.

Here is the call graph for this function:

◆ as608_advance_params()

uint8_t as608_advance_params	(	as608_params_t *	params,
		as608_status_t *	status )

advance example get params

Parameters

[out]	*params	pointer to a param structure
[out]	*status	pointer to a status buffer

Returns

status code

0 success
1 get params failed

Note: none

Definition at line 682 of file driver_as608_advance.c.

Here is the call graph for this function:

◆ as608_advance_print_status()

uint8_t as608_advance_print_status ( as608_status_t status )

advance example print status

Parameters

[in] status print status

Returns

status code

0 success
1 print failed

Note: none

Definition at line 519 of file driver_as608_advance.c.

Here is the call graph for this function:

◆ as608_advance_random()

uint8_t as608_advance_random	(	uint32_t *	randn,
		as608_status_t *	status )

advance example get random

Parameters

[out]	*randn	pointer to a random buffer
[out]	*status	pointer to a status buffer

Returns

status code

0 success
1 random failed

Note: none

Definition at line 635 of file driver_as608_advance.c.

Here is the call graph for this function:

◆ as608_advance_read_notepad()

uint8_t as608_advance_read_notepad	(	uint8_t	page_number,
		uint8_t	data[32],
		as608_status_t *	status )

advance example read notepad

Parameters

[in]	page_number	page number
[out]	*data	pointer to an output buffer
[out]	*status	pointer to a status buffer

Returns

status code

0 success
1 read notepad failed

Note: none

Definition at line 612 of file driver_as608_advance.c.

Here is the call graph for this function:

◆ as608_advance_upload_flash_feature()

uint8_t as608_advance_upload_flash_feature	(	uint16_t	page_number,
		uint8_t *	output_buffer,
		uint16_t *	output_len,
		as608_status_t *	status )

advance example upload flash feature

Parameters

[in]	page_number	page number
[out]	*output_buffer	pointer to an output buffer
[in,out]	*output_len	pointer to an output length buffer
[out]	*status	pointer to a status buffer

Returns

status code

0 success
1 upload flash feature failed

Note: none

Definition at line 754 of file driver_as608_advance.c.

Here is the call graph for this function:

◆ as608_advance_upload_image()

uint8_t as608_advance_upload_image	(	uint8_t *	output_buffer,
		uint16_t *	output_len,
		as608_status_t *	status )

advance example upload image

Parameters

[out]	*output_buffer	pointer to an output buffer
[in,out]	*output_len	pointer to an output length buffer
[out]	*status	pointer to a status buffer

Returns

status code

0 success
1 upload image failed

Note: none

Definition at line 873 of file driver_as608_advance.c.

Here is the call graph for this function:

◆ as608_advance_upload_image_feature()

uint8_t as608_advance_upload_image_feature	(	uint8_t *	output_buffer,
		uint16_t *	output_len,
		as608_status_t *	status )

advance example upload image feature

Parameters

[out]	*output_buffer	pointer to an output buffer
[in,out]	*output_len	pointer to an output length buffer
[out]	*status	pointer to a status buffer

Returns

status code

0 success
1 upload image feature failed

Note: none

Definition at line 792 of file driver_as608_advance.c.

Here is the call graph for this function:

◆ as608_advance_verify()

uint8_t as608_advance_verify	(	uint16_t *	found_page,
		uint16_t *	score,
		as608_status_t *	status )

advance example verify

Parameters

[out]	*found_page	pointer to a found page buffer
[out]	*score	pointer to a score buffer
[out]	*status	pointer to a status buffer

Returns

status code

0 success
1 verify failed

Note: none

Definition at line 423 of file driver_as608_advance.c.

Here is the call graph for this function:

◆ as608_advance_write_notepad()

uint8_t as608_advance_write_notepad	(	uint8_t	page_number,
		uint8_t	data[32],
		as608_status_t *	status )

advance example write notepad

Parameters

[in]	page_number	page number
[in]	*data	pointer to an input buffer
[out]	*status	pointer to a status buffer

Returns

status code

0 success
1 write notepad failed

Note: none

Definition at line 588 of file driver_as608_advance.c.

Here is the call graph for this function:

◆ as608_basic_deinit()

uint8_t as608_basic_deinit ( void )

basic example deinit

Returns

status code

0 success
1 deinit failed

Note: none

Definition at line 585 of file driver_as608_basic.c.

Here is the call graph for this function:

◆ as608_basic_delete_fingerprint()

uint8_t as608_basic_delete_fingerprint	(	uint16_t	page_number,
		as608_status_t *	status )

basic example delete fingerprint

Parameters

[in]	page_number	page number
[out]	*status	pointer to a status buffer

Returns

status code

0 success
1 delete fingerprint failed

Note: none

Definition at line 542 of file driver_as608_basic.c.

Here is the call graph for this function:

◆ as608_basic_empty_fingerprint()

uint8_t as608_basic_empty_fingerprint ( as608_status_t * status )

basic example empty fingerprint

Parameters

[out] *status pointer to a status buffer

Returns

status code

0 success
1 empty fingerprint failed

Note: none

Definition at line 564 of file driver_as608_basic.c.

Here is the call graph for this function:

◆ as608_basic_high_speed_verify()

uint8_t as608_basic_high_speed_verify	(	uint16_t *	found_page,
		uint16_t *	score,
		as608_status_t *	status )

basic example high speed verify

Parameters

[out]	*found_page	pointer to a found page buffer
[out]	*score	pointer to a score buffer
[out]	*status	pointer to a status buffer

Returns

status code

0 success
1 high speed verify failed

Note: none

Definition at line 472 of file driver_as608_basic.c.

Here is the call graph for this function:

◆ as608_basic_init()

uint8_t as608_basic_init ( uint32_t addr )

basic example init

Parameters

[in] addr chip address

Returns

status code

0 success
1 init failed

Note: none

Definition at line 50 of file driver_as608_basic.c.

Here is the call graph for this function:

◆ as608_basic_input_fingerprint()

uint8_t as608_basic_input_fingerprint	(	void(*	callback )(int8_t status, const char *const fmt,...),
		uint16_t *	score,
		uint16_t *	page_number,
		as608_status_t *	status )

basic example input fingerprint

Parameters

[out]	*callback	pointer to a callback function
[out]	*score	pointer to a score buffer
[out]	*page_number	pointer to a page number buffer
[out]	*status	pointer to a status buffer

Returns

status code

0 success
1 input fingerprint failed
2 timeout

Note

callback status

-1 error
0 please put your finger on the sensor
1 please put your finger on the sensor again
2 generate feature success

Definition at line 214 of file driver_as608_basic.c.

Here is the call graph for this function:

◆ as608_basic_print_status()

uint8_t as608_basic_print_status ( as608_status_t status )

basic example print status

Parameters

[in] status print status

Returns

status code

0 success
1 print failed

Note: none

Definition at line 519 of file driver_as608_basic.c.

Here is the call graph for this function:

◆ as608_basic_verify()

uint8_t as608_basic_verify	(	uint16_t *	found_page,
		uint16_t *	score,
		as608_status_t *	status )

basic example verify

Parameters

[out]	*found_page	pointer to a found page buffer
[out]	*score	pointer to a score buffer
[out]	*status	pointer to a status buffer

Returns

status code

0 success
1 verify failed

Note: none

Definition at line 423 of file driver_as608_basic.c.

Here is the call graph for this function:

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ AS608_ADVANCE_DEFAULT_ADDRESS

◆ AS608_ADVANCE_DEFAULT_BAUD_RATE

◆ AS608_ADVANCE_DEFAULT_FEATURE

◆ AS608_ADVANCE_DEFAULT_LEVEL

◆ AS608_ADVANCE_DEFAULT_PACKET_SIZE

◆ AS608_ADVANCE_DEFAULT_PASSWORD

◆ AS608_ADVANCE_DEFAULT_PORT

◆ AS608_ADVANCE_DEFAULT_TIMEOUT

◆ AS608_ADVANCE_SEND_CONFIG

◆ AS608_BASIC_DEFAULT_ADDRESS

◆ AS608_BASIC_DEFAULT_BAUD_RATE

◆ AS608_BASIC_DEFAULT_FEATURE

◆ AS608_BASIC_DEFAULT_LEVEL

◆ AS608_BASIC_DEFAULT_PACKET_SIZE

◆ AS608_BASIC_DEFAULT_PASSWORD

◆ AS608_BASIC_DEFAULT_PORT

◆ AS608_BASIC_DEFAULT_TIMEOUT

◆ AS608_BASIC_SEND_CONFIG

Function Documentation

◆ as608_advance_deinit()

◆ as608_advance_delete_fingerprint()

◆ as608_advance_download_flash_feature()

◆ as608_advance_download_image()

◆ as608_advance_empty_fingerprint()

◆ as608_advance_enroll()

◆ as608_advance_flash_information()

◆ as608_advance_high_speed_verify()

◆ as608_advance_identify()

◆ as608_advance_init()

◆ as608_advance_input_fingerprint()

◆ as608_advance_params()

◆ as608_advance_print_status()

◆ as608_advance_random()

◆ as608_advance_read_notepad()

◆ as608_advance_upload_flash_feature()

◆ as608_advance_upload_image()

◆ as608_advance_upload_image_feature()

◆ as608_advance_verify()

◆ as608_advance_write_notepad()

◆ as608_basic_deinit()

◆ as608_basic_delete_fingerprint()

◆ as608_basic_empty_fingerprint()

◆ as608_basic_high_speed_verify()

◆ as608_basic_init()

◆ as608_basic_input_fingerprint()

◆ as608_basic_print_status()

◆ as608_basic_verify()