127 lines
7.6 KiB
Markdown
127 lines
7.6 KiB
Markdown
[](https://www.paypal.com/donate?hosted_button_id=WT735CX4UMZ9U)
|
|
|
|
# Ultimate Pop'n Controller
|
|
|
|
USB HID controller with 17 inputs (9 buttons, coin, test, reset, service), 20 outputs (18 lights, coin blocker, coin counter), 12-key matrix numpad, high polling rate, custom dll for full cabinet compatibility, and nice programmable features.
|
|
|
|
The goal was to replace the official IO Board from my pop'n cabinet with a DIY controller instead, for stability reasons (Konami IO boards are prone to failure, most Pop'n Music cabinets in the wild have broken lamps...) but also for QoL improvements (this allows me to use my panel system-wide and not only in-game, which means I can control a multiboot menu, play with emulators etc..).
|
|
|
|
In combination with the PN5180-cardio project, the whole IO from a Pop'n Music cabinet can be replaced pretty cheaply :)
|
|
|
|
# Leonardo version
|
|
|
|
Because I loved the ModeSwitch feature, I adapted the code so it could compile for Leonardo as well. Due to lack of gpio, in this case there's only 11 buttons and 9 lights, no keypad support, and reactive mode won't include AC light simulation (there's no side or top lamps, duh).
|
|
|
|
I'm also taking advantage of the Leonardo EEPROM. On manually switching, the resulting lightmode is stored in the EEPROM so that it persists on controller disconnect/reconnect.
|
|
|
|
# Demo
|
|
|
|
https://www.instagram.com/p/CKE9HCQFCYM/
|
|
|
|
https://www.instagram.com/p/CBWgSMklvvT/
|
|
|
|
# Acknowledgments
|
|
|
|
Other pop'n controller codes like Knuckleslee's https://github.com/knuckleslee/RhythmCodes/ or 4yn's https://github.com/4yn/iivx/tree/master/leoo/leoo are widely popular.
|
|
|
|
They are usually based on mon's https://github.com/mon/Arduino-HID-Lighting which is based on NicoHood's https://github.com/NicoHood/HID/blob/master/src/SingleReport/RawHID.cpp
|
|
|
|
As I needed more gpio than usual, this project was my first time working with Arduino Due and unfortunately the USB HID definitions are not compatible with Leonardo code so a lot of changes had to be made.
|
|
|
|
The keypad code uses the Keypad library by Mark Stanley and Alexander Brevig.
|
|
|
|
Switch debouncing is done with Bounce2 library by Thomas O Fredericks.
|
|
|
|
PSX Controller code is based on busslave's PSX_RECEIVER.cpp, with PS1 compatibility fixes by [veroxzik](https://github.com/veroxzik)
|
|
|
|
# Supported devices and requirements
|
|
|
|
This code was designed for Arduino Due. It will compile for Leonardo as well but some features are stripped due to lack of gpio (only 11 buttons and 9 lights, no keypad, lower polling rate).
|
|
Code is updated automatically depending on the selected target board, no changes are needed.
|
|
|
|
The controller code requires the Bounce2 library by Thomas O Fredericks. It can be installed from the Arduino IDE Library manager.
|
|
|
|
The keypad code requires the Keypad library by Mark Stanley and Alexander Brevig. It can be installed from the Arduino IDE Library manager.
|
|
|
|
# Features
|
|
|
|
## Playstation Controller (Leonardo only, Due coming soon)
|
|
|
|
This controller can be used as a playstation controller for Pop'n Music CS versions.
|
|
|
|
Note that this requires a couple hardware mods in order to work as we are using two extra pins (SS and ACK, on the RX and TX leds aka PB0 and PD5) which are not readily available on the pre-soldered headers.
|
|
|
|
Of course you'll need either a dualshock breakout board or a dualshock extension cable for it to work.
|
|
|
|
Refer to the pinout to know how to wire the controller plug to the arduino.
|
|
|
|
**Note:** This is PoC code, I'll try to port a more complete dualshock implementation soon and make it Due compatible as well
|
|
|
|
## I/O
|
|
|
|
This controller has 13 buttons (9 buttons + coin + service + reset + test), 4 dip-switches (only DIP4 is used in cabinets to select between 15 or 31kHz monitor resolution on boot), 8 lights (9 buttons + 5 top neon + 4 side pillar), 2 coin outputs (coin blocker, coin counter).
|
|
|
|
It also has 7 pins for the 12-key numpad, following the original cabinet pinout. It is recognized as a separate keyboard, and it is mapped to the keyboard toprow rather than the numpad (due to lack of stability when sending the numlock command to the BemaniPC).
|
|
|
|
The 00 key is mapped to comma (for direct compatibility with spicetools) and the originally unused bottom right key is mapped to the default card scan key.
|
|
|
|
It also has a cool light animation on boot which you can easily adapt to your liking :)
|
|
|
|
## ezusb driver
|
|
|
|
The I/O is HID so it can be mapped with the usual IO emulation tools, but it can also be used without emulation, just like an official IOBoard, provided you replace the original `ezusb.dll` file with the one from this repo.
|
|
|
|
This way the firmware is fully compatible with anything that works on an official cabinet (PopnForwarder (a bit silly but why not :D), DJMame, ezPSXe pad plugin...)
|
|
|
|
## Light modes
|
|
|
|
There are 5 different modes :
|
|
|
|
### Reactive mode
|
|
|
|
This mode roughly simulates AC lighting and was meant to be used for emulators or other games with no HID light support.
|
|
|
|
Pressing a button will trigger blinking lights from the side pillars, blue most of the time, red with 1/7 probability, and purple with 1/20 probability.
|
|
|
|
The top neons follow a fill-empty pattern whose speed is dynamically adjusted with the rate at which you press buttons (might need more work tweaking values, but looks good enough already).
|
|
|
|
### HID mode
|
|
|
|
This is the original IO board mode where only messages from the game can control the lamps.
|
|
|
|
### Mixed mode (default mode)
|
|
|
|
This mode behaves like HID mode as soon as messages are received. If 3 seconds elapse without any received message, the firmware switches to reactive behavior (and will switch back to HID as soon as new HID messages are received).
|
|
|
|
### Combined mode
|
|
|
|
This combines the HID messages with button presses for instant lighting (you don't have to wait for the game to register the input and send a message back to light the lamp, and as a bonus it also allows you to play with the lights while the cabinet is booting ;) ).
|
|
|
|
### Invert mode
|
|
|
|
This is like the Mixed mode except ON and OFF states are switched around just for the fun of it. Might be even more fun to use with colored leds and nothing but white buttons.
|
|
|
|
## Switching lightmodes
|
|
|
|
You can either press button 2 (left yellow button) while holding service to switch between modes, or you can request a mode change with an HID message, which is incredibly useful in a multiboot environment as you can set the proper lightmode from the commandline before launching a game.
|
|
|
|
I included pre-compiled binaries and sources in the "ModeSwitch" folder. Refer to readme.md inside that folder for more details.
|
|
|
|
# Pinout (Leonardo)
|
|
|
|
Arduino Leonardo has 5V logic therefore one can directly connect 5V leds to it.
|
|
|
|
|
|
|
|
For ACK (TXLED aka PD5) and SS (RXLED aka PB0) you have to solder new headers or cables directly on the leonardo PCB. For the PSX controller function to work properly you need to short SS to ground (leonardo doesn't work well as SPI slave otherwise, which is why we cannot use the "attention" line from the controller cable unfortunately).
|
|
|
|
## Donation
|
|
|
|
If this project helps you and you want to give back, you can help me with my future projects.
|
|
|
|
While not necessary, donations are much appreciated and will only go towards funding future github projects (arcade hardware ain't cheap :( ).
|
|
|
|
Of course you'll also receive my gratitude and I'll remember you if you post a feature request ;)
|
|
|
|
[](https://www.paypal.com/donate?hosted_button_id=WT735CX4UMZ9U)
|