Introduction
============
.. image:: https://readthedocs.org/projects/circuitpython-ps2controller/badge/?version=latest
:target: https://circuitpython-ps2controller.readthedocs.io/
:alt: Documentation Status
.. image:: https://img.shields.io/discord/327254708534116352.svg
:target: https://adafru.it/discord
:alt: Discord
.. image:: https://github.com/todbot/CircuitPython_PS2Controller/workflows/Build%20CI/badge.svg
:target: https://github.com/todbot/CircuitPython_PS2Controller/actions
:alt: Build Status
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: Code Style: Black
CircuitPython library to read Sony PS2 or PS1 ("PSX") game controllers
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_
or individual libraries can be installed using
`circup <https://github.com/adafruit/circup>`_.
Installing from PyPI
=====================
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/circuitpython-ps2controller/>`_.
To install for current user:
.. code-block:: shell
pip3 install circuitpython-ps2controller
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install circuitpython-ps2controller
To install in a virtual environment in your current project:
.. code-block:: shell
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:
.. code-block:: shell
pip3 install circup
With ``circup`` installed and your CircuitPython device connected use the
following command to install:
.. code-block:: shell
circup install ps2controller
Or the following command to update an existing version:
.. code-block:: shell
circup update
Usage Example
=============
.. code-block:: python
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:
.. image:: https://raw.githubusercontent.com/todbot/CircuitPython_PS2Controller/main/docs/ps2controller_wiring.png
(Thanks to `Vanepp <https://forum.fritzing.org/u/vanepp/summary>`_ via `nandanhere/PiPyPS2 <https://github.com/nandanhere/PiPyPS2>`_ for Fritzing wiring diagram)
References
==========
This library is highly inspired by the `SukkoPera/PsxNewLib <https://github.com/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 <https://circuitpython-ps2controller.readthedocs.io/>`_.
For information on building library documentation, please check out
`this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.
Contributing
============
Contributions are welcome! Please read our `Code of Conduct
<https://github.com/todbot/CircuitPython_PS2Controller/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": "",
"name": "circuitpython-ps2controller",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,blinka,circuitpython,micropython,ps2controller,ps2,psx,controller,gamepad,sony,dualshock",
"author": "",
"author_email": "Tod Kurt <tod@todbot.com>",
"download_url": "https://files.pythonhosted.org/packages/cd/06/35adee1672cd16afdcc4aca97d7403ceb4dd9a5f7d30df16735935094093/circuitpython-ps2controller-1.2.2.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/circuitpython-ps2controller/badge/?version=latest\n :target: https://circuitpython-ps2controller.readthedocs.io/\n :alt: Documentation Status\n\n.. image:: https://img.shields.io/discord/327254708534116352.svg\n :target: https://adafru.it/discord\n :alt: Discord\n\n.. image:: https://github.com/todbot/CircuitPython_PS2Controller/workflows/Build%20CI/badge.svg\n :target: https://github.com/todbot/CircuitPython_PS2Controller/actions\n :alt: Build Status\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Code Style: Black\n\nCircuitPython library to read Sony PS2 or PS1 (\"PSX\") game controllers\n\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_\nor individual libraries can be installed using\n`circup <https://github.com/adafruit/circup>`_.\n\nInstalling from PyPI\n=====================\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/circuitpython-ps2controller/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n pip3 install circuitpython-ps2controller\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install circuitpython-ps2controller\n\nTo install in a virtual environment in your current project:\n\n.. code-block:: shell\n\n mkdir project-name && cd project-name\n python3 -m venv .venv\n source .env/bin/activate\n pip3 install circuitpython-ps2controller\n\nInstalling to a Connected CircuitPython Device with Circup\n==========================================================\n\nMake sure that you have ``circup`` installed in your Python environment.\nInstall it with the following command if necessary:\n\n.. code-block:: shell\n\n pip3 install circup\n\nWith ``circup`` installed and your CircuitPython device connected use the\nfollowing command to install:\n\n.. code-block:: shell\n\n circup install ps2controller\n\nOr the following command to update an existing version:\n\n.. code-block:: shell\n\n circup update\n\nUsage Example\n=============\n\n.. code-block:: python\n\n import board\n from ps2controller import PS2Controller\n\n # one way to wire this up, for example on a Pico\n ps2 = PS2Controller(dat=board.GP2, cmd=board.GP3, att=board.GP4, clk=board.GP5)\n\n print(\"hi! Press buttons\")\n while True:\n events = ps2.update()\n if events:\n print(\"events\", events)\n print(\"sticks: L:\", ps2.analog_left(), \"R:\", ps2.analog_right())\n\nWiring\n======\n\nWiring to the PSX controller needs four GPIO pins.These can be any pins.\nThe wiring is:\n\n* CLK pin - clock OUT to controller (blue wire)\n* CMD pin - command data OUT to controller (orange wire)\n* ATT pin - attention / chip select OUT to controller (yellow wire)\n* DAT pin - data IN from controller (brown wire)\n* GND pin - signal ground (black wire)\n* VCC pin - +3.3V power (red wire)\n* VCC2 pin - +7.5V power to rumble motors (optional)\n\nHere's one way to wire that up on a Raspberry Pi Pico:\n\n.. image:: https://raw.githubusercontent.com/todbot/CircuitPython_PS2Controller/main/docs/ps2controller_wiring.png\n\n(Thanks to `Vanepp <https://forum.fritzing.org/u/vanepp/summary>`_ via `nandanhere/PiPyPS2 <https://github.com/nandanhere/PiPyPS2>`_ for Fritzing wiring diagram)\n\n\nReferences\n==========\n\nThis library is highly inspired by the `SukkoPera/PsxNewLib <https://github.com/SukkoPera/PsxNewLib>`_ library.\nIt currently has only been tested on a handful of PS1 and PS2 controllers,\nbut it should be easy to add any specialized controller tuning.\n\nOther resources that have been helpful:\n\n* https://store.curiousinventor.com/guides/PS2/\n* https://gist.github.com/scanlime/5042071\n* https://gamesx.com/wiki/doku.php?id=controls:playstation_controller\n* https://github.com/SukkoPera/PsxNewLib\n* https://github.com/nandanhere/PiPyPS2\n* https://github.com/veroxzik/arduino-psx-controller\n* https://github.com/madsci1016/Arduino-PS2X\n\nDocumentation\n=============\nAPI documentation for this library can be found on `Read the Docs <https://circuitpython-ps2controller.readthedocs.io/>`_.\n\nFor information on building library documentation, please check out\n`this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/todbot/CircuitPython_PS2Controller/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython library to read Sony PS2 game controllers",
"version": "1.2.2",
"project_urls": {
"Homepage": "https://github.com/todbot/CircuitPython_PS2Controller"
},
"split_keywords": [
"adafruit",
"blinka",
"circuitpython",
"micropython",
"ps2controller",
"ps2",
"psx",
"controller",
"gamepad",
"sony",
"dualshock"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3ac688eb72ad24714e0a1ce3921e439dc7b31789b2101403af077f685bfa50af",
"md5": "fc413957f3409474830e47189912cb4c",
"sha256": "fecb94fe00a7101c231faa7d1beded6f4af5b8e8ff5f597ffe262b4f9b50f774"
},
"downloads": -1,
"filename": "circuitpython_ps2controller-1.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fc413957f3409474830e47189912cb4c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 8538,
"upload_time": "2023-10-11T17:30:52",
"upload_time_iso_8601": "2023-10-11T17:30:52.962430Z",
"url": "https://files.pythonhosted.org/packages/3a/c6/88eb72ad24714e0a1ce3921e439dc7b31789b2101403af077f685bfa50af/circuitpython_ps2controller-1.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cd0635adee1672cd16afdcc4aca97d7403ceb4dd9a5f7d30df16735935094093",
"md5": "967763c9e0849cef7e13e44fb2f33ddc",
"sha256": "1f93f013852da3547a98a8095f245cb25f52eee9f437f67fd2783d5a7d8a9da1"
},
"downloads": -1,
"filename": "circuitpython-ps2controller-1.2.2.tar.gz",
"has_sig": false,
"md5_digest": "967763c9e0849cef7e13e44fb2f33ddc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 90133,
"upload_time": "2023-10-11T17:30:54",
"upload_time_iso_8601": "2023-10-11T17:30:54.253224Z",
"url": "https://files.pythonhosted.org/packages/cd/06/35adee1672cd16afdcc4aca97d7403ceb4dd9a5f7d30df16735935094093/circuitpython-ps2controller-1.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-11 17:30:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "todbot",
"github_project": "CircuitPython_PS2Controller",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "circuitpython-ps2controller"
}
JSON
