From 96e0afc8e8f3274a71da1da4d2ea5de572b911f0 Mon Sep 17 00:00:00 2001 From: Scott Shawcroft Date: Fri, 8 Dec 2017 13:57:20 -0800 Subject: [PATCH 1/2] Update to new build process and turn on lint. 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 | 3 + .pylintrc | 432 +++++++++++++++++++++ .travis.yml | 63 +-- adafruit_ina219.py | 829 ++++++++++++++++++---------------------- examples/get_current.py | 31 +- readthedocs.yml | 3 +- 6 files changed, 846 insertions(+), 515 deletions(-) create mode 100644 .pylintrc 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 c99f778..225d601 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,53 +1,30 @@ -# Travis CI configuration for automated .mpy file generation. -# Author: Tony DiCola -# License: Public Domain -# This configuration will work with Travis CI (travis-ci.org) to automacially -# build .mpy files for CircuitPython when a new tagged release is created. This -# file is relatively generic and can be shared across multiple repositories by -# following these steps: -# 1. Copy this file into a .travis.yml file in the root of the repository. -# 2. Change the deploy > file section below to list each of the .mpy files -# that should be generated. The config will automatically look for -# .py files with the same name as the source for generating the .mpy files. -# Note that the .mpy extension should be lower case! -# 3. Commit the .travis.yml file and push it to GitHub. -# 4. Go to travis-ci.org and find the repository (it needs to be setup to access -# your github account, and your github account needs access to write to the -# repo). Flip the 'ON' switch on for Travis and the repo, see the Travis -# docs for more details: https://docs.travis-ci.com/user/getting-started/ -# 5. Get a GitHub 'personal access token' which has at least 'public_repo' or -# 'repo' scope: https://help.github.com/articles/creating-an-access-token-for-command-line-use/ -# Keep this token safe and secure! Anyone with the token will be able to -# access and write to your GitHub repositories. Travis will use the token -# to attach the .mpy files to the release. -# 6. In the Travis CI settings for the repository that was enabled find the -# environment variable editing page: https://docs.travis-ci.com/user/environment-variables/#Defining-Variables-in-Repository-Settings -# Add an environment variable named GITHUB_TOKEN and set it to the value -# of the GitHub personal access token above. Keep 'Display value in build -# log' flipped off. -# 7. That's it! Tag a release and Travis should go to work to add .mpy files -# to the release. It takes about a 2-3 minutes for a worker to spin up, -# build mpy-cross, and add the binaries to the release. -language: generic +# 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_ina219.mpy" + file_glob: true + file: bundles/* skip_cleanup: true on: tags: true -before_install: -- sudo apt-get -yqq update -- sudo apt-get install -y build-essential git python python-pip -- git clone https://github.com/adafruit/circuitpython.git -b 2.x -- make -C circuitpython/mpy-cross -- export PATH=$PATH:$PWD/circuitpython/mpy-cross/ -- sudo pip install shyaml +install: + - pip install pylint circuitpython-travis-build-tools -before_deploy: -- shyaml get-values deploy.file < .travis.yml | sed 's/.mpy/.py/' | xargs -L1 mpy-cross +script: + - pylint adafruit_ina219.py + - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name examples/*.py) + - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-ina219 --library_location . diff --git a/adafruit_ina219.py b/adafruit_ina219.py index e763311..31e0ec1 100644 --- a/adafruit_ina219.py +++ b/adafruit_ina219.py @@ -23,7 +23,7 @@ `adafruit_ina219` ==================================================== -TODO(description) +CircuitPython driver for the `INA219 current sensor `_. * Author(s): Dean Miller """ @@ -31,455 +31,382 @@ from micropython import const from adafruit_bus_device.i2c_device import I2CDevice -""" -BITS -""" -INA219_READ = const(0x01) - - -""" -CONFIG REGISTER (R/W) -""" -INA219_REG_CONFIG = const(0x00) -INA219_CONFIG_RESET = const(0x8000) # Reset Bit - -INA219_CONFIG_BVOLTAGERANGE_MASK = const(0x2000) # Bus Voltage Range Mask -INA219_CONFIG_BVOLTAGERANGE_16V = const(0x0000) # 0-16V Range -INA219_CONFIG_BVOLTAGERANGE_32V = const(0x2000) # 0-32V Range - -INA219_CONFIG_GAIN_MASK = const(0x1800) # Gain Mask -INA219_CONFIG_GAIN_1_40MV = const(0x0000) # Gain 1, 40mV Range -INA219_CONFIG_GAIN_2_80MV = const(0x0800) # Gain 2, 80mV Range -INA219_CONFIG_GAIN_4_160MV = const(0x1000) # Gain 4, 160mV Range -INA219_CONFIG_GAIN_8_320MV = const(0x1800) # Gain 8, 320mV Range - -INA219_CONFIG_BADCRES_MASK = const(0x0780) # Bus ADC Resolution Mask -INA219_CONFIG_BADCRES_9BIT = const(0x0080) # 9-bit bus res = 0..511 -INA219_CONFIG_BADCRES_10BIT = const(0x0100) # 10-bit bus res = 0..1023 -INA219_CONFIG_BADCRES_11BIT = const(0x0200) # 11-bit bus res = 0..2047 -INA219_CONFIG_BADCRES_12BIT = const(0x0400) # 12-bit bus res = 0..4097 - -INA219_CONFIG_SADCRES_MASK = const(0x0078) # Shunt ADC Resolution and Averaging Mask -INA219_CONFIG_SADCRES_9BIT_1S_84US = const(0x0000) # 1 x 9-bit shunt sample -INA219_CONFIG_SADCRES_10BIT_1S_148US = const(0x0008) # 1 x 10-bit shunt sample -INA219_CONFIG_SADCRES_11BIT_1S_276US = const(0x0010) # 1 x 11-bit shunt sample -INA219_CONFIG_SADCRES_12BIT_1S_532US = const(0x0018) # 1 x 12-bit shunt sample -INA219_CONFIG_SADCRES_12BIT_2S_1060US = const(0x0048) # 2 x 12-bit shunt samples averaged together -INA219_CONFIG_SADCRES_12BIT_4S_2130US = const(0x0050) # 4 x 12-bit shunt samples averaged together -INA219_CONFIG_SADCRES_12BIT_8S_4260US = const(0x0058) # 8 x 12-bit shunt samples averaged together -INA219_CONFIG_SADCRES_12BIT_16S_8510US = const(0x0060) # 16 x 12-bit shunt samples averaged together -INA219_CONFIG_SADCRES_12BIT_32S_17MS = const(0x0068) # 32 x 12-bit shunt samples averaged together -INA219_CONFIG_SADCRES_12BIT_64S_34MS = const(0x0070) # 64 x 12-bit shunt samples averaged together -INA219_CONFIG_SADCRES_12BIT_128S_69MS = const(0x0078) # 128 x 12-bit shunt samples averaged together - -INA219_CONFIG_MODE_MASK = const(0x0007) # Operating Mode Mask -INA219_CONFIG_MODE_POWERDOWN = const(0x0000) -INA219_CONFIG_MODE_SVOLT_TRIGGERED = const(0x0001) -INA219_CONFIG_MODE_BVOLT_TRIGGERED = const(0x0002) -INA219_CONFIG_MODE_SANDBVOLT_TRIGGERED = const(0x0003) -INA219_CONFIG_MODE_ADCOFF = const(0x0004) -INA219_CONFIG_MODE_SVOLT_CONTINUOUS = const(0x0005) -INA219_CONFIG_MODE_BVOLT_CONTINUOUS = const(0x0006) -INA219_CONFIG_MODE_SANDBVOLT_CONTINUOUS = const(0x0007) - - -""" -SHUNT VOLTAGE REGISTER (R) -""" -INA219_REG_SHUNTVOLTAGE = const(0x01) - - -""" -BUS VOLTAGE REGISTER (R) -""" -INA219_REG_BUSVOLTAGE = const(0x02) - - -""" -POWER REGISTER (R) -""" -INA219_REG_POWER = const(0x03) - - -""" -CURRENT REGISTER (R) -""" -INA219_REG_CURRENT = const(0x04) - - -""" -CALIBRATION REGISTER (R/W) -""" -INA219_REG_CALIBRATION = const(0x05) - +__version__ = "0.0.0-auto.0" +__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_INA219.git" + +# Bits +# pylint: disable=bad-whitespace +_READ = const(0x01) + +# Config Register (R/W) +_REG_CONFIG = const(0x00) +_CONFIG_RESET = const(0x8000) # Reset Bit + +_CONFIG_BVOLTAGERANGE_MASK = const(0x2000) # Bus Voltage Range Mask +_CONFIG_BVOLTAGERANGE_16V = const(0x0000) # 0-16V Range +_CONFIG_BVOLTAGERANGE_32V = const(0x2000) # 0-32V Range + +_CONFIG_GAIN_MASK = const(0x1800) # Gain Mask +_CONFIG_GAIN_1_40MV = const(0x0000) # Gain 1, 40mV Range +_CONFIG_GAIN_2_80MV = const(0x0800) # Gain 2, 80mV Range +_CONFIG_GAIN_4_160MV = const(0x1000) # Gain 4, 160mV Range +_CONFIG_GAIN_8_320MV = const(0x1800) # Gain 8, 320mV Range + +_CONFIG_BADCRES_MASK = const(0x0780) # Bus ADC Resolution Mask +_CONFIG_BADCRES_9BIT = const(0x0080) # 9-bit bus res = 0..511 +_CONFIG_BADCRES_10BIT = const(0x0100) # 10-bit bus res = 0..1023 +_CONFIG_BADCRES_11BIT = const(0x0200) # 11-bit bus res = 0..2047 +_CONFIG_BADCRES_12BIT = const(0x0400) # 12-bit bus res = 0..4097 + +_CONFIG_SADCRES_MASK = const(0x0078) # Shunt ADC Resolution and Averaging Mask +_CONFIG_SADCRES_9BIT_1S_84US = const(0x0000) # 1 x 9-bit shunt sample +_CONFIG_SADCRES_10BIT_1S_148US = const(0x0008) # 1 x 10-bit shunt sample +_CONFIG_SADCRES_11BIT_1S_276US = const(0x0010) # 1 x 11-bit shunt sample +_CONFIG_SADCRES_12BIT_1S_532US = const(0x0018) # 1 x 12-bit shunt sample +_CONFIG_SADCRES_12BIT_2S_1060US = const(0x0048) # 2 x 12-bit shunt samples averaged together +_CONFIG_SADCRES_12BIT_4S_2130US = const(0x0050) # 4 x 12-bit shunt samples averaged together +_CONFIG_SADCRES_12BIT_8S_4260US = const(0x0058) # 8 x 12-bit shunt samples averaged together +_CONFIG_SADCRES_12BIT_16S_8510US = const(0x0060) # 16 x 12-bit shunt samples averaged together +_CONFIG_SADCRES_12BIT_32S_17MS = const(0x0068) # 32 x 12-bit shunt samples averaged together +_CONFIG_SADCRES_12BIT_64S_34MS = const(0x0070) # 64 x 12-bit shunt samples averaged together +_CONFIG_SADCRES_12BIT_128S_69MS = const(0x0078) # 128 x 12-bit shunt samples averaged together + +_CONFIG_MODE_MASK = const(0x0007) # Operating Mode Mask +_CONFIG_MODE_POWERDOWN = const(0x0000) +_CONFIG_MODE_SVOLT_TRIGGERED = const(0x0001) +_CONFIG_MODE_BVOLT_TRIGGERED = const(0x0002) +_CONFIG_MODE_SANDBVOLT_TRIGGERED = const(0x0003) +_CONFIG_MODE_ADCOFF = const(0x0004) +_CONFIG_MODE_SVOLT_CONTINUOUS = const(0x0005) +_CONFIG_MODE_BVOLT_CONTINUOUS = const(0x0006) +_CONFIG_MODE_SANDBVOLT_CONTINUOUS = const(0x0007) + +# SHUNT VOLTAGE REGISTER (R) +_REG_SHUNTVOLTAGE = const(0x01) + +# BUS VOLTAGE REGISTER (R) +_REG_BUSVOLTAGE = const(0x02) + +# POWER REGISTER (R) +_REG_POWER = const(0x03) + +# CURRENT REGISTER (R) +_REG_CURRENT = const(0x04) + +# CALIBRATION REGISTER (R/W) +_REG_CALIBRATION = const(0x05) +# pylint: enable=bad-whitespace + +def _to_signed(num): + if num > 0x7FFF: + num -= 0x10000 + return num class INA219: - - def __init__(self, i2c, addr=0x40): - self.i2c_device = I2CDevice(i2c, addr) - - - self.i2c_addr = addr - self.current_divider_mA = 0 - self.power_divider_mW = 0 - - # Set chip to known config values to start - self.set_calibration_32V_2A() - - - def write_register (self, reg, value): - seq = bytearray([reg, (value >> 8) & 0xFF, value & 0xFF]) - with self.i2c_device as i2c: - self.i2c_device.write(seq) - - def read_register(self, reg): - buf = bytearray(3) - buf[0] = reg - with self.i2c_device as i2c: - i2c.write(buf, end=1, stop=False) - i2c.readinto(buf, start=1) - - value = (buf[1] << 8) | (buf[2]) - return value - - """ - - @brief Configures to INA219 to be able to measure up to 32V and 2A - of current. Each unit of current corresponds to 100uA, and - each unit of power corresponds to 2mW. Counter overflow - occurs at 3.2A. - - @note These calculations assume a 0.1 ohm resistor is present - - """ - def set_calibration_32V_2A(self): - # By default we use a pretty huge range for the input voltage, - # which probably isn't the most appropriate choice for system - # that don't use a lot of power. But all of the calculations - # are shown below if you want to change the settings. You will - # also need to change any relevant register settings, such as - # setting the VBUS_MAX to 16V instead of 32V, etc. - - # VBUS_MAX = 32V (Assumes 32V, can also be set to 16V) - # VSHUNT_MAX = 0.32 (Assumes Gain 8, 320mV, can also be 0.16, 0.08, 0.04) - # RSHUNT = 0.1 (Resistor value in ohms) - - # 1. Determine max possible current - # MaxPossible_I = VSHUNT_MAX / RSHUNT - # MaxPossible_I = 3.2A - - # 2. Determine max expected current - # MaxExpected_I = 2.0A - - # 3. Calculate possible range of LSBs (Min = 15-bit, Max = 12-bit) - # MinimumLSB = MaxExpected_I/32767 - # MinimumLSB = 0.000061 (61uA per bit) - # MaximumLSB = MaxExpected_I/4096 - # MaximumLSB = 0,000488 (488uA per bit) - - # 4. Choose an LSB between the min and max values - # (Preferrably a roundish number close to MinLSB) - # CurrentLSB = 0.0001 (100uA per bit) - - # 5. Compute the calibration register - # Cal = trunc (0.04096 / (Current_LSB * RSHUNT)) - # Cal = 4096 (0x1000) - - self.cal_value = 4096 - - # 6. Calculate the power LSB - # PowerLSB = 20 * CurrentLSB - # PowerLSB = 0.002 (2mW per bit) - - # 7. Compute the maximum current and shunt voltage values before overflow - # - # Max_Current = Current_LSB * 32767 - # Max_Current = 3.2767A before overflow - # - # If Max_Current > Max_Possible_I then - # Max_Current_Before_Overflow = MaxPossible_I - # Else - # Max_Current_Before_Overflow = Max_Current - # End If - # - # Max_ShuntVoltage = Max_Current_Before_Overflow * RSHUNT - # Max_ShuntVoltage = 0.32V - # - # If Max_ShuntVoltage >= VSHUNT_MAX - # Max_ShuntVoltage_Before_Overflow = VSHUNT_MAX - # Else - # Max_ShuntVoltage_Before_Overflow = Max_ShuntVoltage - # End If - - # 8. Compute the Maximum Power - # MaximumPower = Max_Current_Before_Overflow * VBUS_MAX - # MaximumPower = 3.2 * 32V - # MaximumPower = 102.4W - - # Set multipliers to convert raw current/power values - self.current_divider_mA = 10 # Current LSB = 100uA per bit (1000/100 = 10) - self.power_divider_mW = 2 # Power LSB = 1mW per bit (2/1) - - # Set Calibration register to 'Cal' calculated above - self.write_register(INA219_REG_CALIBRATION, self.cal_value) - - # Set Config register to take into account the settings above - config = INA219_CONFIG_BVOLTAGERANGE_32V | \ - INA219_CONFIG_GAIN_8_320MV | \ - INA219_CONFIG_BADCRES_12BIT | \ - INA219_CONFIG_SADCRES_12BIT_1S_532US | \ - INA219_CONFIG_MODE_SANDBVOLT_CONTINUOUS - self.write_register(INA219_REG_CONFIG, config) - - - """ - - @brief Configures to INA219 to be able to measure up to 32V and 1A - of current. Each unit of current corresponds to 40uA, and each - unit of power corresponds to 800�W. Counter overflow occurs at - 1.3A. - - @note These calculations assume a 0.1 ohm resistor is present - - """ - def set_calibration_32V_1A(self): - # By default we use a pretty huge range for the input voltage, - # which probably isn't the most appropriate choice for system - # that don't use a lot of power. But all of the calculations - # are shown below if you want to change the settings. You will - # also need to change any relevant register settings, such as - # setting the VBUS_MAX to 16V instead of 32V, etc. - - # VBUS_MAX = 32V (Assumes 32V, can also be set to 16V) - # VSHUNT_MAX = 0.32 (Assumes Gain 8, 320mV, can also be 0.16, 0.08, 0.04) - # RSHUNT = 0.1 (Resistor value in ohms) - - # 1. Determine max possible current - # MaxPossible_I = VSHUNT_MAX / RSHUNT - # MaxPossible_I = 3.2A - - # 2. Determine max expected current - # MaxExpected_I = 1.0A - - # 3. Calculate possible range of LSBs (Min = 15-bit, Max = 12-bit) - # MinimumLSB = MaxExpected_I/32767 - # MinimumLSB = 0.0000305 (30.5�A per bit) - # MaximumLSB = MaxExpected_I/4096 - # MaximumLSB = 0.000244 (244�A per bit) - - # 4. Choose an LSB between the min and max values - # (Preferrably a roundish number close to MinLSB) - # CurrentLSB = 0.0000400 (40�A per bit) - - # 5. Compute the calibration register - # Cal = trunc (0.04096 / (Current_LSB * RSHUNT)) - # Cal = 10240 (0x2800) - - self.cal_value = 10240 - - # 6. Calculate the power LSB - # PowerLSB = 20 * CurrentLSB - # PowerLSB = 0.0008 (800�W per bit) - - # 7. Compute the maximum current and shunt voltage values before overflow - # - # Max_Current = Current_LSB * 32767 - # Max_Current = 1.31068A before overflow - # - # If Max_Current > Max_Possible_I then - # Max_Current_Before_Overflow = MaxPossible_I - # Else - # Max_Current_Before_Overflow = Max_Current - # End If - # - # ... In this case, we're good though since Max_Current is less than MaxPossible_I - # - # Max_ShuntVoltage = Max_Current_Before_Overflow * RSHUNT - # Max_ShuntVoltage = 0.131068V - # - # If Max_ShuntVoltage >= VSHUNT_MAX - # Max_ShuntVoltage_Before_Overflow = VSHUNT_MAX - # Else - # Max_ShuntVoltage_Before_Overflow = Max_ShuntVoltage - # End If - - # 8. Compute the Maximum Power - # MaximumPower = Max_Current_Before_Overflow * VBUS_MAX - # MaximumPower = 1.31068 * 32V - # MaximumPower = 41.94176W - - # Set multipliers to convert raw current/power values - self.current_divider_mA = 25 # Current LSB = 40uA per bit (1000/40 = 25) - self.power_divider_mW = 1 # Power LSB = 800�W per bit - - # Set Calibration register to 'Cal' calculated above - self.write_register(INA219_REG_CALIBRATION, self.cal_value) - - # Set Config register to take into account the settings above - config = INA219_CONFIG_BVOLTAGERANGE_32V | \ - INA219_CONFIG_GAIN_8_320MV | \ - INA219_CONFIG_BADCRES_12BIT | \ - INA219_CONFIG_SADCRES_12BIT_1S_532US | \ - INA219_CONFIG_MODE_SANDBVOLT_CONTINUOUS - self.write_register(INA219_REG_CONFIG, config) - - - def set_calibration_16V_400mA(self): - - # Calibration which uses the highest precision for - # current measurement (0.1mA), at the expense of - # only supporting 16V at 400mA max. - - # VBUS_MAX = 16V - # VSHUNT_MAX = 0.04 (Assumes Gain 1, 40mV) - # RSHUNT = 0.1 (Resistor value in ohms) - - # 1. Determine max possible current - # MaxPossible_I = VSHUNT_MAX / RSHUNT - # MaxPossible_I = 0.4A - - # 2. Determine max expected current - # MaxExpected_I = 0.4A - - # 3. Calculate possible range of LSBs (Min = 15-bit, Max = 12-bit) - # MinimumLSB = MaxExpected_I/32767 - # MinimumLSB = 0.0000122 (12uA per bit) - # MaximumLSB = MaxExpected_I/4096 - # MaximumLSB = 0.0000977 (98uA per bit) - - # 4. Choose an LSB between the min and max values - # (Preferrably a roundish number close to MinLSB) - # CurrentLSB = 0.00005 (50uA per bit) - - # 5. Compute the calibration register - # Cal = trunc (0.04096 / (Current_LSB * RSHUNT)) - # Cal = 8192 (0x2000) - - self.cal_value = 8192 - - # 6. Calculate the power LSB - # PowerLSB = 20 * CurrentLSB - # PowerLSB = 0.001 (1mW per bit) - - # 7. Compute the maximum current and shunt voltage values before overflow - # - # Max_Current = Current_LSB * 32767 - # Max_Current = 1.63835A before overflow - # - # If Max_Current > Max_Possible_I then - # Max_Current_Before_Overflow = MaxPossible_I - # Else - # Max_Current_Before_Overflow = Max_Current - # End If - # - # Max_Current_Before_Overflow = MaxPossible_I - # Max_Current_Before_Overflow = 0.4 - # - # Max_ShuntVoltage = Max_Current_Before_Overflow * RSHUNT - # Max_ShuntVoltage = 0.04V - # - # If Max_ShuntVoltage >= VSHUNT_MAX - # Max_ShuntVoltage_Before_Overflow = VSHUNT_MAX - # Else - # Max_ShuntVoltage_Before_Overflow = Max_ShuntVoltage - # End If - # - # Max_ShuntVoltage_Before_Overflow = VSHUNT_MAX - # Max_ShuntVoltage_Before_Overflow = 0.04V - - # 8. Compute the Maximum Power - # MaximumPower = Max_Current_Before_Overflow * VBUS_MAX - # MaximumPower = 0.4 * 16V - # MaximumPower = 6.4W - - # Set multipliers to convert raw current/power values - self.current_divider_mA = 20 # Current LSB = 50uA per bit (1000/50 = 20) - self.power_divider_mW = 1 # Power LSB = 1mW per bit - - # Set Calibration register to 'Cal' calculated above - self.write_register(INA219_REG_CALIBRATION, self.cal_value) - - # Set Config register to take into account the settings above - config = INA219_CONFIG_BVOLTAGERANGE_16V | \ - INA219_CONFIG_GAIN_1_40MV | \ - INA219_CONFIG_BADCRES_12BIT | \ - INA219_CONFIG_SADCRES_12BIT_1S_532US | \ - INA219_CONFIG_MODE_SANDBVOLT_CONTINUOUS - self.write_register(INA219_REG_CONFIG, config) - - - """ - - @brief Gets the raw bus voltage (16-bit signed integer, so +-32767) - - """ - def get_bus_voltage_raw(self): - value = self.read_register(INA219_REG_BUSVOLTAGE) - - # Shift to the right 3 to drop CNVR and OVF and multiply by LSB - value = (self.to_signed(value >> 3) * 4) - return value - - - """ - - @brief Gets the raw shunt voltage (16-bit signed integer, so +-32767) - - """ - def get_shunt_voltage_raw(self): - return self.to_signed(self.read_register(INA219_REG_SHUNTVOLTAGE)) - - - """ - - @brief Gets the raw current value (16-bit signed integer, so +-32767) - - """ - def get_current_raw(self): - - # Sometimes a sharp load will reset the INA219, which will - # reset the cal register, meaning CURRENT and POWER will - # not be available ... athis by always setting a cal - # value even if it's an unfortunate extra step - self.write_register(INA219_REG_CALIBRATION, self.cal_value) - - # Now we can safely read the CURRENT register! - return self.to_signed(self.read_register(INA219_REG_CURRENT)) - - - """ - - @brief Gets the shunt voltage in mV (so +-327mV) - - """ - def get_shunt_voltage_mV(self): - value = self.get_shunt_voltage_raw() - return value * 0.01 - - - """ - - @brief Gets the shunt voltage in volts - - """ - def get_bus_voltage_V(self): - value = self.get_bus_voltage_raw() - return value * 0.001 - - - """ - - @brief Gets the current value in mA, taking into account the - config settings and current LSB - - """ - def get_current_mA(self): - valueDec = self.get_current_raw() - valueDec /= self.current_divider_mA - return valueDec - - def to_signed(self, num): - v = num - if(num > 0x7FFF): - v -= 0x10000 - return v + """Driver for the `INA219 current sensor""" + def __init__(self, i2c_bus, addr=0x40): + self.i2c_device = I2CDevice(i2c_bus, addr) + + self.i2c_addr = addr + # Multiplier in mA used to determine current from raw reading + self._current_lsb = 0 + # Multiplier in W used to determine power from raw reading + self._power_lsb = 0 + + # Set chip to known config values to start + self._cal_value = 4096 + self.set_calibration_32V_2A() + + def _write_register(self, reg, value): + seq = bytearray([reg, (value >> 8) & 0xFF, value & 0xFF]) + with self.i2c_device as i2c: + i2c.write(seq) + + def _read_register(self, reg): + buf = bytearray(3) + buf[0] = reg + with self.i2c_device as i2c: + i2c.write(buf, end=1, stop=False) + i2c.readinto(buf, start=1) + + value = (buf[1] << 8) | (buf[2]) + return value + + @property + def shunt_voltage(self): + """The shunt voltage (between V+ and V-) in Volts (so +-.327V)""" + value = _to_signed(self._read_register(_REG_SHUNTVOLTAGE)) + # The least signficant bit is 10uV which is 0.00001 volts + return value * 0.00001 + + @property + def bus_voltage(self): + """The bus voltage (between V- and GND) in Volts""" + raw_voltage = self._read_register(_REG_BUSVOLTAGE) + + # Shift to the right 3 to drop CNVR and OVF and multiply by LSB + # Each least signficant bit is 4mV + voltage_mv = _to_signed(raw_voltage >> 3) * 4 + return voltage_mv * 0.001 + + @property + def current(self): + """The current through the shunt resistor in milliamps.""" + # Sometimes a sharp load will reset the INA219, which will + # reset the cal register, meaning CURRENT and POWER will + # not be available ... athis by always setting a cal + # value even if it's an unfortunate extra step + self._write_register(_REG_CALIBRATION, self._cal_value) + + # Now we can safely read the CURRENT register! + raw_current = _to_signed(self._read_register(_REG_CURRENT)) + return raw_current * self._current_lsb + + def set_calibration_32V_2A(self): # pylint: disable=invalid-name + """Configures to INA219 to be able to measure up to 32V and 2A of current. Counter + overflow occurs at 3.2A. + + ..note :: These calculations assume a 0.1 shunt ohm resistor is present + """ + # By default we use a pretty huge range for the input voltage, + # which probably isn't the most appropriate choice for system + # that don't use a lot of power. But all of the calculations + # are shown below if you want to change the settings. You will + # also need to change any relevant register settings, such as + # setting the VBUS_MAX to 16V instead of 32V, etc. + + # VBUS_MAX = 32V (Assumes 32V, can also be set to 16V) + # VSHUNT_MAX = 0.32 (Assumes Gain 8, 320mV, can also be 0.16, 0.08, 0.04) + # RSHUNT = 0.1 (Resistor value in ohms) + + # 1. Determine max possible current + # MaxPossible_I = VSHUNT_MAX / RSHUNT + # MaxPossible_I = 3.2A + + # 2. Determine max expected current + # MaxExpected_I = 2.0A + + # 3. Calculate possible range of LSBs (Min = 15-bit, Max = 12-bit) + # MinimumLSB = MaxExpected_I/32767 + # MinimumLSB = 0.000061 (61uA per bit) + # MaximumLSB = MaxExpected_I/4096 + # MaximumLSB = 0,000488 (488uA per bit) + + # 4. Choose an LSB between the min and max values + # (Preferrably a roundish number close to MinLSB) + # CurrentLSB = 0.0001 (100uA per bit) + self._current_lsb = .1 # Current LSB = 100uA per bit + + # 5. Compute the calibration register + # Cal = trunc (0.04096 / (Current_LSB * RSHUNT)) + # Cal = 4096 (0x1000) + + self._cal_value = 4096 + + # 6. Calculate the power LSB + # PowerLSB = 20 * CurrentLSB + # PowerLSB = 0.002 (2mW per bit) + self._power_lsb = .002 # Power LSB = 2mW per bit + + # 7. Compute the maximum current and shunt voltage values before overflow + # + # Max_Current = Current_LSB * 32767 + # Max_Current = 3.2767A before overflow + # + # If Max_Current > Max_Possible_I then + # Max_Current_Before_Overflow = MaxPossible_I + # Else + # Max_Current_Before_Overflow = Max_Current + # End If + # + # Max_ShuntVoltage = Max_Current_Before_Overflow * RSHUNT + # Max_ShuntVoltage = 0.32V + # + # If Max_ShuntVoltage >= VSHUNT_MAX + # Max_ShuntVoltage_Before_Overflow = VSHUNT_MAX + # Else + # Max_ShuntVoltage_Before_Overflow = Max_ShuntVoltage + # End If + + # 8. Compute the Maximum Power + # MaximumPower = Max_Current_Before_Overflow * VBUS_MAX + # MaximumPower = 3.2 * 32V + # MaximumPower = 102.4W + + # Set Calibration register to 'Cal' calculated above + self._write_register(_REG_CALIBRATION, self._cal_value) + + # Set Config register to take into account the settings above + config = _CONFIG_BVOLTAGERANGE_32V | \ + _CONFIG_GAIN_8_320MV | \ + _CONFIG_BADCRES_12BIT | \ + _CONFIG_SADCRES_12BIT_1S_532US | \ + _CONFIG_MODE_SANDBVOLT_CONTINUOUS + self._write_register(_REG_CONFIG, config) + + def set_calibration_32V_1A(self): # pylint: disable=invalid-name + """Configures to INA219 to be able to measure up to 32V and 1A of current. Counter overflow + occurs at 1.3A. + + .. note:: These calculations assume a 0.1 ohm shunt resistor is present""" + # By default we use a pretty huge range for the input voltage, + # which probably isn't the most appropriate choice for system + # that don't use a lot of power. But all of the calculations + # are shown below if you want to change the settings. You will + # also need to change any relevant register settings, such as + # setting the VBUS_MAX to 16V instead of 32V, etc. + + # VBUS_MAX = 32V (Assumes 32V, can also be set to 16V) + # VSHUNT_MAX = 0.32 (Assumes Gain 8, 320mV, can also be 0.16, 0.08, 0.04) + # RSHUNT = 0.1 (Resistor value in ohms) + + # 1. Determine max possible current + # MaxPossible_I = VSHUNT_MAX / RSHUNT + # MaxPossible_I = 3.2A + + # 2. Determine max expected current + # MaxExpected_I = 1.0A + + # 3. Calculate possible range of LSBs (Min = 15-bit, Max = 12-bit) + # MinimumLSB = MaxExpected_I/32767 + # MinimumLSB = 0.0000305 (30.5uA per bit) + # MaximumLSB = MaxExpected_I/4096 + # MaximumLSB = 0.000244 (244uA per bit) + + # 4. Choose an LSB between the min and max values + # (Preferrably a roundish number close to MinLSB) + # CurrentLSB = 0.0000400 (40uA per bit) + self._current_lsb = 0.04 # In milliamps + + # 5. Compute the calibration register + # Cal = trunc (0.04096 / (Current_LSB * RSHUNT)) + # Cal = 10240 (0x2800) + + self._cal_value = 10240 + + # 6. Calculate the power LSB + # PowerLSB = 20 * CurrentLSB + # PowerLSB = 0.0008 (800uW per bit) + self._power_lsb = 0.0008 + + # 7. Compute the maximum current and shunt voltage values before overflow + # + # Max_Current = Current_LSB * 32767 + # Max_Current = 1.31068A before overflow + # + # If Max_Current > Max_Possible_I then + # Max_Current_Before_Overflow = MaxPossible_I + # Else + # Max_Current_Before_Overflow = Max_Current + # End If + # + # ... In this case, we're good though since Max_Current is less than MaxPossible_I + # + # Max_ShuntVoltage = Max_Current_Before_Overflow * RSHUNT + # Max_ShuntVoltage = 0.131068V + # + # If Max_ShuntVoltage >= VSHUNT_MAX + # Max_ShuntVoltage_Before_Overflow = VSHUNT_MAX + # Else + # Max_ShuntVoltage_Before_Overflow = Max_ShuntVoltage + # End If + + # 8. Compute the Maximum Power + # MaximumPower = Max_Current_Before_Overflow * VBUS_MAX + # MaximumPower = 1.31068 * 32V + # MaximumPower = 41.94176W + + # Set Calibration register to 'Cal' calculated above + self._write_register(_REG_CALIBRATION, self._cal_value) + + # Set Config register to take into account the settings above + config = (_CONFIG_BVOLTAGERANGE_32V | + _CONFIG_GAIN_8_320MV | + _CONFIG_BADCRES_12BIT | + _CONFIG_SADCRES_12BIT_1S_532US | + _CONFIG_MODE_SANDBVOLT_CONTINUOUS) + self._write_register(_REG_CONFIG, config) + + def set_calibration_16V_400mA(self): # pylint: disable=invalid-name + """Configures to INA219 to be able to measure up to 16V and 400mA of current. Counter + overflow occurs at 1.6A. + + .. note:: These calculations assume a 0.1 ohm shunt resistor is present""" + # Calibration which uses the highest precision for + # current measurement (0.1mA), at the expense of + # only supporting 16V at 400mA max. + + # VBUS_MAX = 16V + # VSHUNT_MAX = 0.04 (Assumes Gain 1, 40mV) + # RSHUNT = 0.1 (Resistor value in ohms) + + # 1. Determine max possible current + # MaxPossible_I = VSHUNT_MAX / RSHUNT + # MaxPossible_I = 0.4A + + # 2. Determine max expected current + # MaxExpected_I = 0.4A + + # 3. Calculate possible range of LSBs (Min = 15-bit, Max = 12-bit) + # MinimumLSB = MaxExpected_I/32767 + # MinimumLSB = 0.0000122 (12uA per bit) + # MaximumLSB = MaxExpected_I/4096 + # MaximumLSB = 0.0000977 (98uA per bit) + + # 4. Choose an LSB between the min and max values + # (Preferrably a roundish number close to MinLSB) + # CurrentLSB = 0.00005 (50uA per bit) + self._current_lsb = 0.05 # in milliamps + + # 5. Compute the calibration register + # Cal = trunc (0.04096 / (Current_LSB * RSHUNT)) + # Cal = 8192 (0x2000) + + self._cal_value = 8192 + + # 6. Calculate the power LSB + # PowerLSB = 20 * CurrentLSB + # PowerLSB = 0.001 (1mW per bit) + self._power_lsb = 0.001 + + # 7. Compute the maximum current and shunt voltage values before overflow + # + # Max_Current = Current_LSB * 32767 + # Max_Current = 1.63835A before overflow + # + # If Max_Current > Max_Possible_I then + # Max_Current_Before_Overflow = MaxPossible_I + # Else + # Max_Current_Before_Overflow = Max_Current + # End If + # + # Max_Current_Before_Overflow = MaxPossible_I + # Max_Current_Before_Overflow = 0.4 + # + # Max_ShuntVoltage = Max_Current_Before_Overflow * RSHUNT + # Max_ShuntVoltage = 0.04V + # + # If Max_ShuntVoltage >= VSHUNT_MAX + # Max_ShuntVoltage_Before_Overflow = VSHUNT_MAX + # Else + # Max_ShuntVoltage_Before_Overflow = Max_ShuntVoltage + # End If + # + # Max_ShuntVoltage_Before_Overflow = VSHUNT_MAX + # Max_ShuntVoltage_Before_Overflow = 0.04V + + # 8. Compute the Maximum Power + # MaximumPower = Max_Current_Before_Overflow * VBUS_MAX + # MaximumPower = 0.4 * 16V + # MaximumPower = 6.4W + + # Set Calibration register to 'Cal' calculated above + self._write_register(_REG_CALIBRATION, self._cal_value) + + # Set Config register to take into account the settings above + config = (_CONFIG_BVOLTAGERANGE_16V | + _CONFIG_GAIN_1_40MV | + _CONFIG_BADCRES_12BIT | + _CONFIG_SADCRES_12BIT_1S_532US | + _CONFIG_MODE_SANDBVOLT_CONTINUOUS) + self._write_register(_REG_CONFIG, config) diff --git a/examples/get_current.py b/examples/get_current.py index 399cd6b..fb95269 100644 --- a/examples/get_current.py +++ b/examples/get_current.py @@ -1,30 +1,21 @@ -from board import * import time + +from board import SCL, SDA import busio import adafruit_ina219 -myI2C = busio.I2C(SCL, SDA) +i2c_bus = busio.I2C(SCL, SDA) -ina219 = adafruit_ina219.INA219(myI2C) +ina219 = adafruit_ina219.INA219(i2c_bus) print("ina219 test") -while(1): - shuntvoltage = 0 - busvoltage = 0 - current_mA = 0 - loadvoltage = 0 - - shuntvoltage = ina219.get_shunt_voltage_mV() - busvoltage = ina219.get_bus_voltage_V() - current_mA = ina219.get_current_mA() - loadvoltage = busvoltage + (shuntvoltage / 1000) - - print("Bus Voltage: " + str(busvoltage) + " V") - print("Shunt Voltage: " + str(shuntvoltage) + " mV") - print("Load Voltage: " + str(loadvoltage) + " V") - print("Current: " + str(current_mA) + " mA") - print("") +while True: + print("Bus Voltage: {} V".format(ina219.bus_voltage)) + print("Shunt Voltage: {} mV".format(ina219.shunt_voltage / 1000)) + print("Load Voltage: {} V".format(ina219.bus_voltage + ina219.shunt_voltage)) + print("Current: {} mA".format(ina219.current)) + print("") - time.sleep(2) \ No newline at end of file + time.sleep(2) 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 - From d1644cb89242a5f688548734a73878aa8b5857b1 Mon Sep 17 00:00:00 2001 From: Kattni Date: Sun, 10 Dec 2017 15:51:28 -0500 Subject: [PATCH 2/2] update to remove error circuitpython-travis-build-tools > circuitpython-build-tools --- .travis.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.travis.yml b/.travis.yml index 225d601..ece679b 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_ina219.py