Add keyboard related constants.

.gitignore

@@ -0,0 +1,3 @@
+__pycache__
+_build
+*.pyc

.travis.yml

@@ -0,0 +1,53 @@
+# Travis CI configuration for automated .mpy file generation.
+# Author: Tony DiCola
+# License: Public Domain
+# This configuration will work with Travis CI (travis-ci.org) to automacially
+# build .mpy files for CircuitPython when a new tagged release is created.  This
+# file is relatively generic and can be shared across multiple repositories by
+# following these steps:
+#   1. Copy this file into a .travis.yml file in the root of the repository.
+#   2. Change the deploy > file section below to list each of the .mpy files
+#      that should be generated.  The config will automatically look for
+#      .py files with the same name as the source for generating the .mpy files.
+#      Note that the .mpy extension should be lower case!
+#   3. Commit the .travis.yml file and push it to GitHub.
+#   4. Go to travis-ci.org and find the repository (it needs to be setup to access
+#      your github account, and your github account needs access to write to the
+#      repo).  Flip the 'ON' switch on for Travis and the repo, see the Travis
+#      docs for more details: https://docs.travis-ci.com/user/getting-started/
+#   5. Get a GitHub 'personal access token' which has at least 'public_repo' or
+#      'repo' scope: https://help.github.com/articles/creating-an-access-token-for-command-line-use/
+#      Keep this token safe and secure!  Anyone with the token will be able to
+#      access and write to your GitHub repositories.  Travis will use the token
+#      to attach the .mpy files to the release.
+#   6. In the Travis CI settings for the repository that was enabled find the
+#      environment variable editing page: https://docs.travis-ci.com/user/environment-variables/#Defining-Variables-in-Repository-Settings
+#      Add an environment variable named GITHUB_TOKEN and set it to the value
+#      of the GitHub personal access token above.  Keep 'Display value in build
+#      log' flipped off.
+#   7. That's it!  Tag a release and Travis should go to work to add .mpy files
+#      to the release.  It takes about a 2-3 minutes for a worker to spin up,
+#      build mpy-cross, and add the binaries to the release.
+language: generic
+
+sudo: true
+
+deploy:
+  provider: releases
+  api_key: $GITHUB_TOKEN
+  file:
+  - "adafruit_hid.mpy"
+  skip_cleanup: true
+  on:
+    tags: true
+
+before_install:
+- sudo apt-get -yqq update
+- sudo apt-get install -y build-essential git python python-pip
+- git clone https://github.com/adafruit/circuitpython.git
+- make -C circuitpython/mpy-cross
+- export PATH=$PATH:$PWD/circuitpython/mpy-cross/
+- sudo pip install shyaml
+
+before_deploy:
+- shyaml get-values deploy.file < .travis.yml | sed 's/.mpy/.py/' | xargs -L1 mpy-cross

CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at support@adafruit.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Scott Shawcroft for Adafruit Industries
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.rst

@@ -0,0 +1,76 @@
+
+Introduction
+============
+
+.. image:: https://readthedocs.org/projects/adafruit-circuitpython-hid/badge/?version=latest
+    :target: https://circuitpython.readthedocs.io/projects/hid/en/latest/
+    :alt: Documentation Status
+
+.. image :: https://badges.gitter.im/adafruit/circuitpython.svg
+    :target: https://gitter.im/adafruit/circuitpython?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge
+    :alt: Gitter
+
+This driver provides USB HID related constants. In the future it will include
+helper functions and classes as well.
+
+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://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
+
+Usage Example
+=============
+
+The current `keyboard` module stores key constants which make it easier to
+construct keypress reports for a keyboard device.
+
+.. code-block:: python
+
+    import usb_hid
+    import adafruit_hid.keyboard as kbd
+    import time
+
+    report = bytearray(8) # Keyboard reports are always 8 bytes.
+
+    # Devices are initialized earlier so find the one for the keyboard.
+    keyboard = None
+    for device in usb_hid.devices:
+        if device.usage_page is 0x1 and device.usage is 0x06:
+            keyboard = device
+            break
+
+    # The first byte of the report includes a bitfield indicating which
+    # modifiers are pressed. Their bit position is their code's difference from
+    # 0xE0.
+    report[0] |= 1 << (kbd.LEFT_SHIFT - 0xE0)
+    # Normal keys are simply their byte code in bytes 2-7. When fewer than six
+    # keys are pressed then the trailing bytes are zero.
+    report[2] = kbd.A
+    keyboard.send_report(report)
+
+    time.sleep(0.1)
+
+    # Clear the key presses and send another report.
+    report[0] = 0
+    report[2] = 0
+    keyboard.send_report(report)
+
+Contributing
+============
+
+Contributions are welcome! Please read our `Code of Conduct
+<https://github.com/adafruit/Adafruit_CircuitPython_hid/blob/master/CODE_OF_CONDUCT.md>`_
+before contributing to help this project stay welcoming.
+
+API Reference
+=============
+
+.. toctree::
+   :maxdepth: 2
+
+   api

adafruit_hid/__init__.py

@@ -0,0 +1,30 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2017 Scott Shawcroft for Adafruit Industries
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+"""
+`adafruit_hid`
+====================================================
+
+TODO(description)
+
+* Author(s): Scott Shawcroft
+"""

adafruit_hid/keyboard.py

@@ -0,0 +1,167 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2017 Scott Shawcroft for Adafruit Industries
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+"""
+:mod:`adafruit_hid.keyboard`
+====================================================
+
+USB keyboard related constants.
+
+* Author(s): Scott Shawcroft
+"""
+
+# Usage codes from here: http://www.usb.org/developers/hidpage/Hut1_12v2.pdf
+
+A = 0x04
+"""``a``"""
+B = 0x05
+"""``b``"""
+C = 0x06
+"""``c``"""
+D = 0x07
+"""``d``"""
+E = 0x08
+"""``e``"""
+F = 0x09
+"""``f``"""
+G = 0x0A
+"""``g``"""
+H = 0x0B
+"""``h``"""
+I = 0x0C
+"""``i``"""
+J = 0x0D
+"""``j``"""
+K = 0x0E
+"""``k``"""
+L = 0x0F
+"""``l``"""
+M = 0x10
+"""``m``"""
+N = 0x11
+"""``n``"""
+O = 0x12
+"""``o``"""
+P = 0x13
+"""``p``"""
+Q = 0x14
+"""``q``"""
+R = 0x15
+"""``r``"""
+S = 0x16
+"""``s``"""
+T = 0x17
+"""``t``"""
+U = 0x18
+"""``u``"""
+V = 0x19
+"""``v``"""
+W = 0x1A
+"""``w``"""
+X = 0x1B
+"""``x``"""
+Y = 0x1C
+"""``y``"""
+Z = 0x1D
+"""``z``"""
+ONE = 0x1E
+"""``1``"""
+TWO = 0x1F
+"""``2``"""
+THREE = 0x20
+"""``3``"""
+FOUR = 0x21
+"""``4``"""
+FIVE = 0x22
+"""``5``"""
+SIX = 0x23
+"""``6``"""
+SEVEN = 0x24
+"""``7``"""
+EIGHT = 0x25
+"""``8``"""
+NINE = 0x26
+"""``9``"""
+ZERO = 0x27
+"""``0``"""
+RETURN = 0x28
+"""Moves the cursor to the next line. Also known as enter."""
+ESCAPE = 0x29
+"""Escape."""
+BACKSPACE = 0x2A
+"""Deletes a character to the left of the cursor."""
+TAB = 0x2B
+"""A tab character. It is whitespace."""
+SPACEBAR = 0x2C
+"""`` ``"""
+MINUS = 0x2D
+"""``-``"""
+EQUALS = 0x2E
+"""``=``"""
+LEFT_BRACKET = 0x2F
+"""``[``"""
+RIGHT_BRACKET = 0x30
+"""``]``"""
+BACKSLASH = 0x31
+"""``\``"""
+POUND = 0x32
+"""``#``"""
+SEMICOLON = 0x33
+"""``;``"""
+QUOTE = 0x34
+"""``'``"""
+GRAVE_ACCENT = 0x35
+r""":literal:`\``"""
+COMMA = 0x36
+"""``,``"""
+PERIOD = 0x37
+"""``.``"""
+FORWARD_SLASH = 0x38
+"""``/``"""
+
+DELETE = 0x4C
+"""Deletes a character to the right of the cursor."""
+
+RIGHT_ARROW = 0x4F
+"""Moves the cursor right."""
+LEFT_ARROW = 0x50
+"""Moves the cursor left."""
+DOWN_ARROW = 0x51
+"""Moves the cursor down."""
+UP_ARROW = 0x52
+"""Moves the cursor up."""
+
+LEFT_CONTROL = 0xE0
+"""Control modifier left of the spacebar."""
+LEFT_SHIFT = 0xE1
+"""Shift modifier left of the spacebar."""
+LEFT_ALT = 0xE2
+"""Alt modifier left of the spacebar."""
+LEFT_GUI = 0xE3
+"""GUI modifier (aka Windows key, Option or Meta) left of the spacebar."""
+RIGHT_CONTROL = 0xE4
+"""Control modifier right of the spacebar."""
+RIGHT_SHIFT = 0xE5
+"""Shift modifier right of the spacebar."""
+RIGHT_ALT = 0xE6
+"""Alt modifier right of the spacebar."""
+RIGHT_GUI = 0xE7
+"""GUI modifier (aka Windows key, Option or Meta) right of the spacebar."""

api.rst

@@ -0,0 +1,7 @@
+
+.. If you created a package, create one automodule per module in the package.
+
+.. automodule:: adafruit_hid.keyboard
+    :members:
+    :member-order: bysource
+    :synopsis: Provide keyboard HID related helpers.

conf.py

@@ -0,0 +1,142 @@
+# -*- coding: utf-8 -*-
+
+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.4', None),'CircuitPython': ('https://circuitpython.readthedocs.io/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 = 'README'
+
+# General information about the project.
+project = u'Adafruit HID Library'
+copyright = u'2017 Scott Shawcroft'
+author = u'Scott Shawcroft'
+
+# 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 = u'1.0'
+# The full version, including alpha/beta/rc tags.
+release = u'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']
+
+# 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
+
+
+# -- 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']
+
+# 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', u'Adafruit HID Library Documentation',
+     u'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', u'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', u'Adafruit HID Library Documentation',
+     author, 'AdafruitHIDLibrary', 'One line description of project.',
+     'Miscellaneous'),
+]

readthedocs.yml

@@ -0,0 +1,2 @@
+requirements_file: requirements.txt
+

requirements.txt

@@ -0,0 +1 @@
+