spintac_vel_id.h File Reference

Public interface, object, and function definitions related to the SpinTAC Velocity Identify component. More...

#include "spintac_version.h"

Go to the source code of this file.

Data Structures
struct	ST_VelIdCfg_t
	Defines the ST_VelIdCfg_t data. More...
struct	ST_VelId_t
	Defines the ST_VelId_t data. More...

Typedefs
typedef struct _ST_VELID_Handle_ *	ST_VELID_Handle

Enumerations
enum	ST_VelIdStatus_e { ST_VEL_ID_IDLE =0, ST_VEL_ID_INIT, ST_VEL_ID_BUSY }
	Enumeration for the Velocity Identify Status states. More...

Functions
static void	STVELID_setSampleTime_sec (ST_VELID_Handle handle, _iq24 sampleTime)
	Sets the Sample Time (cfg.T_sec) for SpinTAC Velocity Identify. More...
static void	STVELID_setOutputMaximum (ST_VELID_Handle handle, _iq24 outMax)
	Sets the Maximum Output (cfg.OutMax) for SpinTAC Velocity Identify. More...
static void	STVELID_setGoalSpeed (ST_VELID_Handle handle, _iq24 goalSpeed)
	Sets the Goal Speed of inertia identification (cfg.GoalSpeed) for SpinTAC Velocity Identify. More...
static _iq24	STVELID_getGoalSpeed (ST_VELID_Handle handle)
	Gets the Goal Speed of inertia identification (cfg.GoalSpeed) for SpinTAC Velocity Identify. More...
static void	STVELID_setLowPassFilterTime_tick (ST_VELID_Handle handle, int16_t lpfTime)
	Sets the Low Pass Filter Time Constant (cfg.LpfTime_tick) for SpinTAC Velocity Identify. More...
static void	STVELID_setTimeOut_sec (ST_VELID_Handle handle, _iq24 timeOut)
	Sets the Time Out Time (cfg.TimeOut_sec) for SpinTAC Velocity Identify. More...
static void	STVELID_setTorqueRampTime_sec (ST_VELID_Handle handle, _iq24 rampTime)
	Sets the Torque Ramp Time (cfg.RampTime_sec) for SpinTAC Velocity Identify. More...
static _iq24	STVELID_getTorqueRampTime_sec (ST_VELID_Handle handle)
	Gets the Torque Ramp Time (cfg.RampTime_sec) for SpinTAC Velocity Identify. More...
static void	STVELID_setSensorlessFeedback (ST_VELID_Handle handle, bool sensorless)
	Sets the feedback type (cfg.Sensorless) for SpinTAC Velocity Identify. More...
static void	STVELID_setVelocityFeedback (ST_VELID_Handle handle, _iq24 velFdb)
	Sets the Velocity Feedback (VelFdb) for SpinTAC Velocity Identify. More...
static _iq24	STVELID_getTorqueReference (ST_VELID_Handle handle)
	Gets the Torque (Iq) Reference value (Out) from SpinTAC Velocity Identify. More...
static void	STVELID_setTorqueReference (ST_VELID_Handle handle, _iq24 out)
	Sets the Torque (Iq) Reference (Out) for SpinTAC Velocity Identify. More...
static _iq24	STVELID_getInertiaEstimate (ST_VELID_Handle handle)
	Gets the System Inertia (InertiaEst) from SpinTAC Velocity Identify. More...
static _iq24	STVELID_getFrictionEstimate (ST_VELID_Handle handle)
	Gets the System Friction (FrictionEst) from SpinTAC Velocity Identify. More...
static void	STVELID_setEnable (ST_VELID_Handle handle, bool enb)
	Sets the Enable signal (ENB) for SpinTAC Velocity Identify. More...
static bool	STVELID_getEnable (ST_VELID_Handle handle)
	Gets the Enable signal (ENB) for SpinTAC Velocity Identify. More...
static ST_VelIdStatus_e	STVELID_getStatus (ST_VELID_Handle handle)
	Gets the Status value (STATUS) for SpinTAC Velocity Identify. More...
static uint16_t	STVELID_getErrorID (ST_VELID_Handle handle)
	Gets the Error value (ERR_ID) for SpinTAC Velocity Identify. More...
ST_VELID_Handle	STVELID_init (void *pMemory, const size_t numBytes)
	Initializes the SpinTAC Velocity Identify object. More...
void	STVELID_run (ST_VELID_Handle handle)
	Runs the SpinTAC Identify function. More...

Detailed Description

Public interface, object, and function definitions related to the SpinTAC Velocity Identify component.

(C) Copyright 2012, LineStream Technologies, Inc. (C) Copyright 2011, Texas Instruments, Inc.

Definition in file spintac_vel_id.h.