API for configuring and manipulating Heart Rate 11 Click driver. More...

Topics
	Heart Rate 11 Registers List
	List of registers of Heart Rate 11 Click driver.

	Heart Rate 11 Registers Settings
	Settings for registers of Heart Rate 11 Click driver.

	Heart Rate 11 MikroBUS Map
	MikroBUS pin mapping of Heart Rate 11 Click driver.

Functions
void	heartrate11_cfg_setup (heartrate11_cfg_t *cfg)
	Heart Rate 11 configuration object setup function.

err_t	heartrate11_init (heartrate11_t ctx, heartrate11_cfg_t cfg)
	Heart Rate 11 initialization function.

err_t	heartrate11_default_cfg (heartrate11_t *ctx)
	Heart Rate 11 default configuration function.

err_t	heartrate11_generic_write (heartrate11_t ctx, uint8_t reg, uint8_t data_in, uint8_t len)
	Heart Rate 11 I2C writing function.

err_t	heartrate11_generic_read (heartrate11_t ctx, uint8_t reg, uint8_t data_out, uint8_t len)
	Heart Rate 11 I2C reading function.

err_t	heartrate11_write_register (heartrate11_t *ctx, uint8_t reg, uint8_t data_in)
	Heart Rate 11 write register function.

err_t	heartrate11_read_register (heartrate11_t ctx, uint8_t reg, uint8_t data_out)
	Heart Rate 11 read register function.

uint8_t	heartrate11_get_int_pin (heartrate11_t *ctx)
	Heart Rate 11 get int pin function.

err_t	heartrate11_reset_device (heartrate11_t *ctx)
	Heart Rate 11 reset device function.

err_t	heartrate11_set_led_current (heartrate11_t *ctx, uint8_t led, float current)
	Heart Rate 11 set led current function.

err_t	heartrate11_read_fifo (heartrate11_t ctx, uint32_t fifo_data)
	Heart Rate 11 read fifo function.

Detailed Description

API for configuring and manipulating Heart Rate 11 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

◆ heartrate11_cfg_setup()

void heartrate11_cfg_setup ( heartrate11_cfg_t * cfg )

Heart Rate 11 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

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

Returns: Nothing.

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

◆ heartrate11_default_cfg()

err_t heartrate11_default_cfg ( heartrate11_t * ctx )

Heart Rate 11 default configuration function.

This function executes a default configuration of Heart Rate 11 click board.

Parameters

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

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: This function can consist any necessary configuration or setting to put device into operating mode.

◆ heartrate11_generic_read()

err_t heartrate11_generic_read	(	heartrate11_t *	ctx,
		uint8_t	reg,
		uint8_t *	data_out,
		uint8_t	len )

Heart Rate 11 I2C reading function.

This function reads a desired number of data bytes starting from the selected register by using I2C serial interface.

Parameters

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

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ heartrate11_generic_write()

err_t heartrate11_generic_write	(	heartrate11_t *	ctx,
		uint8_t	reg,
		uint8_t *	data_in,
		uint8_t	len )

Heart Rate 11 I2C writing function.

This function writes a desired number of data bytes starting from the selected register by using I2C serial interface.

Parameters

[in]	ctx	: Click context object. See heartrate11_t object definition for detailed explanation.
[in]	reg	: Start register address.
[in]	data_in	: Data to be written.
[in]	len	: Number of bytes to be written.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ heartrate11_get_int_pin()

uint8_t heartrate11_get_int_pin ( heartrate11_t * ctx )

Heart Rate 11 get int pin function.

This function returns the INT pin logic state.

Parameters

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

Returns: None.

Note: None.

◆ heartrate11_init()

err_t heartrate11_init	(	heartrate11_t *	ctx,
		heartrate11_cfg_t *	cfg )

Heart Rate 11 initialization function.

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

Parameters

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

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ heartrate11_read_fifo()

err_t heartrate11_read_fifo	(	heartrate11_t *	ctx,
		uint32_t *	fifo_data )

Heart Rate 11 read fifo function.

This function reads a 24-bit data from the FIFO.

Parameters

[in]	ctx	: Click context object. See heartrate11_t object definition for detailed explanation.
[out]	fifo_data	: 24-bit FIFO data.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ heartrate11_read_register()

err_t heartrate11_read_register	(	heartrate11_t *	ctx,
		uint8_t	reg,
		uint8_t *	data_out )

Heart Rate 11 read register function.

This function reads data from the selected register by using I2C serial interface.

Parameters

[in]	ctx	: Click context object. See heartrate11_t object definition for detailed explanation.
[in]	reg	: Register address.
[out]	data_out	: Output read data.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ heartrate11_reset_device()

err_t heartrate11_reset_device ( heartrate11_t * ctx )

Heart Rate 11 reset device function.

This function performs the device software reset by setting the SW_RESET bit.

Parameters

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

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ heartrate11_set_led_current()

err_t heartrate11_set_led_current	(	heartrate11_t *	ctx,
		uint8_t	led,
		float	current )

Heart Rate 11 set led current function.

This function sets the maximal current of the selected LED.

Parameters

[in]	ctx	: Click context object. See heartrate11_t object definition for detailed explanation.
[in]	led	: LED selection `0` - PS LED, `1` - IR LED, `2` - RED LED.
[in]	current	: Maximal current - up to 250mA (125mA for RED LED),

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ heartrate11_write_register()

err_t heartrate11_write_register	(	heartrate11_t *	ctx,
		uint8_t	reg,
		uint8_t	data_in )

Heart Rate 11 write register function.

This function writes a desired data to the selected register by using I2C serial interface.

Parameters

[in]	ctx	: Click context object. See heartrate11_t object definition for detailed explanation.
[in]	reg	: Register address.
[in]	data_in	: Data to be written.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

Topics

Functions

Detailed Description

Function Documentation

◆ heartrate11_cfg_setup()

◆ heartrate11_default_cfg()

◆ heartrate11_generic_read()

◆ heartrate11_generic_write()

◆ heartrate11_get_int_pin()

◆ heartrate11_init()

◆ heartrate11_read_fifo()

◆ heartrate11_read_register()

◆ heartrate11_reset_device()

◆ heartrate11_set_led_current()

◆ heartrate11_write_register()