add circuitpython code

10 files changed, 305 insertions, 0 deletions

diff --git a/circuitpython/frozen/Adafruit_CircuitPython_HID/docs/_static/favicon.ico b/circuitpython/frozen/Adafruit_CircuitPython_HID/docs/_static/favicon.ico
new file mode 100644
index 0000000..5aca983
--- /dev/null
+++ b/circuitpython/frozen/Adafruit_CircuitPython_HID/docs/_static/favicon.ico
diff --git a/circuitpython/frozen/Adafruit_CircuitPython_HID/docs/_static/favicon.ico.license b/circuitpython/frozen/Adafruit_CircuitPython_HID/docs/_static/favicon.ico.license
new file mode 100644
index 0000000..86a3fbf
--- /dev/null
+++ b/circuitpython/frozen/Adafruit_CircuitPython_HID/docs/_static/favicon.ico.license
@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: 2018 Phillip Torrone for Adafruit Industries
+
+SPDX-License-Identifier: CC-BY-4.0
diff --git a/circuitpython/frozen/Adafruit_CircuitPython_HID/docs/api.rst b/circuitpython/frozen/Adafruit_CircuitPython_HID/docs/api.rst
new file mode 100644
index 0000000..03b92bc
--- /dev/null
+++ b/circuitpython/frozen/Adafruit_CircuitPython_HID/docs/api.rst
@@ -0,0 +1,23 @@
+
+.. If you created a package, create one automodule per module in the package.
+
+.. automodule:: adafruit_hid.keyboard
+   :members:
+
+.. automodule:: adafruit_hid.keycode
+   :members:
+
+.. automodule:: adafruit_hid.keyboard_layout_us
+   :members:
+
+.. automodule:: adafruit_hid.keyboard_layout_base
+   :members:
+
+.. automodule:: adafruit_hid.mouse
+   :members:
+
+.. automodule:: adafruit_hid.consumer_control
+   :members:
+
+.. automodule:: adafruit_hid.consumer_control_code
+   :members:
diff --git a/circuitpython/frozen/Adafruit_CircuitPython_HID/docs/api.rst.license b/circuitpython/frozen/Adafruit_CircuitPython_HID/docs/api.rst.license
new file mode 100644
index 0000000..9aae48d
--- /dev/null
+++ b/circuitpython/frozen/Adafruit_CircuitPython_HID/docs/api.rst.license
@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: 2020 ladyada for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
diff --git a/circuitpython/frozen/Adafruit_CircuitPython_HID/docs/conf.py b/circuitpython/frozen/Adafruit_CircuitPython_HID/docs/conf.py
new file mode 100644
index 0000000..c35d131
--- /dev/null
+++ b/circuitpython/frozen/Adafruit_CircuitPython_HID/docs/conf.py
@@ -0,0 +1,176 @@
+# -*- coding: utf-8 -*-
+
+# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath(".."))
+
+# -- General configuration ------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.viewcode",
+]
+
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3", None),
+    "CircuitPython": ("https://docs.circuitpython.org/en/latest/", None),
+}
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates"]
+
+source_suffix = ".rst"
+
+# The master toctree document.
+master_doc = "index"
+
+# General information about the project.
+project = "Adafruit HID Library"
+copyright = "2017 Scott Shawcroft"
+author = "Scott Shawcroft"
+
+# Ignore imports of these modules, which sphinx will not know about.
+autodoc_mock_imports = ["usb_hid"]
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = "1.0"
+# The full version, including alpha/beta/rc tags.
+release = "1.0"
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", ".env", "CODE_OF_CONDUCT.md"]
+
+# The reST default role (used for this markup: `text`) to use for all
+# documents.
+#
+default_role = "any"
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#
+add_function_parentheses = True
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = "sphinx"
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+# If this is True, todo emits a warning for each TODO entries. The default is False.
+todo_emit_warnings = True
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+on_rtd = os.environ.get("READTHEDOCS", None) == "True"
+
+if not on_rtd:  # only import and set the theme if we're building docs locally
+    try:
+        import sphinx_rtd_theme
+
+        html_theme = "sphinx_rtd_theme"
+        html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."]
+    except:
+        html_theme = "default"
+        html_theme_path = ["."]
+else:
+    html_theme_path = ["."]
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ["_static"]
+
+# The name of an image file (relative to this directory) to use as a favicon of
+# the docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#
+html_favicon = "_static/favicon.ico"
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = "AdafruitHIDLibrarydoc"
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (
+        master_doc,
+        "AdafruitHIDLibrary.tex",
+        "Adafruit HID Library Documentation",
+        "Scott Shawcroft",
+        "manual",
+    ),
+]
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (
+        master_doc,
+        "adafruitHIDlibrary",
+        "Adafruit HID Library Documentation",
+        [author],
+        1,
+    )
+]
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (
+        master_doc,
+        "AdafruitHIDLibrary",
+        "Adafruit HID Library Documentation",
+        author,
+        "AdafruitHIDLibrary",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
+]
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
diff --git a/circuitpython/frozen/Adafruit_CircuitPython_HID/docs/index.rst b/circuitpython/frozen/Adafruit_CircuitPython_HID/docs/index.rst
new file mode 100644
index 0000000..5ddac8b
--- /dev/null
+++ b/circuitpython/frozen/Adafruit_CircuitPython_HID/docs/index.rst
@@ -0,0 +1,45 @@
+.. include:: ../README.rst
+
+Table of Contents
+=================
+
+.. toctree::
+    :maxdepth: 4
+    :hidden:
+
+    self
+
+.. toctree::
+    :caption: Examples
+
+    examples
+
+.. toctree::
+    :caption: API Reference
+    :maxdepth: 3
+
+    api
+
+.. toctree::
+    :caption: Tutorials
+
+.. toctree::
+    :caption: Related Products
+
+.. toctree::
+    :caption: Other Links
+
+    Download <https://github.com/adafruit/Adafruit_CircuitPython_HID/releases/latest>
+    CircuitPython Reference Documentation <https://docs.circuitpython.org>
+    CircuitPython Support Forum <https://forums.adafruit.com/viewforum.php?f=60>
+    Discord Chat <https://adafru.it/discord>
+    Adafruit Learning System <https://learn.adafruit.com>
+    Adafruit Blog <https://blog.adafruit.com>
+    Adafruit Store <https://www.adafruit.com>
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/circuitpython/frozen/Adafruit_CircuitPython_HID/docs/index.rst.license b/circuitpython/frozen/Adafruit_CircuitPython_HID/docs/index.rst.license
new file mode 100644
index 0000000..9aae48d
--- /dev/null
+++ b/circuitpython/frozen/Adafruit_CircuitPython_HID/docs/index.rst.license
@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: 2020 ladyada for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
diff --git a/circuitpython/frozen/Adafruit_CircuitPython_HID/docs/requirements.txt b/circuitpython/frozen/Adafruit_CircuitPython_HID/docs/requirements.txt
new file mode 100644
index 0000000..88e6733
--- /dev/null
+++ b/circuitpython/frozen/Adafruit_CircuitPython_HID/docs/requirements.txt
@@ -0,0 +1,5 @@
+# SPDX-FileCopyrightText: 2021 Kattni Rembor for Adafruit Industries
+#
+# SPDX-License-Identifier: Unlicense
+
+sphinx>=4.0.0