spintac_pos_move.h File Reference

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

#include "spintac_version.h"

Go to the source code of this file.

Data Structures
struct	ST_PosMoveCfg_t
	Defines the ST_PosMoveCfg_t data. More...
struct	ST_PosMoveMsg_t
	Defines the ST_PosMoveMsg_t data. More...
struct	ST_PosMove_t
	Defines the ST_PosMove_t data. More...

Macros
#define	__ST_AXIS_ENUM__
#define	__ST_MOVE_CURVE_TYPE_ENUM__
#define	__ST_MOVE_STATUS_ENUM__

Typedefs
typedef struct _ST_POSMOVE_Handle_ *	ST_POSMOVE_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 Mode states. More...
enum	ST_PosMoveProfileType_e { ST_POS_MOVE_VEL_TYPE =0, ST_POS_MOVE_POS_TYPE }
	Enumeration for the Profile Mode states. 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	STPOSMOVE_setAxis (ST_POSMOVE_Handle handle, ST_Axis_e axis)
	Sets the Axis (cfg.Axis) for SpinTAC Position Move. More...
static void	STPOSMOVE_setProfileType (ST_POSMOVE_Handle handle, ST_PosMoveProfileType_e profileType)
	Sets the Profile Type (cfg.ProfileType) for SpinTAC Position Move. More...
static void	STPOSMOVE_setCurveType (ST_POSMOVE_Handle handle, ST_MoveCurveType_e curveType)
	Sets the Curve Type (cfg.CurveType) for SpinTAC Position Move. More...
static void	STPOSMOVE_setSampleTime_sec (ST_POSMOVE_Handle handle, _iq24 sampleTime)
	Sets the Sample Time (cfg.T_sec) for SpinTAC Position Move. More...
static void	STPOSMOVE_setMRevMaximum_mrev (ST_POSMOVE_Handle handle, _iq24 mRevROMax)
	Sets the Mechanical Revolution Maximum (cfg.ROMax_mrev) for SpinTAC Position Move. More...
static void	STPOSMOVE_setUnitConversion (ST_POSMOVE_Handle handle, float_t baseFreq, uint16_t polePairs)
	Sets the Unit Conversions for SpinTAC Position Move. More...
static void	STPOSMOVE_setHaltLimits (ST_POSMOVE_Handle handle, _iq24 haltAccLim, _iq20 haltJrkLim)
	Sets the Halt Limits (cfg.HaltAccLim & cfg.HaltJrkLim) for SpinTAC Position Move. More...
static void	STPOSMOVE_setVelocityStart (ST_POSMOVE_Handle handle, _iq24 velStart)
	Sets the Velocity Start (cfg.VelStart) for SpinTAC Position Move. More...
static _iq24	STPOSMOVE_getVelocityStart (ST_POSMOVE_Handle handle)
	Gets the Velocity Start (cfg.VelStart) for SpinTAC Position Move. More...
static void	STPOSMOVE_setPositionStart_mrev (ST_POSMOVE_Handle handle, _iq24 posStart)
	Sets the Position Start (cfg.PosStart_mrev) for SpinTAC Position Move. More...
static _iq24	STPOSMOVE_getPositionStart_mrev (ST_POSMOVE_Handle handle)
	Gets the Position Start (cfg.PosStart_mrev) for SpinTAC Position Move. More...
static void	STPOSMOVE_getProfileTime_tick (ST_POSMOVE_Handle handle, uint32_t *ProTime_tick, uint32_t *ProTime_mtick)
	Gets the Profile Time (msg.ProTime_tick) for SpinTAC Position Move. More...
static _iq24	STPOSMOVE_getActualVelocity (ST_POSMOVE_Handle handle)
	Gets the Actual Velocity (msg.ActualVelLim) for SpinTAC Position Move. More...
static _iq24	STPOSMOVE_getActualAcceleration (ST_POSMOVE_Handle handle)
	Gets the Actual Acceleration (msg.ActualAccLim) for SpinTAC Position Move. More...
static _iq24	STPOSMOVE_getActualDeceleration (ST_POSMOVE_Handle handle)
	Gets the Actual Deceleration (msg.ActualDecLim) for SpinTAC Position Move. More...
static _iq20	STPOSMOVE_getActualJerk (ST_POSMOVE_Handle handle)
	Gets the Actual Jerk (msg.ActualJrkLim) for SpinTAC Position Move. More...
