XBOXOLD Class Reference

#include <XBOXOLD.h>

Inheritance diagram for XBOXOLD:

Collaboration diagram for XBOXOLD:

Public Member Functions
	XBOXOLD (USB *pUsb)
USBDeviceConfig implementation
virtual uint8_t	Init (uint8_t parent, uint8_t port, bool lowspeed)
virtual uint8_t	Release ()
virtual uint8_t	Poll ()
virtual uint8_t	GetAddress ()
virtual bool	isReady ()
virtual boolean	VIDPIDOK (uint16_t vid, uint16_t pid)
Xbox Controller functions
uint8_t	getButtonPress (ButtonEnum b)
bool	getButtonClick (ButtonEnum b)
int16_t	getAnalogHat (AnalogHatEnum a)
void	setRumbleOff ()
void	setRumbleOn (uint8_t lValue, uint8_t rValue)
void	attachOnInit (void(*funcOnInit)(void))
Public Member Functions inherited from USBDeviceConfig
virtual uint8_t	ConfigureDevice (uint8_t parent, uint8_t port, bool lowspeed)
virtual void	ResetHubPort (uint8_t port)
virtual boolean	DEVCLASSOK (uint8_t klass)

Public Attributes
bool	XboxConnected

Protected Attributes
USB *	pUsb
uint8_t	bAddress
EpInfo	epInfo [XBOX_MAX_ENDPOINTS]

Detailed Description

This class implements support for a the original Xbox controller via USB.

Definition at line 52 of file XBOXOLD.h.

Constructor & Destructor Documentation

XBOXOLD::XBOXOLD

(

USB *

pUsb

)

Constructor for the XBOXOLD class.

Parameters

pUsb	Pointer to USB class instance.

Definition at line 47 of file XBOXOLD.cpp.

Member Function Documentation

uint8_t XBOXOLD::Init ( uint8_t  parent, uint8_t  port, bool  lowspeed  )

virtual

Initialize the Xbox Controller.

Parameters

parent	Hub number.
port	Port number on the hub.
lowspeed	Speed of the device.

Returns

0 on success.

Reimplemented from USBDeviceConfig.

Definition at line 62 of file XBOXOLD.cpp.

uint8_t XBOXOLD::Release ( )

virtual

Release the USB device.

Returns

0 on success.

Reimplemented from USBDeviceConfig.

Definition at line 236 of file XBOXOLD.cpp.

uint8_t XBOXOLD::Poll ( )

virtual

Poll the USB Input endpoins and run the state machines.

Returns

0 on success.

Reimplemented from USBDeviceConfig.

Definition at line 244 of file XBOXOLD.cpp.

virtual uint8_t XBOXOLD::GetAddress ( )

inlinevirtual

Get the device address.

Returns

The device address.

Reimplemented from USBDeviceConfig.

Definition at line 84 of file XBOXOLD.h.

virtual bool XBOXOLD::isReady ( )

inlinevirtual

Used to check if the controller has been initialized.

Returns

True if it's ready.

Definition at line 92 of file XBOXOLD.h.

virtual boolean XBOXOLD::VIDPIDOK ( uint16_t  vid, uint16_t  pid  )

inlinevirtual

Used by the USB core to check what this driver support.

Parameters

vid	The device's VID.
pid	The device's PID.

Returns

Returns true if the device's VID and PID matches this driver.

Reimplemented from USBDeviceConfig.

Definition at line 102 of file XBOXOLD.h.

uint8_t XBOXOLD::getButtonPress

(

ButtonEnum

b

)

getButtonPress(ButtonEnum b) will return true as long as the button is held down.

While getButtonClick(ButtonEnum b) will only return it once.

So you instance if you need to increase a variable once you would use getButtonClick(ButtonEnum b), but if you need to drive a robot forward you would use getButtonPress(ButtonEnum b).

Parameters

b	ButtonEnum to read.

Returns

getButtonClick(ButtonEnum b) will return a bool, while getButtonPress(ButtonEnum b) will return a byte if reading L2 or R2.

Definition at line 294 of file XBOXOLD.cpp.

bool XBOXOLD::getButtonClick

(

ButtonEnum

b

)

getButtonPress(ButtonEnum b) will return true as long as the button is held down.

While getButtonClick(ButtonEnum b) will only return it once.

So you instance if you need to increase a variable once you would use getButtonClick(ButtonEnum b), but if you need to drive a robot forward you would use getButtonPress(ButtonEnum b).

Parameters

b	ButtonEnum to read.

Returns

getButtonClick(ButtonEnum b) will return a bool, while getButtonPress(ButtonEnum b) will return a byte if reading L2 or R2.

Definition at line 301 of file XBOXOLD.cpp.

int16_t XBOXOLD::getAnalogHat

(

AnalogHatEnum

a

)

Return the analog value from the joysticks on the controller.

Parameters

a	Either LeftHatX, LeftHatY, RightHatX or RightHatY.

Returns

Returns a signed 16-bit integer.

Definition at line 316 of file XBOXOLD.cpp.

void XBOXOLD::setRumbleOff ( )

inline

Turn rumble off the controller.

Definition at line 131 of file XBOXOLD.h.

void XBOXOLD::setRumbleOn	(	uint8_t	lValue,
		uint8_t	rValue
	)

Turn rumble on.

Parameters

lValue	Left motor (big weight) inside the controller.
rValue	Right motor (small weight) inside the controller.

Definition at line 326 of file XBOXOLD.cpp.

void XBOXOLD::attachOnInit ( void(*)(void)  funcOnInit )

inline

Used to call your own function when the controller is successfully initialized.

Parameters

funcOnInit

Function to call.

Definition at line 145 of file XBOXOLD.h.

Member Data Documentation

bool XBOXOLD::XboxConnected

True if a Xbox controller is connected.

Definition at line 147 of file XBOXOLD.h.

USB* XBOXOLD::pUsb

protected

Pointer to USB class instance.

Definition at line 155 of file XBOXOLD.h.

uint8_t XBOXOLD::bAddress

protected

Device address.

Definition at line 157 of file XBOXOLD.h.

EpInfo XBOXOLD::epInfo[XBOX_MAX_ENDPOINTS]

protected

Endpoint info structure.

Definition at line 159 of file XBOXOLD.h.

---

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

• XBOXOLD.h
• XBOXOLD.cpp