MotorWare f2806x Module API Documentation
Data Structures | Typedefs | Functions
angle.h File Reference

Contains the public interface to the angle generator (ANGLE) module routines. More...

#include <stdint.h>
#include "sw/modules/types/src/types.h"
#include "sw/modules/est/src/float/est.h"
#include "sw/modules/math/src/float/math.h"

Go to the source code of this file.

Data Structures

struct  _ANGLE_Obj_
 Defines the angle generator (ANGLE) object. More...
 

Typedefs

typedef struct _ANGLE_Obj_ ANGLE_Obj
 Defines the angle generator (ANGLE) object. More...
 
typedef struct _ANGLE_Obj_ANGLE_Handle
 Defines the ANGLE handle. More...
 

Functions

static float_t ANGLE_getAccelEst_rps2 (ANGLE_Handle handle)
 Gets the estimated acceleration value. More...
 
static float_t ANGLE_getAngle_rad (ANGLE_Handle handle)
 Gets the predicted angle value. More...
 
static float_t ANGLE_getAngleEst_rad (ANGLE_Handle handle)
 Gets the estimated angle value. More...
 
static float_t ANGLE_getAngleWithDelay_rad (ANGLE_Handle handle)
 Gets the updated angle value considering system delay. More...
 
static float_t ANGLE_getAngleDelayed_sf_sec (ANGLE_Handle handle)
 Gets the scale factor for computing the delayed angle. More...
 
static float_t ANGLE_getSpeed_rps (ANGLE_Handle handle)
 Gets the predicted speed value. More...
 
static float_t ANGLE_getSpeedEst_rps (ANGLE_Handle handle)
 Gets the estimated speed value. More...
 
static int_least32_t ANGLE_getTimeStamp (ANGLE_Handle handle)
 Gets the time stamp value for the estimated data. More...
 
static float_t ANGLE_getTimeStampPeriod_sec (ANGLE_Handle handle)
 Gets the time stamp period value. More...
 
ANGLE_Handle ANGLE_init (void *pMemory, const size_t numBytes)
 Initializes the angle generator (ANGLE) module. More...
 
ANGLE_Handle cla_ANGLE_init (void *pMemory, const size_t numBytes)
 
void ANGLE_run (ANGLE_Handle handle, const int_least32_t timeStamp)
 Updates the angle value in the angle generator. More...
 
void cla_ANGLE_run (ANGLE_Handle handle, const int_least32_t timeStamp)
 
static void ANGLE_setAccelEst_rps2 (ANGLE_Handle handle, const float_t accel_rps2)
 Sets the estimated acceleration value. More...
 
static void ANGLE_setAngle_rad (ANGLE_Handle handle, const float_t angle_rad)
 Sets the predicted angle value. More...
 
static void ANGLE_setAngleEst_rad (ANGLE_Handle handle, const float_t angle_rad)
 Sets the estimated angle value. More...
 
static void ANGLE_setAngleWithDelay_rad (ANGLE_Handle handle, const float_t angle_rad)
 Sets the angle value considering system delay. More...
 
static void ANGLE_setAngleDelayed_sf_sec (ANGLE_Handle handle, const float_t angleDelayed_sf_sec)
 Sets the scale factor for computing the delayed angle. More...
 
void ANGLE_setParams (ANGLE_Handle handle, const float_t timeStampPeriod_sec, const float_t angleDelayed_sf_sec)
 Sets the parameters. More...
 
void cla_ANGLE_setParams (ANGLE_Handle handle, const float_t timeStampPeriod_sec, const float_t angleDelayed_sf_sec)
 
static void ANGLE_setSpeed_rps (ANGLE_Handle handle, const float_t speed_rps)
 Sets the predicted speed value. More...
 
static void ANGLE_setSpeedEst_rps (ANGLE_Handle handle, const float_t speed_rps)
 Sets the estimated speed value. More...
 
static void ANGLE_setTimeStamp (ANGLE_Handle handle, const int_least32_t timeStamp)
 Sets the time stamp value for the estimated data. More...
 
static void ANGLE_setTimeStampPeriod_sec (ANGLE_Handle handle, const float_t timeStampPeriod_sec)
 Sets the time stamp period value. More...
 
void ANGLE_setup (ANGLE_Handle handle, const int_least32_t timeStamp, const float_t angle_rad, const float_t speed_rps, const float_t accel_rps2)
 Updates the angle generator with new data. More...
 
void cla_ANGLE_setup (ANGLE_Handle handle, const int_least32_t timeStamp, const float_t angle_rad, const float_t speed_rps, const float_t accel_rps2)
 

Detailed Description

Contains the public interface to the angle generator (ANGLE) module routines.

(C) Copyright 2014, Texas Instruments, Inc.

Definition in file angle.h.