Ambient 10 Click Driver

API for configuring and manipulating Ambient 10 Click driver. More...

Topics
	Ambient 10 Settings
	Settings for Ambient 10 Click driver.
	Ambient 10 MikroBUS Map
	MikroBUS pin mapping of Ambient 10 Click driver.

Functions
void	ambient10_cfg_setup (ambient10_cfg_t *cfg)
	Ambient 10 configuration object setup function.
err_t	ambient10_init (ambient10_t *ctx, ambient10_cfg_t *cfg)
	Ambient 10 initialization function.
err_t	ambient10_read_an_pin_value (ambient10_t *ctx, uint16_t *data_out)
	Ambient 10 read AN pin value function.
err_t	ambient10_read_an_pin_voltage (ambient10_t *ctx, float *data_out)
	Ambient 10 read AN pin voltage level function.
err_t	ambient10_read_raw_adc (ambient10_t *ctx, uint16_t *raw_adc)
	Ambient 10 read raw ADC function.
err_t	ambient10_read_adc_voltage (ambient10_t *ctx, float *voltage)
	Ambient 10 read ADC voltage function.
err_t	ambient10_set_vref (ambient10_t *ctx, float vref)
	Ambient 10 set vref function.
uint16_t	ambient10_voltage_to_lux (ambient10_t *ctx, float voltage)
	Ambient 10 voltage to illuminance function.

Detailed Description

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

ambient10_cfg_setup()

void ambient10_cfg_setup

(

ambient10_cfg_t *

cfg

)

Ambient 10 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

[out]

cfg

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

Returns

Nothing.

Note

The all used pins will be set to unconnected state.

ambient10_init()

err_t ambient10_init	(	ambient10_t *	ctx,
		ambient10_cfg_t *	cfg )

Ambient 10 initialization function.

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

Parameters

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

Returns

• 0 - Success,
• -1 - Error.

See #err_t definition for detailed explanation.

Note

None.

ambient10_read_adc_voltage()

err_t ambient10_read_adc_voltage	(	ambient10_t *	ctx,
		float *	voltage )

Ambient 10 read ADC voltage function.

This function reads raw 12-bit ADC data and converts it to voltage by using I2C serial interface.

Parameters

[in]	ctx	: Click context object. See ambient10_t object definition for detailed explanation.
[out]	voltage	: Calculated ADC voltage.

Returns

• 0 - Success,
• -1 - Error.

See #err_t definition for detailed explanation.

Note

None.

ambient10_read_an_pin_value()

err_t ambient10_read_an_pin_value	(	ambient10_t *	ctx,
		uint16_t *	data_out )

Ambient 10 read AN pin value function.

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

Parameters

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

ambient10_read_an_pin_voltage()

err_t ambient10_read_an_pin_voltage	(	ambient10_t *	ctx,
		float *	data_out )

Ambient 10 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 ambient10_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).

ambient10_read_raw_adc()

err_t ambient10_read_raw_adc	(	ambient10_t *	ctx,
		uint16_t *	raw_adc )

Ambient 10 read raw ADC function.

This function reads raw 12-bit ADC data by using I2C serial interface.

Parameters

[in]	ctx	: Click context object. See ambient10_t object definition for detailed explanation.
[out]	raw_adc	: Raw ADC read data.

Returns

• 0 - Success,
• -1 - Error.

See #err_t definition for detailed explanation.

Note

None.

ambient10_set_vref()

err_t ambient10_set_vref	(	ambient10_t *	ctx,
		float	vref )

Ambient 10 set vref function.

This function sets the voltage reference for Ambient 10 click driver.

Parameters

[in]

vref

: Reference voltage (volts).

Returns

• 0 - Success,
• -1 - Error.

See #err_t definition for detailed explanation.

Note

The default voltage reference set with ambient10_init is 3.3V.

ambient10_voltage_to_lux()

uint16_t ambient10_voltage_to_lux	(	ambient10_t *	ctx,
		float	voltage )

Ambient 10 voltage to illuminance function.

This function calculates illuminance (lux) based on the voltage input.

Parameters

[in]

voltage

: Voltage from OUT (volts).

Returns

Illuminance in lux.

Note

None.