Useful Functions

Contains generic functions that is usable to the application. More...

Collaboration diagram for Useful Functions:

Files
file	pwrctrl_common.c
	Contains generic functions that handles power control ramp Up/Down and the averaging generic function.
file	pwrctrl_common.h
	Contains the power control reusable functions.

Functions
uint16_t	PwrCtrl_UpdateAverage (AVERAGING_t *data, uint16_t sample)
	Average the raw data over number of samples.
uint16_t	PwrCtrl_UpdateAverageRolling (AVERAGING_ROLLING_t *data, uint16_t sample)
	Rolling Average the raw data over number of samples.
bool	PwrCtrl_RampReference (START_UP_RAMP_t *rampUp)
	Softly increment / decrement to the set reference target.

Detailed Description

This document covers some generic power control functions that the user can utilize while developing the application code.

Function Documentation

PwrCtrl_RampReference()

bool PwrCtrl_RampReference

(

START_UP_RAMP_t *

rampUp

)

Parameters

rampUp

Pointer to start-up ramp data object of type START_UP_RAMP_t

Returns

RampComplete Indicates if the ramp-up/down is done

This function increments or decrements the reference with its defined step size to meet the reference target. Once the value reached the reference target, the RampComplete will be set.

Definition at line 68 of file pwrctrl_common.c.

Here is the caller graph for this function:

PwrCtrl_UpdateAverage()

uint16_t PwrCtrl_UpdateAverage	(	AVERAGING_t *	data,
		uint16_t	sample )

Parameters

data	Pointer to averaging data object of type AVERAGING_t
sample	data that will be averaged

Returns

AverageValue Returns the average value

This function averages the data over number of samples.

Definition at line 25 of file pwrctrl_common.c.

Here is the caller graph for this function:

PwrCtrl_UpdateAverageRolling()

uint16_t PwrCtrl_UpdateAverageRolling	(	AVERAGING_ROLLING_t *	data,
		uint16_t	sample )

Parameters

data	Pointer to averaging data object of type AVERAGING_ROLLING_t
sample	data that will be averaged

Returns

AverageValue Returns the average value

This function averages the data over number of samples.

Definition at line 45 of file pwrctrl_common.c.

Here is the caller graph for this function: