APIs for speed frequency function

Introduction

Here is the list of speed frequency function APIs sensored speed calculation

Files
file	speedfr.h
	Contains speed frequency functions implementation.

Data Structures
struct	SPDFR_Obj

Functions
SPDFR_Handle	SPDFR_init (void *pMemory, const size_t numBytes)
	Set the SPDFR controller. More...
void	SPDFR_reset (SPDFR_Handle handle)
	Set the SPDFR controller. More...
void	SPDFR_setParams (SPDFR_Handle handle, const USER_Params *pUserParams)
	Set the SPDFR controller. More...
static float32_t	SPDFR_getSpeedHz (SPDFR_Handle handle)
	Set the SPDFR controller. More...
static void	SPDFR_run (SPDFR_Handle handle, float32_t theta)
	Set the SPDFR controller. More...

Typedefs
typedef struct _SPDFR_obj_ *	SPDFR_Handle
	Defines the SPDFR handle. More...

Typedef Documentation

SPDFR_Handle

typedef struct _SPDFR_obj_* SPDFR_Handle

Defines the SPDFR handle.

Function Documentation

SPDFR_init()

SPDFR_Handle SPDFR_init	(	void *	pMemory,
		const size_t	numBytes
	)

Set the SPDFR controller.

Parameters

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

Returns

The handle to SPDFR object

SPDFR_reset()

void SPDFR_reset

(

SPDFR_Handle

handle

)

Set the SPDFR controller.

Parameters

[in]

handle

The ESMO controller handle

SPDFR_setParams()

void SPDFR_setParams	(	SPDFR_Handle	handle,
		const USER_Params *	pUserParams
	)

Set the SPDFR controller.

Parameters

[in]	handle	The SPDFR controller handle
[in]	pUserParams	The pointer to User_Params object

SPDFR_getSpeedHz()

static float32_t SPDFR_getSpeedHz ( SPDFR_Handle  handle )

inlinestatic

Set the SPDFR controller.

Parameters

[in]

handle

The SPDFR controller handle

SPDFR_run()

static void SPDFR_run ( SPDFR_Handle  handle, float32_t  theta  )

static

Set the SPDFR controller.

Parameters

[in]	handle	The SPDFR controller handle
[in]	theta	The rotor angle in radians