com.studica.frc.TitanSmall Class Reference

Inheritance diagram for com.studica.frc.TitanSmall:

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

Detailed Description

Titan class testing java documentation.

Author

Studica Limited

Constructor & Destructor Documentation

TitanSmall() [1/2]

com.studica.frc.TitanSmall.TitanSmall ( int  deviceID, int  frequency  )

inline

Constuctor for Titan class

Parameters

deviceID	- Initialize the device ID
frequency	- Defines the Titan's frequency

TitanSmall() [2/2]

com.studica.frc.TitanSmall.TitanSmall ( int  deviceID )

inline

Constructor for Titan Quad Motor Controller

Parameters

deviceID

Device id for the controller

Member Function Documentation

clearFaults()

void com.studica.frc.TitanSmall.clearFaults ( )

inline

clear faults

enableSoftLimit()

boolean com.studica.frc.TitanSmall.enableSoftLimit ( )

inline

enable soft limits

Returns

enable or disabled

getCurrent()

double com.studica.frc.TitanSmall.getCurrent ( )

inline

Gets the current of the specified motor.

Returns

The current of the specified motor.

getFaults()

int com.studica.frc.TitanSmall.getFaults ( )

inline

get faults

Returns

faults

getFirmwareVersion()

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

inline

Gets the current firmware version of the Titan.

Returns

Firmware version of the TItan in string format.

getFrequency()

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

inline

Gets the current frequency of the Titan.

Returns

Frequency of the Titan.

getHardwareVersion()

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

inline

Gets the current hardware version of the Titan.

Returns

Hardware version of the Titan in string format.

getID()

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

inline

Gets the current device ID of the Titan.

Returns

Device ID of the Titan.

getLimitSwitch()

double com.studica.frc.TitanSmall.getLimitSwitch ( boolean  direction )

inline

Gets limit switch (description)

Parameters

direction

- forward or reverse

Returns

limit switch

getSerialNumber()

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

inline

get serial number

Returns

serial number

setCurrentLimit()

void com.studica.frc.TitanSmall.setCurrentLimit ( )

inline

Sets the current limit for specified motor

setMotorSpeed()

void com.studica.frc.TitanSmall.setMotorSpeed ( double  speed )

inline

Sets the speed of the specified motor

Parameters

speed

- The speed to control the motor

---

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

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