Hydrogen Click Driver

API for configuring and manipulating Hydrogen Click driver. More...

Topics
	Hydrogen Registers List
	List of registers of Hydrogen Click driver.
	Hydrogen Registers Settings
	Hydrogen description register.
	Hydrogen MikroBUS Map
	Hydrogen description setting.

Functions
void	hydrogen_cfg_setup (hydrogen_cfg_t *cfg)
	Hydrogen configuration object setup function.
err_t	hydrogen_init (hydrogen_t *ctx, hydrogen_cfg_t *cfg)
	Hydrogen initialization function.
err_t	hydrogen_read_an_pin_value (hydrogen_t *ctx, uint16_t *data_out)
	Hydrogen read AN pin value function.
err_t	hydrogen_read_an_pin_voltage (hydrogen_t *ctx, float *data_out)
	Hydrogen read AN pin voltage level function.

Detailed Description

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

hydrogen_cfg_setup()

void hydrogen_cfg_setup

(

hydrogen_cfg_t *

cfg

)

Hydrogen configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

[out]

cfg

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

Returns

Nothing.

Note

The all used pins will be set to unconnected state.

hydrogen_init()

err_t hydrogen_init	(	hydrogen_t *	ctx,
		hydrogen_cfg_t *	cfg )

Hydrogen initialization function.

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

Parameters

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

Returns

• 0 - Success,
• -1 - Error.

See #err_t definition for detailed explanation.

Note

None.

hydrogen_read_an_pin_value()

err_t hydrogen_read_an_pin_value	(	hydrogen_t *	ctx,
		uint16_t *	data_out )

Hydrogen read AN pin value function.

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

Parameters

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

Returns

• 0 - Success,
• -1 - Error.

See #err_t definition for detailed explanation.

Note

None.

hydrogen_read_an_pin_voltage()

err_t hydrogen_read_an_pin_voltage	(	hydrogen_t *	ctx,
		float *	data_out )

Hydrogen 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 hydrogen_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).