circuitpython-usb-host-gamepad 1.2.5__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,117 @@
1
+ Metadata-Version: 2.4
2
+ Name: circuitpython-usb-host-gamepad
3
+ Version: 1.2.5
4
+ Summary: CircuitPython USB host driver for game controller devices.
5
+ Author-email: Cooper Dalrymple <me@dcdalrymple.com>
6
+ License: MIT
7
+ Project-URL: Homepage, https://github.com/relic-se/CircuitPython_USB_Host_Gamepad
8
+ 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
9
+ Classifier: Intended Audience :: Developers
10
+ Classifier: Topic :: Software Development :: Libraries
11
+ Classifier: Topic :: Software Development :: Embedded Systems
12
+ Classifier: Topic :: System :: Hardware
13
+ Classifier: License :: OSI Approved :: MIT License
14
+ Classifier: Programming Language :: Python :: 3
15
+ Description-Content-Type: text/x-rst
16
+ License-File: LICENSE
17
+ Requires-Dist: Adafruit-Blinka
18
+ Provides-Extra: optional
19
+ Dynamic: license-file
20
+
21
+ Introduction
22
+ ============
23
+
24
+
25
+ .. image:: https://readthedocs.org/projects/circuitpython-usb-host-gamepad/badge/?version=latest
26
+ :target: https://circuitpython-usb-host-gamepad.readthedocs.io/
27
+ :alt: Documentation Status
28
+
29
+
30
+ .. image:: https://img.shields.io/discord/327254708534116352.svg
31
+ :target: https://adafru.it/discord
32
+ :alt: Discord
33
+
34
+
35
+ .. image:: https://github.com/relic-se/CircuitPython_USB_Host_Gamepad/workflows/Build%20CI/badge.svg
36
+ :target: https://github.com/relic-se/CircuitPython_USB_Host_Gamepad/actions
37
+ :alt: Build Status
38
+
39
+
40
+ .. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
41
+ :target: https://github.com/astral-sh/ruff
42
+ :alt: Code Style: Ruff
43
+
44
+ CircuitPython USB host driver for game controller devices.
45
+
46
+ Supports the following devices:
47
+
48
+ * Generix XInput Controllers
49
+ * Switch Pro Controller (Wired)
50
+ * `Adafruit SNES Controller <https://www.adafruit.com/product/6285>`_
51
+ * 8BitDo Zero 2 (Wired)
52
+ * PowerA Wired Controller
53
+ * Sony PlayStation DUALSHOCK 4 Controller (Wired)
54
+ * Some HID-compliant Joysticks
55
+ * Microsoft SideWinder Force Feedback 2
56
+
57
+
58
+ Dependencies
59
+ =============
60
+ This driver depends on:
61
+
62
+ * `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
63
+
64
+ Please ensure all dependencies are available on the CircuitPython filesystem.
65
+ This is easily achieved by downloading
66
+ `the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_
67
+ or individual libraries can be installed using
68
+ `circup <https://github.com/adafruit/circup>`_.
69
+
70
+ Installing to a Connected CircuitPython Device with Circup
71
+ ==========================================================
72
+
73
+ Make sure that you have ``circup`` installed in your Python environment.
74
+ Install it with the following command if necessary:
75
+
76
+ .. code-block:: shell
77
+
78
+ pip3 install circup
79
+
80
+ With ``circup`` installed and your CircuitPython device connected use the
81
+ following command to install:
82
+
83
+ .. code-block:: shell
84
+
85
+ circup install relic_usb_host_gamepad
86
+
87
+ Or the following command to update an existing version:
88
+
89
+ .. code-block:: shell
90
+
91
+ circup update
92
+
93
+ Usage Example
94
+ =============
95
+
96
+ .. code-block:: python
97
+
98
+ import relic_usb_host_gamepad
99
+ gamepad = relic_usb_host_gamepad.Gamepad()
100
+ while True:
101
+ if gamepad.update():
102
+ for event in gamepad.events:
103
+ print(event)
104
+
105
+ Documentation
106
+ =============
107
+ API documentation for this library can be found on `Read the Docs <https://circuitpython-usb-host-gamepad.readthedocs.io/>`_.
108
+
109
+ For information on building library documentation, please check out
110
+ `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.
111
+
112
+ Contributing
113
+ ============
114
+
115
+ Contributions are welcome! Please read our `Code of Conduct
116
+ <https://github.com/relic-se/CircuitPython_USB_Host_Gamepad/blob/HEAD/CODE_OF_CONDUCT.md>`_
117
+ before contributing to help this project stay welcoming.
@@ -0,0 +1,6 @@
1
+ relic_usb_host_gamepad.py,sha256=yzOiaRyMF5MxuHDiOZFhY8MnEqHLLsBhgiSoQRFsplE,48220
2
+ circuitpython_usb_host_gamepad-1.2.5.dist-info/licenses/LICENSE,sha256=LwDPpZXBmCqBaXJMRoiiTkKWmTEoAutba-hXPytsnLQ,1083
3
+ circuitpython_usb_host_gamepad-1.2.5.dist-info/METADATA,sha256=YdG54sTngOsmTRE9v4RqkF-UsVgu4Y4w8ycNtMwZ52Y,3891
4
+ circuitpython_usb_host_gamepad-1.2.5.dist-info/WHEEL,sha256=YCfwYGOYMi5Jhw2fU4yNgwErybb2IX5PEwBKV4ZbdBo,91
5
+ circuitpython_usb_host_gamepad-1.2.5.dist-info/top_level.txt,sha256=x74ZZmOk4grttibhJ02pGW8dm0VR9sl3GBGOqaMYj4M,23
6
+ circuitpython_usb_host_gamepad-1.2.5.dist-info/RECORD,,
@@ -0,0 +1,5 @@
1
+ Wheel-Version: 1.0
2
+ Generator: setuptools (82.0.0)
3
+ Root-Is-Purelib: true
4
+ Tag: py3-none-any
5
+
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2025 Cooper Dalrymple
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1 @@
1
+ relic_usb_host_gamepad