WPILib 2012
WPILibRoboticsLibraryforFRC
Public Member Functions
Jaguar Class Reference

#include <Jaguar.h>

Inheritance diagram for Jaguar:
SafePWM SpeedController PIDOutput PWM MotorSafety SensorBase ErrorBase

List of all members.

Public Member Functions

 Jaguar (UINT32 channel)
 Jaguar (UINT8 moduleNumber, UINT32 channel)
virtual void Set (float value, UINT8 syncGroup=0)
virtual float Get ()
virtual void Disable ()
virtual void PIDWrite (float output)

Detailed Description

Luminary Micro Jaguar Speed Control


Constructor & Destructor Documentation

Jaguar::Jaguar ( UINT32  channel) [explicit]

Constructor that assumes the default digital module.

Parameters:
channelThe PWM channel on the digital module that the Jaguar is attached to.
Jaguar::Jaguar ( UINT8  moduleNumber,
UINT32  channel 
)

Constructor that specifies the digital module.

Parameters:
moduleNumberThe digital module (1 or 2).
channelThe PWM channel on the digital module that the Jaguar is attached to.

Member Function Documentation

void Jaguar::Disable ( ) [virtual]

Common interface for disabling a motor.

Implements SpeedController.

float Jaguar::Get ( ) [virtual]

Get the recently set value of the PWM.

Returns:
The most recently set value for the PWM between -1.0 and 1.0.

Implements SpeedController.

void Jaguar::PIDWrite ( float  output) [virtual]

Write out the PID value as seen in the PIDOutput base object.

Parameters:
outputWrite out the PWM value as was found in the PIDController

Implements PIDOutput.

void Jaguar::Set ( float  speed,
UINT8  syncGroup = 0 
) [virtual]

Set the PWM value.

The PWM value is set using a range of -1.0 to 1.0, appropriately scaling the value for the FPGA.

Parameters:
speedThe speed value between -1.0 and 1.0 to set.
syncGroupUnused interface.

Implements SpeedController.


The documentation for this class was generated from the following files:
 All Classes Functions Variables