From f73676aaa5cf1944e4d8a55e1e0f6c55fa166c55 Mon Sep 17 00:00:00 2001 From: caternuson Date: Tue, 14 Aug 2018 10:17:34 -0700 Subject: [PATCH 1/9] added working code --- .gitignore | 7 + .pylintrc | 433 ++++++++++++++++++++++++++++++++ .readthedocs.yml | 3 + .travis.yml | 32 +++ CODE_OF_CONDUCT.md | 127 ++++++++++ LICENSE | 4 +- README.md | 2 - README.rst | 112 +++++++++ adafruit_tca9548a.py | 96 +++++++ docs/_static/favicon.ico | Bin 0 -> 4414 bytes docs/api.rst | 8 + docs/conf.py | 160 ++++++++++++ docs/examples.rst | 8 + docs/index.rst | 51 ++++ examples/tca9548a_simpletest.py | 22 ++ requirements.txt | 1 + 16 files changed, 1062 insertions(+), 4 deletions(-) create mode 100644 .gitignore create mode 100644 .pylintrc create mode 100644 .readthedocs.yml create mode 100644 .travis.yml create mode 100644 CODE_OF_CONDUCT.md delete mode 100644 README.md create mode 100644 README.rst create mode 100644 adafruit_tca9548a.py create mode 100644 docs/_static/favicon.ico create mode 100644 docs/api.rst create mode 100644 docs/conf.py create mode 100644 docs/examples.rst create mode 100644 docs/index.rst create mode 100644 examples/tca9548a_simpletest.py create mode 100644 requirements.txt diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..daac230 --- /dev/null +++ b/.gitignore @@ -0,0 +1,7 @@ +__pycache__ +_build +*.pyc +.env +build* +bundles +.vscode \ No newline at end of file diff --git a/.pylintrc b/.pylintrc new file mode 100644 index 0000000..81d8170 --- /dev/null +++ b/.pylintrc @@ -0,0 +1,433 @@ +[MASTER] + +# A comma-separated list of package or module names from where C extensions may +# be loaded. Extensions are loading into the active Python interpreter and may +# run arbitrary code +extension-pkg-whitelist= + +# Add files or directories to the blacklist. They should be base names, not +# paths. +ignore=CVS + +# Add files or directories matching the regex patterns to the blacklist. The +# regex matches against base names, not paths. +ignore-patterns= + +# Python code to execute, usually for sys.path manipulation such as +# pygtk.require(). +#init-hook= + +# Use multiple processes to speed up Pylint. +# jobs=1 +jobs=2 + +# List of plugins (as comma separated values of python modules names) to load, +# usually to register additional checkers. +load-plugins= + +# Pickle collected data for later comparisons. +persistent=yes + +# Specify a configuration file. +#rcfile= + +# Allow loading of arbitrary C extensions. Extensions are imported into the +# active Python interpreter and may run arbitrary code. +unsafe-load-any-extension=no + + +[MESSAGES CONTROL] + +# Only show warnings with the listed confidence levels. Leave empty to show +# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED +confidence= + +# Disable the message, report, category or checker with the given id(s). You +# can either give multiple identifiers separated by comma (,) or put this +# option multiple times (only on the command line, not in the configuration +# file where it should appear only once).You can also use "--disable=all" to +# disable everything first and then reenable specific checks. For example, if +# you want to run only the similarities checker, you can use "--disable=all +# --enable=similarities". If you want to run only the classes checker, but have +# no Warning level messages displayed, use"--disable=all --enable=classes +# --disable=W" +# disable=import-error,print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call +disable=print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call,import-error + +# Enable the message, report, category or checker with the given id(s). You can +# either give multiple identifier separated by comma (,) or put this option +# multiple time (only on the command line, not in the configuration file where +# it should appear only once). See also the "--disable" option for examples. +enable= + + +[REPORTS] + +# Python expression which should return a note less than 10 (10 is the highest +# note). You have access to the variables errors warning, statement which +# respectively contain the number of errors / warnings messages and the total +# number of statements analyzed. This is used by the global evaluation report +# (RP0004). +evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10) + +# Template used to display messages. This is a python new-style format string +# used to format the message information. See doc for all details +#msg-template= + +# Set the output format. Available formats are text, parseable, colorized, json +# and msvs (visual studio).You can also give a reporter class, eg +# mypackage.mymodule.MyReporterClass. +output-format=text + +# Tells whether to display a full report or only the messages +reports=no + +# Activate the evaluation score. +score=yes + + +[REFACTORING] + +# Maximum number of nested blocks for function / method body +max-nested-blocks=5 + + +[LOGGING] + +# Logging modules to check that the string format arguments are in logging +# function parameter format +logging-modules=logging + + +[SPELLING] + +# Spelling dictionary name. Available dictionaries: none. To make it working +# install python-enchant package. +spelling-dict= + +# List of comma separated words that should not be checked. +spelling-ignore-words= + +# A path to a file that contains private dictionary; one word per line. +spelling-private-dict-file= + +# Tells whether to store unknown words to indicated private dictionary in +# --spelling-private-dict-file option instead of raising a message. +spelling-store-unknown-words=no + + +[MISCELLANEOUS] + +# List of note tags to take in consideration, separated by a comma. +# notes=FIXME,XXX,TODO +notes=FIXME,XXX + + +[TYPECHECK] + +# List of decorators that produce context managers, such as +# contextlib.contextmanager. Add to this list to register other decorators that +# produce valid context managers. +contextmanager-decorators=contextlib.contextmanager + +# List of members which are set dynamically and missed by pylint inference +# system, and so shouldn't trigger E1101 when accessed. Python regular +# expressions are accepted. +generated-members= + +# Tells whether missing members accessed in mixin class should be ignored. A +# mixin class is detected if its name ends with "mixin" (case insensitive). +ignore-mixin-members=yes + +# This flag controls whether pylint should warn about no-member and similar +# checks whenever an opaque object is returned when inferring. The inference +# can return multiple potential results while evaluating a Python object, but +# some branches might not be evaluated, which results in partial inference. In +# that case, it might be useful to still emit no-member and other checks for +# the rest of the inferred objects. +ignore-on-opaque-inference=yes + +# List of class names for which member attributes should not be checked (useful +# for classes with dynamically set attributes). This supports the use of +# qualified names. +ignored-classes=optparse.Values,thread._local,_thread._local + +# List of module names for which member attributes should not be checked +# (useful for modules/projects where namespaces are manipulated during runtime +# and thus existing member attributes cannot be deduced by static analysis. It +# supports qualified module names, as well as Unix pattern matching. +ignored-modules= + +# Show a hint with possible names when a member name was not found. The aspect +# of finding the hint is based on edit distance. +missing-member-hint=yes + +# The minimum edit distance a name should have in order to be considered a +# similar match for a missing member name. +missing-member-hint-distance=1 + +# The total number of similar names that should be taken in consideration when +# showing a hint for a missing member. +missing-member-max-choices=1 + + +[VARIABLES] + +# List of additional names supposed to be defined in builtins. Remember that +# you should avoid to define new builtins when possible. +additional-builtins= + +# Tells whether unused global variables should be treated as a violation. +allow-global-unused-variables=yes + +# List of strings which can identify a callback function by name. A callback +# name must start or end with one of those strings. +callbacks=cb_,_cb + +# A regular expression matching the name of dummy variables (i.e. expectedly +# not used). +dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_ + +# Argument names that match this expression will be ignored. Default to name +# with leading underscore +ignored-argument-names=_.*|^ignored_|^unused_ + +# Tells whether we should check for unused import in __init__ files. +init-import=no + +# List of qualified module names which can have objects that can redefine +# builtins. +redefining-builtins-modules=six.moves,future.builtins + + +[FORMAT] + +# Expected format of line ending, e.g. empty (any line ending), LF or CRLF. +# expected-line-ending-format= +expected-line-ending-format=LF + +# Regexp for a line that is allowed to be longer than the limit. +ignore-long-lines=^\s*(# )??$ + +# Number of spaces of indent required inside a hanging or continued line. +indent-after-paren=4 + +# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 +# tab). +indent-string=' ' + +# Maximum number of characters on a single line. +max-line-length=100 + +# Maximum number of lines in a module +max-module-lines=1000 + +# List of optional constructs for which whitespace checking is disabled. `dict- +# separator` is used to allow tabulation in dicts, etc.: {1 : 1,\n222: 2}. +# `trailing-comma` allows a space between comma and closing bracket: (a, ). +# `empty-line` allows space-only lines. +no-space-check=trailing-comma,dict-separator + +# Allow the body of a class to be on the same line as the declaration if body +# contains single statement. +single-line-class-stmt=no + +# Allow the body of an if to be on the same line as the test if there is no +# else. +single-line-if-stmt=no + + +[SIMILARITIES] + +# Ignore comments when computing similarities. +ignore-comments=yes + +# Ignore docstrings when computing similarities. +ignore-docstrings=yes + +# Ignore imports when computing similarities. +ignore-imports=no + +# Minimum lines number of a similarity. +min-similarity-lines=4 + + +[BASIC] + +# Naming hint for argument names +argument-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Regular expression matching correct argument names +argument-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Naming hint for attribute names +attr-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Regular expression matching correct attribute names +attr-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Bad variable names which should always be refused, separated by a comma +bad-names=foo,bar,baz,toto,tutu,tata + +# Naming hint for class attribute names +class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ + +# Regular expression matching correct class attribute names +class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ + +# Naming hint for class names +# class-name-hint=[A-Z_][a-zA-Z0-9]+$ +class-name-hint=[A-Z_][a-zA-Z0-9_]+$ + +# Regular expression matching correct class names +# class-rgx=[A-Z_][a-zA-Z0-9]+$ +class-rgx=[A-Z_][a-zA-Z0-9_]+$ + +# Naming hint for constant names +const-name-hint=(([A-Z_][A-Z0-9_]*)|(__.*__))$ + +# Regular expression matching correct constant names +const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$ + +# Minimum line length for functions/classes that require docstrings, shorter +# ones are exempt. +docstring-min-length=-1 + +# Naming hint for function names +function-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Regular expression matching correct function names +function-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Good variable names which should always be accepted, separated by a comma +# good-names=i,j,k,ex,Run,_ +good-names=r,g,b,w,i,j,k,n,x,y,z,ex,ok,Run,_ + +# Include a hint for the correct naming format with invalid-name +include-naming-hint=no + +# Naming hint for inline iteration names +inlinevar-name-hint=[A-Za-z_][A-Za-z0-9_]*$ + +# Regular expression matching correct inline iteration names +inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$ + +# Naming hint for method names +method-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Regular expression matching correct method names +method-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Naming hint for module names +module-name-hint=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ + +# Regular expression matching correct module names +module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ + +# Colon-delimited sets of names that determine each other's naming style when +# the name regexes allow several styles. +name-group= + +# Regular expression which should only match function or class names that do +# not require a docstring. +no-docstring-rgx=^_ + +# List of decorators that produce properties, such as abc.abstractproperty. Add +# to this list to register other decorators that produce valid properties. +property-classes=abc.abstractproperty + +# Naming hint for variable names +variable-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Regular expression matching correct variable names +variable-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + + +[IMPORTS] + +# Allow wildcard imports from modules that define __all__. +allow-wildcard-with-all=no + +# Analyse import fallback blocks. This can be used to support both Python 2 and +# 3 compatible code, which means that the block might have code that exists +# only in one or another interpreter, leading to false positives when analysed. +analyse-fallback-blocks=no + +# Deprecated modules which should not be used, separated by a comma +deprecated-modules=optparse,tkinter.tix + +# Create a graph of external dependencies in the given file (report RP0402 must +# not be disabled) +ext-import-graph= + +# Create a graph of every (i.e. internal and external) dependencies in the +# given file (report RP0402 must not be disabled) +import-graph= + +# Create a graph of internal dependencies in the given file (report RP0402 must +# not be disabled) +int-import-graph= + +# Force import order to recognize a module as part of the standard +# compatibility libraries. +known-standard-library= + +# Force import order to recognize a module as part of a third party library. +known-third-party=enchant + + +[CLASSES] + +# List of method names used to declare (i.e. assign) instance attributes. +defining-attr-methods=__init__,__new__,setUp + +# List of member names, which should be excluded from the protected access +# warning. +exclude-protected=_asdict,_fields,_replace,_source,_make + +# List of valid names for the first argument in a class method. +valid-classmethod-first-arg=cls + +# List of valid names for the first argument in a metaclass class method. +valid-metaclass-classmethod-first-arg=mcs + + +[DESIGN] + +# Maximum number of arguments for function / method +max-args=5 + +# Maximum number of attributes for a class (see R0902). +# max-attributes=7 +max-attributes=11 + +# Maximum number of boolean expressions in a if statement +max-bool-expr=5 + +# Maximum number of branch for function / method body +max-branches=12 + +# Maximum number of locals for function / method body +max-locals=15 + +# Maximum number of parents for a class (see R0901). +max-parents=7 + +# Maximum number of public methods for a class (see R0904). +max-public-methods=20 + +# Maximum number of return / yield for function / method body +max-returns=6 + +# Maximum number of statements in function / method body +max-statements=50 + +# Minimum number of public methods for a class (see R0903). +min-public-methods=1 + + +[EXCEPTIONS] + +# Exceptions that will emit a warning when being caught. Defaults to +# "Exception" +overgeneral-exceptions=Exception diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 0000000..f4243ad --- /dev/null +++ b/.readthedocs.yml @@ -0,0 +1,3 @@ +python: + version: 3 +requirements_file: requirements.txt diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..ecac5c4 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,32 @@ +# This is a common .travis.yml for generating library release zip files for +# CircuitPython library releases using circuitpython-build-tools. +# See https://github.com/adafruit/circuitpython-build-tools for detailed setup +# instructions. + +dist: trusty +sudo: false +language: python +python: + - "3.6" + +cache: + pip: true + +deploy: + provider: releases + api_key: $GITHUB_TOKEN + file_glob: true + file: $TRAVIS_BUILD_DIR/bundles/* + skip_cleanup: true + overwrite: true + on: + tags: true + +install: + - pip install pylint circuitpython-build-tools Sphinx sphinx-rtd-theme + +script: + - pylint adafruit_tca9548a.py + - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace examples/*.py) + - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-tca9548a --library_location . + - cd docs && sphinx-build -E -W -b html . _build/html diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..8ee6e44 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,127 @@ +# Adafruit Community Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and leaders pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, gender identity and expression, level or type of +experience, education, socio-economic status, nationality, personal appearance, +race, religion, or sexual identity and orientation. + +## Our Standards + +We are committed to providing a friendly, safe and welcoming environment for +all. + +Examples of behavior that contributes to creating a positive environment +include: + +* Be kind and courteous to others +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Collaborating with other community members +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and sexual attention or advances +* The use of inappropriate images, including in a community member's avatar +* The use of inappropriate language, including in a community member's nickname +* Any spamming, flaming, baiting or other attention-stealing behavior +* Excessive or unwelcome helping; answering outside the scope of the question + asked +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate + +The goal of the standards and moderation guidelines outlined here is to build +and maintain a respectful community. We ask that you don’t just aim to be +"technically unimpeachable", but rather try to be your best self. + +We value many things beyond technical expertise, including collaboration and +supporting others within our community. Providing a positive experience for +other community members can have a much more significant impact than simply +providing the correct answer. + +## Our Responsibilities + +Project leaders are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project leaders have the right and responsibility to remove, edit, or +reject messages, comments, commits, code, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any community member for other behaviors that they deem +inappropriate, threatening, offensive, or harmful. + +## Moderation + +Instances of behaviors that violate the Adafruit Community Code of Conduct +may be reported by any member of the community. Community members are +encouraged to report these situations, including situations they witness +involving other community members. + +You may report in the following ways: + +In any situation, you may send an email to . + +On the Adafruit Discord, you may send an open message from any channel +to all Community Helpers by tagging @community helpers. You may also send an +open message from any channel, or a direct message to @kattni#1507, +@tannewt#4653, @Dan Halbert#1614, @cater#2442, @sommersoft#0222, or +@Andon#8175. + +Email and direct message reports will be kept confidential. + +In situations on Discord where the issue is particularly egregious, possibly +illegal, requires immediate action, or violates the Discord terms of service, +you should also report the message directly to Discord. + +These are the steps for upholding our community’s standards of conduct. + +1. Any member of the community may report any situation that violates the +Adafruit Community Code of Conduct. All reports will be reviewed and +investigated. +2. If the behavior is an egregious violation, the community member who +committed the violation may be banned immediately, without warning. +3. Otherwise, moderators will first respond to such behavior with a warning. +4. Moderators follow a soft "three strikes" policy - the community member may +be given another chance, if they are receptive to the warning and change their +behavior. +5. If the community member is unreceptive or unreasonable when warned by a +moderator, or the warning goes unheeded, they may be banned for a first or +second offense. Repeated offenses will result in the community member being +banned. + +## Scope + +This Code of Conduct and the enforcement policies listed above apply to all +Adafruit Community venues. This includes but is not limited to any community +spaces (both public and private), the entire Adafruit Discord server, and +Adafruit GitHub repositories. Examples of Adafruit Community spaces include +but are not limited to meet-ups, audio chats on the Adafruit Discord, or +interaction at a conference. + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. As a community +member, you are representing our community, and are expected to behave +accordingly. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 1.4, available at +, +and the [Rust Code of Conduct](https://www.rust-lang.org/en-US/conduct.html). + +For other projects adopting the Adafruit Community Code of +Conduct, please contact the maintainers of those projects for enforcement. +If you wish to use this code of conduct for your own project, consider +explicitly mentioning your moderation policy or making a copy with your +own moderation policy so as to avoid confusion. diff --git a/LICENSE b/LICENSE index 13a521e..56d9239 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ -MIT License +The MIT License (MIT) -Copyright (c) 2018 Adafruit Industries +Copyright (c) 2018 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 diff --git a/README.md b/README.md deleted file mode 100644 index 40b9643..0000000 --- a/README.md +++ /dev/null @@ -1,2 +0,0 @@ -# Adafruit_CircuitPython_TCA9548A -CircuitPython driver for the TCA9548A I2C Multiplexer. diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..1d436bf --- /dev/null +++ b/README.rst @@ -0,0 +1,112 @@ +Introduction +============ + +.. image:: https://readthedocs.org/projects/adafruit-circuitpython-tca9548a/badge/?version=latest + :target: https://circuitpython.readthedocs.io/projects/tca9548a/en/latest/ + :alt: Documentation Status + +.. image:: https://img.shields.io/discord/327254708534116352.svg + :target: https://discord.gg/nBQh6qu + :alt: Discord + +.. image:: https://travis-ci.org/adafruit/Adafruit_CircuitPython_TCA9548A.svg?branch=master + :target: https://travis-ci.org/adafruit/Adafruit_CircuitPython_TCA9548A + :alt: Build Status + +CircuitPython driver for the TCA9548A I2C Multiplexer. + +Dependencies +============= +This driver depends on: + +* `Adafruit CircuitPython `_ +* `Bus Device `_ + +Please ensure all dependencies are available on the CircuitPython filesystem. +This is easily achieved by downloading +`the Adafruit library and driver bundle `_. + +Usage Example +============= + +```python +# This example shows using two TSL2491 light sensors attached to TCA9548A channels 0 and 1. +# Use with other I2C sensors would be similar. +import time +import board +import busio +import adafruit_tsl2591 +import adafruit_tca9548a + +# Create I2C bus as normal +i2c = busio.I2C(board.SCL, board.SDA) + +# Create the TCA9548A object and give it the I2C bus +tca = adafruit_tca9548a.TCA9548A(i2c) + +# For each sensor, create it using the TCA9548A channel instead of the I2C object +tsl1 = adafruit_tsl2591.TSL2591(tca[0]) +tsl2 = adafruit_tsl2591.TSL2591(tca[1]) + +# Loop and profit! +while True: + print(tsl1.lux, tsl2.lux) + time.sleep(0.1) +``` + +Contributing +============ + +Contributions are welcome! Please read our `Code of Conduct +`_ +before contributing to help this project stay welcoming. + +Building locally +================ + +Zip release files +----------------- + +To build this library locally you'll need to install the +`circuitpython-build-tools `_ package. + +.. code-block:: shell + + python3 -m venv .env + source .env/bin/activate + pip install circuitpython-build-tools + +Once installed, make sure you are in the virtual environment: + +.. code-block:: shell + + source .env/bin/activate + +Then run the build: + +.. code-block:: shell + + circuitpython-build-bundles --filename_prefix adafruit-circuitpython-tca9548a --library_location . + +Sphinx documentation +----------------------- + +Sphinx is used to build the documentation based on rST files and comments in the code. First, +install dependencies (feel free to reuse the virtual environment from above): + +.. code-block:: shell + + python3 -m venv .env + source .env/bin/activate + pip install Sphinx sphinx-rtd-theme + +Now, once you have the virtual environment activated: + +.. code-block:: shell + + cd docs + sphinx-build -E -W -b html . _build/html + +This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to +view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to +locally verify it will pass. diff --git a/adafruit_tca9548a.py b/adafruit_tca9548a.py new file mode 100644 index 0000000..5ce3d9b --- /dev/null +++ b/adafruit_tca9548a.py @@ -0,0 +1,96 @@ +# The MIT License (MIT) +# +# Copyright (c) 2018 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_TCA9548A` +==================================================== + +CircuitPython driver for the TCA9548A I2C Multiplexer. + +* Author(s): Carter Nelson + +Implementation Notes +-------------------- + +**Hardware:** + +* TCA9548A I2C Multiplexer: https://www.adafruit.com/product/2717 + +**Software and Dependencies:** + +* Adafruit CircuitPython firmware for the supported boards: + https://github.com/adafruit/circuitpython/releases +* Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice +""" + +# imports +from micropython import const + +_DEFAULT_ADDRESS = const(0x70) + +__version__ = "0.0.0-auto.0" +__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_TCA9548A.git" + +class TCA9548A_Channel(): + """Helper class to represent an output channel on the TCA9548A and take care + of the necessary I2C commands for channel switching. This class needs to + behave like an I2CDevice.""" + + def __init__(self, tca, channel): + self.tca = tca + self.channel = channel + self.channel_switch = bytearray([1 << channel]) + + def try_lock(self): + while not self.tca.i2c.try_lock(): + pass + self.tca.i2c.writeto(self.tca.address, self.channel_switch) + return True + + def unlock(self): + return self.tca.i2c.unlock() + + def readfrom_into(self, address, buffer, **kwargs): + if address == self.tca.address: + raise ValueError("Device address must be different than TCA9548A address.") + return self.tca.i2c.readfrom_into(address, buffer, **kwargs) + + def writeto(self, address, buffer, **kwargs): + if address == self.tca.address: + raise ValueError("Device address must be different than TCA9548A address.") + return self.tca.i2c.writeto(address, buffer, **kwargs) + + +class TCA9548A(): + """Class which provides interface to TCA9548A I2C multiplexer.""" + + def __init__(self, i2c, address=_DEFAULT_ADDRESS): + self.i2c = i2c + self.address = address + self.used_channels = [] + + def __getitem__(self, key): + if not 0 <= key <= 7: + raise ValueError("Channel must be an integer in the range: 0-7") + if key in self.used_channels: + raise ValueError("Channel already in use.") + self.used_channels.append(key) + return TCA9548A_Channel(self, key) \ No newline at end of file diff --git a/docs/_static/favicon.ico b/docs/_static/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..5aca98376a1f7e593ebd9cf41a808512c2135635 GIT binary patch literal 4414 zcmd^BX;4#F6n=SG-XmlONeGrD5E6J{RVh+e928U#MG!$jWvO+UsvWh`x&VqGNx*en zx=qox7Dqv{kPwo%fZC$dDwVpRtz{HzTkSs8QhG0)%Y=-3@Kt!4ag|JcIo?$-F|?bXVS9UDUyev>MVZQ(H8K4#;BQW-t2CPorj8^KJrMX}QK zp+e<;4ldpXz~=)2GxNy811&)gt-}Q*yVQpsxr@VMoA##{)$1~=bZ1MmjeFw?uT(`8 z^g=09<=zW%r%buwN%iHtuKSg|+r7HkT0PYN*_u9k1;^Ss-Z!RBfJ?Un4w(awqp2b3 z%+myoFis_lTlCrGx2z$0BQdh+7?!JK#9K9@Z!VrG zNj6gK5r(b4?YDOLw|DPRoN7bdP{(>GEG41YcN~4r_SUHU2hgVtUwZG@s%edC;k7Sn zC)RvEnlq~raE2mY2ko64^m1KQL}3riixh?#J{o)IT+K-RdHae2eRX91-+g!y`8^># z-zI0ir>P%Xon)!@xp-BK2bDYUB9k613NRrY6%lVjbFcQc*pRqiK~8xtkNPLxt}e?&QsTB}^!39t_%Qb)~Ukn0O%iC;zt z<&A-y;3h++)>c1br`5VFM~5(83!HKx$L+my8sW_c#@x*|*vB1yU)_dt3vH;2hqPWx zAl^6@?ipx&U7pf`a*>Yq6C85nb+B=Fnn+(id$W#WB^uHAcZVG`qg;rWB}ubvi(Y>D z$ei>REw$#xp0SHAd^|1hq&9HJ=jKK8^zTH~nk)G?yUcmTh9vUM6Y0LMw4(gYVY$D$ zGl&WY&H<)BbJ&3sYbKjx1j^=3-0Q#f^}(aP1?8^`&FUWMp|rmtpK)bLQ1Zo?^s4jqK=Lfg*9&geMGVQ z#^-*!V`fG@;H&{M9S8%+;|h&Qrxym0Ar>WT4BCVLR8cGXF=JmEYN(sNT(9vl+S|%g z8r7nXQ(95i^`=+XHo|){$vf2$?=`F$^&wFlYXyXg$B{a>$-Fp+V}+D;9k=~Xl~?C4 zAB-;RKXdUzBJE{V&d&%R>aEfFe;vxqI$0@hwVM}gFeQR@j}a>DDxR+n+-*6|_)k%% z*mSpDV|=5I9!&VC&9tD%fcVygWZV!iIo2qFtm#!*(s|@ZT33*Ad;+<|3^+yrp*;oH zBSYLV(H1zTU?2WjrCQoQW)Z>J2a=dTriuvezBmu16`tM2fm7Q@d4^iqII-xFpwHGI zn9CL}QE*1vdj2PX{PIuqOe5dracsciH6OlAZATvE8rj6ykqdIjal2 z0S0S~PwHb-5?OQ-tU-^KTG@XNrEVSvo|HIP?H;7ZhYeZkhSqh-{reE!5di;1zk$#Y zCe7rOnlzFYJ6Z#Hm$GoidKB=2HBCwm`BbZVeZY4ukmG%1uz7p2URs6c9j-Gjj^oQV zsdDb3@k2e`C$1I5ML5U0Qs0C1GAp^?!*`=|Nm(vWz3j*j*8ucum2;r0^-6Aca=Gv) zc%}&;!+_*S2tlnnJnz0EKeRmw-Y!@9ob!XQBwiv}^u9MkaXHvM=!<3YX;+2#5Cj5pp?FEK750S3BgeSDtaE^ zXUM@xoV6yBFKfzvY20V&Lr0yC + CircuitPython Reference Documentation + CircuitPython Support Forum + Discord Chat + Adafruit Learning System + Adafruit Blog + Adafruit Store + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/examples/tca9548a_simpletest.py b/examples/tca9548a_simpletest.py new file mode 100644 index 0000000..3e47d2a --- /dev/null +++ b/examples/tca9548a_simpletest.py @@ -0,0 +1,22 @@ +# This example shows using two TSL2491 light sensors attached to TCA9548A channels 0 and 1. +# Use with other I2C sensors would be similar. +import time +import board +import busio +import adafruit_tsl2591 +import adafruit_tca9548a + +# Create I2C bus as normal +i2c = busio.I2C(board.SCL, board.SDA) + +# Create the TCA9548A object and give it the I2C bus +tca = adafruit_tca9548a.TCA9548A(i2c) + +# For each sensor, create it using the TCA9548A channel instead of the I2C object +tsl1 = adafruit_tsl2591.TSL2591(tca[0]) +tsl2 = adafruit_tsl2591.TSL2591(tca[1]) + +# Loop and profit! +while True: + print(tsl1.lux, tsl2.lux) + time.sleep(0.1) \ No newline at end of file diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..675d26a --- /dev/null +++ b/requirements.txt @@ -0,0 +1 @@ +adafruit-circuitpython-busdevice \ No newline at end of file From d53068042ca947bdf7865a2297619b22bf474396 Mon Sep 17 00:00:00 2001 From: caternuson Date: Tue, 14 Aug 2018 10:20:50 -0700 Subject: [PATCH 2/9] md is not rst --- README.rst | 49 +++++++++++++++++++++++++------------------------ 1 file changed, 25 insertions(+), 24 deletions(-) diff --git a/README.rst b/README.rst index 1d436bf..b491de2 100644 --- a/README.rst +++ b/README.rst @@ -29,30 +29,31 @@ This is easily achieved by downloading Usage Example ============= -```python -# This example shows using two TSL2491 light sensors attached to TCA9548A channels 0 and 1. -# Use with other I2C sensors would be similar. -import time -import board -import busio -import adafruit_tsl2591 -import adafruit_tca9548a - -# Create I2C bus as normal -i2c = busio.I2C(board.SCL, board.SDA) - -# Create the TCA9548A object and give it the I2C bus -tca = adafruit_tca9548a.TCA9548A(i2c) - -# For each sensor, create it using the TCA9548A channel instead of the I2C object -tsl1 = adafruit_tsl2591.TSL2591(tca[0]) -tsl2 = adafruit_tsl2591.TSL2591(tca[1]) - -# Loop and profit! -while True: - print(tsl1.lux, tsl2.lux) - time.sleep(0.1) -``` +.. code-block :: python + + # This example shows using two TSL2491 light sensors attached to TCA9548A channels 0 and 1. + # Use with other I2C sensors would be similar. + import time + import board + import busio + import adafruit_tsl2591 + import adafruit_tca9548a + + # Create I2C bus as normal + i2c = busio.I2C(board.SCL, board.SDA) + + # Create the TCA9548A object and give it the I2C bus + tca = adafruit_tca9548a.TCA9548A(i2c) + + # For each sensor, create it using the TCA9548A channel instead of the I2C object + tsl1 = adafruit_tsl2591.TSL2591(tca[0]) + tsl2 = adafruit_tsl2591.TSL2591(tca[1]) + + # Loop and profit! + while True: + print(tsl1.lux, tsl2.lux) + time.sleep(0.1) + Contributing ============ From 0f6da4e46fddaf4258f127171b2d727f721d9966 Mon Sep 17 00:00:00 2001 From: caternuson Date: Tue, 14 Aug 2018 11:03:31 -0700 Subject: [PATCH 3/9] travis kick --- examples/tca9548a_simpletest.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/examples/tca9548a_simpletest.py b/examples/tca9548a_simpletest.py index 3e47d2a..8bb7200 100644 --- a/examples/tca9548a_simpletest.py +++ b/examples/tca9548a_simpletest.py @@ -16,7 +16,7 @@ tsl1 = adafruit_tsl2591.TSL2591(tca[0]) tsl2 = adafruit_tsl2591.TSL2591(tca[1]) -# Loop and profit! +# After initial setup, can just use sensors as normal. while True: print(tsl1.lux, tsl2.lux) - time.sleep(0.1) \ No newline at end of file + time.sleep(0.1) From 898a7b1059fc69b5a66d5396c8fde0440a6b135a Mon Sep 17 00:00:00 2001 From: caternuson Date: Tue, 14 Aug 2018 11:10:14 -0700 Subject: [PATCH 4/9] pylint --- adafruit_tca9548a.py | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/adafruit_tca9548a.py b/adafruit_tca9548a.py index 5ce3d9b..caa4349 100644 --- a/adafruit_tca9548a.py +++ b/adafruit_tca9548a.py @@ -60,20 +60,24 @@ def __init__(self, tca, channel): self.channel_switch = bytearray([1 << channel]) def try_lock(self): + """Pass thru for try_lock.""" while not self.tca.i2c.try_lock(): pass self.tca.i2c.writeto(self.tca.address, self.channel_switch) return True def unlock(self): + """Pass thru for unlock.""" return self.tca.i2c.unlock() def readfrom_into(self, address, buffer, **kwargs): + """Pass thru for readfrom_into.""" if address == self.tca.address: raise ValueError("Device address must be different than TCA9548A address.") return self.tca.i2c.readfrom_into(address, buffer, **kwargs) def writeto(self, address, buffer, **kwargs): + """Pass thru for writeto.""" if address == self.tca.address: raise ValueError("Device address must be different than TCA9548A address.") return self.tca.i2c.writeto(address, buffer, **kwargs) @@ -83,7 +87,7 @@ class TCA9548A(): """Class which provides interface to TCA9548A I2C multiplexer.""" def __init__(self, i2c, address=_DEFAULT_ADDRESS): - self.i2c = i2c + self.i2c = i2c self.address = address self.used_channels = [] @@ -93,4 +97,4 @@ def __getitem__(self, key): if key in self.used_channels: raise ValueError("Channel already in use.") self.used_channels.append(key) - return TCA9548A_Channel(self, key) \ No newline at end of file + return TCA9548A_Channel(self, key) From 17744aebfe134d4b1a52ed2064b226b9af9e1b9f Mon Sep 17 00:00:00 2001 From: caternuson Date: Tue, 14 Aug 2018 11:25:29 -0700 Subject: [PATCH 5/9] autodoc micropython --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 2facce9..9704fb2 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -20,7 +20,7 @@ # Uncomment the below if you use native CircuitPython modules such as # digitalio, micropython and busio. List the modules you use. Without it, the # autodoc module docs will fail to generate with a warning. -# autodoc_mock_imports = ["digitalio", "busio"] +autodoc_mock_imports = ["micropython"] intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None),'BusDevice': ('https://circuitpython.readthedocs.io/projects/busdevice/en/latest/', None),'Register': ('https://circuitpython.readthedocs.io/projects/register/en/latest/', None),'CircuitPython': ('https://circuitpython.readthedocs.io/en/latest/', None)} From 417f0fe14cb9579b414ff87147f506e754581f98 Mon Sep 17 00:00:00 2001 From: caternuson Date: Tue, 14 Aug 2018 11:37:30 -0700 Subject: [PATCH 6/9] fixed todos --- docs/index.rst | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index 304e508..63b8fb5 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -23,14 +23,10 @@ Table of Contents .. toctree:: :caption: Tutorials -.. todo:: Add any Learn guide links here. If there are none, then simply delete this todo and leave - the toctree above for use later. - .. toctree:: :caption: Related Products -.. todo:: Add any product links here. If there are none, then simply delete this todo and leave - the toctree above for use later. + TCA9548A I2C Multiplexer .. toctree:: :caption: Other Links From f1cdad8f6d55a6c9722b29bd149354aac7ef948f Mon Sep 17 00:00:00 2001 From: caternuson Date: Tue, 14 Aug 2018 12:57:35 -0700 Subject: [PATCH 7/9] sphinx doc string fix --- adafruit_tca9548a.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/adafruit_tca9548a.py b/adafruit_tca9548a.py index caa4349..3a4c689 100644 --- a/adafruit_tca9548a.py +++ b/adafruit_tca9548a.py @@ -20,7 +20,7 @@ # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN # THE SOFTWARE. """ -`Adafruit_TCA9548A` +``Adafruit_TCA9548A`` ==================================================== CircuitPython driver for the TCA9548A I2C Multiplexer. From 6c4e212e237ad1307de9497557919ccf991cdcd0 Mon Sep 17 00:00:00 2001 From: caternuson Date: Wed, 15 Aug 2018 15:19:06 -0700 Subject: [PATCH 8/9] code review updates --- .pylintrc | 2 +- .travis.yml | 3 ++- adafruit_tca9548a.py | 14 ++++++++------ requirements.txt | 1 - 4 files changed, 11 insertions(+), 9 deletions(-) diff --git a/.pylintrc b/.pylintrc index 81d8170..039eaec 100644 --- a/.pylintrc +++ b/.pylintrc @@ -156,7 +156,7 @@ ignored-classes=optparse.Values,thread._local,_thread._local # (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= +ignored-modules=board # Show a hint with possible names when a member name was not found. The aspect # of finding the hint is based on edit distance. diff --git a/.travis.yml b/.travis.yml index ecac5c4..3aea788 100644 --- a/.travis.yml +++ b/.travis.yml @@ -23,7 +23,8 @@ deploy: tags: true install: - - pip install pylint circuitpython-build-tools Sphinx sphinx-rtd-theme + - pip install circuitpython-build-tools Sphinx sphinx-rtd-theme + - pip install --force-reinstall pylint==1.9.2 script: - pylint adafruit_tca9548a.py diff --git a/adafruit_tca9548a.py b/adafruit_tca9548a.py index 3a4c689..957c03e 100644 --- a/adafruit_tca9548a.py +++ b/adafruit_tca9548a.py @@ -89,12 +89,14 @@ class TCA9548A(): def __init__(self, i2c, address=_DEFAULT_ADDRESS): self.i2c = i2c self.address = address - self.used_channels = [] + self.channels = [None]*8 + + def __len__(self): + return 8 def __getitem__(self, key): if not 0 <= key <= 7: - raise ValueError("Channel must be an integer in the range: 0-7") - if key in self.used_channels: - raise ValueError("Channel already in use.") - self.used_channels.append(key) - return TCA9548A_Channel(self, key) + raise IndexError("Channel must be an integer in the range: 0-7") + if self.channels[key] is None: + self.channels[key] = TCA9548A_Channel(self, key) + return self.channels[key] diff --git a/requirements.txt b/requirements.txt index 675d26a..e69de29 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1 +0,0 @@ -adafruit-circuitpython-busdevice \ No newline at end of file From dcda8fe35a2752b905a99d790dd52cd121c1316a Mon Sep 17 00:00:00 2001 From: caternuson Date: Wed, 15 Aug 2018 15:56:36 -0700 Subject: [PATCH 9/9] remove unused member --- adafruit_tca9548a.py | 1 - 1 file changed, 1 deletion(-) diff --git a/adafruit_tca9548a.py b/adafruit_tca9548a.py index 957c03e..5e709b1 100644 --- a/adafruit_tca9548a.py +++ b/adafruit_tca9548a.py @@ -56,7 +56,6 @@ class TCA9548A_Channel(): def __init__(self, tca, channel): self.tca = tca - self.channel = channel self.channel_switch = bytearray([1 << channel]) def try_lock(self):