circuitpython-usb-host-gamepad 1.3.0
CircuitPython USB host driver for game controller devices.
License: MIT
Keywords: adafruit, blinka, circuitpython, micropython, relic_usb_host_gamepad, usb_host_gamepad, circuitpython, relic-usb-host-gamepad, usb-host-gamepad, usb-host, usb, gamepad, controller, game, relic

Introduction
============


.. image:: https://readthedocs.org/projects/circuitpython-usb-host-gamepad/badge/?version=latest
    :target: https://circuitpython-usb-host-gamepad.readthedocs.io/
    :alt: Documentation Status


.. image:: https://img.shields.io/discord/327254708534116352.svg
    :target: https://adafru.it/discord
    :alt: Discord


.. image:: https://github.com/relic-se/CircuitPython_USB_Host_Gamepad/workflows/Build%20CI/badge.svg
    :target: https://github.com/relic-se/CircuitPython_USB_Host_Gamepad/actions
    :alt: Build Status


.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
    :target: https://github.com/astral-sh/ruff
    :alt: Code Style: Ruff

CircuitPython USB host driver for game controller devices.

Supports the following devices:

* Generix XInput Controllers
* Switch Pro Controller (Wired)
* `Adafruit SNES Controller <https://www.adafruit.com/product/6285>`_
* 8BitDo Zero 2 (Wired)
* PowerA Wired Controller
* Sony PlayStation DUALSHOCK 4 Controller (Wired)
* Some HID-compliant Joysticks
    * Microsoft SideWinder Force Feedback 2
* Supported pygame joystick devices (for use with `Blinka <github.com/FoamyGuy/Blinka_Displayio_PyGameDisplay>`_)


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-usb-host-descriptor-parser/>`_.
To install for current user:

.. code-block:: shell

    pip3 install circuitpython-usb-host-gamepad

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

.. code-block:: shell

    sudo pip3 install circuitpython-usb-host-gamepad

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-usb-host-gamepad

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 relic_usb_host_gamepad

Or the following command to update an existing version:

.. code-block:: shell

    circup update

Usage Example
=============

.. code-block:: python

    import relic_usb_host_gamepad
    gamepad = relic_usb_host_gamepad.Gamepad()
    while True:
        if gamepad.update():
            for event in gamepad.events:
                print(event)

Documentation
=============
API documentation for this library can be found on `Read the Docs <https://circuitpython-usb-host-gamepad.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/relic-se/CircuitPython_USB_Host_Gamepad/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.