MotorWare f2806x Module API Documentation

- Main Page
- Modules
- Data Structures
- Files

- File List
- Globals

Typedefs | Functions
vib_comp.h File Reference

Contains the public interface to the Vibration Compensation (VIB_COMP) module routines. More...

`#include "sw/modules/iqmath/src/32b/IQmathLib.h"`
`#include "sw/modules/types/src/types.h"`

Go to the source code of this file.

## Typedefs
typedef struct _VIB_COMP_Obj_ * | VIB_COMP_Handle
| Defines the VIB_COMP handle. More...

## Functions
int16_t | VIB_COMP_getAdvIndexDelta (VIB_COMP_Handle handle)
_iq | VIB_COMP_getAlpha (VIB_COMP_Handle handle)
bool | VIB_COMP_getFlag_enableOutput (VIB_COMP_Handle handle)
bool | VIB_COMP_getFlag_enableUpdates (VIB_COMP_Handle handle)
int16_t | VIB_COMP_getIndex (VIB_COMP_Handle handle)
size_t | VIB_COMP_getSizeOfObject (void)
| Gets the size of the vibration compensation module in 16 bit words. More...
VIB_COMP_Handle | VIB_COMP_init (void *pMemory, const size_t numBytes)
| Initializes the vibration compensation module. More...
void | VIB_COMP_reset (VIB_COMP_Handle handle)
| Resets the vibration compensation module. More...
_iq | VIB_COMP_run (VIB_COMP_Handle handle, const _iq angle_mech_pu, const _iq Iq_in_pu)
| Runs the vibration compensation algorithm. More...
void | VIB_COMP_setAdvIndexDelta (VIB_COMP_Handle handle, const int16_t adv_index_delta)
void | VIB_COMP_setAlpha (VIB_COMP_Handle handle, const _iq alpha)
void | VIB_COMP_setFlag_enableOutput (VIB_COMP_Handle handle, const bool state)
void | VIB_COMP_setFlag_enableUpdates (VIB_COMP_Handle handle, const bool state)
void | VIB_COMP_setIndex (VIB_COMP_Handle handle, const int16_t index)
void | VIB_COMP_setParams (VIB_COMP_Handle handle, const _iq alpha, const int16_t adv_index_delta)

## Detailed Description

Contains the public interface to the Vibration Compensation (VIB_COMP) module routines.

(C) Copyright 2015, Texas Instruments, Inc.

Definition in file vib_comp.h.