APIs for Phase Voltage Calculation (VOLREC)

Introduction

Here is the list of VOLREC function APIs

Files
file	volt_recons.h
	Contains phase voltage calculation (VOLREC) functions implementation.

Data Structures
struct	VOLREC_Obj
	Defines the VOLREC controller object. More...

Functions
VOLREC_Handle	VOLREC_init (void *pMemory, const size_t numBytes)
	Initializes the Voltage reconstruct module. More...
void	VOLREC_reset (VOLREC_Handle handle)
	reset the Phase Voltage reconstruction variables More...
void	VOLREC_setParams (VOLREC_Handle handle, const float32_t filterPole_rps, const float32_t ctrlFreq_Hz)
	set the Phase Voltage reconstruction parameters More...
static void	VOLREC_calcVolSF (VOLREC_Handle handle, float32_t VaSen)
	Runs the Phase Voltage reconstruction. More...
static void	VOLREC_run (VOLREC_Handle handle, float32_t Vdcbus, MATH_Vec3 *pVin, MATH_Vec2 *pVab)
	Runs the Phase Voltage reconstruction. More...
static bool	VOLREC_getFlagCalSf (VOLREC_Handle handle)
	Gets the SF enable flag. More...
static void	VOLREC_setFlagCalSf (VOLREC_Handle handle, const bool flagCalSf)
	Sets up the SF enable flag. More...
static void	VOLREC_enableFlagCalSf (VOLREC_Handle handle)
	Enables the SF enable flag. More...
static void	VOLREC_disableFlagEnableSf (VOLREC_Handle handle)
	Disables the SF enable flag. More...

Typedefs
typedef struct _VOLREC_Obj_ *	VOLREC_Handle
	Defines the VOLREC_Handle. More...

Typedef Documentation

VOLREC_Handle

typedef struct _VOLREC_Obj_* VOLREC_Handle

Defines the VOLREC_Handle.

Function Documentation

VOLREC_init()

VOLREC_Handle VOLREC_init	(	void *	pMemory,
		const size_t	numBytes
	)

Initializes the Voltage reconstruct module.

Parameters

[in]	pMemory	A pointer to the memory for the Voltage reconstruct object
[in]	numBytes	The number of bytes allocated for the Voltage reconstruct object

Returns

The Voltage reconstruct (VOLREC) object handle

VOLREC_reset()

void VOLREC_reset

(

VOLREC_Handle

handle

)

reset the Phase Voltage reconstruction variables

Parameters

[in]

handle

The Voltage reconstruction handle

VOLREC_setParams()

void VOLREC_setParams	(	VOLREC_Handle	handle,
		const float32_t	filterPole_rps,
		const float32_t	ctrlFreq_Hz
	)

set the Phase Voltage reconstruction parameters

Parameters

[in]	handle	The Voltage reconstruction handle
[in]	filterPole_rps	The voltage filter pole
[in]	ctrlFreq_Hz	The controller frequency

VOLREC_calcVolSF()

static void VOLREC_calcVolSF ( VOLREC_Handle  handle, float32_t  VaSen  )

inlinestatic

Runs the Phase Voltage reconstruction.

Parameters

[in]	handle	The Voltage reconstruct handle
[in]	VaSen	The input phase voltage in volts

VOLREC_run()

static void VOLREC_run ( VOLREC_Handle  handle, float32_t  Vdcbus, MATH_Vec3 *  pVin, MATH_Vec2 *  pVab  )

inlinestatic

Runs the Phase Voltage reconstruction.

Parameters

[in]	handle	The Voltage reconstruct handle
[in]	Vdcbus	The DC bus voltage
[in]	pVin	The pointer to the input vector
[in]	pVab	The pointer to the output vector

VOLREC_getFlagCalSf()

static bool VOLREC_getFlagCalSf ( VOLREC_Handle  handle )

inlinestatic

Gets the SF enable flag.

Parameters

[in]

handle

The Voltage reconstruct handle

Returns

flag

VOLREC_setFlagCalSf()

static void VOLREC_setFlagCalSf ( VOLREC_Handle  handle, const bool  flagCalSf  )

inlinestatic

Sets up the SF enable flag.

Parameters

[in]	handle	The Voltage reconstruct handle
[in]	flagCalSf	The SF enable flag

VOLREC_enableFlagCalSf()

static void VOLREC_enableFlagCalSf ( VOLREC_Handle  handle )

inlinestatic

Enables the SF enable flag.

Parameters

[in]

handle

The Voltage reconstruct handle

VOLREC_disableFlagEnableSf()

static void VOLREC_disableFlagEnableSf ( VOLREC_Handle  handle )

inlinestatic

Disables the SF enable flag.

Parameters

[in]

handle

The Voltage reconstruct handle