API for configuring and manipulating Fingerprint 4 Click driver. More...

Topics
	Fingerprint 4 Registers List
	List of registers of Fingerprint 4 Click driver.

	Fingerprint 4 Registers Settings
	Settings for registers of Fingerprint 4 Click driver.

	Fingerprint 4 MikroBUS Map
	MikroBUS pin mapping of Fingerprint 4 Click driver.

Functions
void	fingerprint4_cfg_setup (fingerprint4_cfg_t *cfg)
	Fingerprint 4 configuration object setup function.

err_t	fingerprint4_init (fingerprint4_t ctx, fingerprint4_cfg_t cfg)
	Fingerprint 4 initialization function.

err_t	fingerprint4_generic_write (fingerprint4_t ctx, uint8_t data_in, uint16_t len)
	Fingerprint 4 data writing function.

err_t	fingerprint4_generic_read (fingerprint4_t ctx, uint8_t data_out, uint16_t len)
	Fingerprint 4 data reading function.

void	fingerprint4_set_rst_pin (fingerprint4_t *ctx, uint8_t state)
	Fingerprint 4 set rst pin function.

uint8_t	fingerprint4_get_irq_pin (fingerprint4_t *ctx)
	Fingerprint 4 get irq pin function.

void	fingerprint4_reset_device (fingerprint4_t *ctx)
	Fingerprint 4 reset device function.

err_t	fingerprint4_init_cmd (fingerprint4_t *ctx, uint16_t cmd, uint16_t arg_key)
	Fingerprint 4 init cmd function.

err_t	fingerprint4_add_arg (fingerprint4_t ctx, uint16_t arg_key, void arg_data, uint16_t arg_size)
	Fingerprint 4 add arg function.

err_t	fingerprint4_get_arg (fingerprint4_t *ctx, uint16_t arg_key)
	Fingerprint 4 get arg function.

err_t	fingerprint4_copy_arg (fingerprint4_t ctx, uint16_t arg_key, void arg_data, uint16_t arg_size)
	Fingerprint 4 copy arg function.

err_t	fingerprint4_transceive (fingerprint4_t *ctx)
	Fingerprint 4 transceive function.

err_t	fingerprint4_receive (fingerprint4_t *ctx)
	Fingerprint 4 receive function.

err_t	fingerprint4_send (fingerprint4_t *ctx)
	Fingerprint 4 send function.

err_t	fingerprint4_send_cmd (fingerprint4_t *ctx, uint16_t cmd, uint16_t arg_key)
	Fingerprint 4 send cmd function.

err_t	fingerprint4_send_cmd_arg (fingerprint4_t ctx, uint16_t cmd, uint16_t arg1_key, uint16_t arg2_key, void arg2_data, uint16_t arg2_length)
	Fingerprint 4 send cmd arg function.

err_t	fingerprint4_identify_finger (fingerprint4_t ctx, uint32_t timeout, uint16_t template_id, bool *match)
	Fingerprint 4 identify finger function.

err_t	fingerprint4_wait_finger_present (fingerprint4_t *ctx, uint32_t timeout)
	Fingerprint 4 wait finger present function.

err_t	fingerprint4_wait_finger_not_present (fingerprint4_t *ctx, uint32_t timeout)
	Fingerprint 4 wait finger not present function.

err_t	fingerprint4_image_get_size (fingerprint4_t ctx, uint32_t size)
	Fingerprint 4 image get size function.

err_t	fingerprint4_image_create (fingerprint4_t *ctx)
	Fingerprint 4 image create function.

err_t	fingerprint4_image_delete (fingerprint4_t *ctx)
	Fingerprint 4 image delete function.

err_t	fingerprint4_image_get (fingerprint4_t ctx, uint8_t data_out, uint32_t size)
	Fingerprint 4 image get function.

err_t	fingerprint4_image_put (fingerprint4_t ctx, uint8_t data_in, uint32_t size)
	Fingerprint 4 image put function.

err_t	fingerprint4_image_extract (fingerprint4_t *ctx)
	Fingerprint 4 image extract function.

err_t	fingerprint4_identify (fingerprint4_t *ctx)
	Fingerprint 4 identify function.

err_t	fingerprint4_template_save (fingerprint4_t *ctx, uint16_t template_id)
	Fingerprint 4 template save function.

err_t	fingerprint4_template_remove_ram (fingerprint4_t *ctx)
	Fingerprint 4 template remove ram function.

err_t	fingerprint4_template_get (fingerprint4_t ctx, uint8_t data_out, uint32_t size)
	Fingerprint 4 template get function.

err_t	fingerprint4_template_put (fingerprint4_t ctx, uint8_t data_in, uint16_t size)
	Fingerprint 4 template put function.

err_t	fingerprint4_template_remove (fingerprint4_t *ctx, uint16_t template_id)
	Fingerprint 4 template remove function.

err_t	fingerprint4_template_remove_all (fingerprint4_t *ctx)
	Fingerprint 4 template remove all function.

err_t	fingerprint4_template_load_storage (fingerprint4_t *ctx, uint16_t template_id)
	Fingerprint 4 template load storage function.

err_t	fingerprint4_template_get_count (fingerprint4_t ctx, uint16_t count)
	Fingerprint 4 template get count function.

err_t	fingerprint4_template_get_ids (fingerprint4_t *ctx)
	Fingerprint 4 template get ids function.

err_t	fingerprint4_sw_reset (fingerprint4_t *ctx)
	Fingerprint 4 sw reset function.

err_t	fingerprint4_sensor_calibrate (fingerprint4_t *ctx)
	Fingerprint 4 sensor calibrate function.

err_t	fingerprint4_sensor_calibrate_remove (fingerprint4_t *ctx)
	Fingerprint 4 sensor calibrate remove function.

err_t	fingerprint4_version (fingerprint4_t ctx, char version, uint8_t len)
	Fingerprint 4 version function.

err_t	fingerprint4_unique_id_get (fingerprint4_t ctx, uint8_t unique_id)
	Fingerprint 4 version function.

err_t	fingerprint4_uart_speed_set (fingerprint4_t *ctx, uint32_t speed)
	Fingerprint 4 uart speed set function.

err_t	fingerprint4_uart_speed_get (fingerprint4_t ctx, uint32_t speed)
	Fingerprint 4 uart speed get function.

err_t	fingerprint4_sensor_reset (fingerprint4_t *ctx)
	Fingerprint 4 sensor reset function.

Detailed Description

API for configuring and manipulating Fingerprint 4 Click driver.

Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.

Function Documentation

◆ fingerprint4_add_arg()

err_t fingerprint4_add_arg	(	fingerprint4_t *	ctx,
		uint16_t	arg_key,
		void *	arg_data,
		uint16_t	arg_size )

Fingerprint 4 add arg function.

This function adds an argument to the HCP command in the ctx->phy_pkt. Must be used only after the command is initialized with fingerprint4_init_cmd().

Parameters

[in]	ctx	: Click context object. See fingerprint4_t object definition for detailed explanation.
[in]	arg_key	: HCP argument key word.
[in]	arg_data	: HCP argument data payload.
[in]	arg_size	: HCP argument payload size.

Returns

0 - Success,
<0 - Error. See fingerprint4_return_value_t definition for detailed explanation.

Note: None.

◆ fingerprint4_cfg_setup()

void fingerprint4_cfg_setup ( fingerprint4_cfg_t * cfg )

Fingerprint 4 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

[out] cfg : Click configuration structure. See fingerprint4_cfg_t object definition for detailed explanation.

Returns: Nothing.

Note: The all used pins will be set to unconnected state.

◆ fingerprint4_copy_arg()

err_t fingerprint4_copy_arg	(	fingerprint4_t *	ctx,
		uint16_t	arg_key,
		void *	arg_data,
		uint16_t	arg_size )

Fingerprint 4 copy arg function.

