#include <PS4Parser.h>

Inheritance diagram for PS4Parser:

Public Member Functions
	PS4Parser ()

PS4 Controller functions
bool	getButtonPress (ButtonEnum b)

bool	getButtonClick (ButtonEnum b)

uint8_t	getAnalogButton (ButtonEnum b)

uint8_t	getAnalogHat (AnalogHatEnum a)

uint16_t	getX (uint8_t finger=0, uint8_t xyId=0)

uint16_t	getY (uint8_t finger=0, uint8_t xyId=0)

bool	isTouching (uint8_t finger=0, uint8_t xyId=0)

uint8_t	getTouchCounter (uint8_t finger=0, uint8_t xyId=0)

float	getAngle (AngleEnum a)

int16_t	getSensor (SensorEnum s)

uint8_t	getBatteryLevel ()

bool	getUsbStatus ()

bool	getAudioStatus ()

bool	getMicStatus ()

void	setAllOff ()

void	setRumbleOff ()

void	setRumbleOn (RumbleEnum mode)

void	setRumbleOn (uint8_t bigRumble, uint8_t smallRumble)

void	setLedOff ()

void	setLed (uint8_t r, uint8_t g, uint8_t b)

void	setLed (ColorsEnum color)

void	setLedFlash (uint8_t flashOn, uint8_t flashOff)

Protected Member Functions
void	Parse (uint8_t len, uint8_t *buf)

void	Reset ()

virtual void	sendOutputReport (PS4Output *output)=0

Detailed Description

This class parses all the data sent by the PS4 controller

Definition at line 124 of file PS4Parser.h.

Constructor & Destructor Documentation

◆ PS4Parser()

PS4Parser::PS4Parser ( )

inline

Constructor for the PS4Parser class.

Definition at line 127 of file PS4Parser.h.

Member Function Documentation

◆ getButtonPress()

bool PS4Parser::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: getButtonPress(ButtonEnum b) will return a true as long as a button is held down, while getButtonClick(ButtonEnum b) will return true once for each button press.

Definition at line 56 of file PS4Parser.cpp.

◆ getButtonClick()

bool PS4Parser::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: getButtonPress(ButtonEnum b) will return a true as long as a button is held down, while getButtonClick(ButtonEnum b) will return true once for each button press.

Definition at line 64 of file PS4Parser.cpp.

◆ getAnalogButton()

uint8_t PS4Parser::getAnalogButton ( ButtonEnum b )

Used to get the analog value from button presses.

Parameters

b	The ButtonEnum to read. The supported buttons are: L2 and R2.

Returns: Analog value in the range of 0-255.

Definition at line 72 of file PS4Parser.cpp.

◆ getAnalogHat()

uint8_t PS4Parser::getAnalogHat ( AnalogHatEnum a )

Used to read the analog joystick.

Parameters

a	LeftHatX, LeftHatY, RightHatX, and RightHatY.

Returns: Return the analog value in the range of 0-255.

Definition at line 81 of file PS4Parser.cpp.

◆ getX()

uint16_t PS4Parser::getX	(	uint8_t	finger = `0`,
		uint8_t	xyId = `0`
	)

inline

Get the x-coordinate of the touchpad. Position 0 is in the top left.

Parameters

finger	0 = first finger, 1 = second finger. If omitted, then 0 will be used.
xyId	The controller sends out three packets with the same structure. The third one will contain the last measure, but if you read from the controller then there is only be data in the first one. For that reason it will be set to 0 if the argument is omitted.

Returns: Returns the x-coordinate of the finger.

Definition at line 170 of file PS4Parser.h.

◆ getY()

uint16_t PS4Parser::getY	(	uint8_t	finger = `0`,
		uint8_t	xyId = `0`
	)

inline

Get the y-coordinate of the touchpad. Position 0 is in the top left.

Parameters

finger	0 = first finger, 1 = second finger. If omitted, then 0 will be used.
xyId	The controller sends out three packets with the same structure. The third one will contain the last measure, but if you read from the controller then there is only be data in the first one. For that reason it will be set to 0 if the argument is omitted.

Returns: Returns the y-coordinate of the finger.

Definition at line 182 of file PS4Parser.h.

◆ isTouching()

bool PS4Parser::isTouching	(	uint8_t	finger = `0`,
		uint8_t	xyId = `0`
	)

inline

Returns whenever the user is toucing the touchpad.

Parameters

finger	0 = first finger, 1 = second finger. If omitted, then 0 will be used.
xyId	The controller sends out three packets with the same structure. The third one will contain the last measure, but if you read from the controller then there is only be data in the first one. For that reason it will be set to 0 if the argument is omitted.

Returns: Returns true if the specific finger is touching the touchpad.

Definition at line 194 of file PS4Parser.h.

◆ getTouchCounter()

uint8_t PS4Parser::getTouchCounter	(	uint8_t	finger = `0`,
		uint8_t	xyId = `0`
	)

inline

This counter increments every time a finger touches the touchpad.

Parameters

finger	0 = first finger, 1 = second finger. If omitted, then 0 will be used.
xyId	The controller sends out three packets with the same structure. The third one will contain the last measure, but if you read from the controller then there is only be data in the first one. For that reason it will be set to 0 if the argument is omitted.

