Introduction

CircuitPython library to read Sony PS2 or PS1 (“PSX”) game controllers

Dependencies

This driver depends on:

• Adafruit CircuitPython

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle or individual libraries can be installed using circup.

Installing from PyPI

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:

pip3 install circuitpython-ps2controller

To install system-wide (this may be required in some cases):

sudo pip3 install circuitpython-ps2controller

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .venv
source .env/bin/activate
pip3 install circuitpython-ps2controller

Installing to a Connected CircuitPython Device with Circup

Make sure that you have circup installed in your Python environment. Install it with the following command if necessary:

pip3 install circup

With circup installed and your CircuitPython device connected use the following command to install:

circup install ps2controller

Or the following command to update an existing version:

circup update

Usage Example

import board
from ps2controller import PS2Controller

# one way to wire this up, for example on a Pico
ps2 = PS2Controller(dat=board.GP2, cmd=board.GP3, att=board.GP4, clk=board.GP5)

print("hi! Press buttons")
while True:
    events = ps2.update()
    if events:
        print("events", events)
        print("sticks: L:", ps2.analog_left(), "R:", ps2.analog_right())

Wiring

Wiring to the PSX controller needs four GPIO pins.These can be any pins. The wiring is:

• CLK pin - clock OUT to controller (blue wire)

• CMD pin - command data OUT to controller (orange wire)

• ATT pin - attention / chip select OUT to controller (yellow wire)

• DAT pin - data IN from controller (brown wire)

• GND pin - signal ground (black wire)

• VCC pin - +3.3V power (red wire)

• VCC2 pin - +7.5V power to rumble motors (optional)

Here’s one way to wire that up on a Raspberry Pi Pico:

(Thanks to Vanepp via nandanhere/PiPyPS2 for Fritzing wiring diagram)

References

This library is highly inspired by the SukkoPera/PsxNewLib library. It currently has only been tested on a handful of PS1 and PS2 controllers, but it should be easy to add any specialized controller tuning.

Other resources that have been helpful:

• https://store.curiousinventor.com/guides/PS2/

• https://gist.github.com/scanlime/5042071

• https://gamesx.com/wiki/doku.php?id=controls:playstation_controller

• https://github.com/SukkoPera/PsxNewLib

• https://github.com/nandanhere/PiPyPS2

• https://github.com/veroxzik/arduino-psx-controller

• https://github.com/madsci1016/Arduino-PS2X

Documentation

API documentation for this library can be found on Read the Docs.

For information on building library documentation, please check out this guide.

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.