This function searches for the selected argument in the ctx->phy_pkt. If found, it will be stored in the ctx->arg, and arg_size bytes will be copied in the arg_data.

Parameters

[in]	ctx	: Click context object. See fingerprint4_t object definition for detailed explanation.
[in]	arg_key	: HCP argument key word to search for.
[out]	arg_data	: Pointer to memory where to copy argument payload.
[in]	arg_size	: Number of bytes to copy from argument payload to arg_data.

Returns

0 - Success,
<0 - Error. See fingerprint4_return_value_t definition for detailed explanation.

Note: None.

◆ fingerprint4_generic_read()

err_t fingerprint4_generic_read	(	fingerprint4_t *	ctx,
		uint8_t *	data_out,
		uint16_t	len )

Fingerprint 4 data reading function.

This function reads a desired number of data bytes by using FINGERPRINT4_DRV_INTERFACE serial interface.

Parameters

[in]	ctx	: Click context object. See fingerprint4_t object definition for detailed explanation.
[out]	data_out	: Output read data.
[in]	len	: Number of bytes to be read.

Returns

0 - Success,
<0 - Error. See fingerprint4_return_value_t definition for detailed explanation.

Note: None.

◆ fingerprint4_generic_write()

err_t fingerprint4_generic_write	(	fingerprint4_t *	ctx,
		uint8_t *	data_in,
		uint16_t	len )

Fingerprint 4 data writing function.

This function writes a desired number of data bytes by using FINGERPRINT4_DRV_INTERFACE serial interface.

Parameters

[in]	ctx	: Click context object. See fingerprint4_t object definition for detailed explanation.
[in]	data_in	: Data to be written.
[in]	len	: Number of bytes to be written.

Returns

0 - Success,
<0 - Error. See fingerprint4_return_value_t definition for detailed explanation.

Note: None.

◆ fingerprint4_get_arg()

err_t fingerprint4_get_arg	(	fingerprint4_t *	ctx,
		uint16_t	arg_key )

Fingerprint 4 get arg function.

This function searches for the selected argument in the ctx->phy_pkt. If found, it will be stored in the ctx->arg.

Parameters

[in]	ctx	: Click context object. See fingerprint4_t object definition for detailed explanation.
[in]	arg_key	: HCP argument key word to search for.

Returns

0 - Success,
<0 - Error. See fingerprint4_return_value_t definition for detailed explanation.

Note: None.

◆ fingerprint4_get_irq_pin()

uint8_t fingerprint4_get_irq_pin ( fingerprint4_t * ctx )

Fingerprint 4 get irq pin function.

This function returns the IRQ pin logic state.

Parameters

[in] ctx : Click context object. See fingerprint4_t object definition for detailed explanation.

Returns: Pin logic state.

Note: None.

◆ fingerprint4_identify()

err_t fingerprint4_identify ( fingerprint4_t * ctx )

Fingerprint 4 identify function.

This function runs an identification of the template in memory against the templates in storage. Extracts features from an image into a template.

Parameters

[in] ctx : Click context object. See fingerprint4_t object definition for detailed explanation.

Returns

0 - Success,
<0 - Error. See fingerprint4_return_value_t definition for detailed explanation.

Note: None.

◆ fingerprint4_identify_finger()

err_t fingerprint4_identify_finger	(	fingerprint4_t *	ctx,
		uint32_t	timeout,
		uint16_t *	template_id,
		bool *	match )

Fingerprint 4 identify finger function.

This function captures and identifies finger against existing templates in Flash storage.

Parameters

[in]	ctx	: Click context object. See fingerprint4_t object definition for detailed explanation.
[in]	timeout	: Timeout in milliseconds. Set to 0 for waiting indefinitely.
[out]	template_id	: Pointer for matched template ID.
[out]	match	: Pointer to match result. `1` - Match, `0` - No match.

Returns

0 - Success,
<0 - Error. See fingerprint4_return_value_t definition for detailed explanation.

Note: None.

◆ fingerprint4_image_create()

err_t fingerprint4_image_create ( fingerprint4_t * ctx )

