Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: adafruit/Adafruit_CircuitPython_HID
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: 6.1.3
Choose a base ref
...
head repository: adafruit/Adafruit_CircuitPython_HID
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: main
Choose a head ref
  • 3 commits
  • 3 files changed
  • 3 contributors

Commits on Dec 18, 2024

  1. Copy the full SHA
    ed85927 View commit details

Commits on Dec 19, 2024

  1. Merge pull request #131 from dhalbert/missing-doc

    Add inadvertently omitted __init__.py docs, and fix indentation
    tannewt authored Dec 19, 2024
    Copy the full SHA
    5f71daf View commit details

Commits on Jan 16, 2025

  1. add sphinx configuration to rtd.yaml

    Signed-off-by: foamyguy <foamyguy@gmail.com>
    FoamyGuy committed Jan 16, 2025
    Copy the full SHA
    d26db69 View commit details
Showing with 11 additions and 9 deletions.
  1. +3 −0 .readthedocs.yaml
  2. +5 −9 adafruit_hid/__init__.py
  3. +3 −0 docs/api.rst
3 changes: 3 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -8,6 +8,9 @@
# Required
version: 2

sphinx:
configuration: docs/conf.py

build:
os: ubuntu-20.04
tools:
14 changes: 5 additions & 9 deletions adafruit_hid/__init__.py
Original file line number Diff line number Diff line change
@@ -9,12 +9,6 @@
This driver simulates USB HID devices.
* Author(s): Scott Shawcroft, Dan Halbert
Implementation Notes
--------------------
**Software and Dependencies:**
* Adafruit CircuitPython firmware for the supported boards:
https://github.com/adafruit/circuitpython/releases
"""

# imports
@@ -48,12 +42,14 @@ def find_device(
usage: int,
timeout: int = None,
) -> object:
"""Search through the provided sequence of devices to find the one with the matching
"""
Search through the provided sequence of devices to find the one with the matching
usage_page and usage.
:param timeout: Time in seconds to wait for USB to become ready before timing out.
Defaults to None to wait indefinitely.
Ignored if device is not a `usb_hid.Device`; it might be BLE, for instance."""
Defaults to None to wait indefinitely.
Ignored if device is not a `usb_hid.Device`; it might be BLE, for instance.
"""

if hasattr(devices, "send_report"):
devices = [devices] # type: ignore
3 changes: 3 additions & 0 deletions docs/api.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@

.. If you created a package, create one automodule per module in the package.
.. automodule:: adafruit_hid
:members:

.. automodule:: adafruit_hid.keyboard
:members: