From 961e581ce5da38cf2eea4d53bd245241efe357a4 Mon Sep 17 00:00:00 2001 From: Scott Shawcroft Date: Thu, 7 Dec 2017 17:13:23 -0800 Subject: [PATCH 1/2] Update to new build process and turn on lint. This also standardizes the README and CODE_OF_CONDUCT. I haven't tested these changes on device yet. Please only merge you test it or I follow up later to say its tested. For https://github.com/adafruit/circuitpython/issues/475 --- .gitignore | 4 +- .pylintrc | 432 ++++++++++++++++++ .travis.yml | 69 +-- CODE_OF_CONDUCT.md | 74 +++ README.md | 5 - README.rst | 66 +++ .../lis3dh.py => adafruit_lis3dh.py | 35 +- adafruit_lis3dh/__init__.py | 1 - api.rst | 5 + conf.py | 142 ++++++ examples/spinner.py | 7 +- examples/spinner_advanced.py | 7 +- readthedocs.yml | 3 + requirements.txt | 0 14 files changed, 781 insertions(+), 69 deletions(-) create mode 100644 .pylintrc create mode 100644 CODE_OF_CONDUCT.md delete mode 100644 README.md create mode 100644 README.rst rename adafruit_lis3dh/lis3dh.py => adafruit_lis3dh.py (92%) delete mode 100755 adafruit_lis3dh/__init__.py create mode 100644 api.rst create mode 100644 conf.py create mode 100644 readthedocs.yml create mode 100644 requirements.txt diff --git a/.gitignore b/.gitignore index c3adf00..fa20fae 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,5 @@ .DS_Store *.mpy - +.env +build* +bundles diff --git a/.pylintrc b/.pylintrc new file mode 100644 index 0000000..946d694 --- /dev/null +++ b/.pylintrc @@ -0,0 +1,432 @@ +[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 + + +[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/.travis.yml b/.travis.yml index 530605b..f642537 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,59 +1,30 @@ -# Travis CI configuration for automated .mpy file generation. -# Version: 2.0 (support for both .mpy and packages) -# Author: Tony DiCola -# License: Public Domain -# This configuration will work with Travis CI (travis-ci.org) to automacially -# build .mpy files and packages for MicroPython 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 or -# package .zip files that should be generated. -# For each .mpy file listed 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! -# For each .zip file listed the config will assume a folder with the same -# name exists (minus the .zip extension) and will recursively walk the folder -# to generate .mpy versions of all .py files EXCEPT __init__.py (not supported -# right now because of a bug). Then a zip of the directory will be generated -# with just the .mpy and __init__.py files. -# 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 +# 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. -sudo: true +dist: trusty +sudo: false +language: python +python: + - "3.6" + +cache: + pip: true deploy: provider: releases api_key: $GITHUB_TOKEN - file: - - adafruit_lis3dh.zip + file_glob: true + file: bundles/* skip_cleanup: true on: tags: true -before_install: - - wget https://raw.githubusercontent.com/adafruit/MicroPython_TravisCI_Deploy/master/install_dependencies.sh - - chmod +x install_dependencies.sh - - source install_dependencies.sh +install: + - pip install pylint circuitpython-travis-build-tools -before_deploy: - - wget https://raw.githubusercontent.com/adafruit/MicroPython_TravisCI_Deploy/master/build_release.sh - - chmod +x build_release.sh - - ./build_release.sh +script: + - pylint adafruit_lis3dh.py + - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name examples/*.py) + - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-lis3dh --library_location . 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/README.md b/README.md deleted file mode 100644 index c5bc695..0000000 --- a/README.md +++ /dev/null @@ -1,5 +0,0 @@ -# Adafruit CircuitPython LIS3DH - -Adafruit CircuitPython module for the LIS3DH accelerometer. Note this module -is currently made to work with CircuitPython and not MicroPython APIs. See the guide at: -https://learn.adafruit.com/circuitpython-hardware-lis3dh-accelerometer diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..a2b5c63 --- /dev/null +++ b/README.rst @@ -0,0 +1,66 @@ + +Introduction +============ + +.. image:: https://readthedocs.org/projects/adafruit-circuitpython-lis3dh/badge/?version=latest + :target: https://circuitpython.readthedocs.io/projects/lis3dh/en/latest/ + :alt: Documentation Status + +.. image :: https://img.shields.io/discord/327254708534116352.svg + :target: https://discord.gg/nBQh6qu + :alt: Discord + +Adafruit CircuitPython module for the LIS3DH accelerometer. + +Note this module is made to work with CircuitPython and not MicroPython APIs. + +See the guide at: https://learn.adafruit.com/circuitpython-hardware-lis3dh-accelerometer + +Dependencies +============= +This driver depends on: + +* `Adafruit CircuitPython `_ + +Please ensure all dependencies are available on the CircuitPython filesystem. +This is easily achieved by downloading +`the Adafruit library and driver bundle `_. + +API Reference +============= + +.. toctree:: + :maxdepth: 2 + + api + +Contributing +============ + +Contributions are welcome! Please read our `Code of Conduct +`_ +before contributing to help this project stay welcoming. + +Building locally +================ + +To build this library locally you'll need to install the +`circuitpython-travis-build-tools `_ package. + +.. code-block::shell + + python3 -m venv .env + source .env/bin/activate + pip install -r requirements.txt + +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-lis3dh --library_location . diff --git a/adafruit_lis3dh/lis3dh.py b/adafruit_lis3dh.py similarity index 92% rename from adafruit_lis3dh/lis3dh.py rename to adafruit_lis3dh.py index 205602c..d59d32e 100755 --- a/adafruit_lis3dh/lis3dh.py +++ b/adafruit_lis3dh.py @@ -3,16 +3,31 @@ # https://github.com/adafruit/Adafruit_LIS3DH/ # Author: Tony DiCola # License: MIT License (https://en.wikipedia.org/wiki/MIT_License) +""" +`adafruit_lis3dh` +==================================================== + +CircuitPython driver for the LIS3DH accelerometer. + +See examples in the examples directory. + +* Author(s): Tony DiCola +""" + +import time +import math try: import struct except ImportError: import ustruct as struct from micropython import const -import time -import math + +__version__ = "0.0.0-auto.0" +__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_LIS3DH.git" # Register addresses: +# pylint: disable=bad-whitespace REG_OUTADC1_L = const(0x08) REG_WHOAMI = const(0x0F) REG_TEMPCFG = const(0x1F) @@ -43,10 +58,11 @@ DATARATE_POWERDOWN = const(0) DATARATE_LOWPOWER_1K6HZ = const(0b1000) DATARATE_LOWPOWER_5KHZ = const(0b1001) +# pylint: enable=bad-whitespace class LIS3DH: - + """Driver base for the LIS3DH accelerometer.""" def __init__(self): # Check device ID. device_id = self._read_register_byte(REG_WHOAMI) @@ -97,9 +113,7 @@ def range(self, range_value): @property def acceleration(self): - """Read the x, y, z acceleration values. These values are returned in - a 3-tuple and are in m / s ^ 2. - """ + """The x, y, z acceleration values returned in a 3-tuple and are in m / s ^ 2.""" divider = 1 accel_range = self.range if accel_range == RANGE_16_G: @@ -128,7 +142,7 @@ def shake(self, shake_threshold=30, avg_count=10, total_delay=0.1): readings from acceleration. (Default 0.1) """ shake_accel = (0, 0, 0) - for i in range(avg_count): + for _ in range(avg_count): # shake_accel creates a list of tuples from acceleration data. # zip takes multiple tuples and zips them together, as in: # In : zip([-0.2, 0.0, 9.5], [37.9, 13.5, -72.8]) @@ -151,7 +165,7 @@ def read_adc_raw(self, adc): return struct.unpack(' 0, raw & 0x20 > 0) - def set_click(self, click, threshold, time_limit=10, time_latency=20, time_window=255, click_cfg=None): + def set_click(self, click, threshold, *, + time_limit=10, time_latency=20, time_window=255, click_cfg=None): """Set the click detection parameters. Must specify at least: click - Set to 0 to disable click detection, 1 to detect only single clicks, and 2 to detect single & double clicks. @@ -235,6 +250,7 @@ def _write_register_byte(self, register, value): class LIS3DH_I2C(LIS3DH): + """Driver for the LIS3DH accelerometer connected over I2C.""" def __init__(self, i2c, address=0x18): import adafruit_bus_device.i2c_device as i2c_device @@ -257,6 +273,7 @@ def _write_register_byte(self, register, value): class LIS3DH_SPI(LIS3DH): + """Driver for the LIS3DH accelerometer connected over SPI.""" def __init__(self, spi, cs, baudrate=100000): import adafruit_bus_device.spi_device as spi_device diff --git a/adafruit_lis3dh/__init__.py b/adafruit_lis3dh/__init__.py deleted file mode 100755 index 261ef5a..0000000 --- a/adafruit_lis3dh/__init__.py +++ /dev/null @@ -1 +0,0 @@ -from adafruit_lis3dh.lis3dh import * diff --git a/api.rst b/api.rst new file mode 100644 index 0000000..0a1245e --- /dev/null +++ b/api.rst @@ -0,0 +1,5 @@ + +.. If you created a package, create one automodule per module in the package. + +.. automodule:: adafruit_lis3dh.lis3dh + :members: diff --git a/conf.py b/conf.py new file mode 100644 index 0000000..d24516a --- /dev/null +++ b/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),'BusDevice': ('https://circuitpython.readthedocs.io/projects/bus_device/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 = 'README' + +# General information about the project. +project = u'Adafruit VL53L0X Library' +copyright = u'2017 Tony DiCola' +author = u'Tony DiCola' + +# 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 = 'AdafruitVL53L0XLibrarydoc' + +# -- 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, 'AdafruitVL53L0XLibrary.tex', u'Adafruit VL53L0X 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, 'adafruitVL53L0Xlibrary', u'Adafruit VL53L0X 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, 'AdafruitVL53L0XLibrary', u'Adafruit VL53L0X Library Documentation', + author, 'AdafruitVL53L0XLibrary', 'One line description of project.', + 'Miscellaneous'), +] diff --git a/examples/spinner.py b/examples/spinner.py index e891f37..2b2023e 100644 --- a/examples/spinner.py +++ b/examples/spinner.py @@ -6,6 +6,7 @@ # https://github.com/adafruit/Adafruit_CircuitPython_NeoPixel # Author: Tony DiCola # License: MIT License (https://opensource.org/licenses/MIT) +# pylint: disable=redefined-outer-name import math import time @@ -17,7 +18,7 @@ # Configuration: -ACCEL_RANGE = adafruit_lis3dh.RANGE_16_G # Accelerometer range. +ACCEL_RANGE = adafruit_lis3dh.RANGE_16_G # Accelerometer range. TAP_THRESHOLD = 20 # Accelerometer tap threshold. Higher values # mean you need to tap harder to start a spin. SPINNER_DECAY = 0.5 # Decay rate for the spinner. Set to a value @@ -55,7 +56,7 @@ def get_position(self, delta): # Initialize NeoPixels and accelerometer. pixels = neopixel.NeoPixel(board.NEOPIXEL, 10, auto_write=False) -pixels.fill((0,0,0)) +pixels.fill((0, 0, 0)) pixels.show() i2c = busio.I2C(board.ACCELEROMETER_SCL, board.ACCELEROMETER_SDA) lis3dh = adafruit_lis3dh.LIS3DH_I2C(i2c, address=25) @@ -69,8 +70,10 @@ def get_position(self, delta): # call internal methods that change a few register values. This must be done # AFTER calling set_click above because the set_click function also changes # REG_CTRL5. +# pylint: disable=protected-access lis3dh._write_register_byte(adafruit_lis3dh.REG_CTRL5, 0b01001000) lis3dh._write_register_byte(0x2E, 0b10000000) # Set FIFO_CTRL to Stream mode. +# pylint: disable=protected-access # Create a fidget spinner object. spinner = FidgetSpinner(SPINNER_DECAY) diff --git a/examples/spinner_advanced.py b/examples/spinner_advanced.py index a973b7c..0fe00b3 100644 --- a/examples/spinner_advanced.py +++ b/examples/spinner_advanced.py @@ -12,6 +12,7 @@ # https://github.com/adafruit/Adafruit_CircuitPython_NeoPixel # Author: Tony DiCola # License: MIT License (https://opensource.org/licenses/MIT) +# pylint: disable=redefined-outer-name import math import time @@ -24,7 +25,7 @@ # Configuration: -ACCEL_RANGE = adafruit_lis3dh.RANGE_16_G # Accelerometer range. +ACCEL_RANGE = adafruit_lis3dh.RANGE_16_G # Accelerometer range. TAP_THRESHOLD = 20 # Accelerometer tap threshold. Higher values # mean you need to tap harder to start a spin. SPINNER_DECAY = 0.5 # Decay rate for the spinner. Set to a value @@ -162,7 +163,7 @@ def update(self, position, primary, secondary): # Initialize and turn off NeoPixels. pixels = neopixel.NeoPixel(board.NEOPIXEL, 10, auto_write=False) -pixels.fill((0,0,0)) +pixels.fill((0, 0, 0)) pixels.show() # Initialize buttons. @@ -190,8 +191,10 @@ def update(self, position, primary, secondary): # readings in a FIFO buffer so they can be read later to see a history of # recent acceleration. This is handy to look for the maximum/minimum impulse # after a click is detected. +# pylint: disable=protected-access lis3dh._write_register_byte(adafruit_lis3dh.REG_CTRL5, 0b01001000) lis3dh._write_register_byte(0x2E, 0b10000000) # Set FIFO_CTRL to Stream mode. +# pylint: disable=protected-access # Create a fidget spinner object. spinner = FidgetSpinner(SPINNER_DECAY) 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/requirements.txt b/requirements.txt new file mode 100644 index 0000000..e69de29 From 318aebf0bf53a528e93794dae25d8c8cc0642875 Mon Sep 17 00:00:00 2001 From: Kattni Date: Sat, 9 Dec 2017 14:33:12 -0500 Subject: [PATCH 2/2] Update .travis.yml --- .travis.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.travis.yml b/.travis.yml index f642537..ae17fd9 100644 --- a/.travis.yml +++ b/.travis.yml @@ -22,7 +22,7 @@ deploy: tags: true install: - - pip install pylint circuitpython-travis-build-tools + - pip install pylint circuitpython-build-tools script: - pylint adafruit_lis3dh.py