Fingerprint 4 image create function.

This function allocates image buffer on the sensor.

Parameters

[in] ctx : Click context object. See fingerprint4_t object definition for detailed explanation.

Returns

0 - Success,
<0 - Error. See fingerprint4_return_value_t definition for detailed explanation.

Note: None.

◆ fingerprint4_image_delete()

err_t fingerprint4_image_delete ( fingerprint4_t * ctx )

Fingerprint 4 image delete function.

This function deletes image buffer on the sensor.

Parameters

[in] ctx : Click context object. See fingerprint4_t object definition for detailed explanation.

Returns

0 - Success,
<0 - Error. See fingerprint4_return_value_t definition for detailed explanation.

Note: None.

◆ fingerprint4_image_extract()

err_t fingerprint4_image_extract ( fingerprint4_t * ctx )

Fingerprint 4 image extract function.

This function extracts features from an image into a template.

Parameters

[in] ctx : Click context object. See fingerprint4_t object definition for detailed explanation.

Returns

0 - Success,
<0 - Error. See fingerprint4_return_value_t definition for detailed explanation.

Note: None.

◆ fingerprint4_image_get()

err_t fingerprint4_image_get	(	fingerprint4_t *	ctx,
		uint8_t *	data_out,
		uint32_t	size )

Fingerprint 4 image get function.

This function pulls captured image from the sensor.

Parameters

[in]	ctx	: Click context object. See fingerprint4_t object definition for detailed explanation.
[out]	data_out	: Pointer to image buffer.
[in]	size	: Size of the image buffer. If buffer size is not enough the image will be truncated. The ctx->arg.size will contain the real size of the image.

Returns

0 - Success,
<0 - Error. See fingerprint4_return_value_t definition for detailed explanation.

Note: None.

◆ fingerprint4_image_get_size()

err_t fingerprint4_image_get_size	(	fingerprint4_t *	ctx,
		uint32_t *	size )

Fingerprint 4 image get size function.

This function reads the size of a captured image.

Parameters

[in]	ctx	: Click context object. See fingerprint4_t object definition for detailed explanation.
[out]	size	: Size of a captured image.

Returns

0 - Success,
<0 - Error. See fingerprint4_return_value_t definition for detailed explanation.

Note: None.

◆ fingerprint4_image_put()

err_t fingerprint4_image_put	(	fingerprint4_t *	ctx,
		uint8_t *	data_in,
		uint32_t	size )

Fingerprint 4 image put function.

This function push image to the sensor.

Parameters

[in]	ctx	: Click context object. See fingerprint4_t object definition for detailed explanation.
[in]	data_in	: Pointer to image buffer.
[in]	size	: Size of the image buffer.

Returns

0 - Success,
<0 - Error. See fingerprint4_return_value_t definition for detailed explanation.

Note: None.

◆ fingerprint4_init()

err_t fingerprint4_init	(	fingerprint4_t *	ctx,
		fingerprint4_cfg_t *	cfg )

Fingerprint 4 initialization function.

This function initializes all necessary pins and peripherals used for this click board.

Parameters

[out]	ctx	: Click context object. See fingerprint4_t object definition for detailed explanation.
[in]	cfg	: Click configuration structure. See fingerprint4_cfg_t object definition for detailed explanation.

Returns

0 - Success,
<0 - Error. See fingerprint4_return_value_t definition for detailed explanation.

Note: None.

◆ fingerprint4_init_cmd()

err_t fingerprint4_init_cmd	(	fingerprint4_t *	ctx,
		uint16_t	cmd,
		uint16_t	arg_key )

Fingerprint 4 init cmd function.

This function initializes a new HCP command in the ctx->phy_pkt.

Parameters

[in]	ctx	: Click context object. See fingerprint4_t object definition for detailed explanation.
[in]	cmd	: HCP command word.
[in]	arg_key	: HCP argument word for the selected command without parameters. Use FINGERPRINT4_ARG_NONE and add arguments with fingerprint4_add_arg() if you need to add argument with parameter.

