RMS to DC 2 Click Driver

API for configuring and manipulating RMS to DC 2 Click driver. More...

Topics
	RMS to DC 2 Registers Settings
	Settings for registers of RMS to DC 2 Click driver.
	RMS to DC 2 MikroBUS Map
	MikroBUS pin mapping of RMS to DC 2 Click driver.

Functions
void	rmstodc2_cfg_setup (rmstodc2_cfg_t *cfg)
	RMS to DC 2 configuration object setup function.
void	rmstodc2_drv_interface_sel (rmstodc2_cfg_t *cfg, rmstodc2_drv_t drv_sel)
	RMS to DC 2 driver interface setup function.
err_t	rmstodc2_init (rmstodc2_t *ctx, rmstodc2_cfg_t *cfg)
	RMS to DC 2 initialization function.
err_t	rmstodc2_read_raw_adc (rmstodc2_t *ctx, uint16_t *raw_adc)
	RMS to DC 2 read raw ADC value function.
err_t	rmstodc2_read_voltage (rmstodc2_t *ctx, float *voltage)
	RMS to DC 2 read voltage level function.
err_t	rmstodc2_set_vref (rmstodc2_t *ctx, float vref)
	RMS to DC 2 set vref function.

Detailed Description

API for configuring and manipulating RMS to DC 2 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

rmstodc2_cfg_setup()

void rmstodc2_cfg_setup

(

rmstodc2_cfg_t *

cfg

)

RMS to DC 2 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

[out]

cfg

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

Returns

Nothing.

Note

The all used pins will be set to unconnected state.

rmstodc2_drv_interface_sel()

void rmstodc2_drv_interface_sel	(	rmstodc2_cfg_t *	cfg,
		rmstodc2_drv_t	drv_sel )

RMS to DC 2 driver interface setup function.

This function sets a serial driver interface which will be used further in the click driver.

Parameters

[out]	cfg	: Click configuration structure. See rmstodc2_cfg_t object definition for detailed explanation.
[in]	drv_sel	: Driver interface selection. See rmstodc2_drv_t object definition for detailed explanation.

Returns

Nothing.

Note

This driver selection should be call before init function to configure the driver to work with the serial interface which is consistent with the real state of the hardware. If this function is not called, the default driver interface will be set.

rmstodc2_init()

err_t rmstodc2_init	(	rmstodc2_t *	ctx,
		rmstodc2_cfg_t *	cfg )

RMS to DC 2 initialization function.

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

Parameters

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

Returns

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

Note

None.

rmstodc2_read_raw_adc()

err_t rmstodc2_read_raw_adc	(	rmstodc2_t *	ctx,
		uint16_t *	raw_adc )

RMS to DC 2 read raw ADC value function.

This function reads raw ADC value.

Parameters

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

Returns

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

Note

None.

rmstodc2_read_voltage()

err_t rmstodc2_read_voltage	(	rmstodc2_t *	ctx,
		float *	voltage )

RMS to DC 2 read voltage level function.

This function reads raw ADC value and converts it to proportional voltage level.

Parameters

[in]	ctx	: Click context object. See rmstodc2_t object definition for detailed explanation.
[out]	voltage	: Output voltage level [V].

Returns

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

Note

The conversion to voltage depends on the entered reference voltage.

rmstodc2_set_vref()

err_t rmstodc2_set_vref	(	rmstodc2_t *	ctx,
		float	vref )

RMS to DC 2 set vref function.

This function sets the voltage reference for RMS to DC 2 click driver.

Parameters

[in]	ctx	: Click context object. See rmstodc2_t object definition for detailed explanation.
[in]	vref	: Reference voltage (volts).

Returns

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

Note

The default voltage reference set with rmstodc2_init is 3.3V.