Jaguar Class Reference

#include <Jaguar.h>

Inheritance diagram for Jaguar:

Collaboration diagram for Jaguar:

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

Definition at line 17 of file Jaguar.h.

---

Constructor & Destructor Documentation

Jaguar::Jaguar

(

UINT32

channel

)

[explicit]

Constructor that assumes the default digital module.

Parameters:

channel

The PWM channel on the digital module that the Jaguar is attached to.

Definition at line 36 of file Jaguar.cpp.

Jaguar::Jaguar	(	UINT8	moduleNumber,
		UINT32	channel
	)

Constructor that specifies the digital module.

Parameters:

	moduleNumber	The digital module (1 or 2).
	channel	The PWM channel on the digital module that the Jaguar is attached to.

Definition at line 47 of file Jaguar.cpp.

---

Member Function Documentation

void Jaguar::Disable

(

)

[virtual]

Common interface for disabling a motor.

Definition at line 83 of file Jaguar.cpp.

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.

Definition at line 75 of file Jaguar.cpp.

void Jaguar::PIDWrite

(

float

output

)

[virtual]

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

Parameters:

output

Write out the PWM value as was found in the PIDController

Implements PIDOutput.

Definition at line 93 of file Jaguar.cpp.

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:

	speed	The speed value between -1.0 and 1.0 to set.
	syncGroup	Unused interface.

Definition at line 65 of file Jaguar.cpp.

---

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

• Jaguar.h
• Jaguar.cpp