Returns

0 - Success,
<0 - Error. See fingerprint4_return_value_t definition for detailed explanation.

Note: None.

◆ fingerprint4_receive()

err_t fingerprint4_receive ( fingerprint4_t * ctx )

Fingerprint 4 receive function.

This function reads the answer from the sensor. The result will be stored in the ctx->phy_pkt.

Parameters

[in] ctx : Click context object. See fingerprint4_t object definition for detailed explanation.

Returns

0 - Success,
<0 - Error. See fingerprint4_return_value_t definition for detailed explanation.

Note: None.

◆ fingerprint4_reset_device()

void fingerprint4_reset_device ( fingerprint4_t * ctx )

Fingerprint 4 reset device function.

This function resets the device by toggling the RST pin.

Parameters

[in] ctx : Click context object. See fingerprint4_t object definition for detailed explanation.

Returns: None.

Note: None.

◆ fingerprint4_send()

err_t fingerprint4_send ( fingerprint4_t * ctx )

Fingerprint 4 send function.

This function sends a prepared command packet to the sensor.

Parameters

[in] ctx : Click context object. See fingerprint4_t object definition for detailed explanation.

Returns

0 - Success,
<0 - Error. See fingerprint4_return_value_t definition for detailed explanation.

Note: None.

◆ fingerprint4_send_cmd()

err_t fingerprint4_send_cmd	(	fingerprint4_t *	ctx,
		uint16_t	cmd,
		uint16_t	arg_key )

Fingerprint 4 send cmd function.

This function builds and sends the command packet to the sensor.

Parameters

[in]	ctx	: Click context object. See fingerprint4_t object definition for detailed explanation.
[in]	cmd	: HCP command word.
[in]	arg_key	: HCP argument word for the selected command without parameters. Set to FINGERPRINT4_ARG_NONE if the command has no argument.

Returns

0 - Success,
<0 - Error. See fingerprint4_return_value_t definition for detailed explanation.

Note: None.

◆ fingerprint4_send_cmd_arg()

err_t fingerprint4_send_cmd_arg	(	fingerprint4_t *	ctx,
		uint16_t	cmd,
		uint16_t	arg1_key,
		uint16_t	arg2_key,
		void *	arg2_data,
		uint16_t	arg2_length )

Fingerprint 4 send cmd arg function.

This function builds and sends to the sensor the command packet with additional argument with parameters.

Parameters

[in]	ctx	: Click context object. See fingerprint4_t object definition for detailed explanation.
[in]	cmd	: HCP command word.
[in]	arg1_key	: HCP argument 1 word for the selected command without parameters. Set to FINGERPRINT4_ARG_NONE if the command has no argument without parameter.
[in]	arg2_key	: HCP argument 2 word for the selected command.
[in]	arg2_data	: HCP argument 2 data payload. Set to 0 if the argument 2 has no parameter.
[in]	arg2_length	: HCP argument 2 data length. Set to 0 if the argument 2 has no parameter.

Returns

0 - Success,
<0 - Error. See fingerprint4_return_value_t definition for detailed explanation.

Note: None.

◆ fingerprint4_sensor_calibrate()

err_t fingerprint4_sensor_calibrate ( fingerprint4_t * ctx )

Fingerprint 4 sensor calibrate function.

This function calibrate the sensor and store the calibration data to the Flash storage.

Parameters

[in] ctx : Click context object. See fingerprint4_t object definition for detailed explanation.

Returns

0 - Success,
<0 - Error. See fingerprint4_return_value_t definition for detailed explanation.

Note: None.

◆ fingerprint4_sensor_calibrate_remove()

err_t fingerprint4_sensor_calibrate_remove ( fingerprint4_t * ctx )

Fingerprint 4 sensor calibrate remove function.

This function removes the sensor calibration data from the Flash storage.

Parameters

[in] ctx : Click context object. See fingerprint4_t object definition for detailed explanation.

Returns

0 - Success,
<0 - Error. See fingerprint4_return_value_t definition for detailed explanation.

