com.studica.frc.TitanQuad Class Reference

Inheritance diagram for com.studica.frc.TitanQuad:

Public Member Functions
	TitanQuad (int deviceID, int frequency, int motor)
	TitanQuad (int deviceID, int motor)
int	getID ()
void	set (double speed)
void	setInverted (boolean isInverted)
boolean	getInverted ()
int	getFrequency ()
String	getFirmwareVersion ()
String	getHardwareVersion ()
double	getCurrent (int motor)
double	getControllerTemp ()
void	setCurrentLimit (int motor)
double	getLimitSwitch (int motor, boolean direction)
double	getRPM ()
int	getFaults (int motor)
void	clearFaults (int motor)
boolean	enableSoftLimit (int motor)
String	getSerialNumber ()
void	pidWrite (double output)
double	get ()
void	disable ()
void	stopMotor ()

Detailed Description

Motor controller features for Studica Titan Quad motor controllers

Constructor & Destructor Documentation

TitanQuad() [1/2]

com.studica.frc.TitanQuad.TitanQuad ( int  deviceID, int  frequency, int  motor  )

inline

Constructor for Titan Quad Motor Controller

Allows for a custom frequency to be set

Parameters

deviceID	Device id for the controller
frequency	Frequency internal motor pwm operates at, range 0 - 20kHz
motor	The motor to initialize

TitanQuad() [2/2]

com.studica.frc.TitanQuad.TitanQuad ( int  deviceID, int  motor  )

inline

Constructor for Titan Quad Motor Controller

Parameters

deviceID	Device id for the controller
motor	THe motor to initialize

Member Function Documentation

clearFaults()

void com.studica.frc.TitanQuad.clearFaults ( int  motor )

inline

clear faults

Parameters

motor

- description

enableSoftLimit()

boolean com.studica.frc.TitanQuad.enableSoftLimit ( int  motor )

inline

enable soft limits

Parameters

motor

- decription

Returns

enable or disabled

getControllerTemp()

double com.studica.frc.TitanQuad.getControllerTemp ( )

inline

Gets the controller temp

Returns

controller temp value

getCurrent()

double com.studica.frc.TitanQuad.getCurrent ( int  motor )

inline

Grabs the specified motors current pull

Parameters

motor

motor to be checked

Returns

current in amps

getFaults()

int com.studica.frc.TitanQuad.getFaults ( int  motor )

inline

get faults

Parameters

motor

- description

Returns

faults

getFirmwareVersion()

String com.studica.frc.TitanQuad.getFirmwareVersion ( )

inline

Gets the firmware version

Returns

a string with the firmware version

getFrequency()

int com.studica.frc.TitanQuad.getFrequency ( )

inline

Gets the frequency that the motor internal PWM is operating at

Returns

frequency in Hz

getHardwareVersion()

String com.studica.frc.TitanQuad.getHardwareVersion ( )

inline

Gets the hardware and hardware version

Returns

a string with hardware type and version number

getID()

int com.studica.frc.TitanQuad.getID ( )

inline

Gets the device id

Returns

the device id

getLimitSwitch()

double com.studica.frc.TitanQuad.getLimitSwitch ( int  motor, boolean  direction  )

inline

Gets limit switch (description)

Parameters

motor	- description
direction	- forward or reverse

Returns

limit switch

getRPM()

double com.studica.frc.TitanQuad.getRPM ( )

inline

Gets motor's round per minute

Returns

Round per minute

getSerialNumber()

String com.studica.frc.TitanQuad.getSerialNumber ( )

inline

Serial Number is required for any support requesets

Returns

Serial Number

set()

void com.studica.frc.TitanQuad.set ( double  speed )

inline

Sets the output of the Titan Quad as a percentage from -1.0 to 1.0.

Parameters

speed

Percentage value between -1.0 to 1.0, 0.0 meaning stopped.

setCurrentLimit()

void com.studica.frc.TitanQuad.setCurrentLimit ( int  motor )

inline

Sets the current limit for specified motor

Parameters

motor

- The motor to set current limit to.

setInverted()

void com.studica.frc.TitanQuad.setInverted ( boolean  isInverted )

inline

Inverts the output of the motor controller,

Parameters

isInverted

- The invert state to be set.

---

The documentation for this class was generated from the following file:

• C:/Users/Studica/Studica/Studica/src/main/java/com/studica/frc/TitanQuad.java