diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..0dd8629 --- /dev/null +++ b/.gitignore @@ -0,0 +1,6 @@ +__pycache__ +_build +*.pyc +.env +build* +bundles diff --git a/.pylintrc b/.pylintrc new file mode 100644 index 0000000..81d8170 --- /dev/null +++ b/.pylintrc @@ -0,0 +1,433 @@ +[MASTER] + +# A comma-separated list of package or module names from where C extensions may +# be loaded. Extensions are loading into the active Python interpreter and may +# run arbitrary code +extension-pkg-whitelist= + +# Add files or directories to the blacklist. They should be base names, not +# paths. +ignore=CVS + +# Add files or directories matching the regex patterns to the blacklist. The +# regex matches against base names, not paths. +ignore-patterns= + +# Python code to execute, usually for sys.path manipulation such as +# pygtk.require(). +#init-hook= + +# Use multiple processes to speed up Pylint. +# jobs=1 +jobs=2 + +# List of plugins (as comma separated values of python modules names) to load, +# usually to register additional checkers. +load-plugins= + +# Pickle collected data for later comparisons. +persistent=yes + +# Specify a configuration file. +#rcfile= + +# Allow loading of arbitrary C extensions. Extensions are imported into the +# active Python interpreter and may run arbitrary code. +unsafe-load-any-extension=no + + +[MESSAGES CONTROL] + +# Only show warnings with the listed confidence levels. Leave empty to show +# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED +confidence= + +# Disable the message, report, category or checker with the given id(s). You +# can either give multiple identifiers separated by comma (,) or put this +# option multiple times (only on the command line, not in the configuration +# file where it should appear only once).You can also use "--disable=all" to +# disable everything first and then reenable specific checks. For example, if +# you want to run only the similarities checker, you can use "--disable=all +# --enable=similarities". If you want to run only the classes checker, but have +# no Warning level messages displayed, use"--disable=all --enable=classes +# --disable=W" +# disable=import-error,print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call +disable=print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call,import-error + +# Enable the message, report, category or checker with the given id(s). You can +# either give multiple identifier separated by comma (,) or put this option +# multiple time (only on the command line, not in the configuration file where +# it should appear only once). See also the "--disable" option for examples. +enable= + + +[REPORTS] + +# Python expression which should return a note less than 10 (10 is the highest +# note). You have access to the variables errors warning, statement which +# respectively contain the number of errors / warnings messages and the total +# number of statements analyzed. This is used by the global evaluation report +# (RP0004). +evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10) + +# Template used to display messages. This is a python new-style format string +# used to format the message information. See doc for all details +#msg-template= + +# Set the output format. Available formats are text, parseable, colorized, json +# and msvs (visual studio).You can also give a reporter class, eg +# mypackage.mymodule.MyReporterClass. +output-format=text + +# Tells whether to display a full report or only the messages +reports=no + +# Activate the evaluation score. +score=yes + + +[REFACTORING] + +# Maximum number of nested blocks for function / method body +max-nested-blocks=5 + + +[LOGGING] + +# Logging modules to check that the string format arguments are in logging +# function parameter format +logging-modules=logging + + +[SPELLING] + +# Spelling dictionary name. Available dictionaries: none. To make it working +# install python-enchant package. +spelling-dict= + +# List of comma separated words that should not be checked. +spelling-ignore-words= + +# A path to a file that contains private dictionary; one word per line. +spelling-private-dict-file= + +# Tells whether to store unknown words to indicated private dictionary in +# --spelling-private-dict-file option instead of raising a message. +spelling-store-unknown-words=no + + +[MISCELLANEOUS] + +# List of note tags to take in consideration, separated by a comma. +# notes=FIXME,XXX,TODO +notes=FIXME,XXX + + +[TYPECHECK] + +# List of decorators that produce context managers, such as +# contextlib.contextmanager. Add to this list to register other decorators that +# produce valid context managers. +contextmanager-decorators=contextlib.contextmanager + +# List of members which are set dynamically and missed by pylint inference +# system, and so shouldn't trigger E1101 when accessed. Python regular +# expressions are accepted. +generated-members= + +# Tells whether missing members accessed in mixin class should be ignored. A +# mixin class is detected if its name ends with "mixin" (case insensitive). +ignore-mixin-members=yes + +# This flag controls whether pylint should warn about no-member and similar +# checks whenever an opaque object is returned when inferring. The inference +# can return multiple potential results while evaluating a Python object, but +# some branches might not be evaluated, which results in partial inference. In +# that case, it might be useful to still emit no-member and other checks for +# the rest of the inferred objects. +ignore-on-opaque-inference=yes + +# List of class names for which member attributes should not be checked (useful +# for classes with dynamically set attributes). This supports the use of +# qualified names. +ignored-classes=optparse.Values,thread._local,_thread._local + +# List of module names for which member attributes should not be checked +# (useful for modules/projects where namespaces are manipulated during runtime +# and thus existing member attributes cannot be deduced by static analysis. It +# supports qualified module names, as well as Unix pattern matching. +ignored-modules= + +# Show a hint with possible names when a member name was not found. The aspect +# of finding the hint is based on edit distance. +missing-member-hint=yes + +# The minimum edit distance a name should have in order to be considered a +# similar match for a missing member name. +missing-member-hint-distance=1 + +# The total number of similar names that should be taken in consideration when +# showing a hint for a missing member. +missing-member-max-choices=1 + + +[VARIABLES] + +# List of additional names supposed to be defined in builtins. Remember that +# you should avoid to define new builtins when possible. +additional-builtins= + +# Tells whether unused global variables should be treated as a violation. +allow-global-unused-variables=yes + +# List of strings which can identify a callback function by name. A callback +# name must start or end with one of those strings. +callbacks=cb_,_cb + +# A regular expression matching the name of dummy variables (i.e. expectedly +# not used). +dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_ + +# Argument names that match this expression will be ignored. Default to name +# with leading underscore +ignored-argument-names=_.*|^ignored_|^unused_ + +# Tells whether we should check for unused import in __init__ files. +init-import=no + +# List of qualified module names which can have objects that can redefine +# builtins. +redefining-builtins-modules=six.moves,future.builtins + + +[FORMAT] + +# Expected format of line ending, e.g. empty (any line ending), LF or CRLF. +# expected-line-ending-format= +expected-line-ending-format=LF + +# Regexp for a line that is allowed to be longer than the limit. +ignore-long-lines=^\s*(# )??$ + +# Number of spaces of indent required inside a hanging or continued line. +indent-after-paren=4 + +# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 +# tab). +indent-string=' ' + +# Maximum number of characters on a single line. +max-line-length=100 + +# Maximum number of lines in a module +max-module-lines=1000 + +# List of optional constructs for which whitespace checking is disabled. `dict- +# separator` is used to allow tabulation in dicts, etc.: {1 : 1,\n222: 2}. +# `trailing-comma` allows a space between comma and closing bracket: (a, ). +# `empty-line` allows space-only lines. +no-space-check=trailing-comma,dict-separator + +# Allow the body of a class to be on the same line as the declaration if body +# contains single statement. +single-line-class-stmt=no + +# Allow the body of an if to be on the same line as the test if there is no +# else. +single-line-if-stmt=no + + +[SIMILARITIES] + +# Ignore comments when computing similarities. +ignore-comments=yes + +# Ignore docstrings when computing similarities. +ignore-docstrings=yes + +# Ignore imports when computing similarities. +ignore-imports=no + +# Minimum lines number of a similarity. +min-similarity-lines=4 + + +[BASIC] + +# Naming hint for argument names +argument-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Regular expression matching correct argument names +argument-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Naming hint for attribute names +attr-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Regular expression matching correct attribute names +attr-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Bad variable names which should always be refused, separated by a comma +bad-names=foo,bar,baz,toto,tutu,tata + +# Naming hint for class attribute names +class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ + +# Regular expression matching correct class attribute names +class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ + +# Naming hint for class names +# class-name-hint=[A-Z_][a-zA-Z0-9]+$ +class-name-hint=[A-Z_][a-zA-Z0-9_]+$ + +# Regular expression matching correct class names +# class-rgx=[A-Z_][a-zA-Z0-9]+$ +class-rgx=[A-Z_][a-zA-Z0-9_]+$ + +# Naming hint for constant names +const-name-hint=(([A-Z_][A-Z0-9_]*)|(__.*__))$ + +# Regular expression matching correct constant names +const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$ + +# Minimum line length for functions/classes that require docstrings, shorter +# ones are exempt. +docstring-min-length=-1 + +# Naming hint for function names +function-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Regular expression matching correct function names +function-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Good variable names which should always be accepted, separated by a comma +# good-names=i,j,k,ex,Run,_ +good-names=r,g,b,w,i,j,k,n,x,y,z,ex,ok,Run,_ + +# Include a hint for the correct naming format with invalid-name +include-naming-hint=no + +# Naming hint for inline iteration names +inlinevar-name-hint=[A-Za-z_][A-Za-z0-9_]*$ + +# Regular expression matching correct inline iteration names +inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$ + +# Naming hint for method names +method-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Regular expression matching correct method names +method-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Naming hint for module names +module-name-hint=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ + +# Regular expression matching correct module names +module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ + +# Colon-delimited sets of names that determine each other's naming style when +# the name regexes allow several styles. +name-group= + +# Regular expression which should only match function or class names that do +# not require a docstring. +no-docstring-rgx=^_ + +# List of decorators that produce properties, such as abc.abstractproperty. Add +# to this list to register other decorators that produce valid properties. +property-classes=abc.abstractproperty + +# Naming hint for variable names +variable-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Regular expression matching correct variable names +variable-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + + +[IMPORTS] + +# Allow wildcard imports from modules that define __all__. +allow-wildcard-with-all=no + +# Analyse import fallback blocks. This can be used to support both Python 2 and +# 3 compatible code, which means that the block might have code that exists +# only in one or another interpreter, leading to false positives when analysed. +analyse-fallback-blocks=no + +# Deprecated modules which should not be used, separated by a comma +deprecated-modules=optparse,tkinter.tix + +# Create a graph of external dependencies in the given file (report RP0402 must +# not be disabled) +ext-import-graph= + +# Create a graph of every (i.e. internal and external) dependencies in the +# given file (report RP0402 must not be disabled) +import-graph= + +# Create a graph of internal dependencies in the given file (report RP0402 must +# not be disabled) +int-import-graph= + +# Force import order to recognize a module as part of the standard +# compatibility libraries. +known-standard-library= + +# Force import order to recognize a module as part of a third party library. +known-third-party=enchant + + +[CLASSES] + +# List of method names used to declare (i.e. assign) instance attributes. +defining-attr-methods=__init__,__new__,setUp + +# List of member names, which should be excluded from the protected access +# warning. +exclude-protected=_asdict,_fields,_replace,_source,_make + +# List of valid names for the first argument in a class method. +valid-classmethod-first-arg=cls + +# List of valid names for the first argument in a metaclass class method. +valid-metaclass-classmethod-first-arg=mcs + + +[DESIGN] + +# Maximum number of arguments for function / method +max-args=5 + +# Maximum number of attributes for a class (see R0902). +# max-attributes=7 +max-attributes=11 + +# Maximum number of boolean expressions in a if statement +max-bool-expr=5 + +# Maximum number of branch for function / method body +max-branches=12 + +# Maximum number of locals for function / method body +max-locals=15 + +# Maximum number of parents for a class (see R0901). +max-parents=7 + +# Maximum number of public methods for a class (see R0904). +max-public-methods=20 + +# Maximum number of return / yield for function / method body +max-returns=6 + +# Maximum number of statements in function / method body +max-statements=50 + +# Minimum number of public methods for a class (see R0903). +min-public-methods=1 + + +[EXCEPTIONS] + +# Exceptions that will emit a warning when being caught. Defaults to +# "Exception" +overgeneral-exceptions=Exception diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 0000000..f4243ad --- /dev/null +++ b/.readthedocs.yml @@ -0,0 +1,3 @@ +python: + version: 3 +requirements_file: requirements.txt diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..f1c0164 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,32 @@ +# This is a common .travis.yml for generating library release zip files for +# CircuitPython library releases using circuitpython-build-tools. +# See https://github.com/adafruit/circuitpython-build-tools for detailed setup +# instructions. + +dist: trusty +sudo: false +language: python +python: + - "3.6" + +cache: + pip: true + +deploy: + provider: releases + api_key: $GITHUB_TOKEN + file_glob: true + file: $TRAVIS_BUILD_DIR/bundles/* + skip_cleanup: true + overwrite: true + on: + tags: true + +install: + - pip install pylint circuitpython-build-tools Sphinx sphinx-rtd-theme + +script: + - pylint adafruit_stmpe610.py + - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace examples/*.py) + - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-stmpe610 --library_location . + - cd docs && sphinx-build -E -W -b html . _build/html diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..1617586 --- /dev/null +++ b/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/ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..9c96cad --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2017 Jerry Needell + +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. diff --git a/README.md b/README.md deleted file mode 100644 index fbb6b98..0000000 --- a/README.md +++ /dev/null @@ -1,2 +0,0 @@ -# Adafruit_CircuitPython_STMPE610 -Adafruit CircuitPython driver for the STMPE610 resistive touchscreen controller diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..176e45d --- /dev/null +++ b/README.rst @@ -0,0 +1,89 @@ +Introduction +============ + +.. image:: https://readthedocs.org/projects/adafruit-circuitpython-stmpe610/badge/?version=latest + :target: https://circuitpython.readthedocs.io/projects/stmpe610/en/latest/ + :alt: Documentation Status + +.. image:: https://img.shields.io/discord/327254708534116352.svg + :target: https://discord.gg/nBQh6qu + :alt: Discord + +.. image:: https://travis-ci.org/adafruit/adafruit_CircuitPython_stmpe610.svg?branch=master + :target: https://travis-ci.org/adafruit/adafruit_CircuitPython_stmpe610 + :alt: Build Status + +Adafruit CircuitPython module for the STMPE610 Resistive Touch Screen Controller + +Dependencies +============= +This driver depends on: + +* `Adafruit CircuitPython `_ +* `Bus Device `_ +* `Register `_ + +Please ensure all dependencies are available on the CircuitPython filesystem. +This is easily achieved by downloading +`the Adafruit library and driver bundle `_. + +Usage Example +============= + +see examples in githup repository: https://github.com/adafruit/Adafruit_CircuitPython_STMPE610/exmaples +Contributing +============ + +Contributions are welcome! Please read our `Code of Conduct +`_ +before contributing to help this project stay welcoming. + +Building locally +================ + +Zip release files +----------------- + +To build this library locally you'll need to install the +`circuitpython-build-tools `_ package. + +.. code-block:: shell + + python3 -m venv .env + source .env/bin/activate + pip install circuitpython-build-tools + +Once installed, make sure you are in the virtual environment: + +.. code-block:: shell + + source .env/bin/activate + +Then run the build: + +.. code-block:: shell + + circuitpython-build-bundles --filename_prefix adafruit-circuitpython-stmpe610 --library_location . + +Sphinx documentation +----------------------- + +Sphinx is used to build the documentation based on rST files and comments in the code. First, +install dependencies (feel free to reuse the virtual environment from above): + +.. code-block:: shell + + python3 -m venv .env + source .env/bin/activate + pip install Sphinx sphinx-rtd-theme + +Now, once you have the virtual environment activated: + +.. code-block:: shell + + cd docs + sphinx-build -E -W -b html . _build/html + +This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to +view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to +locally verify it will pass. diff --git a/adafruit_stmpe610.py b/adafruit_stmpe610.py new file mode 100644 index 0000000..223d990 --- /dev/null +++ b/adafruit_stmpe610.py @@ -0,0 +1,303 @@ +# The MIT License (MIT) +# +# Copyright (c) 2017 Jerry Needell +# +# 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_stmpe610` +==================================================== + +This is a CircuitPython Driver for the STMPE610 Resistive Touch sensor + +* Author(s): Jerry Needell +""" + +# imports + +import time +from micropython import const + + +__version__ = "0.0.0-auto.0" +__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_STMPE610.git" + + + +_STMPE_ADDR = const(0x41) +_STMPE_VERSION = const(0x0811) + +_STMPE_SYS_CTRL1 = const(0x03) +_STMPE_SYS_CTRL1_RESET = const(0x02) +_STMPE_SYS_CTRL2 = const(0x04) + +_STMPE_TSC_CTRL = const(0x40) +_STMPE_TSC_CTRL_EN = const(0x01) +_STMPE_TSC_CTRL_XYZ = const(0x00) +_STMPE_TSC_CTRL_XY = const(0x02) + +_STMPE_INT_CTRL = const(0x09) +_STMPE_INT_CTRL_POL_HIGH = const(0x04) +_STMPE_INT_CTRL_POL_LOW = const(0x00) +_STMPE_INT_CTRL_EDGE = const(0x02) +_STMPE_INT_CTRL_LEVEL = const(0x00) +_STMPE_INT_CTRL_ENABLE = const(0x01) +_STMPE_INT_CTRL_DISABLE = const(0x00) + + + +_STMPE_INT_EN = const(0x0A) +_STMPE_INT_EN_TOUCHDET = const(0x01) +_STMPE_INT_EN_FIFOTH = const(0x02) +_STMPE_INT_EN_FIFOOF = const(0x04) +_STMPE_INT_EN_FIFOFULL = const(0x08) +_STMPE_INT_EN_FIFOEMPTY = const(0x10) +_STMPE_INT_EN_ADC = const(0x40) +_STMPE_INT_EN_GPIO = const(0x80) + +_STMPE_INT_STA = const(0x0B) +_STMPE_INT_STA_TOUCHDET = const(0x01) + +_STMPE_ADC_CTRL1 = const(0x20) +_STMPE_ADC_CTRL1_12BIT = const(0x08) +_STMPE_ADC_CTRL1_10BIT = const(0x00) + +_STMPE_ADC_CTRL2 = const(0x21) +_STMPE_ADC_CTRL2_1_625MHZ = const(0x00) +_STMPE_ADC_CTRL2_3_25MHZ = const(0x01) +_STMPE_ADC_CTRL2_6_5MHZ = const(0x02) + +_STMPE_TSC_CFG = const(0x41) +_STMPE_TSC_CFG_1SAMPLE = const(0x00) +_STMPE_TSC_CFG_2SAMPLE = const(0x40) +_STMPE_TSC_CFG_4SAMPLE = const(0x80) +_STMPE_TSC_CFG_8SAMPLE = const(0xC0) +_STMPE_TSC_CFG_DELAY_10US = const(0x00) +_STMPE_TSC_CFG_DELAY_50US = const(0x08) +_STMPE_TSC_CFG_DELAY_100US = const(0x10) +_STMPE_TSC_CFG_DELAY_500US = const(0x18) +_STMPE_TSC_CFG_DELAY_1MS = const(0x20) +_STMPE_TSC_CFG_DELAY_5MS = const(0x28) +_STMPE_TSC_CFG_DELAY_10MS = const(0x30) +_STMPE_TSC_CFG_DELAY_50MS = const(0x38) +_STMPE_TSC_CFG_SETTLE_10US = const(0x00) +_STMPE_TSC_CFG_SETTLE_100US = const(0x01) +_STMPE_TSC_CFG_SETTLE_500US = const(0x02) +_STMPE_TSC_CFG_SETTLE_1MS = const(0x03) +_STMPE_TSC_CFG_SETTLE_5MS = const(0x04) +_STMPE_TSC_CFG_SETTLE_10MS = const(0x05) +_STMPE_TSC_CFG_SETTLE_50MS = const(0x06) +_STMPE_TSC_CFG_SETTLE_100MS = const(0x07) + +_STMPE_FIFO_TH = const(0x4A) + +_STMPE_FIFO_SIZE = const(0x4C) + +_STMPE_FIFO_STA = const(0x4B) +_STMPE_FIFO_STA_RESET = const(0x01) +_STMPE_FIFO_STA_OFLOW = const(0x80) +_STMPE_FIFO_STA_FULL = const(0x40) +_STMPE_FIFO_STA_EMPTY = const(0x20) +_STMPE_FIFO_STA_THTRIG = const(0x10) + +_STMPE_TSC_I_DRIVE = const(0x58) +_STMPE_TSC_I_DRIVE_20MA = const(0x00) +_STMPE_TSC_I_DRIVE_50MA = const(0x01) + +_STMPE_TSC_DATA_X = const(0x4D) +_STMPE_TSC_DATA_Y = const(0x4F) +_STMPE_TSC_FRACTION_Z = const(0x56) + +_STMPE_GPIO_SET_PIN = const(0x10) +_STMPE_GPIO_CLR_PIN = const(0x11) +_STMPE_GPIO_DIR = const(0x13) +_STMPE_GPIO_ALT_FUNCT = const(0x17) + + + +class Adafruit_STMPE610: + """ + A driver for the STMPE610 Resistive Touch sensor. + """ + def __init__(self): + """Check the STMPE610 was found""" + # Check device version. + version = self.get_version + if _STMPE_VERSION != version: + raise RuntimeError('Failed to find STMPE610! Chip Version 0x%x' % version) + self._write_register_byte(_STMPE_SYS_CTRL1, _STMPE_SYS_CTRL1_RESET) + time.sleep(.001) + + + self._write_register_byte(_STMPE_SYS_CTRL2, 0x0) # turn on clocks! + self._write_register_byte( + _STMPE_TSC_CTRL, _STMPE_TSC_CTRL_XYZ | _STMPE_TSC_CTRL_EN) # XYZ and enable! + self._write_register_byte(_STMPE_INT_EN, _STMPE_INT_EN_TOUCHDET) + self._write_register_byte( + _STMPE_ADC_CTRL1, _STMPE_ADC_CTRL1_10BIT | (0x6 << 4)) # 96 clocks per conversion + self._write_register_byte(_STMPE_ADC_CTRL2, _STMPE_ADC_CTRL2_6_5MHZ) + self._write_register_byte( + _STMPE_TSC_CFG, _STMPE_TSC_CFG_4SAMPLE | _STMPE_TSC_CFG_DELAY_1MS + | _STMPE_TSC_CFG_SETTLE_5MS) + self._write_register_byte(_STMPE_TSC_FRACTION_Z, 0x6) + self._write_register_byte(_STMPE_FIFO_TH, 1) + self._write_register_byte(_STMPE_FIFO_STA, _STMPE_FIFO_STA_RESET) + self._write_register_byte(_STMPE_FIFO_STA, 0) # unreset + self._write_register_byte(_STMPE_TSC_I_DRIVE, _STMPE_TSC_I_DRIVE_50MA) + self._write_register_byte(_STMPE_INT_STA, 0xFF) # reset all ints + self._write_register_byte( + _STMPE_INT_CTRL, _STMPE_INT_CTRL_POL_HIGH | _STMPE_INT_CTRL_ENABLE) + + def read_data(self): + """Request next stored reading - return tuple containing (x,y,pressure) """ + d_1 = self._read_byte(0xD7) + d_2 = self._read_byte(0xD7) + d_3 = self._read_byte(0xD7) + d_4 = self._read_byte(0xD7) + x_loc = d_1 << 4 | d_2 >> 4 + y_loc = (d_2 & 0xF) << 8 | d_3 + pressure = d_4 + # reset all ints (not sure what this does) + if self.buffer_empty: + self._write_register_byte(_STMPE_INT_STA, 0xFF) + return (x_loc, y_loc, pressure) + + def _read_byte(self, register): + """Read a byte register value and return it""" + return self._read_register(register, 1)[0] + + def _read_register(self, register, length): + # Read an arbitrarily long register (specified by length number of + # bytes) and return a bytearray of the retrieved data. + # Subclasses MUST implement this! + raise NotImplementedError + + def _write_register_byte(self, register, value): + # Write a single byte register at the specified register address. + # Subclasses MUST implement this! + raise NotImplementedError + + + @property + def touches(self): + """ + Returns a list of touchpoint dicts, with 'x' and 'y' containing the + touch coordinates, and 'pressure' + """ + touchpoints = [] + while (len(touchpoints) < 4) and not self.buffer_empty: + (x_loc, y_loc, pressure) = self.read_data() + point = {'x':x_loc, 'y':y_loc, 'pressure':pressure} + touchpoints.append(point) + return touchpoints + + + @property + def get_version(self): + "Read the version number from the sensosr" + v_1 = self._read_byte(0) + v_2 = self._read_byte(1) + version = v_1<<8 | v_2 + #print("version ",hex(version)) + return version + + @property + def touched(self): + "Report if any touches have been detectd" + touch = self._read_byte(_STMPE_TSC_CTRL)&0x80 + return touch == 0x80 + + + @property + def buffer_size(self): + "The amount of touch data in the buffer" + return self._read_byte(_STMPE_FIFO_SIZE) + + @property + def buffer_empty(self): + "Buffer empty status" + empty = self._read_byte(_STMPE_FIFO_STA) & _STMPE_FIFO_STA_EMPTY + return empty != 0 + + + + @property + def get_point(self): + "Read one touch from the buffer" + (x_loc, y_loc, pressure) = self.read_data() + point = {'x':x_loc, 'y':y_loc, 'pressure':pressure} + return point + + + + +class Adafruit_STMPE610_I2C(Adafruit_STMPE610): + """ + I2C driver for the STMPE610 Resistive Touch sensor. + """ + def __init__(self, i2c, address=_STMPE_ADDR): + """ + Check the STMPE610 was founnd + Default address is 0x41 but another address can be passed in as an argument + """ + import adafruit_bus_device.i2c_device as i2c_device + self._i2c = i2c_device.I2CDevice(i2c, address) + super().__init__() + + def _read_register(self, register, length): + """Low level register reading over I2C, returns a list of values""" + with self._i2c as i2c: + i2c.write(bytearray([register & 0xFF])) + result = bytearray(length) + i2c.readinto(result) + #print("$%02X => %s" % (register, [hex(i) for i in result])) + return result + + def _write_register_byte(self, register, value): + """Low level register writing over I2C, writes one 8-bit value""" + with self._i2c as i2c: + i2c.write(bytes([register & 0xFF, value & 0xFF])) + #print("$%02X <= 0x%02X" % (register, value)) + +class Adafruit_STMPE610_SPI(Adafruit_STMPE610): + """ + SPI driver for the STMPE610 Resistive Touch sensor. + """ + def __init__(self, spi, cs, baudrate=100000): + """ + Check the STMPE610 was found,Default clock rate is 100000 but can be changed with 'baudrate' + """ + import adafruit_bus_device.spi_device as spi_device + self._spi = spi_device.SPIDevice(spi, cs, baudrate=baudrate) + super().__init__() + + def _read_register(self, register, length): + """Low level register reading over SPI, returns a list of values""" + register = (register | 0x80) & 0xFF # Read single, bit 7 high. + with self._spi as spi: + spi.write(bytearray([register])) + result = bytearray(length) + spi.readinto(result) +# print("$%02X => %s" % (register, [hex(i) for i in result])) + return result + + def _write_register_byte(self, register, value): + """Low level register writing over SPI, writes one 8-bit value""" + register &= 0x7F # Write, bit 7 low. + with self._spi as spi: + spi.write(bytes([register, value & 0xFF])) diff --git a/docs/_static/favicon.ico b/docs/_static/favicon.ico new file mode 100644 index 0000000..5aca983 Binary files /dev/null and b/docs/_static/favicon.ico differ diff --git a/docs/api.rst b/docs/api.rst new file mode 100644 index 0000000..ae54400 --- /dev/null +++ b/docs/api.rst @@ -0,0 +1,8 @@ + +.. If you created a package, create one automodule per module in the package. + +.. If your library file(s) are nested in a directory (e.g. /adafruit_foo/foo.py) +.. use this format as the module name: "adafruit_foo.foo" + +.. automodule:: adafruit_stmpe610 + :members: diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..7f9160d --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,160 @@ +# -*- 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.napoleon', + 'sphinx.ext.todo', +] + +# TODO: Please Read! +# Uncomment the below if you use native CircuitPython modules such as +# digitalio, micropython and busio. List the modules you use. Without it, the +# autodoc module docs will fail to generate with a warning. +autodoc_mock_imports = ["micropython"] + + +intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None),'BusDevice': ('https://circuitpython.readthedocs.io/projects/busdevice/en/latest/', None),'Register': ('https://circuitpython.readthedocs.io/projects/register/en/latest/', 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 = 'index' + +# General information about the project. +project = u'Adafruit stmpe610 Library' +copyright = u'2017 Jerry Needell' +author = u'Jerry Needell' + +# 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', '.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 + +napoleon_numpy_docstring = 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'] + +# 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 = 'AdafruitStmpe610Librarydoc' + +# -- 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, 'Adafruitstmpe610Library.tex', u'Adafruitstmpe610 Library Documentation', + author, '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, 'Adafruitstmpe610library', u'Adafruit stmpe610 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, 'Adafruitstmpe610Library', u'Adafruit stmpe610 Library Documentation', + author, 'Adafruitstmpe610Library', 'One line description of project.', + 'Miscellaneous'), +] diff --git a/docs/examples.rst b/docs/examples.rst new file mode 100644 index 0000000..2fea9d9 --- /dev/null +++ b/docs/examples.rst @@ -0,0 +1,8 @@ +Simple test +------------ + +Ensure your device works with this simple test. + +.. literalinclude:: ../examples/stmpe610_simpletest.py + :caption: examples/stmpe610_simpletest.py + :linenos: diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..e6aae38 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,47 @@ +.. 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 + CircuitPython Reference Documentation + CircuitPython Support Forum + Discord Chat + Adafruit Learning System + Adafruit Blog + Adafruit Store + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/examples/stmpe610_paint_demo.py b/examples/stmpe610_paint_demo.py new file mode 100644 index 0000000..1cb80f4 --- /dev/null +++ b/examples/stmpe610_paint_demo.py @@ -0,0 +1,37 @@ +""" +Simple painting demo that draws on an Adafruit capacitive touch shield with +ILI9341 display and STMPE610 resistive touch driver +""" + +import busio +import board +import digitalio +import adafruit_stmpe610 +from adafruit_rgb_display import ili9341, color565 + +# Create library object using our Bus SPI port +spi = busio.SPI(clock=board.SCK, MOSI=board.MOSI, MISO=board.MISO) + +# Adafruit Metro M0 + 2.8" Capacitive touch shield +cs_pin = digitalio.DigitalInOut(board.D9) +dc_pin = digitalio.DigitalInOut(board.D10) + +# Initialize display +display = ili9341.ILI9341(spi, cs=cs_pin, dc=dc_pin) +# Fill with black! +display.fill(color565(0, 0, 0)) + +st_cs_pin = digitalio.DigitalInOut(board.D6) +st = adafruit_stmpe610.Adafruit_STMPE610_SPI(spi,st_cs_pin) + +while True: + if st.touched: + while not st.buffer_empty: + ts = st.touches + for point in ts: + # perform transformation to get into display coordinate system! + y = point['y'] + x = 4096 - point['x'] + x = 2 * x // 30 + y = 8 * y // 90 + display.fill_rectangle(x-2, y-2, 4, 4, color565(255, 0, 0)) diff --git a/examples/stmpe610_simpletest.py b/examples/stmpe610_simpletest.py new file mode 100644 index 0000000..fd0000c --- /dev/null +++ b/examples/stmpe610_simpletest.py @@ -0,0 +1,11 @@ +import busio +import board +import digitalio +from adafruit_stmpe610 import Adafruit_STMPE610_SPI +spi=busio.SPI(board.SCK,board.MOSI,board.MISO) +cs = digitalio.DigitalInOut(board.D6) +st=Adafruit_STMPE610_SPI(spi,cs) +print("Go Ahead - Touch the Screen - Make My Day!") +while True: + if not st.buffer_empty: + print(st.read_data()) diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..7053ecf --- /dev/null +++ b/requirements.txt @@ -0,0 +1,2 @@ +adafruit-circuitpython-bus-device +adafruit-circuitpython-register