Note: None.

◆ fingerprint4_sensor_reset()

err_t fingerprint4_sensor_reset ( fingerprint4_t * ctx )

Fingerprint 4 sensor reset function.

This function performs a reset of the sensor.

Parameters

[in] ctx : Click context object. See fingerprint4_t object definition for detailed explanation.

Returns

0 - Success,
<0 - Error. See fingerprint4_return_value_t definition for detailed explanation.

Note: None.

◆ fingerprint4_set_rst_pin()

void fingerprint4_set_rst_pin	(	fingerprint4_t *	ctx,
		uint8_t	state )

Fingerprint 4 set rst pin function.

This function sets the RST pin logic state.

Parameters

[in]	ctx	: Click context object. See fingerprint4_t object definition for detailed explanation.
[in]	state	: Pin logic state.

Returns: None.

Note: None.

◆ fingerprint4_sw_reset()

err_t fingerprint4_sw_reset ( fingerprint4_t * ctx )

Fingerprint 4 sw reset function.

This function performs the software reset of the sensor.

Parameters

[in] ctx : Click context object. See fingerprint4_t object definition for detailed explanation.

Returns

0 - Success,
<0 - Error. See fingerprint4_return_value_t definition for detailed explanation.

Note: None.

◆ fingerprint4_template_get()

err_t fingerprint4_template_get	(	fingerprint4_t *	ctx,
		uint8_t *	data_out,
		uint32_t	size )

Fingerprint 4 template get function.

This function pulls template stored in RAM from the sensor.

Parameters

[in]	ctx	: Click context object. See fingerprint4_t object definition for detailed explanation.
[out]	data_out	: Pointer to template buffer.
[in]	size	: Size of the template buffer. If buffer size is not enough the template will be truncated. The ctx->arg.size will contain the real size of the template.

Returns

0 - Success,
<0 - Error. See fingerprint4_return_value_t definition for detailed explanation.

Note: None.

◆ fingerprint4_template_get_count()

err_t fingerprint4_template_get_count	(	fingerprint4_t *	ctx,
		uint16_t *	count )

Fingerprint 4 template get count function.

This function reads the number of templates in the Flash storage.

Parameters

[in]	ctx	: Click context object. See fingerprint4_t object definition for detailed explanation.
[out]	count	: The number of templates in the Flash storage.

Returns

0 - Success,
<0 - Error. See fingerprint4_return_value_t definition for detailed explanation.

Note: None.

◆ fingerprint4_template_get_ids()

err_t fingerprint4_template_get_ids ( fingerprint4_t * ctx )

Fingerprint 4 template get ids function.

This function get array of template IDs stored in the Flash storage. ctx->arg.payload - pointer to array of uint16_t of IDs ctx->arg.size - length of the array (in bytes). For calculating number of templates divide it by 2.

Parameters

[in] ctx : Click context object. See fingerprint4_t object definition for detailed explanation.

Returns

0 - Success,
<0 - Error. See fingerprint4_return_value_t definition for detailed explanation.

Note: None.

◆ fingerprint4_template_load_storage()

err_t fingerprint4_template_load_storage	(	fingerprint4_t *	ctx,
		uint16_t	template_id )

Fingerprint 4 template load storage function.

This function copies template with the provided ID from Flash storage to RAM.

Parameters

[in]	ctx	: Click context object. See fingerprint4_t object definition for detailed explanation.
[in]	template_id	: The template ID to copy.

Returns

0 - Success,
<0 - Error. See fingerprint4_return_value_t definition for detailed explanation.

Note: None.

◆ fingerprint4_template_put()

err_t fingerprint4_template_put	(	fingerprint4_t *	ctx,
		uint8_t *	data_in,
		uint16_t	size )

Fingerprint 4 template put function.

This function push template to the sensor and stores it to the RAM.

Parameters

[in]	ctx	: Click context object. See fingerprint4_t object definition for detailed explanation.
[in]	data_in	: Pointer to template buffer.
[in]	size	: Size of the template buffer.

Returns

0 - Success,
<0 - Error. See fingerprint4_return_value_t definition for detailed explanation.

Note: None.

◆ fingerprint4_template_remove()

err_t fingerprint4_template_remove	(	fingerprint4_t *	ctx,
		uint16_t	template_id )

Fingerprint 4 template remove function.

This function deletes from the Flash storage the template with the provided ID.

Parameters

[in]	ctx	: Click context object. See fingerprint4_t object definition for detailed explanation.
[in]	template_id	: The template ID to remove.

Returns

0 - Success,
<0 - Error. See fingerprint4_return_value_t definition for detailed explanation.

Note: None.

◆ fingerprint4_template_remove_all()

err_t fingerprint4_template_remove_all ( fingerprint4_t * ctx )

Fingerprint 4 template remove all function.

This function deletes all templates from the Flash storage.

Parameters

[in] ctx : Click context object. See fingerprint4_t object definition for detailed explanation.

Returns

0 - Success,
<0 - Error. See fingerprint4_return_value_t definition for detailed explanation.

Note: None.

◆ fingerprint4_template_remove_ram()

err_t fingerprint4_template_remove_ram ( fingerprint4_t * ctx )

Fingerprint 4 template remove ram function.

This function removes template from RAM.

Parameters

[in] ctx : Click context object. See fingerprint4_t object definition for detailed explanation.

Returns

0 - Success,
<0 - Error. See fingerprint4_return_value_t definition for detailed explanation.

Note: None.

◆ fingerprint4_template_save()

err_t fingerprint4_template_save	(	fingerprint4_t *	ctx,
		uint16_t	template_id )

Fingerprint 4 template save function.

This function stores the enrolled template template ID to the Flash storage.

Parameters

[in]	ctx	: Click context object. See fingerprint4_t object definition for detailed explanation.
[in]	template_id	: The enrolled template ID.

Returns

0 - Success,
<0 - Error. See fingerprint4_return_value_t definition for detailed explanation.

Note: None.

◆ fingerprint4_transceive()

err_t fingerprint4_transceive ( fingerprint4_t * ctx )

Fingerprint 4 transceive function.

This function sends a prepared command packet to the sensor and reads the answer. The FINGERPRINT4_ARG_RESULT answer will be stored in the ctx->arg. Some commands do not return result in FINGERPRINT4_ARG_RESULT. They return data with some other argument instead.

Parameters

[in] ctx : Click context object. See fingerprint4_t object definition for detailed explanation.

Returns

0 - Success,
<0 - Error. See fingerprint4_return_value_t definition for detailed explanation.

Note: None.

◆ fingerprint4_uart_speed_get()

err_t fingerprint4_uart_speed_get	(	fingerprint4_t *	ctx,
		uint32_t *	speed )

Fingerprint 4 uart speed get function.

This function gets current UART communication speed.

Parameters

[in]	ctx	: Click context object. See fingerprint4_t object definition for detailed explanation.
[out]	speed	: UART speed.

Returns

0 - Success,
<0 - Error. See fingerprint4_return_value_t definition for detailed explanation.

Note: None.

◆ fingerprint4_uart_speed_set()

err_t fingerprint4_uart_speed_set	(	fingerprint4_t *	ctx,
		uint32_t	speed )

Fingerprint 4 uart speed set function.

This function sets requested UART communication speed.

Parameters

[in]	ctx	: Click context object. See fingerprint4_t object definition for detailed explanation.
[in]	speed	: UART speed.

Returns

0 - Success,
<0 - Error. See fingerprint4_return_value_t definition for detailed explanation.

Note: None.

◆ fingerprint4_unique_id_get()

err_t fingerprint4_unique_id_get	(	fingerprint4_t *	ctx,
		uint8_t *	unique_id )

Fingerprint 4 version function.

This function reads out unique ID information from the device. The response contains 12 bytes of LSB data that contains unique ID information of the device.

Parameters

