Methane Click Driver

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

Functions
void	methane_cfg_setup (methane_cfg_t *cfg)
	Methane configuration object setup function.
err_t	methane_init (methane_t *ctx, methane_cfg_t *cfg)
	Methane initialization function.
err_t	methane_read_an_pin_value (methane_t *ctx, uint16_t *data_out)
	Methane read AN pin value function.
err_t	methane_read_an_pin_voltage (methane_t *ctx, float *data_out)
	Methane read AN pin voltage level function.

Detailed Description

API for configuring and manipulating Methane Click driver.

Function Documentation

methane_cfg_setup()

void methane_cfg_setup

(

methane_cfg_t *

cfg

)

Methane configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

[out]

cfg

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

Returns

Nothing.

Note

The all used pins will be set to unconnected state.

methane_init()

err_t methane_init	(	methane_t *	ctx,
		methane_cfg_t *	cfg )

Methane initialization function.

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

Parameters

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

Returns

• 0 - Success,
• -1 - Error.

See #err_t definition for detailed explanation.

Note

None.

methane_read_an_pin_value()

err_t methane_read_an_pin_value	(	methane_t *	ctx,
		uint16_t *	data_out )

Methane read AN pin value function.

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

Parameters

[in]	ctx	: Click context object. See methane_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.

methane_read_an_pin_voltage()

err_t methane_read_an_pin_voltage	(	methane_t *	ctx,
		float *	data_out )

Methane 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 methane_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).