Skip to content

Commit 25117ab

Browse files
LauszusLauszus
committed
Added support for the Playstation Buzz controllers
See #71
1 parent 5776195 commit 25117ab

File tree

6 files changed

+362
-3
lines changed

6 files changed

+362
-3
lines changed

‎PSBuzz.cpp‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
/* Copyright (C) 2014 Kristian Lauszus, TKJ Electronics. All rights reserved.
2+
3+
This software may be distributed and modified under the terms of the GNU
4+
General Public License version 2 (GPL2) as published by the Free Software
5+
Foundation and appearing in the file GPL2.TXT included in the packaging of
6+
this file. Please note that GPL2 Section 2[b] requires that all works based
7+
on this software must also be made publicly available under the terms of
8+
the GPL2 ("Copyleft").
9+
10+
Contact information
11+
-------------------
12+
13+
Kristian Lauszus, TKJ Electronics
14+
Web : http://www.tkjelectronics.com
15+
e-mail : kristianl@tkjelectronics.com
16+
*/
17+
18+
#include "PSBuzz.h"
19+
20+
// To enable serial debugging see "settings.h"
21+
//#define PRINTREPORT // Uncomment to print the report send by the PS Buzz Controllers
22+
23+
void PSBuzz::ParseHIDData(HID *hid, bool is_rpt_id, uint8_t len, uint8_t *buf) {
24+
if (HIDUniversal::VID == PSBUZZ_VID && HIDUniversal::PID == PSBUZZ_PID && len > 0 && buf) {
25+
#ifdef PRINTREPORT
26+
Notify(PSTR("\r\n"), 0x80);
27+
for (uint8_t i = 0; i < len; i++) {
28+
D_PrintHex<uint8_t > (buf[i], 0x80);
29+
Notify(PSTR(" "), 0x80);
30+
}
31+
#endif
32+
memcpy(&psbuzzButtons, buf + 2, min(len - 2, sizeof(psbuzzButtons)));
33+
34+
if (psbuzzButtons.val != oldButtonState.val) { // Check if anything has changed
35+
buttonClickState.val = psbuzzButtons.val & ~oldButtonState.val; // Update click state variable
36+
oldButtonState.val = psbuzzButtons.val;
37+
}
38+
}
39+
};
40+
41+
uint8_t PSBuzz::OnInitSuccessful() {
42+
if (HIDUniversal::VID == PSBUZZ_VID && HIDUniversal::PID == PSBUZZ_PID) {
43+
Reset();
44+
if (pFuncOnInit)
45+
pFuncOnInit(); // Call the user function
46+
else
47+
setLedOnAll(); // Turn the LED on, on all four controllers
48+
};
49+
return 0;
50+
};
51+
52+
bool PSBuzz::getButtonPress(ButtonEnum b, uint8_t controller) {
53+
return psbuzzButtons.val & (1UL << (b + 5 * controller)); // Each controller uses 5 bits, so the value is shifted 5 for each controller
54+
};
55+
56+
bool PSBuzz::getButtonClick(ButtonEnum b, uint8_t controller) {
57+
uint32_t mask = (1UL << (b + 5 * controller)); // Each controller uses 5 bits, so the value is shifted 5 for each controller
58+
bool click = buttonClickState.val & mask;
59+
buttonClickState.val &= ~mask; // Clear "click" event
60+
return click;
61+
};
62+
63+
// Source: http://www.developerfusion.com/article/84338/making-usb-c-friendly/ and https://github.com/torvalds/linux/blob/master/drivers/hid/hid-sony.c
64+
void PSBuzz::setLedRaw(bool value, uint8_t controller) {
65+
ledState[controller] = value; // Save value for next time it is called
66+
67+
uint8_t buf[7];
68+
buf[0] = 0x00;
69+
buf[1] = ledState[0] ? 0xFF : 0x00;
70+
buf[2] = ledState[1] ? 0xFF : 0x00;
71+
buf[3] = ledState[2] ? 0xFF : 0x00;
72+
buf[4] = ledState[3] ? 0xFF : 0x00;
73+
buf[5] = 0x00;
74+
buf[6] = 0x00;
75+
76+
PSBuzz_Command(buf, sizeof(buf));
77+
};
78+
79+
void PSBuzz::PSBuzz_Command(uint8_t *data, uint16_t nbytes) {
80+
// bmRequest = Host to device (0x00) | Class (0x20) | Interface (0x01) = 0x21, bRequest = Set Report (0x09), Report ID (0x00), Report Type (Output 0x02), interface (0x00), datalength, datalength, data)
81+
pUsb->ctrlReq(bAddress, epInfo[0].epAddr, bmREQ_HIDOUT, HID_REQUEST_SET_REPORT, 0x00, 0x02, 0x00, nbytes, nbytes, data, NULL);
82+
};

