PS4Parser Class Reference

#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)
Only available via USB at the moment
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)
double	getAngle (AngleEnum a)
int16_t	getSensor (SensorEnum s)

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

Detailed Description

This class parses all the data sent by the PS4 controller

Definition at line 125 of file PS4Parser.h.

Constructor & Destructor Documentation

PS4Parser::PS4Parser ( )

inline

Constructor for the PS4Parser class.

Definition at line 128 of file PS4Parser.h.

Member Function Documentation

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 38 of file PS4Parser.cpp.

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 49 of file PS4Parser.cpp.

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: UP, RIGHT, DOWN, LEFT, L1, L2, R1, R2, TRIANGLE, CIRCLE, CROSS, SQUARE, and T.

Returns

Analog value in the range of 0-255.

Definition at line 64 of file PS4Parser.cpp.

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 72 of file PS4Parser.cpp.

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 174 of file PS4Parser.h.

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 186 of file PS4Parser.h.

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 198 of file PS4Parser.h.

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 210 of file PS4Parser.h.

double 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 219 of file PS4Parser.h.

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 231 of file PS4Parser.h.

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 76 of file PS4Parser.cpp.

void PS4Parser::Reset ( )

inlineprotected

Used to reset the different buffers to their default values

Definition at line 260 of file PS4Parser.h.

---

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

• PS4Parser.h
• PS4Parser.cpp