spintac_pos_ctl.h File Reference

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

#include "spintac_version.h"

Go to the source code of this file.

Data Structures
struct	ST_PosCtlCfg_t
	Defines the ST_PosCtlCfg_t data. More...
struct	ST_PosCtl_t
	Defines the ST_PosCtl_t data. More...

Macros
#define	__ST_AXIS_ENUM__
#define	__ST_CTL_STATUS_ENUM__

Typedefs
typedef struct _ST_POSCTL_Handle_ *	ST_POSCTL_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_CtlStatus_e {   ST_CTL_IDLE =0, ST_CTL_INIT, ST_CTL_CONF, ST_CTL_BUSY,   ST_CTL_IDLE =0, ST_CTL_INIT, ST_CTL_CONF, ST_CTL_BUSY }
	Enumeration for the Control Status states. More...

Functions
static void	STPOSCTL_setAxis (ST_POSCTL_Handle handle, ST_Axis_e axis)
	Sets the Axis (cfg.Axis) for SpinTAC Position Controller. More...
static void	STPOSCTL_setSampleTime_sec (ST_POSCTL_Handle handle, _iq24 sampleTime)
	Sets the Sample Time (cfg.T_sec) for SpinTAC Position Controller. More...
static _iq24	STPOSCTL_getOutputMaximum (ST_POSCTL_Handle handle)
	Gets the Maximum Output (cfg.OutMax) for SpinTAC Position Controller. More...
static _iq24	STPOSCTL_getOutputMinimum (ST_POSCTL_Handle handle)
	Gets the Minimum Output (cfg.OutMin) for SpinTAC Position Controller. More...
static void	STPOSCTL_setOutputMaximums (ST_POSCTL_Handle handle, _iq24 outMax, _iq24 outMin)
	Sets the Maximum Output (cfg.OutMax) and Minimum Output (cfg.OutMin) for SpinTAC Position Controller. More...
static void	STPOSCTL_setVelocityMaximum (ST_POSCTL_Handle handle, _iq24 velMax)
	Sets the Maximum Velocity (cfg.VelMax) for SpinTAC Position Controller. More...
static void	STPOSCTL_setPositionRolloverMaximum_mrev (ST_POSCTL_Handle handle, _iq24 roMax)
	Sets the Position Rollover Maximum (cfg.ROMax_mrev) for SpinTAC Position Controller. More...
static void	STPOSCTL_setUnitConversion (ST_POSCTL_Handle handle, float_t baseFreq, uint16_t polePairs)
	Sets the Unit Conversion (cfg.mrev_TO_pu) for SpinTAC Position Controller. More...
static void	STPOSCTL_setRampDisturbanceFlag (ST_POSCTL_Handle handle, bool rampDist)
	Sets the Ramp Disturbance Flag (cfg.RampDist) for SpinTAC Position Controller. More...
static void	STPOSCTL_setPositionErrorMaximum_mrev (ST_POSCTL_Handle handle, _iq24 errMax)
	Sets the Position Error Maximum (cfg.PosErrMax_mrev) for SpinTAC Position Controller. More...
static void	STPOSCTL_setFilterEnableFlag (ST_POSCTL_Handle handle, bool filterEnable)
	Sets the Feedback Filter Enable Flag (cfg.FiltEN) for SpinTAC Position Controller. More...
static void	STPOSCTL_setPositionReference_mrev (ST_POSCTL_Handle handle, _iq24 posRef)
	Sets the Position Reference (PosRef_mrev) for SpinTAC Position Controller. More...
static void	STPOSCTL_setVelocityReference (ST_POSCTL_Handle handle, _iq24 velRef)
	Sets the Velocity Reference (VelRef) for SpinTAC Position Controller. More...
static void	STPOSCTL_setAccelerationReference (ST_POSCTL_Handle handle, _iq24 accRef)
	Sets the Acceleration Reference (AccRef) for SpinTAC Position Controller. More...
static void	STPOSCTL_setPositionFeedback_mrev (ST_POSCTL_Handle handle, _iq24 posFdb)
	Sets the Position Feedback (PosFdb_mrev) for SpinTAC Position Controller. More...
static void	STPOSCTL_setInertia (ST_POSCTL_Handle handle, _iq24 inertia)
	Sets the Inertia (Inertia) for SpinTAC Position Controller. More...
static _iq24	STPOSCTL_getInertia (ST_POSCTL_Handle handle)
	Gets the Inertia (Inertia) for SpinTAC Position Controller. More...
static void	STPOSCTL_setFriction (ST_POSCTL_Handle handle, _iq24 friction)
	Sets the Friction (Friction) for SpinTAC Position Controller. More...
static _iq24	STPOSCTL_getFriction (ST_POSCTL_Handle handle)
	Gets the Friction (Friction) for SpinTAC Position Controller. More...
static void	STPOSCTL_setBandwidth_radps (ST_POSCTL_Handle handle, _iq20 bw)
	Sets the Bandwidth (Bw_radps) for SpinTAC Position Controller. More...
static _iq20	STPOSCTL_getBandwidth_radps (ST_POSCTL_Handle handle)
	Gets the Bandwidth (Bw_radps) for SpinTAC Position Controller. More...
static void	STPOSCTL_setEnable (ST_POSCTL_Handle handle, bool enb)
	Sets the Enable signal (ENB) for SpinTAC Position Controller. More...
static bool	STPOSCTL_getEnable (ST_POSCTL_Handle handle)
	Gets the Enable signal (ENB) for SpinTAC Position Controller. More...
static void	STPOSCTL_setTorqueReference (ST_POSCTL_Handle handle, _iq24 out)
	Sets the Torque (Iq) Reference (Out) for SpinTAC Position Controller. More...
static _iq24	STPOSCTL_getTorqueReference (ST_POSCTL_Handle handle)
	Gets the Torque (Iq) Reference (Out) for SpinTAC Position Controller. More...
static ST_CtlStatus_e	STPOSCTL_getStatus (ST_POSCTL_Handle handle)
	Gets the Status value (STATUS) for SpinTAC Position Controller. More...
static uint16_t	STPOSCTL_getErrorID (ST_POSCTL_Handle handle)
	Gets the Error value (ERR_ID) for SpinTAC Position Controller. More...
static _iq24	STPOSCTL_getPositionError_mrev (ST_POSCTL_Handle handle)
	Gets the Position Error (PosErr_mrev) for SpinTAC Position Controller. More...
ST_POSCTL_Handle	STPOSCTL_init (void *pMemory, const size_t numBytes)
	Initializes the SpinTAC Position Controller object. More...
void	STPOSCTL_run (ST_POSCTL_Handle handle)
	Runs the SpinTAC Position Control Function. More...

Detailed Description

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

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

Definition in file spintac_pos_ctl.h.