‎PSBuzz.h‎

Lines changed: 185 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,185 @@
1+
/* Copyright (C) 2014 Kristian Lauszus, TKJ Electronics. All rights reserved.
2+
3+
This software may be distributed and modified under the terms of the GNU
4+
General Public License version 2 (GPL2) as published by the Free Software
5+
Foundation and appearing in the file GPL2.TXT included in the packaging of
6+
this file. Please note that GPL2 Section 2[b] requires that all works based
7+
on this software must also be made publicly available under the terms of
8+
the GPL2 ("Copyleft").
9+
10+
Contact information
11+
-------------------
12+
13+
Kristian Lauszus, TKJ Electronics
14+
Web : http://www.tkjelectronics.com
15+
e-mail : kristianl@tkjelectronics.com
16+
*/
17+
18+
#ifndef _psbuzz_h_
19+
#define _psbuzz_h_
20+
21+
#include "hiduniversal.h"
22+
#include "controllerEnums.h"
23+
24+
#define PSBUZZ_VID 0x054C // Sony Corporation
25+
#define PSBUZZ_PID 0x1000 // PS Buzz Controller
26+
27+
/** Struct used to easily read the different buttons on the controllers */
28+
union PSBUZZButtons {
29+
struct {
30+
uint8_t red : 1;
31+
uint8_t yellow : 1;
32+
uint8_t green : 1;
33+
uint8_t orange : 1;
34+
uint8_t blue : 1;
35+
} __attribute__((packed)) btn[4];
36+
uint32_t val : 20;
37+
} __attribute__((packed));
38+
39+
/**
40+
* This class implements support for the PS Buzz controllers via USB.
41+
* It uses the HIDUniversal class for all the USB communication.
42+
*/
43+
class PSBuzz : public HIDUniversal {
44+
public:
45+
/**
46+
* Constructor for the PSBuzz class.
47+
* @param p Pointer to the USB class instance.
48+
*/
49+
PSBuzz(USB *p) :
50+
HIDUniversal(p) {
51+
Reset();
52+
};
53+
54+
/**
55+
* Used to check if a PS Buzz controller is connected.
56+
* @return Returns true if it is connected.
57+
*/
58+
bool connected() {
59+
return HIDUniversal::isReady() && HIDUniversal::VID == PSBUZZ_VID && HIDUniversal::PID == PSBUZZ_PID;
60+
};
61+
62+
/**
63+
* Used to call your own function when the device is successfully initialized.
64+
* @param funcOnInit Function to call.
65+
*/
66+
void attachOnInit(void (*funcOnInit)(void)) {
67+
pFuncOnInit = funcOnInit;
68+
};
69+
70+
/** @name PS Buzzer Controller functions */
71+
/**
72+
* getButtonPress(ButtonEnum b) will return true as long as the button is held down.
73+
*
74+
* While getButtonClick(ButtonEnum b) will only return it once.
75+
*
76+
* So you instance if you need to increase a variable once you would use getButtonClick(ButtonEnum b),
77+
* but if you need to drive a robot forward you would use getButtonPress(ButtonEnum b).
78+
* @param b ::ButtonEnum to read.
79+
* @param controller The controller to read from. Default to 0.
80+
* @return 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.
81+
*/
82+
bool getButtonPress(ButtonEnum b, uint8_t controller = 0);
83+
bool getButtonClick(ButtonEnum b, uint8_t controller = 0);
84+
/**@}*/
85+
/** @name PS Buzzer Controller functions */
86+
/**
87+
* Set LED value without using ::LEDEnum.
88+
* @param value See: ::LEDEnum.
89+
*/
90+
/**
91+
* Set LED values directly.
92+
* @param value Used to set whenever the LED should be on or off
93+
* @param controller The controller to control. Defaults to 0.
94+
*/
95+
void setLedRaw(bool value, uint8_t controller = 0);
96+
97+
/** Turn all LEDs off. */
98+
void setLedOffAll() {
99+
for (uint8_t i = 1; i < 4; i++) // Skip first as it will be set in setLedRaw
100+
ledState[i] = false; // Just an easy way to set all four off at the same time
101+
setLedRaw(false); // Turn the LED off, on all four controllers
102+
};
103+
104+
/**
105+
* Turn the LED off on a specific controller.
106+
* @param controller The controller to turn off. Defaults to 0.
107+
*/
108+
void setLedOff(uint8_t controller = 0) {
109+
setLedRaw(false, controller);
110+
};
111+
112+
113+
/** Turn all LEDs on. */
114+
void setLedOnAll() {
115+
for (uint8_t i = 1; i < 4; i++) // Skip first as it will be set in setLedRaw
116+
ledState[i] = true; // Just an easy way to set all four off at the same time
117+
setLedRaw(true); // Turn the LED on, on all four controllers
118+
};
119+
120+
/**
121+
* Turn the LED on on a specific controller.
122+
* @param controller The controller to turn off. Defaults to 0.
123+
*/
124+
void setLedOn(uint8_t controller = 0) {
125+
setLedRaw(true, controller);
126+
};
127+
128+
/**
129+
* Toggle the LED on a specific controller.
130+
* @param controller The controller to turn off. Defaults to 0.
131+
*/
132+
void setLedToggle(uint8_t controller = 0) {
133+
setLedRaw(!ledState[controller], controller);
134+
};
135+
/**@}*/
136+
137+
protected:
138+
/** @name HIDUniversal implementation */
139+
/**
140+
* Used to parse USB HID data.
141+
* @param hid Pointer to the HID class.
142+
* @param is_rpt_id Only used for Hubs.
143+
* @param len The length of the incoming data.
144+
* @param buf Pointer to the data buffer.
145+
*/
146+
virtual void ParseHIDData(HID *hid, bool is_rpt_id, uint8_t len, uint8_t *buf);
147+
148+
/**
149+
* Called when a device is successfully initialized.
150+
* Use attachOnInit(void (*funcOnInit)(void)) to call your own function.
151+
* This is useful for instance if you want to set the LEDs in a specific way.
152+
*/
153+
virtual uint8_t OnInitSuccessful();
154+
/**@}*/
155+
156+
/** Used to reset the different buffers to their default values */
157+
void Reset() {
158+
psbuzzButtons.val = 0;
159+
oldButtonState.val = 0;
160+
buttonClickState.val = 0;
161+
for (uint8_t i = 0; i < sizeof(ledState); i++)
162+
ledState[i] = 0;
163+
};
164+
165+
/** @name USBDeviceConfig implementation */
166+
/**
167+
* Used by the USB core to check what this driver support.
168+
* @param vid The device's VID.
169+
* @param pid The device's PID.
170+
* @return Returns true if the device's VID and PID matches this driver.
171+
*/
172+
virtual boolean VIDPIDOK(uint16_t vid, uint16_t pid) {
173+
return (vid == PSBUZZ_VID && pid == PSBUZZ_PID);
174+
};
175+
/**@}*/
176+
177+
private:
178+
void (*pFuncOnInit)(void); // Pointer to function called in onInit()
179+
180+
void PSBuzz_Command(uint8_t *data, uint16_t nbytes);
181+
182+
PSBUZZButtons psbuzzButtons, oldButtonState, buttonClickState;
183+
bool ledState[4];
184+
};
185+
#endif