Returns: Return the value of the counter, note that it is only a 7-bit value.

Definition at line 206 of file PS4Parser.h.

◆ getAngle()

float PS4Parser::getAngle ( AngleEnum a )

inline

Get the angle of the controller calculated using the accelerometer.

Parameters

a	Either Pitch or Roll.

Returns: Return the angle in the range of 0-360.

Definition at line 215 of file PS4Parser.h.

◆ getSensor()

int16_t PS4Parser::getSensor ( SensorEnum s )

inline

Used to get the raw values from the 3-axis gyroscope and 3-axis accelerometer inside the PS4 controller.

Parameters

s	The sensor to read.

Returns: Returns the raw sensor reading.

Definition at line 227 of file PS4Parser.h.

◆ getBatteryLevel()

uint8_t PS4Parser::getBatteryLevel ( )

inline

Return the battery level of the PS4 controller.

Returns: The battery level in the range 0-15.

Definition at line 250 of file PS4Parser.h.

◆ getUsbStatus()

bool PS4Parser::getUsbStatus ( )

inline

Use this to check if an USB cable is connected to the PS4 controller.

Returns: Returns true if an USB cable is connected.

Definition at line 258 of file PS4Parser.h.

◆ getAudioStatus()

bool PS4Parser::getAudioStatus ( )

inline

Use this to check if an audio jack cable is connected to the PS4 controller.

Returns: Returns true if an audio jack cable is connected.

Definition at line 266 of file PS4Parser.h.

◆ getMicStatus()

bool PS4Parser::getMicStatus ( )

inline

Use this to check if a microphone is connected to the PS4 controller.

Returns: Returns true if a microphone is connected.

Definition at line 274 of file PS4Parser.h.

◆ setAllOff()

void PS4Parser::setAllOff ( )

inline

Turn both rumble and the LEDs off.

Definition at line 279 of file PS4Parser.h.

◆ setRumbleOff()

void PS4Parser::setRumbleOff ( )

inline

Set rumble off.

Definition at line 285 of file PS4Parser.h.

◆ setRumbleOn() [1/2]

void PS4Parser::setRumbleOn ( RumbleEnum mode )

inline

Turn on rumble.

Parameters

mode	Either RumbleHigh or RumbleLow.

Definition at line 293 of file PS4Parser.h.

◆ setRumbleOn() [2/2]

void PS4Parser::setRumbleOn	(	uint8_t	bigRumble,
		uint8_t	smallRumble
	)

inline

Turn on rumble.

Parameters

bigRumble	Value for big motor.
smallRumble	Value for small motor.

Definition at line 305 of file PS4Parser.h.

◆ setLedOff()

void PS4Parser::setLedOff ( )

inline

Turn all LEDs off.

Definition at line 312 of file PS4Parser.h.

◆ setLed() [1/2]

void PS4Parser::setLed	(	uint8_t	r,
		uint8_t	g,
		uint8_t	b
	)

inline

Use this to set the color using RGB values.

Parameters

r,g,b RGB value.

Definition at line 320 of file PS4Parser.h.

◆ setLed() [2/2]

void PS4Parser::setLed ( ColorsEnum color )

inline

Use this to set the color using the predefined colors in ColorsEnum.

Parameters

color The desired color.

Definition at line 331 of file PS4Parser.h.

◆ setLedFlash()

void PS4Parser::setLedFlash	(	uint8_t	flashOn,
		uint8_t	flashOff
	)

inline

Set the LEDs flash time.

Parameters

flashOn	Time to flash bright (255 = 2.5 seconds).
flashOff	Time to flash dark (255 = 2.5 seconds).

Definition at line 340 of file PS4Parser.h.

◆ Parse()

void PS4Parser::Parse	(	uint8_t	len,
		uint8_t *	buf
	)

protected

Used to parse data sent from the PS4 controller.

Parameters

len	Length of the data.
buf	Pointer to the data buffer.

Definition at line 85 of file PS4Parser.cpp.

◆ Reset()

void PS4Parser::Reset ( )

protected

Used to reset the different buffers to their default values

Definition at line 139 of file PS4Parser.cpp.

◆ sendOutputReport()

virtual void PS4Parser::sendOutputReport ( PS4Output * output )

protectedpure virtual

Send the output to the PS4 controller. This is implemented in PS4BT.h and PS4USB.h.

Parameters

output Pointer to PS4Output buffer;

Implemented in PS4USB, and PS4BT.

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

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ PS4Parser()

Member Function Documentation

◆ getButtonPress()

◆ getButtonClick()

◆ getAnalogButton()

◆ getAnalogHat()

◆ getX()

◆ getY()

◆ isTouching()

◆ getTouchCounter()

◆ getAngle()

◆ getSensor()

◆ getBatteryLevel()

◆ getUsbStatus()

◆ getAudioStatus()

◆ getMicStatus()

◆ setAllOff()

◆ setRumbleOff()

◆ setRumbleOn() [1/2]

◆ setRumbleOn() [2/2]

◆ setLedOff()

◆ setLed() [1/2]

◆ setLed() [2/2]

◆ setLedFlash()

◆ Parse()

◆ Reset()

◆ sendOutputReport()