spintac_vel_ctl.h File Reference

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

#include "spintac_version.h"

Go to the source code of this file.

Data Structures
struct	ST_VelCtlCfg_t
	Defines the ST_VelCtlCfg_t data. More...
struct	ST_VelCtl_t
	Defines the ST_VelCtl_t data. More...

Macros
#define	__ST_AXIS_ENUM__
#define	__ST_CTL_STATUS_ENUM__

Typedefs
typedef struct _ST_VELCTL_Handle_ *	ST_VELCTL_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	STVELCTL_setAxis (ST_VELCTL_Handle handle, ST_Axis_e axis)
	Sets the Axis (cfg.Axis) for SpinTAC Velocity Controller. More...
static void	STVELCTL_setSampleTime_sec (ST_VELCTL_Handle handle, _iq24 sampleTime)
	Sets the Sample Time (cfg.T_sec) for SpinTAC Velocity Controller. More...
static _iq24	STVELCTL_getOutputMaximum (ST_VELCTL_Handle handle)
	Gets the Maximum Output (cfg.OutMax) for SpinTAC Velocity Controller. More...
static _iq24	STVELCTL_getOutputMinimum (ST_VELCTL_Handle handle)
	Gets the Minimum Output (cfg.OutMin) for SpinTAC Velocity Controller. More...
static void	STVELCTL_setOutputMaximums (ST_VELCTL_Handle handle, _iq24 outMax, _iq24 outMin)
	Sets the Maximum Output (cfg.OutMax) and Minimum Output (cfg.OutMin) for SpinTAC Velocity Controller. More...
static void	STVELCTL_setFilterEnableFlag (ST_VELCTL_Handle handle, bool filterEnable)
	Sets the Feedback Filter Enable Flag (cfg.FiltEN) for SpinTAC Velocity Controller. More...
static void	STVELCTL_setVelocityReference (ST_VELCTL_Handle handle, _iq24 velRef)
	Sets the Velocity Reference (VelRef) for SpinTAC Velocity Controller. More...
static _iq24	STVELCTL_getVelocityReference (ST_VELCTL_Handle handle)
	Gets the Velocity Reference (VelRef) for SpinTAC Velocity Controller. More...
static void	STVELCTL_setAccelerationReference (ST_VELCTL_Handle handle, _iq24 accRef)
	Sets the Acceleration Reference (AccRef) for SpinTAC Velocity Controller. More...
static void	STVELCTL_setVelocityFeedback (ST_VELCTL_Handle handle, _iq24 velFdb)
	Sets the Velocity Feedback (VelFdb) for SpinTAC Velocity Controller. More...
static _iq24	STVELCTL_getVelocityFeedback (ST_VELCTL_Handle handle)
	Gets the Velocity Feedback (VelFdb) for SpinTAC Velocity Controller. More...
static void	STVELCTL_setInertia (ST_VELCTL_Handle handle, _iq24 inertia)
	Sets the Inertia (Inertia) for SpinTAC Velocity Controller. More...
static _iq24	STVELCTL_getInertia (ST_VELCTL_Handle handle)
	Gets the Inertia (Inertia) for SpinTAC Velocity Controller. More...
static void	STVELCTL_setFriction (ST_VELCTL_Handle handle, _iq24 friction)
	Sets the Friction (Friction) for SpinTAC Velocity Controller. More...
static _iq24	STVELCTL_getFriction (ST_VELCTL_Handle handle)
	Gets the Friction (Friction) from SpinTAC Velocity Controller. More...
static void	STVELCTL_setBandwidth_radps (ST_VELCTL_Handle handle, _iq20 bw)
	Sets the Bandwidth (Bw_radps) for SpinTAC Velocity Controller. More...
static _iq20	STVELCTL_getBandwidth_radps (ST_VELCTL_Handle handle)
	Gets the Bandwidth (Bw_radps) for SpinTAC Velocity Controller. More...
static void	STVELCTL_setEnable (ST_VELCTL_Handle handle, bool enb)
	Sets the Enable signal (ENB) for SpinTAC Velocity Controller. More...
static bool	STVELCTL_getEnable (ST_VELCTL_Handle handle)
	Gets the Enable signal (ENB) for SpinTAC Velocity Controller. More...
static void	STVELCTL_setTorqueReference (ST_VELCTL_Handle handle, _iq24 out)
	Sets the Torque (Iq) Reference (Out) for SpinTAC Velocity Controller. More...
static _iq24	STVELCTL_getTorqueReference (ST_VELCTL_Handle handle)
	Gets the Torque (Iq) Reference (Out) for SpinTAC Velocity Controller. More...
static ST_CtlStatus_e	STVELCTL_getStatus (ST_VELCTL_Handle handle)
	Gets the Status value (STATUS) for SpinTAC Velocity Controller. More...
static uint16_t	STVELCTL_getErrorID (ST_VELCTL_Handle handle)
	Gets the Error value (ERR_ID) for SpinTAC Velocity Controller. More...
ST_VELCTL_Handle	STVELCTL_init (void *pMemory, const size_t numBytes)
	Initializes the SpinTAC Velocity Controller object. More...
void	STVELCTL_run (ST_VELCTL_Handle handle)
	Runs the SpinTAC Velocity Control Function. More...

Detailed Description

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

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

Definition in file spintac_vel_ctl.h.