‎README.md‎

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ For more information about the hardware see the [Hardware Manual](http://www.cir
2222
* __Alexei Glushchenko, Circuits@Home__ - <alex-gl@mail.ru>
2323
* Developers of the USB Core, HID, FTDI, ADK, ACM, and PL2303 libraries
2424
* __Kristian Lauszus, TKJ Electronics__ - <kristianl@tkjelectronics.com>
25-
* Developer of the [BTD](#bluetooth-libraries), [BTHID](#bthid-library), [SPP](#spp-library), [PS4](#ps4-library), [PS3](#ps3-library), [Wii](#wii-library), and [Xbox](#xbox-library) libraries
25+
* Developer of the [BTD](#bluetooth-libraries), [BTHID](#bthid-library), [SPP](#spp-library), [PS4](#ps4-library), [PS3](#ps3-library), [Wii](#wii-library), [Xbox](#xbox-library), and [PSBuzz](#ps-buzz-library) libraries
2626
* __Andrew Kroll__ - <xxxajk@gmail.com>
2727
* Major contributor to mass storage code
2828

@@ -240,6 +240,17 @@ All the information about the Wii controllers are from these sites:
240240
* <http://wiibrew.org/wiki/Wiimote/Extension_Controllers/Wii_Motion_Plus>
241241
* The old library created by _Tomoyuki Tanaka_: <https://github.com/moyuchin/WiiRemote_on_Arduino> also helped a lot.
242242
243+
### [PS Buzz Library](PSBuzz.cpp)
244+
245+
This library implements support for the Playstation Buzz controllers via USB.
246+
247+
It is essentially just a wrapper around the [HIDUniversal](hiduniversal.cpp) which takes care of the initializing and reading of the controllers. The [PSBuzz](PSBuzz.cpp) class simply inherits this and parses the data, so it is easy for users to read the buttons and turn the big red button on the controllers on and off.
248+
249+
More information about the controller can be found at the following sites:
250+
251+
* http://www.developerfusion.com/article/84338/making-usb-c-friendly/
252+
* https://github.com/torvalds/linux/blob/master/drivers/hid/hid-sony.c
253+
243254
# FAQ
244255
245256
> When I plug my device into the USB connector nothing happens?

‎controllerEnums.h‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,14 @@ enum ButtonEnum {
137137
BLACK = 8, // Available on the original Xbox controller
138138
WHITE = 9, // Available on the original Xbox controller
139139
/**@}*/
140+
141+
/** PS Buzz controllers */
142+
RED = 0,
143+
YELLOW = 1,
144+
GREEN = 2,
145+
ORANGE = 3,
146+
BLUE = 4,
147+
/**@}*/
140148
};
141149

142150
/** Joysticks on the PS3 and Xbox controllers. */

‎examples/PSBuzz/PSBuzz.ino‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
/*
2+
Example sketch for the Playstation Buzz library - developed by Kristian Lauszus
3+
For more information visit my blog: http://blog.tkjelectronics.dk/ or
4+
send me an e-mail: kristianl@tkjelectronics.com
5+
*/
6+
7+
#include <PSBuzz.h>
8+
9+
// Satisfy IDE, which only needs to see the include statment in the ino.
10+
#ifdef dobogusinclude
11+
#include <spi4teensy3.h>
12+
#endif
13+
14+
USB Usb;
15+
PSBuzz Buzz(&Usb);
16+
17+
void setup() {
18+
Serial.begin(115200);
19+
while (!Serial); // Wait for serial port to connect - used on Leonardo, Teensy and other boards with built-in USB CDC serial connection
20+
if (Usb.Init() == -1) {
21+
Serial.print(F("\r\nOSC did not start"));
22+
while (1); // Halt
23+
}
24+
Serial.println(F("\r\nPS Buzz Library Started"));
25+
}
26+
27+
void loop() {
28+
Usb.Task();
29+
30+
if (Buzz.connected()) {
31+
for (uint8_t i = 0; i < 4; i++) {
32+
if (Buzz.getButtonClick(RED, i)) {
33+
Buzz.setLedToggle(i); // Toggle the LED
34+
Serial.println(F("RED"));
35+
}
36+
if (Buzz.getButtonClick(YELLOW, i))
37+
Serial.println(F("YELLOW"));
38+
if (Buzz.getButtonClick(GREEN, i))
39+
Serial.println(F("GREEN"));
40+
if (Buzz.getButtonClick(ORANGE, i))
41+
Serial.println(F("ORANGE"));
42+
if (Buzz.getButtonClick(BLUE, i))
43+
Serial.println(F("BLUE"));
44+
}
45+
}
46+
}

0 commit comments

Comments
 (0)