spintac_vel_move.h File Reference

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

#include "spintac_version.h"

Go to the source code of this file.

Data Structures
struct	ST_VelMoveCfg_t
	Defines the ST_VelMoveCfg_t data. More...
struct	ST_VelMoveMsg_t
	Defines the ST_VelMoveMsg_t message data. More...
struct	ST_VelMove_t
	Defines the ST_VelMove_t data. More...

Macros
#define	__ST_AXIS_ENUM__
#define	__ST_MOVE_CURVE_TYPE_ENUM__
#define	__ST_MOVE_STATUS_ENUM__

Typedefs
typedef struct _ST_VELMOVE_Handle_ *	ST_VELMOVE_Handle

Enumerations
enum	ST_Axis_e {   ST_AXIS0 =0, ST_AXIS1, ST_AXIS0 =0, ST_AXIS1,   ST_AXIS0 =0, ST_AXIS1, ST_AXIS0 =0, ST_AXIS1 }
	Enumeration for the Axis Status states. More...
enum	ST_MoveCurveType_e {   ST_MOVE_CUR_TRAP =0, ST_MOVE_CUR_SCRV, ST_MOVE_CUR_STCRV, ST_MOVE_CUR_TRAP =0,   ST_MOVE_CUR_SCRV, ST_MOVE_CUR_STCRV }
	Enumeration for the Move Curve modes. More...
enum	ST_MoveStatus_e {   ST_MOVE_IDLE =0, ST_MOVE_INIT, ST_MOVE_CONF, ST_MOVE_BUSY,   ST_MOVE_HALT, ST_MOVE_IDLE =0, ST_MOVE_INIT, ST_MOVE_CONF,   ST_MOVE_BUSY, ST_MOVE_HALT }
	Enumeration for the Move Status states. More...

Functions
static void	STVELMOVE_setAxis (ST_VELMOVE_Handle handle, ST_Axis_e axis)
	Sets the Axis (cfg.Axis) for SpinTAC Velocity Move. More...
static void	STVELMOVE_setCurveType (ST_VELMOVE_Handle handle, ST_MoveCurveType_e curveType)
	Sets the Curve Type (cfg.CurveType) for SpinTAC Velocity Move. More...
static ST_MoveCurveType_e	STVELMOVE_getCurveType (ST_VELMOVE_Handle handle)
	Gets the Curve Type (cfg.CurveType) for SpinTAC Velocity Move. More...
static void	STVELMOVE_setSampleTime_sec (ST_VELMOVE_Handle handle, _iq24 sampleTime)
	Sets the Sample Time (cfg.T_sec) for SpinTAC Velocity Move. More...
static void	STVELMOVE_setHaltLimits (ST_VELMOVE_Handle handle, _iq20 haltJrkLim)
	Sets the Halt Limits (cfg.HaltJrkLim) for SpinTAC Velocity Move. More...
static void	STVELMOVE_setVelocityStart (ST_VELMOVE_Handle handle, _iq24 velStart)
	Sets the Velocity Start (cfg.VelStart) for SpinTAC Velocity Move. More...
static _iq24	STVELMOVE_getVelocityStart (ST_VELMOVE_Handle handle)
	Gets the Velocity Start (cfg.VelStart) for SpinTAC Velocity Move. More...
static uint32_t	STVELMOVE_getProfileTime_tick (ST_VELMOVE_Handle handle)
	Gets the Profile Time (msg.ProTime_tick) for SpinTAC Velocity Move. More...
static _iq24	STVELMOVE_getActualAcceleration (ST_VELMOVE_Handle handle)
	Gets the Actual Acceleration (msg.ActualAccLim) for current profile. More...
static _iq20	STVELMOVE_getActualJerk (ST_VELMOVE_Handle handle)
	Gets the Actual Jerk (msg.ActualJrkLim) for current pofile. More...
static void	STVELMOVE_setVelocityEnd (ST_VELMOVE_Handle handle, _iq24 velEnd)
	Sets the Velocity End (VelEnd) for SpinTAC Velocity Move. More...
static _iq24	STVELMOVE_getVelocityEnd (ST_VELMOVE_Handle handle)
	Gets the Velocity End (VelEnd) for SpinTAC Velocity Move. More...
static void	STVELMOVE_setAccelerationLimit (ST_VELMOVE_Handle handle, _iq24 accLim)
	Sets the Acceleration Limit (AccLim) for SpinTAC Velocity Move. More...
static _iq24	STVELMOVE_getAccelerationLimit (ST_VELMOVE_Handle handle)
	Gets the Acceleration Limit (AccLim) for SpinTAC Velocity Move. More...
static void	STVELMOVE_setJerkLimit (ST_VELMOVE_Handle handle, _iq20 jrkLim)
	Sets the Jerk Limit (JrkLim) for SpinTAC Velocity Move. More...
static _iq20	STVELMOVE_getJerkLimit (ST_VELMOVE_Handle handle)
	Gets the Jerk Limit (JrkLim) for SpinTAC Velocity Move. More...
static void	STVELMOVE_setEnable (ST_VELMOVE_Handle handle, bool enb)
	Sets the Enable signal (ENB) for SpinTAC Velocity Move. More...
static bool	STVELMOVE_getEnable (ST_VELMOVE_Handle handle)
	Gets the Enable signal (ENB) for SpinTAC Velocity Move. More...
static void	STVELMOVE_setTest (ST_VELMOVE_Handle handle, bool tst)
	Sets the Test signal (TST) for SpinTAC Velocity Move. More...
static bool	STVELMOVE_getTest (ST_VELMOVE_Handle handle)
	Gets the Test signal (TST) for SpinTAC Velocity Move. More...
static _iq24	STVELMOVE_getVelocityReference (ST_VELMOVE_Handle handle)
	Gets the Velocity Reference (VelRef) for SpinTAC Velocity Move. More...
static void	STVELMOVE_setVelocityReference (ST_VELMOVE_Handle handle, _iq24 velRef)
	Sets the Velocity Reference (VelRef) for SpinTAC Velocity Move. More...
static _iq24	STVELMOVE_getAccelerationReference (ST_VELMOVE_Handle handle)
	Gets the Acceleration Reference (AccRef) for SpinTAC Velocity Move. More...
static _iq20	STVELMOVE_getJerkReference (ST_VELMOVE_Handle handle)
	Gets the Jerk Reference (JrkRef) for SpinTAC Velocity Move. More...
static ST_MoveStatus_e	STVELMOVE_getStatus (ST_VELMOVE_Handle handle)
	Gets the Status value (STATUS) for SpinTAC Velocity Move. More...
static uint16_t	STVELMOVE_getErrorID (ST_VELMOVE_Handle handle)
	Gets the Error value (ERR_ID) for SpinTAC Velocity Move. More...
ST_VELMOVE_Handle	STVELMOVE_init (void *pMemory, const size_t numBytes)
	Initializes the SpinTAC Velocity Move object. More...
void	STVELMOVE_run (ST_VELMOVE_Handle handle)
	Runs the SpinTAC Velocity Move Function. More...

Detailed Description

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

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

Definition in file spintac_vel_move.h.