From f7688a9335a182f82f6dee73f4405e17f0c10818 Mon Sep 17 00:00:00 2001 From: Scott Shawcroft Date: Wed, 6 Dec 2017 11:47:25 -0800 Subject: [PATCH] Update to new build process and add lint. This also fixes lint errors with no external API changes. --- .gitignore | 4 +- .pylintrc | 433 ++++++++++++++++++++++++++ .travis.yml | 69 ++-- adafruit_circuitplayground/express.py | 112 +++++-- readthedocs.yml | 3 +- 5 files changed, 540 insertions(+), 81 deletions(-) create mode 100644 .pylintrc diff --git a/.gitignore b/.gitignore index 7183fce..a7becc0 100644 --- a/.gitignore +++ b/.gitignore @@ -4,5 +4,7 @@ dist *.pyc _build/ *.mpy -build/ .DS_Store +.env +build* +bundles diff --git a/.pylintrc b/.pylintrc new file mode 100644 index 0000000..64f46ab --- /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,i,j,k,n,ex,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=2 + + +[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 a7b3b63..8084f64 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_circuitplayground.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-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_circuitplayground/*.py + - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name examples/*.py) + - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-circuitplayground --library_location . diff --git a/adafruit_circuitplayground/express.py b/adafruit_circuitplayground/express.py index 1b60860..1b91bb8 100755 --- a/adafruit_circuitplayground/express.py +++ b/adafruit_circuitplayground/express.py @@ -1,35 +1,78 @@ +# The MIT License (MIT) +# +# Copyright (c) 2016 Scott Shawcroft for Adafruit Industries +# Copyright (c) 2017 Kattni Rembor 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. + +# We have a lot of attributes for this complex sensor. +# pylint: disable=too-many-instance-attributes + +""" +`adafruit_circuitplayground.express` +==================================================== + +CircuitPython driver from `CircuitPlayground Express `_. + +* Author(s): Kattni Rembor, Scott Shawcroft +""" + +import array +import math import sys +import time +# pylint: disable=wrong-import-position sys.path.insert(0, ".frozen") # prefer frozen modules over local import adafruit_lis3dh import adafruit_thermistor import analogio -import array import audioio import board import busio import digitalio -import math import neopixel -import time import touchio +__version__ = "0.0.0-auto.0" +__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_CircuitPlayground.git" + class Photocell: + """Simple driver for analog photocell on the CircuitPlayground Express.""" + # pylint: disable=too-few-public-methods def __init__(self, pin): self._photocell = analogio.AnalogIn(pin) # TODO(tannewt): Calibrate this against another calibrated sensor. @property - def value(self): + def light(self): + """Light level in SI Lux.""" return self._photocell.value * 330 // (2 ** 16) class Express: """Represents a single CircuitPlayground Express. Do not use more than one at a time.""" def __init__(self): - # Only create the circuit module member when we're aren't being imported by Sphinx - if "__module__" in dir(digitalio.DigitalInOut) and digitalio.DigitalInOut.__module__ == "sphinx.ext.autodoc": + # Only create the cpx module member when we're aren't being imported by Sphinx + if ("__module__" in dir(digitalio.DigitalInOut) and + digitalio.DigitalInOut.__module__ == "sphinx.ext.autodoc"): return self._a = digitalio.DigitalInOut(board.BUTTON_A) self._a.switch_to_input(pull=digitalio.Pull.DOWN) @@ -52,10 +95,14 @@ def __init__(self): # Define audio: self._speaker_enable = digitalio.DigitalInOut(board.SPEAKER_ENABLE) self._speaker_enable.switch_to_output(value=False) - self.sample = None - self.sine_wave = None + self._sample = None + self._sine_wave = None # Define touch: + # We chose these verbose touch_A# names so that beginners could use it without understanding + # lists and the capital A to match the pin name. The capitalization is not strictly Python + # style, so everywhere we use these names, we whitelist the errors using: + # pylint: disable=invalid-name self._touch_A1 = None self._touch_A2 = None self._touch_A3 = None @@ -68,6 +115,11 @@ def __init__(self): self._i2c = busio.I2C(board.ACCELEROMETER_SCL, board.ACCELEROMETER_SDA) self._lis3dh = adafruit_lis3dh.LIS3DH_I2C(self._i2c, address=0x19) self._lis3dh.range = adafruit_lis3dh.RANGE_8_G + + # Enables FIFO stream mode and then sets it to stream mode. + # TODO(tdicola): Replace this with code that doesn't call an internal (starts with _) + # method. https://github.com/adafruit/Adafruit_CircuitPython_LIS3DH/issues/14 + # pylint: disable=protected-access self._lis3dh._write_register_byte(adafruit_lis3dh.REG_CTRL5, 0b01001000) self._lis3dh._write_register_byte(0x2E, 0b10000000) @@ -124,7 +176,7 @@ def shake(self): @property - def touch_A1(self): + def touch_A1(self): # pylint: disable=invalid-name """Detect touch on capacitive touch pad A1. .. image :: /_static/capacitive_touch_pad_A1.jpg @@ -143,7 +195,7 @@ def touch_A1(self): return self._touch_A1.value @property - def touch_A2(self): + def touch_A2(self): # pylint: disable=invalid-name """Detect touch on capacitive touch pad A2. .. image :: /_static/capacitive_touch_pad_A2.jpg @@ -162,7 +214,7 @@ def touch_A2(self): return self._touch_A2.value @property - def touch_A3(self): + def touch_A3(self): # pylint: disable=invalid-name """Detect touch on capacitive touch pad A3. .. image :: /_static/capacitive_touch_pad_A3.jpg @@ -181,7 +233,7 @@ def touch_A3(self): return self._touch_A3.value @property - def touch_A4(self): + def touch_A4(self): # pylint: disable=invalid-name """Detect touch on capacitive touch pad A4. .. image :: /_static/capacitive_touch_pad_A4.jpg @@ -200,7 +252,7 @@ def touch_A4(self): return self._touch_A4.value @property - def touch_A5(self): + def touch_A5(self): # pylint: disable=invalid-name """Detect touch on capacitive touch pad A5. .. image :: /_static/capacitive_touch_pad_A5.jpg @@ -219,7 +271,7 @@ def touch_A5(self): return self._touch_A5.value @property - def touch_A6(self): + def touch_A6(self): # pylint: disable=invalid-name """Detect touch on capacitive touch pad A6. .. image :: /_static/capacitive_touch_pad_A6.jpg @@ -238,7 +290,7 @@ def touch_A6(self): return self._touch_A6.value @property - def touch_A7(self): + def touch_A7(self): # pylint: disable=invalid-name """Detect touch on capacitive touch pad A7. .. image :: /_static/capacitive_touch_pad_A7.jpg @@ -381,7 +433,7 @@ def light(self): print("Lux:", cpx.light) time.sleep(1) """ - return self._light.value + return self._light.light @property def red_led(self): @@ -409,17 +461,17 @@ def red_led(self, value): @staticmethod def _sine_sample(length): - TONE_VOLUME = (2 ** 15) - 1 + tone_volume = (2 ** 15) - 1 shift = 2 ** 15 for i in range(length): - yield int(TONE_VOLUME * math.sin(2*math.pi*(i / length)) + shift) + yield int(tone_volume * math.sin(2*math.pi*(i / length)) + shift) def _generate_sample(self): - if self.sample is not None: + if self._sample is not None: return length = 100 - self.sine_wave = array.array("H", Express._sine_sample(length)) - self.sample = audioio.AudioOut(board.SPEAKER, self.sine_wave) + self._sine_wave = array.array("H", Express._sine_sample(length)) + self._sample = audioio.AudioOut(board.SPEAKER, self._sine_wave) def play_tone(self, frequency, duration): """ Produce a tone using the speaker. Try changing frequency to change @@ -466,9 +518,9 @@ def start_tone(self, frequency): self._speaker_enable.value = True self._generate_sample() # Start playing a tone of the specified frequency (hz). - self.sample.frequency = int(len(self.sine_wave) * frequency) - if not self.sample.playing: - self.sample.play(loop=True) + self._sample.frequency = int(len(self._sine_wave) * frequency) + if not self._sample.playing: + self._sample.play(loop=True) def stop_tone(self): """ Use with start_tone to stop the tone produced. @@ -489,8 +541,8 @@ def stop_tone(self): cpx.stop_tone() """ # Stop playing any tones. - if self.sample is not None and self.sample.playing: - self.sample.stop() + if self._sample is not None and self._sample.playing: + self._sample.stop() self._speaker_enable.value = False def play_file(self, file_name): @@ -513,15 +565,15 @@ def play_file(self, file_name): """ # Play a specified file. self._speaker_enable.value = True - self.a = audioio.AudioOut(board.SPEAKER, open(file_name, "rb")) + audio = audioio.AudioOut(board.SPEAKER, open(file_name, "rb")) - self.a.play() - while self.a.playing: + audio.play() + while audio.playing: pass self._speaker_enable.value = False -cpx = Express() +cpx = Express() # pylint: disable=invalid-name """Object that is automatically created on import. To use, simply import it from the module: diff --git a/readthedocs.yml b/readthedocs.yml index a3a16c1..f4243ad 100644 --- a/readthedocs.yml +++ b/readthedocs.yml @@ -1,2 +1,3 @@ +python: + version: 3 requirements_file: requirements.txt -