PS5USB Class Reference

#include <PS5USB.h>

Inheritance diagram for PS5USB:

Collaboration diagram for PS5USB:

Public Member Functions
	PS5USB (USB *p)
bool	connected ()
void	attachOnInit (void(*funcOnInit)(void))
Public Member Functions inherited from HIDUniversal
	HIDUniversal (USB *p)
uint8_t	Poll () override
void	EndpointXtract (uint8_t conf, uint8_t iface, uint8_t alt, uint8_t proto, const USB_ENDPOINT_DESCRIPTOR *ep) override
Public Member Functions inherited from HIDComposite
	HIDComposite (USB *p)
bool	SetReportParser (uint8_t id, HIDReportParser *prs)
uint8_t	Init (uint8_t parent, uint8_t port, bool lowspeed)
uint8_t	Release ()
virtual uint8_t	GetAddress ()
virtual bool	isReady ()
uint8_t	SndRpt (uint16_t nbytes, uint8_t *dataptr)
Public Member Functions inherited from USBHID
	USBHID (USB *pusb)
const USB *	GetUsb ()
uint8_t	SetProtocol (uint8_t iface, uint8_t protocol)
uint8_t	GetProtocol (uint8_t iface, uint8_t *dataptr)
uint8_t	GetIdle (uint8_t iface, uint8_t reportID, uint8_t *dataptr)
uint8_t	SetIdle (uint8_t iface, uint8_t reportID, uint8_t duration)
uint8_t	GetReportDescr (uint16_t wIndex, USBReadParser *parser=NULL)
uint8_t	GetHidDescr (uint8_t ep, uint16_t nbytes, uint8_t *dataptr)
uint8_t	GetReport (uint8_t ep, uint8_t iface, uint8_t report_type, uint8_t report_id, uint16_t nbytes, uint8_t *dataptr)
uint8_t	SetReport (uint8_t ep, uint8_t iface, uint8_t report_type, uint8_t report_id, uint16_t nbytes, uint8_t *dataptr)
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 bool	DEVCLASSOK (uint8_t klass)
virtual bool	DEVSUBCLASSOK (uint8_t subklass)
Public Member Functions inherited from PS5Parser
	PS5Parser ()
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)
uint16_t	getY (uint8_t finger=0)
bool	isTouching (uint8_t finger=0)
uint8_t	getTouchCounter (uint8_t finger=0)
float	getAngle (AngleEnum a)
int16_t	getSensor (SensorEnum s)
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	setPlayerLedOff ()
void	setPlayerLed (uint8_t mask)
void	setMicLedOff ()
void	setMicLed (bool on)
uint16_t	getMessageCounter ()

Protected Member Functions
HIDUniversal implementation
virtual void	ParseHIDData (USBHID *hid, bool is_rpt_id, uint8_t len, uint8_t *buf)
virtual uint8_t	OnInitSuccessful ()
PS5Parser implementation
virtual void	sendOutputReport (PS5Output *output)
USBDeviceConfig implementation
virtual bool	VIDPIDOK (uint16_t vid, uint16_t pid)
Protected Member Functions inherited from HIDComposite
uint16_t	GetHidClassDescrLen (uint8_t type, uint8_t num)
void	Initialize ()
HIDInterface *	FindInterface (uint8_t iface, uint8_t alt, uint8_t proto)
void	ZeroMemory (uint8_t len, uint8_t *buf)
HIDReportParser *	GetReportParser (uint8_t id)
Protected Member Functions inherited from USBHID
void	PrintEndpointDescriptor (const USB_ENDPOINT_DESCRIPTOR *ep_ptr)
void	PrintHidDescriptor (const USB_HID_DESCRIPTOR *pDesc)
Protected Member Functions inherited from PS5Parser
void	Parse (uint8_t len, uint8_t *buf)
void	Reset ()

Additional Inherited Members
Public Attributes inherited from PS5Parser
PS5Trigger	leftTrigger
PS5Trigger	rightTrigger
Protected Attributes inherited from HIDComposite
struct HIDComposite::ReportParser	rptParsers [MAX_REPORT_PARSERS]
HID_CLASS_DESCRIPTOR_LEN_AND_TYPE	descrInfo [HID_MAX_HID_CLASS_DESCRIPTORS]
uint8_t	bConfNum
uint8_t	bNumIface
uint8_t	bNumEP
uint32_t	qNextPollTime
uint8_t	pollInterval
bool	bPollEnable
EpInfo	epInfo [totalEndpoints]
HIDInterface	hidInterfaces [maxHidInterfaces]
bool	bHasReportId
uint16_t	PID
uint16_t	VID
Protected Attributes inherited from USBHID
USB *	pUsb
uint8_t	bAddress
Static Protected Attributes inherited from HIDComposite
static const uint16_t	constBuffLen = 64
Static Protected Attributes inherited from USBHID
static const uint8_t	epInterruptInIndex = 1
static const uint8_t	epInterruptOutIndex = 2
static const uint8_t	maxHidInterfaces = 5
static const uint8_t	maxEpPerInterface = 2
static const uint8_t	totalEndpoints = (maxHidInterfaces * maxEpPerInterface + 1)

Detailed Description

This class implements support for the PS5 controller via USB. It uses the HIDUniversal class for all the USB communication.

Definition at line 34 of file PS5USB.h.

Constructor & Destructor Documentation

PS5USB()

PS5USB::PS5USB ( USB *  p )

inline

Constructor for the PS5USB class.

Parameters

p	Pointer to the USB class instance.

Definition at line 40 of file PS5USB.h.

Member Function Documentation

connected()

bool PS5USB::connected ( )

inline

Used to check if a PS5 controller is connected.

Returns

Returns true if it is connected.

Definition at line 49 of file PS5USB.h.

attachOnInit()

void PS5USB::attachOnInit ( void(*)(void)  funcOnInit )

inline

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

Parameters

funcOnInit

Function to call.

Definition at line 57 of file PS5USB.h.

ParseHIDData()

virtual void PS5USB::ParseHIDData ( USBHID *  hid, bool  is_rpt_id, uint8_t  len, uint8_t *  buf  )

inlineprotectedvirtual

Used to parse USB HID data.

Parameters

hid	Pointer to the HID class.
is_rpt_id	Only used for Hubs.
len	The length of the incoming data.
buf	Pointer to the data buffer.

Reimplemented from HIDUniversal.

Definition at line 70 of file PS5USB.h.

OnInitSuccessful()

virtual uint8_t PS5USB::OnInitSuccessful ( )

inlineprotectedvirtual

Called when a device is successfully initialized. Use attachOnInit(void (*funcOnInit)(void)) to call your own function. This is useful for instance if you want to set the LEDs in a specific way.

Reimplemented from HIDComposite.

Definition at line 80 of file PS5USB.h.

sendOutputReport()

virtual void PS5USB::sendOutputReport ( PS5Output *  output )

inlineprotectedvirtual

Send the output to the PS5 controller. This is implemented in PS5BT.h and PS5USB.h.

Parameters

output

Pointer to PS5Output buffer;

Implements PS5Parser.

Definition at line 93 of file PS5USB.h.

VIDPIDOK()

virtual bool PS5USB::VIDPIDOK ( uint16_t  vid, uint16_t  pid  )

inlineprotectedvirtual

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 149 of file PS5USB.h.

---

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

• PS5USB.h