APIs for Voltage Frequency Generator (VS_FREQ)

Introduction

Here is the list of VS_FREQ function APIs

Files
file	vs_freq.h
	Contains the public interface to the stator voltage frequency generator (VS_FREQ)

Data Structures
struct	VS_FREQ_Handle
	Defines the angle generator (ANGLE_COMP) object. More...

Functions
static float32_t	VS_FREQ_getVd_out (VS_FREQ_Handle handle)
	Gets the Vd output value in VS_FREQ. More...
static float32_t	VS_FREQ_getVq_out (VS_FREQ_Handle handle)
static void	VS_FREQ_setMaxFreq (VS_FREQ_Handle handle, float32_t maxFreq)
	Sets the parameters maximum frequency. More...
static void	VS_FREQ_setVsMagPu (VS_FREQ_Handle handle, float32_t maxVsMag_pu)
	Sets the parameters VsMag_pu. More...
void	VS_FREQ_setProfile (VS_FREQ_Handle handle, float32_t LowFreq, float32_t HighFreq, float32_t VoltMin, float32_t VoltMax)
	Sets the parameters. More...
VS_FREQ_Handle	VS_FREQ_init (void *pMemory, const size_t numBytes)
	Initializes the angle generator (VS_FREQ) module. More...
static void	VS_FREQ_run (VS_FREQ_Handle handle, const float32_t Freq_pu)
	Generates an output command voltage for a specific input command frequency according to the specified volts/hertz profile. More...

Function Documentation

VS_FREQ_getVd_out()

static float32_t VS_FREQ_getVd_out ( VS_FREQ_Handle  handle )

inlinestatic

Gets the Vd output value in VS_FREQ.

Parameters

[in]

handle

The volts/hertz (VS_FREQ) handle

Returns

The Vd output value in VS_FREQ, pu

VS_FREQ_getVq_out()

static float32_t VS_FREQ_getVq_out ( VS_FREQ_Handle  handle )

inlinestatic

Parameters

[in]

handle

The volts/hertz profile (VS_FREQ) handle

Returns

The Vq output value in VS_FREQ, pu

VS_FREQ_setMaxFreq()

static void VS_FREQ_setMaxFreq ( VS_FREQ_Handle  handle, float32_t  maxFreq  )

inlinestatic

Sets the parameters maximum frequency.

Parameters

[in]	handle	The volts/hertz profile (VS_FREQ) handle
[in]	maxFreq	The maixmum frequency for volts/hertz profile, Hz

VS_FREQ_setVsMagPu()

static void VS_FREQ_setVsMagPu ( VS_FREQ_Handle  handle, float32_t  maxVsMag_pu  )

inlinestatic

Sets the parameters VsMag_pu.

Parameters

[in]	handle	The volts/hertz profile (VS_FREQ) handle
[in]	maxVsMag_pu	The maixmum magintude for volts/hertz profile, pu

VS_FREQ_setProfile()

void VS_FREQ_setProfile	(	VS_FREQ_Handle	handle,
		float32_t	LowFreq,
		float32_t	HighFreq,
		float32_t	VoltMin,
		float32_t	VoltMax
	)

Sets the parameters.

Parameters

[in]	handle	The volts/hertz profile (VS_FREQ) handle
[in]	LowFreq	The low frequency for volts/hertz profile, Hz
[in]	HighFreq	The high frequency for volts/hertz profile, Hz
[in]	VoltMin	The minimum frequency for volts/hertz profile, Volts
[in]	VoltMax	The maximum frequency for volts/hertz profile, Volts

VS_FREQ_init()

VS_FREQ_Handle VS_FREQ_init	(	void *	pMemory,
		const size_t	numBytes
	)

Initializes the angle generator (VS_FREQ) module.

Parameters

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

Returns

The volts/hertz profile (VS_FREQ) object handle

VS_FREQ_run()

static void VS_FREQ_run ( VS_FREQ_Handle  handle, const float32_t  Freq_pu  )

static

Generates an output command voltage for a specific input command frequency according to the specified volts/hertz profile.

Parameters

[in]	handle	The volts/hertz profile (VS_FREQ) handle
[in]	Freq_pu	The input frequency in pu