[in]	ctx	: Click context object. See fingerprint4_t object definition for detailed explanation.
[out]	unique_id	: Pointer to data buffer where the unique ID info will be stored.

Returns

0 - Success,
<0 - Error. See fingerprint4_return_value_t definition for detailed explanation.

Note: None.

◆ fingerprint4_version()

err_t fingerprint4_version	(	fingerprint4_t *	ctx,
		char *	version,
		uint8_t	len )

Fingerprint 4 version function.

This function reads out version information from the device. The response contains a variable length string that contains version information of the device.

Parameters

[in]	ctx	: Click context object. See fingerprint4_t object definition for detailed explanation.
[out]	version	: Pointer to data buffer where the version info will be stored.
[in]	len	: Size of the data buffer. If buffer size is not enough the data will be truncated. The ctx->arg.size will contain the real size of the data.

Returns

0 - Success,
<0 - Error. See fingerprint4_return_value_t definition for detailed explanation.

Note: None.

◆ fingerprint4_wait_finger_not_present()

err_t fingerprint4_wait_finger_not_present	(	fingerprint4_t *	ctx,
		uint32_t	timeout )

Fingerprint 4 wait finger not present function.

This function waits until no finger is detected on the sensor.

Parameters

[in]	ctx	: Click context object. See fingerprint4_t object definition for detailed explanation.
[in]	timeout	: Timeout in milliseconds. Set to 0 for waiting indefinitely.

Returns

0 - Success,
<0 - Error. See fingerprint4_return_value_t definition for detailed explanation.

Note: None.

◆ fingerprint4_wait_finger_present()

err_t fingerprint4_wait_finger_present	(	fingerprint4_t *	ctx,
		uint32_t	timeout )

Fingerprint 4 wait finger present function.

This function waits in Wait-for-finger mode until a finger is detected on the sensor.

Parameters

[in]	ctx	: Click context object. See fingerprint4_t object definition for detailed explanation.
[in]	timeout	: Timeout in milliseconds. Set to 0 for waiting indefinitely.

Returns

0 - Success,
<0 - Error. See fingerprint4_return_value_t definition for detailed explanation.

Note: None.

Topics

Functions

Detailed Description

Function Documentation

◆ fingerprint4_add_arg()

◆ fingerprint4_cfg_setup()

◆ fingerprint4_copy_arg()

◆ fingerprint4_generic_read()

◆ fingerprint4_generic_write()

◆ fingerprint4_get_arg()

◆ fingerprint4_get_irq_pin()

◆ fingerprint4_identify()

◆ fingerprint4_identify_finger()

◆ fingerprint4_image_create()

◆ fingerprint4_image_delete()

◆ fingerprint4_image_extract()

◆ fingerprint4_image_get()

◆ fingerprint4_image_get_size()

◆ fingerprint4_image_put()

◆ fingerprint4_init()

◆ fingerprint4_init_cmd()

◆ fingerprint4_receive()

◆ fingerprint4_reset_device()

◆ fingerprint4_send()

◆ fingerprint4_send_cmd()

◆ fingerprint4_send_cmd_arg()

◆ fingerprint4_sensor_calibrate()

◆ fingerprint4_sensor_calibrate_remove()

◆ fingerprint4_sensor_reset()

◆ fingerprint4_set_rst_pin()

◆ fingerprint4_sw_reset()

◆ fingerprint4_template_get()

◆ fingerprint4_template_get_count()

◆ fingerprint4_template_get_ids()

◆ fingerprint4_template_load_storage()

◆ fingerprint4_template_put()

◆ fingerprint4_template_remove()

◆ fingerprint4_template_remove_all()

◆ fingerprint4_template_remove_ram()

◆ fingerprint4_template_save()

◆ fingerprint4_transceive()

◆ fingerprint4_uart_speed_get()

◆ fingerprint4_uart_speed_set()

◆ fingerprint4_unique_id_get()

◆ fingerprint4_version()

◆ fingerprint4_wait_finger_not_present()

◆ fingerprint4_wait_finger_present()