diff --git a/.gitignore b/.gitignore index 92d3065..0dd8629 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,6 @@ __pycache__ _build *.pyc +.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 88af11f..aa83b31 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_ads1x15.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_ads1x15/*.py + - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name examples/*.py) + - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-ads1x15 --library_location . diff --git a/adafruit_ads1x15/adafruit_ads1x15.py b/adafruit_ads1x15/adafruit_ads1x15.py index 3433eee..b2e4c1f 100644 --- a/adafruit_ads1x15/adafruit_ads1x15.py +++ b/adafruit_ads1x15/adafruit_ads1x15.py @@ -20,27 +20,32 @@ # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN # THE SOFTWARE. """ -`adafruit__ads1x15` +`adafruit_ads1x15` ==================================================== CircuitPython driver for ADS1015/1115 ADCs. * Author(s): Carter Nelson """ + +__version__ = "0.0.0-auto.0" +__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_ADS1x15.git" + import time from micropython import const from adafruit_bus_device.i2c_device import I2CDevice # Register and other configuration values: -ADS1x15_DEFAULT_ADDRESS = const(0x48) -ADS1x15_POINTER_CONVERSION = const(0x00) -ADS1x15_POINTER_CONFIG = const(0x01) -ADS1x15_POINTER_LOW_THRESHOLD = const(0x02) -ADS1x15_POINTER_HIGH_THRESHOLD = const(0x03) -ADS1x15_CONFIG_OS_SINGLE = const(0x8000) -ADS1x15_CONFIG_MUX_OFFSET = const(12) +# pylint: disable=bad-whitespace +ADS1X15_DEFAULT_ADDRESS = const(0x48) +ADS1X15_POINTER_CONVERSION = const(0x00) +ADS1X15_POINTER_CONFIG = const(0x01) +ADS1X15_POINTER_LOW_THRESHOLD = const(0x02) +ADS1X15_POINTER_HIGH_THRESHOLD = const(0x03) +ADS1X15_CONFIG_OS_SINGLE = const(0x8000) +ADS1X15_CONFIG_MUX_OFFSET = const(12) # Maping of gain values to config register values. -ADS1x15_CONFIG_GAIN = { +ADS1X15_CONFIG_GAIN = { 2/3: 0x0000, 1: 0x0200, 2: 0x0400, @@ -48,7 +53,7 @@ 8: 0x0800, 16: 0x0A00 } -ADS1x15_PGA_RANGE = { +ADS1X15_PGA_RANGE = { 2/3: 6.144, 1: 4.096, 2: 2.048, @@ -56,8 +61,8 @@ 8: 0.512, 16: 0.256 } -ADS1x15_CONFIG_MODE_CONTINUOUS = const(0x0000) -ADS1x15_CONFIG_MODE_SINGLE = const(0x0100) +ADS1X15_CONFIG_MODE_CONTINUOUS = const(0x0000) +ADS1X15_CONFIG_MODE_SINGLE = const(0x0100) # Mapping of data/sample rate to config register values for ADS1015 (faster). ADS1015_CONFIG_DR = { 128: 0x0000, @@ -79,21 +84,22 @@ 475: 0x00C0, 860: 0x00E0 } -ADS1x15_CONFIG_COMP_WINDOW = const(0x0010) -ADS1x15_CONFIG_COMP_ACTIVE_HIGH = const(0x0008) -ADS1x15_CONFIG_COMP_LATCHING = const(0x0004) -ADS1x15_CONFIG_COMP_QUE = { +ADS1X15_CONFIG_COMP_WINDOW = const(0x0010) +ADS1X15_CONFIG_COMP_ACTIVE_HIGH = const(0x0008) +ADS1X15_CONFIG_COMP_LATCHING = const(0x0004) +ADS1X15_CONFIG_COMP_QUE = { 1: 0x0000, 2: 0x0001, 4: 0x0002 } -ADS1x15_CONFIG_COMP_QUE_DISABLE = const(0x0003) -ADS1x15_DIFF_CHANNELS = { +ADS1X15_CONFIG_COMP_QUE_DISABLE = const(0x0003) +ADS1X15_DIFF_CHANNELS = { (0,1): 0, (0,3): 1, (1,3): 2, (2,3): 3 } +# pylint: enable=bad-whitespace class ADC_Channel(object): """Provides per channel access to ADC readings.""" @@ -105,18 +111,18 @@ def __init__(self, adc, channel): @property def value(self, ): """ADC reading in raw counts.""" - return self._adc._read_channel(self._channel) + return self._adc._read_channel(self._channel) # pylint: disable=protected-access @property def volts(self, ): """ADC reading in volts.""" - return self._adc._read_channel_volts(self._channel) + return self._adc._read_channel_volts(self._channel) # pylint: disable=protected-access class ADS1x15(object): """Base functionality for ADS1x15 analog to digital converters.""" - def __init__(self, i2c, address=ADS1x15_DEFAULT_ADDRESS, **kwargs): + def __init__(self, i2c, address=ADS1X15_DEFAULT_ADDRESS): self.buf = bytearray(3) self.i2c_device = I2CDevice(i2c, address) self.bits = None @@ -162,13 +168,13 @@ def _read(self, mux, gain, data_rate, mode): """Perform an ADC read with the provided mux, gain, data_rate, and mode values. Returns the signed integer result of the read. """ - config = ADS1x15_CONFIG_OS_SINGLE # Go out of power-down mode for conversion. + config = ADS1X15_CONFIG_OS_SINGLE # Go out of power-down mode for conversion. # Specify mux value. - config |= (mux & 0x07) << ADS1x15_CONFIG_MUX_OFFSET + config |= (mux & 0x07) << ADS1X15_CONFIG_MUX_OFFSET # Validate the passed in gain and then set it in the config. - if gain not in ADS1x15_CONFIG_GAIN: + if gain not in ADS1X15_CONFIG_GAIN: raise ValueError('Gain must be one of: 2/3, 1, 2, 4, 8, 16') - config |= ADS1x15_CONFIG_GAIN[gain] + config |= ADS1X15_CONFIG_GAIN[gain] # Set the mode (continuous or single shot). config |= mode # Get the default data rate if none is specified (default differs between @@ -178,10 +184,10 @@ def _read(self, mux, gain, data_rate, mode): # Set the data rate (this is controlled by the subclass as it differs # between ADS1015 and ADS1115). config |= self._data_rate_config(data_rate) - config |= ADS1x15_CONFIG_COMP_QUE_DISABLE # Disble comparator mode. + config |= ADS1X15_CONFIG_COMP_QUE_DISABLE # Disble comparator mode. # Send the config value to start the ADC conversion. # Explicitly break the 16-bit value down to a big endian pair of bytes. - self.buf[0] = ADS1x15_POINTER_CONFIG + self.buf[0] = ADS1X15_POINTER_CONFIG self.buf[1] = (config >> 8) & 0xFF self.buf[2] = config & 0xFF with self.i2c_device as i2c: @@ -190,7 +196,7 @@ def _read(self, mux, gain, data_rate, mode): # small offset to be sure (0.1 millisecond). time.sleep(1.0/data_rate+0.0001) # Retrieve the result. - self.buf[0] = ADS1x15_POINTER_CONVERSION + self.buf[0] = ADS1X15_POINTER_CONVERSION i2c.write(self.buf, end=1, stop=False) i2c.readinto(self.buf, start=1) return self._conversion_value(self.buf[2], self.buf[1]) @@ -200,7 +206,7 @@ def stop_adc(self): """ # Set the config register to its default value of 0x8583 to stop # continuous conversions. - self.buf[0] = ADS1x15_POINTER_CONFIG + self.buf[0] = ADS1X15_POINTER_CONFIG self.buf[1] = 0x85 self.buf[2] = 0x83 with self.i2c_device as i2c: @@ -212,7 +218,7 @@ def get_last_result(self): """ # Retrieve the conversion register value, convert to a signed int, and # return it. - self.buf[0] = ADS1x15_POINTER_CONVERSION + self.buf[0] = ADS1X15_POINTER_CONVERSION with self.i2c_device as i2c: i2c.write(self.buf, end=1, stop=False) i2c.readinto(self.buf, start=1) diff --git a/adafruit_ads1x15/differential.py b/adafruit_ads1x15/differential.py index 0a9a08c..1e1f9be 100644 --- a/adafruit_ads1x15/differential.py +++ b/adafruit_ads1x15/differential.py @@ -1,11 +1,47 @@ -from .adafruit_ads1x15 import * - +# The MIT License (MIT) +# +# Copyright (c) 2017 Carter Nelson for Adafruit Industries +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), to deal +# in the Software without restriction, including without limitation the rights +# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +# copies of the Software, and to permit persons to whom the Software is +# furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +# THE SOFTWARE. +""" +`adafruit_ads1x15.differential` +==================================================== + +Differential driver for ADS1015/1115 ADCs. + +* Author(s): Carter Nelson +""" + +__version__ = "0.0.0-auto.0" +__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_ADS1x15.git" + +from .adafruit_ads1x15 import ADS1x15, ADS1X15_DIFF_CHANNELS +from .adafruit_ads1x15 import ADS1X15_CONFIG_MODE_SINGLE, ADS1X15_CONFIG_MODE_CONTINUOUS +from .adafruit_ads1x15 import ADS1X15_PGA_RANGE, ADS1015_CONFIG_DR, ADS1115_CONFIG_DR + +# pylint: disable=abstract-method class ADS1x15_Differential(ADS1x15): """Base functionality for ADS1x15 analog to digital converters operating in differential mode.""" def __getitem__(self, key): - return self._channels[ADS1x15_DIFF_CHANNELS[key]] + return self._channels[ADS1X15_DIFF_CHANNELS[key]] def read_adc_difference(self, differential, gain=1, data_rate=None): """Read the difference between two ADC channels and return the ADC value @@ -18,7 +54,7 @@ def read_adc_difference(self, differential, gain=1, data_rate=None): assert 0 <= differential <= 3, 'Differential must be a value within 0-3!' # Perform a single shot read using the provided differential value # as the mux value (which will enable differential mode). - return self._read(differential, gain, data_rate, ADS1x15_CONFIG_MODE_SINGLE) + return self._read(differential, gain, data_rate, ADS1X15_CONFIG_MODE_SINGLE) def read_volts_difference(self, differential, gain=1, data_rate=None): """Read the difference between two ADC channels and return the voltage value @@ -30,7 +66,7 @@ def read_volts_difference(self, differential, gain=1, data_rate=None): """ assert 0 <= differential <= 3, 'Differential must be a value within 0-3!' raw = self.read_adc_difference(differential, gain, data_rate) - volts = raw * (ADS1x15_PGA_RANGE[gain] / (2**(self.bits-1) - 1)) + volts = raw * (ADS1X15_PGA_RANGE[gain] / (2**(self.bits-1) - 1)) return volts def start_adc_difference(self, differential, gain=1, data_rate=None): @@ -47,7 +83,8 @@ def start_adc_difference(self, differential, gain=1, data_rate=None): assert 0 <= differential <= 3, 'Differential must be a value within 0-3!' # Perform a single shot read using the provided differential value # as the mux value (which will enable differential mode). - return self._read(differential, gain, data_rate, ADS1x15_CONFIG_MODE_CONTINUOUS) + return self._read(differential, gain, data_rate, ADS1X15_CONFIG_MODE_CONTINUOUS) +# pylint: enable=abstract-method class ADS1015(ADS1x15_Differential): """ADS1015 12-bit differential analog to digital converter instance.""" diff --git a/adafruit_ads1x15/single_ended.py b/adafruit_ads1x15/single_ended.py index bbd0323..eca1313 100644 --- a/adafruit_ads1x15/single_ended.py +++ b/adafruit_ads1x15/single_ended.py @@ -1,5 +1,41 @@ -from .adafruit_ads1x15 import * - +# The MIT License (MIT) +# +# Copyright (c) 2017 Carter Nelson for Adafruit Industries +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), to deal +# in the Software without restriction, including without limitation the rights +# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +# copies of the Software, and to permit persons to whom the Software is +# furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +# THE SOFTWARE. +""" +`adafruit_ads1x15.single_ended` +==================================================== + +Single-ended driver for ADS1015/1115 ADCs. + +* Author(s): Carter Nelson +""" + +__version__ = "0.0.0-auto.0" +__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_ADS1x15.git" + +from .adafruit_ads1x15 import ADS1x15 +from .adafruit_ads1x15 import ADS1X15_CONFIG_MODE_SINGLE, ADS1X15_CONFIG_MODE_CONTINUOUS +from .adafruit_ads1x15 import ADS1X15_PGA_RANGE, ADS1015_CONFIG_DR, ADS1115_CONFIG_DR + +# pylint: disable=abstract-method class ADS1x15_SingleEnded(ADS1x15): """Base functionality for ADS1x15 analog to digital converters operating in single ended mode.""" @@ -14,7 +50,7 @@ def read_adc(self, channel, gain=1, data_rate=None): assert 0 <= channel <= 3, 'Channel must be a value within 0-3!' # Perform a single shot read and set the mux value to the channel plus # the highest bit (bit 3) set. - return self._read(channel + 0x04, gain, data_rate, ADS1x15_CONFIG_MODE_SINGLE) + return self._read(channel + 0x04, gain, data_rate, ADS1X15_CONFIG_MODE_SINGLE) def read_volts(self, channel, gain=1, data_rate=None): """Read a single ADC channel and return the voltage value as a floating point @@ -22,7 +58,7 @@ def read_volts(self, channel, gain=1, data_rate=None): """ assert 0 <= channel <= 3, 'Channel must be a value within 0-3!' raw = self.read_adc(channel, gain, data_rate) - volts = raw * (ADS1x15_PGA_RANGE[gain] / (2**(self.bits-1) - 1)) + volts = raw * (ADS1X15_PGA_RANGE[gain] / (2**(self.bits-1) - 1)) return volts def start_adc(self, channel, gain=1, data_rate=None): @@ -34,7 +70,8 @@ def start_adc(self, channel, gain=1, data_rate=None): assert 0 <= channel <= 3, 'Channel must be a value within 0-3!' # Start continuous reads and set the mux value to the channel plus # the highest bit (bit 3) set. - return self._read(channel + 0x04, gain, data_rate, ADS1x15_CONFIG_MODE_CONTINUOUS) + return self._read(channel + 0x04, gain, data_rate, ADS1X15_CONFIG_MODE_CONTINUOUS) +# pylint: enable=abstract-method class ADS1015(ADS1x15_SingleEnded): """ADS1015 12-bit single ended analog to digital converter instance.""" 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 -