static void	STPOSMOVE_setPositionStep_mrev (ST_POSMOVE_Handle handle, int32_t posStepInt, _iq24 posStepFrac)
	Sets the Position Step (posStepInt_mrev, posStepFrac_mrev) for SpinTAC Position Move. More...
static void	STPOSMOVE_getPositionStep_mrev (ST_POSMOVE_Handle handle, int32_t *posStepInt, _iq24 *posStepFrac)
	Gets the Position Step (posStepInt_mrev, posStepFrac_mrev) for SpinTAC Position Move. More...
static void	STPOSMOVE_setVelocityLimit (ST_POSMOVE_Handle handle, _iq24 velLim)
	Sets the Velocity Limit (VelLim) for SpinTAC Position Move. More...
static void	STPOSMOVE_setAccelerationLimit (ST_POSMOVE_Handle handle, _iq24 accLim)
	Sets the Acceleration Limit (AccLim) for SpinTAC Position Move. More...
static void	STPOSMOVE_setDecelerationLimit (ST_POSMOVE_Handle handle, _iq24 decLim)
	Sets the Deceleration Limit (DecLim) for SpinTAC Position Move. More...
static void	STPOSMOVE_setJerkLimit (ST_POSMOVE_Handle handle, _iq20 jrkLim)
	Sets the Jerk Limit (JrkLim) for SpinTAC Position Move. More...
static void	STPOSMOVE_setVelocityEnd (ST_POSMOVE_Handle handle, _iq24 velEnd)
	Sets the Velocity End (VelEnd) for SpinTAC Position Move. More...
static _iq24	STPOSMOVE_getVelocityEnd (ST_POSMOVE_Handle handle)
	Gets the Velocity End (VelEnd) for SpinTAC Position Move. More...
static void	STPOSMOVE_setPositionRollOver (ST_POSMOVE_Handle handle, int32_t posRollOver)
	Sets the Position RollOver Counts (PosRollOver) for SpinTAC Position Move. More...
static int32_t	STPOSMOVE_getPositionRollOver (ST_POSMOVE_Handle handle)
	Gets the Position RollOver Counts (PosRollOver) for SpinTAC Position Move. More...
static _iq24	STPOSMOVE_getPositionReference_mrev (ST_POSMOVE_Handle handle)
	Gets the Position Reference (PosRef_mrev) for SpinTAC Position Move. More...
static _iq24	STPOSMOVE_getVelocityReference (ST_POSMOVE_Handle handle)
	Gets the Velocity Reference (VelRef) for SpinTAC Position Move. More...
static _iq24	STPOSMOVE_getAccelerationReference (ST_POSMOVE_Handle handle)
	Gets the Acceleration Reference (AccRef) for SpinTAC Position Move. More...
static _iq20	STPOSMOVE_getJerkReference (ST_POSMOVE_Handle handle)
	Gets the Jerk Reference (JrkRef) for SpinTAC Position Move. More...
static void	STPOSMOVE_setEnable (ST_POSMOVE_Handle handle, bool enb)
	Sets the Enable signal (ENB) for SpinTAC Position Move. More...
static bool	STPOSMOVE_getEnable (ST_POSMOVE_Handle handle)
	Gets the Enable signal (ENB) for SpinTAC Position Move. More...
static void	STPOSMOVE_setTest (ST_POSMOVE_Handle handle, bool tst)
	Sets the Test signal (TST) for SpinTAC Position Move. More...
static bool	STPOSMOVE_getTest (ST_POSMOVE_Handle handle)
	Gets the Test signal (TST) for SpinTAC Position Move. More...
static ST_MoveStatus_e	STPOSMOVE_getStatus (ST_POSMOVE_Handle handle)
	Gets the Status value (STATUS) for SpinTAC Position Move. More...
static uint16_t	STPOSMOVE_getErrorID (ST_POSMOVE_Handle handle)
	Gets the Error value (ERR_ID) for SpinTAC Position Move. More...
ST_POSMOVE_Handle	STPOSMOVE_init (void *pMemory, const size_t numBytes)
	Initializes the SpinTAC Position Move object. More...
void	STPOSMOVE_run (ST_POSMOVE_Handle handle)
	Runs the SpinTAC Position Move ISR Function. More...

Detailed Description

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

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

Definition in file spintac_pos_move.h.