ECG 5 Click Driver

API for configuring and manipulating ECG 5 Click driver. More...

Topics
	ECG 5 Registers Settings
	Settings for registers of ECG 5 Click driver.
	ECG 5 MikroBUS Map
	MikroBUS pin mapping of ECG 5 Click driver.

Functions
void	ecg5_cfg_setup (ecg5_cfg_t *cfg)
	ECG 5 configuration object setup function.
err_t	ecg5_init (ecg5_t *ctx, ecg5_cfg_t *cfg)
	ECG 5 initialization function.
err_t	ecg5_read_an_pin_value (ecg5_t *ctx, uint16_t *data_out)
	ECG 5 read AN pin value function.
err_t	ecg5_read_an_pin_voltage (ecg5_t *ctx, float *data_out)
	ECG 5 read AN pin voltage level function.
void	ecg5_set_mode (ecg5_t *ctx, uint8_t state)
	Mode Setting function.
err_t	ecg5_check_lod_negative (ecg5_t *ctx)
	LOD- Checking function.
err_t	ecg5_check_lod_positive (ecg5_t *ctx)
	LOD+ Checking function.

Detailed Description

API for configuring and manipulating ECG 5 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

ecg5_cfg_setup()

void ecg5_cfg_setup

(

ecg5_cfg_t *

cfg

)

ECG 5 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

[out]

cfg

: Click configuration structure. See ecg5_cfg_t object definition for detailed explanation.

Returns

Nothing.

Note

The all used pins will be set to unconnected state.

ecg5_check_lod_negative()

err_t ecg5_check_lod_negative

(

ecg5_t *

ctx

)

LOD- Checking function.

In DC Leads Off Detection Mode, LOD- is high when the electrode to -IN is disconnected, and it is low when connected. In AC Leads Off Detection Mode, LOD- is always low.

Parameters

[in]

ctx

: Click context object. See ecg5_t object definition for detailed explanation.

Returns

• 0 - Success,
• -1 - Error.

See #err_t definition for detailed explanation.

ecg5_check_lod_positive()

err_t ecg5_check_lod_positive

(

ecg5_t *

ctx

)

LOD+ Checking function.

In DC Leads Off Detection Mode, LOD+ is high when the +IN electrode is disconnected, and it is low when connected. In AC Leads Off Detection Mode, LOD+ is high when either the -IN or +IN electrode is disconnected, and it is low when both electrodes are connected.

Parameters

[in]

ctx

: Click context object. See ecg5_t object definition for detailed explanation.

Returns

• 0 - Success,
• -1 - Error.

See #err_t definition for detailed explanation.

ecg5_init()

err_t ecg5_init	(	ecg5_t *	ctx,
		ecg5_cfg_t *	cfg )

ECG 5 initialization function.

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

Parameters

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

Returns

• 0 - Success,
• -1 - Error.

See #err_t definition for detailed explanation.

ecg5_read_an_pin_value()

err_t ecg5_read_an_pin_value	(	ecg5_t *	ctx,
		uint16_t *	data_out )

ECG 5 read AN pin value function.

This function reads results of AD conversion of the AN pin.

Parameters

[in]	ctx	: Click context object. See ecg5_t object definition for detailed explanation.
[out]	data_out	: Output ADC result.

Returns

• 0 - Success,
• -1 - Error.

See #err_t definition for detailed explanation.

ecg5_read_an_pin_voltage()

err_t ecg5_read_an_pin_voltage	(	ecg5_t *	ctx,
		float *	data_out )

ECG 5 read AN pin voltage level function.

This function reads results of AD conversion of the AN pin and converts them to proportional voltage level.

Parameters

[in]	ctx	: Click context object. See ecg5_t object definition for detailed explanation.
[out]	data_out	: Output voltage level of the analog pin [V].

Returns

• 0 - Success,
• -1 - Error.

See #err_t definition for detailed explanation.

Note

The conversion to voltage depends on the entered configuration of the ADC (resolution, reference voltage).

ecg5_set_mode()

void ecg5_set_mode	(	ecg5_t *	ctx,
		uint8_t	state )

Mode Setting function.

Function performs a device mode setting.

Parameters

[in]	state	: Mode of operation.
[out]	ctx	: Click context object. See ecg5_t object definition for detailed explanation.

Returns

Nothing.