aboutsummaryrefslogtreecommitdiff
path: root/circuitpython/frozen/Adafruit_CircuitPython_HID/docs/examples.rst
diff options
context:
space:
mode:
authorRaghuram Subramani <raghus2247@gmail.com>2022-06-19 19:47:51 +0530
committerRaghuram Subramani <raghus2247@gmail.com>2022-06-19 19:47:51 +0530
commit4fd287655a72b9aea14cdac715ad5b90ed082ed2 (patch)
tree65d393bc0e699dd12d05b29ba568e04cea666207 /circuitpython/frozen/Adafruit_CircuitPython_HID/docs/examples.rst
parent0150f70ce9c39e9e6dd878766c0620c85e47bed0 (diff)
add circuitpython code
Diffstat (limited to '')
-rw-r--r--circuitpython/frozen/Adafruit_CircuitPython_HID/docs/examples.rst44
-rw-r--r--circuitpython/frozen/Adafruit_CircuitPython_HID/docs/examples.rst.license3
2 files changed, 47 insertions, 0 deletions
diff --git a/circuitpython/frozen/Adafruit_CircuitPython_HID/docs/examples.rst b/circuitpython/frozen/Adafruit_CircuitPython_HID/docs/examples.rst
new file mode 100644
index 0000000..549b4bb
--- /dev/null
+++ b/circuitpython/frozen/Adafruit_CircuitPython_HID/docs/examples.rst
@@ -0,0 +1,44 @@
+Simple test
+------------
+
+Ensure your device works with this simple test.
+
+.. literalinclude:: ../examples/hid_simpletest.py
+ :caption: examples/hid_simpletest.py
+ :linenos:
+
+Keyboard Shortcuts
+-------------------
+
+Send ALT+Tab for swapping windows, and CTRL+K for searching in a browser.
+
+.. literalinclude:: ../examples/hid_keyboard_shortcuts.py
+ :caption: examples/hid_keyboard_shortcuts.py
+ :linenos:
+
+Simple Gamepad
+---------------
+
+Send gamepad buttons and joystick to the host.
+
+.. literalinclude:: ../examples/hid_simple_gamepad.py
+ :caption: examples/hid_simple_gamepad.py
+ :linenos:
+
+HID Joywing
+------------
+
+Use Joy FeatherWing to drive Gamepad.
+
+.. literalinclude:: ../examples/hid_joywing_gamepad.py
+ :caption: examples/hid_joywing_gamepad.py
+ :linenos:
+
+Consumer Control Brightness
+----------------------------
+
+Send brightness up and down consumer codes to the host.
+
+.. literalinclude:: ../examples/hid_consumer_control_brightness.py
+ :caption: examples/hid_consumer_control_brightness.py
+ :linenos:
diff --git a/circuitpython/frozen/Adafruit_CircuitPython_HID/docs/examples.rst.license b/circuitpython/frozen/Adafruit_CircuitPython_HID/docs/examples.rst.license
new file mode 100644
index 0000000..9aae48d
--- /dev/null
+++ b/circuitpython/frozen/Adafruit_CircuitPython_HID/docs/examples.rst.license
@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: 2020 ladyada for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT