Init commit
This commit is contained in:
		
							
								
								
									
										13
									
								
								.gitignore
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										13
									
								
								.gitignore
									
									
									
									
										vendored
									
									
										Normal file
									
								
							@@ -0,0 +1,13 @@
 | 
			
		||||
*.mpy
 | 
			
		||||
.idea
 | 
			
		||||
__pycache__
 | 
			
		||||
_build
 | 
			
		||||
*.pyc
 | 
			
		||||
.env
 | 
			
		||||
build*
 | 
			
		||||
bundles
 | 
			
		||||
*.DS_Store
 | 
			
		||||
.eggs
 | 
			
		||||
dist
 | 
			
		||||
**/*.egg-info
 | 
			
		||||
.directory
 | 
			
		||||
							
								
								
									
										433
									
								
								.pylintrc
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										433
									
								
								.pylintrc
									
									
									
									
									
										Normal file
									
								
							@@ -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=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.
 | 
			
		||||
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*(# )?<?https?://\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
 | 
			
		||||
							
								
								
									
										3
									
								
								.readthedocs.yml
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										3
									
								
								.readthedocs.yml
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,3 @@
 | 
			
		||||
python:
 | 
			
		||||
    version: 3
 | 
			
		||||
requirements_file: requirements.txt
 | 
			
		||||
							
								
								
									
										48
									
								
								.travis.yml
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										48
									
								
								.travis.yml
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,48 @@
 | 
			
		||||
# 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: xenial
 | 
			
		||||
language: python
 | 
			
		||||
python:
 | 
			
		||||
  - "3.6"
 | 
			
		||||
 | 
			
		||||
cache:
 | 
			
		||||
  pip: true
 | 
			
		||||
 | 
			
		||||
# TODO: if deployment to PyPi is desired, change 'DEPLOY_PYPI' to "true",
 | 
			
		||||
#       or remove the env block entirely and remove the condition in the
 | 
			
		||||
#       deploy block.
 | 
			
		||||
env:
 | 
			
		||||
  - DEPLOY_PYPI="false"
 | 
			
		||||
 | 
			
		||||
deploy:
 | 
			
		||||
  - provider: releases
 | 
			
		||||
    api_key: "$GITHUB_TOKEN"
 | 
			
		||||
    file_glob: true
 | 
			
		||||
    file: "$TRAVIS_BUILD_DIR/bundles/*"
 | 
			
		||||
    skip_cleanup: true
 | 
			
		||||
    overwrite: true
 | 
			
		||||
    on:
 | 
			
		||||
      tags: true
 | 
			
		||||
  # TODO: Use 'travis encrypt --com -r adafruit/<repo slug>' to generate
 | 
			
		||||
  #       the encrypted password for adafruit-travis. Paste result below.
 | 
			
		||||
  - provider: pypi
 | 
			
		||||
    user: adafruit-travis
 | 
			
		||||
    password:
 | 
			
		||||
      secure: #-- PASTE ENCRYPTED PASSWORD HERE --#
 | 
			
		||||
    on:
 | 
			
		||||
      tags: true
 | 
			
		||||
      condition: $DEPLOY_PYPI = "true"
 | 
			
		||||
 | 
			
		||||
install:
 | 
			
		||||
  - pip install -r requirements.txt
 | 
			
		||||
  - pip install circuitpython-build-tools Sphinx sphinx-rtd-theme
 | 
			
		||||
  - pip install --force-reinstall pylint==1.9.2
 | 
			
		||||
 | 
			
		||||
script:
 | 
			
		||||
  - pylint circuitpython_neotrellism4.py
 | 
			
		||||
  - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace examples/*.py)
 | 
			
		||||
  - circuitpython-build-bundles --filename_prefix circuitpython-circuitpython-neotrellism4 --library_location .
 | 
			
		||||
  - cd docs && sphinx-build -E -W -b html . _build/html && cd ..
 | 
			
		||||
							
								
								
									
										127
									
								
								CODE_OF_CONDUCT.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										127
									
								
								CODE_OF_CONDUCT.md
									
									
									
									
									
										Normal file
									
								
							@@ -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 <support@adafruit.com>.
 | 
			
		||||
 | 
			
		||||
On the Adafruit Discord, you may send an open message from any channel
 | 
			
		||||
to all Community Helpers by tagging @community moderators. 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
 | 
			
		||||
<https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>,
 | 
			
		||||
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.
 | 
			
		||||
							
								
								
									
										21
									
								
								LICENSE
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										21
									
								
								LICENSE
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,21 @@
 | 
			
		||||
The MIT License (MIT)
 | 
			
		||||
 | 
			
		||||
Copyright (c) 2019 arofarn
 | 
			
		||||
 | 
			
		||||
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.
 | 
			
		||||
							
								
								
									
										118
									
								
								README.rst
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										118
									
								
								README.rst
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,118 @@
 | 
			
		||||
Introduction
 | 
			
		||||
============
 | 
			
		||||
 | 
			
		||||
.. image:: https://readthedocs.org/projects/circuitpython-circuitpython-neotrellism4/badge/?version=latest
 | 
			
		||||
    :target: https://circuitpython.readthedocs.io/projects/neotrellism4/en/latest/
 | 
			
		||||
    :alt: Documentation Status
 | 
			
		||||
 | 
			
		||||
.. image:: https://img.shields.io/discord/327254708534116352.svg
 | 
			
		||||
    :target: https://discord.gg/nBQh6qu
 | 
			
		||||
    :alt: Discord
 | 
			
		||||
 | 
			
		||||
.. image:: https://travis-ci.com/arofarn/Circuitpython_CircuitPython_NeoTrellisM4.svg?branch=master
 | 
			
		||||
    :target: https://travis-ci.com/arofarn/Circuitpython_CircuitPython_NeoTrellisM4
 | 
			
		||||
    :alt: Build Status
 | 
			
		||||
 | 
			
		||||
Use Adafruit TrellisM4 Express board as 2 Neotrellis board. You can you use this to extend TrellisM4 with Neotrellis (seesaw) boards.
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
Dependencies
 | 
			
		||||
=============
 | 
			
		||||
This driver depends on:
 | 
			
		||||
 | 
			
		||||
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
 | 
			
		||||
* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_
 | 
			
		||||
 | 
			
		||||
Please ensure all dependencies are available on the CircuitPython filesystem.
 | 
			
		||||
This is easily achieved by downloading
 | 
			
		||||
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
 | 
			
		||||
 | 
			
		||||
Installing from PyPI
 | 
			
		||||
--------------------
 | 
			
		||||
.. note:: This library is not available on PyPI yet. Install documentation is included
 | 
			
		||||
   as a standard element. Stay tuned for PyPI availability!
 | 
			
		||||
.. todo:: Remove the above note if PyPI version is/will be available at time of release.
 | 
			
		||||
   If the library is not planned for PyPI, remove the entire 'Installing from PyPI' section.
 | 
			
		||||
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
 | 
			
		||||
PyPI <https://pypi.org/project/adafruit-circuitpython-neotrellism4/>`_. To install for current user:
 | 
			
		||||
 | 
			
		||||
.. code-block:: shell
 | 
			
		||||
 | 
			
		||||
    pip3 install adafruit-circuitpython-neotrellism4
 | 
			
		||||
 | 
			
		||||
To install system-wide (this may be required in some cases):
 | 
			
		||||
 | 
			
		||||
.. code-block:: shell
 | 
			
		||||
 | 
			
		||||
    sudo pip3 install adafruit-circuitpython-neotrellism4
 | 
			
		||||
 | 
			
		||||
To install in a virtual environment in your current project:
 | 
			
		||||
 | 
			
		||||
.. code-block:: shell
 | 
			
		||||
 | 
			
		||||
    mkdir project-name && cd project-name
 | 
			
		||||
    python3 -m venv .env
 | 
			
		||||
    source .env/bin/activate
 | 
			
		||||
    pip3 install adafruit-circuitpython-neotrellism4
 | 
			
		||||
 | 
			
		||||
Usage Example
 | 
			
		||||
=============
 | 
			
		||||
 | 
			
		||||
.. todo:: Add a quick, simple example. It and other examples should live in the examples folder and be included in docs/examples.rst.
 | 
			
		||||
 | 
			
		||||
Contributing
 | 
			
		||||
============
 | 
			
		||||
 | 
			
		||||
Contributions are welcome! Please read our `Code of Conduct
 | 
			
		||||
<https://github.com/arofarn/Circuitpython_CircuitPython_NeoTrellisM4/blob/master/CODE_OF_CONDUCT.md>`_
 | 
			
		||||
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 <https://github.com/adafruit/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 circuitpython-circuitpython-neotrellism4 --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.
 | 
			
		||||
							
								
								
									
										297
									
								
								circuitpython_neotrellism4.py
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										297
									
								
								circuitpython_neotrellism4.py
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,297 @@
 | 
			
		||||
# The MIT License (MIT)
 | 
			
		||||
#
 | 
			
		||||
# Copyright (c) 2019 arofarn
 | 
			
		||||
#
 | 
			
		||||
# 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.
 | 
			
		||||
"""
 | 
			
		||||
`circuitpython_neotrellism4`
 | 
			
		||||
================================================================================
 | 
			
		||||
 | 
			
		||||
Use Adafruit TrellisM4 Express board as 2 Neotrellis board. You can you use this to extend TrellisM4 with Neotrellis (seesaw) boards.
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
* Author(s): arofarn
 | 
			
		||||
 | 
			
		||||
Implementation Notes
 | 
			
		||||
--------------------
 | 
			
		||||
 | 
			
		||||
**Hardware:**
 | 
			
		||||
 | 
			
		||||
* Adafruit NeoTrellis M4 Express: https://www.adafruit.com/product/3938
 | 
			
		||||
 | 
			
		||||
**Software and Dependencies:**
 | 
			
		||||
 | 
			
		||||
* Adafruit CircuitPython firmware for the supported boards:
 | 
			
		||||
  https://github.com/adafruit/circuitpython/releases
 | 
			
		||||
 | 
			
		||||
"""
 | 
			
		||||
 | 
			
		||||
# imports
 | 
			
		||||
 | 
			
		||||
__version__ = "0.0.0-auto.0"
 | 
			
		||||
__repo__ = "https://github.com/arofarn/Circuitpython_CircuitPython_neotrellism4.git"
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
import board
 | 
			
		||||
import digitalio
 | 
			
		||||
from micropython import const
 | 
			
		||||
from adafruit_seesaw.keypad import KeyEvent
 | 
			
		||||
from adafruit_matrixkeypad import Matrix_Keypad
 | 
			
		||||
from neopixel import NeoPixel
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
_NEO_TRELLIS_NUM_ROWS = const(4)
 | 
			
		||||
_NEO_TRELLIS_NUM_COLS = const(4)
 | 
			
		||||
_NEO_TRELLIS_NUM_KEYS = const(16)
 | 
			
		||||
 | 
			
		||||
# _NEO_TRELLIS_MAX_CALLBACKS = const(32)
 | 
			
		||||
 | 
			
		||||
_TRELLISM4_LEFT_PART = const(0)
 | 
			
		||||
_TRELLISM4_RIGHT_PART = const(4)
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
def _key(xval):
 | 
			
		||||
    return int(int(xval/4)*8 + (xval%4))
 | 
			
		||||
 | 
			
		||||
def _seesaw_key(xval):
 | 
			
		||||
    return int(int(xval/8)*4 + (xval%8))
 | 
			
		||||
 | 
			
		||||
def _to_seesaw_key(xval):
 | 
			
		||||
    return int(xval + (xval // 4) * 4)
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
class _TrellisNeoPixel:
 | 
			
		||||
    """Neopixel driver
 | 
			
		||||
    """
 | 
			
		||||
    # Lots of stuff come from Adafruit_CircuitPython_seesaw/neopixel.py
 | 
			
		||||
 | 
			
		||||
    def __init__(self, auto_write=True, brightness=1.0,
 | 
			
		||||
                 part=_TRELLISM4_LEFT_PART, left_part=None):
 | 
			
		||||
        if part == _TRELLISM4_LEFT_PART:
 | 
			
		||||
            self.pix = NeoPixel(board.NEOPIXEL, 32, auto_write=False, brightness=brightness)
 | 
			
		||||
        elif part == _TRELLISM4_RIGHT_PART:
 | 
			
		||||
            self.pix = left_part.pix
 | 
			
		||||
        self.auto_write = auto_write
 | 
			
		||||
        self._offset = part
 | 
			
		||||
 | 
			
		||||
    def __setitem__(self, key, color):
 | 
			
		||||
        self.pix[_key(key) + self._offset] = color
 | 
			
		||||
        if self.auto_write:
 | 
			
		||||
            self.show()
 | 
			
		||||
 | 
			
		||||
    def __getitem__(self, key):
 | 
			
		||||
        return self.pix[_key(key) + self._offset]
 | 
			
		||||
 | 
			
		||||
    def fill(self, color):
 | 
			
		||||
        """Fill method wrapper
 | 
			
		||||
        """
 | 
			
		||||
        # Suppress auto_write while filling.
 | 
			
		||||
        current_auto_write = self.auto_write
 | 
			
		||||
        self.auto_write = False
 | 
			
		||||
        for i in range(16):
 | 
			
		||||
            self[i] = color
 | 
			
		||||
        if current_auto_write:
 | 
			
		||||
            self.show()
 | 
			
		||||
        self.auto_write = current_auto_write
 | 
			
		||||
 | 
			
		||||
    def show(self):
 | 
			
		||||
        """fill method wrapper
 | 
			
		||||
        """
 | 
			
		||||
        self.pix.show()
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
class _TrellisKeypad:
 | 
			
		||||
    """Simple Keypad object for Trellis M4
 | 
			
		||||
    No pixel, no rotation
 | 
			
		||||
    Key numbers : 0 - 15"""
 | 
			
		||||
 | 
			
		||||
    def __init__(self, part=_TRELLISM4_LEFT_PART, row_pins=None):
 | 
			
		||||
        self._offset = part
 | 
			
		||||
        col_pins = []
 | 
			
		||||
        for x in range(self._offset, self._offset + _NEO_TRELLIS_NUM_COLS):
 | 
			
		||||
            col_pin = digitalio.DigitalInOut(getattr(board, "COL{}".format(x)))
 | 
			
		||||
            col_pins.append(col_pin)
 | 
			
		||||
 | 
			
		||||
        if part == _TRELLISM4_LEFT_PART:
 | 
			
		||||
            self.row_pins = []
 | 
			
		||||
            for y in range(_NEO_TRELLIS_NUM_ROWS):
 | 
			
		||||
                row_pin = digitalio.DigitalInOut(getattr(board, "ROW{}".format(y)))
 | 
			
		||||
                self.row_pins.append(row_pin)
 | 
			
		||||
        elif part == _TRELLISM4_RIGHT_PART:
 | 
			
		||||
            if row_pins is None:
 | 
			
		||||
                raise ValueError("Missing row_pins list for the right part")
 | 
			
		||||
            else:
 | 
			
		||||
                self.row_pins = row_pins
 | 
			
		||||
        else:
 | 
			
		||||
            raise ValueError("part arg should be 0 (left part) or 4 (right part)")
 | 
			
		||||
 | 
			
		||||
        key_names = []
 | 
			
		||||
        for y in range(4):
 | 
			
		||||
            row = []
 | 
			
		||||
            for x in range(4):
 | 
			
		||||
                row.append(4 * x + y)
 | 
			
		||||
            key_names.append(row)    # Keys of each halves is numbered from 0-15
 | 
			
		||||
 | 
			
		||||
        self._matrix = Matrix_Keypad(col_pins, self.row_pins, key_names)
 | 
			
		||||
 | 
			
		||||
    @property
 | 
			
		||||
    def pressed_keys(self):
 | 
			
		||||
        """A list of tuples of currently pressed button coordinates.
 | 
			
		||||
 | 
			
		||||
        .. code-block:: python
 | 
			
		||||
 | 
			
		||||
            import time
 | 
			
		||||
            import adafruit_trellism4
 | 
			
		||||
 | 
			
		||||
            trellis = adafruit_trellism4.TrellisM4Express()
 | 
			
		||||
 | 
			
		||||
            current_press = set()
 | 
			
		||||
            while True:
 | 
			
		||||
                pressed = set(trellis.pressed_keys)
 | 
			
		||||
                for press in pressed - current_press:
 | 
			
		||||
                    print("Pressed:", press)
 | 
			
		||||
                for release in current_press - pressed:
 | 
			
		||||
                    print("Released:", release)
 | 
			
		||||
                time.sleep(0.08)
 | 
			
		||||
                current_press = pressed
 | 
			
		||||
        """
 | 
			
		||||
        return self._matrix.pressed_keys
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
class NeoTrellisM4:
 | 
			
		||||
    """Driver for the Adafruit NeoTrellis."""
 | 
			
		||||
 | 
			
		||||
    EDGE_HIGH = const(0)
 | 
			
		||||
    EDGE_LOW = const(1)
 | 
			
		||||
    EDGE_FALLING = const(2)
 | 
			
		||||
    EDGE_RISING = const(3)
 | 
			
		||||
 | 
			
		||||
    def __init__(self, left_part=None):
 | 
			
		||||
        if left_part is None:
 | 
			
		||||
            self._offset = _TRELLISM4_LEFT_PART
 | 
			
		||||
            self.pixels = _TrellisNeoPixel()
 | 
			
		||||
            self.keypad = _TrellisKeypad()
 | 
			
		||||
        else:
 | 
			
		||||
            self._offset = _TRELLISM4_RIGHT_PART
 | 
			
		||||
            self.pixels = _TrellisNeoPixel(32,
 | 
			
		||||
                                           part=_TRELLISM4_RIGHT_PART,
 | 
			
		||||
                                           left_part=left_part.pixels)
 | 
			
		||||
            self.keypad = _TrellisKeypad(part=_TRELLISM4_RIGHT_PART,
 | 
			
		||||
                                         row_pins=left_part.keypad.row_pins)
 | 
			
		||||
 | 
			
		||||
        self._events = [0] * _NEO_TRELLIS_NUM_KEYS
 | 
			
		||||
        self._current_press = set()
 | 
			
		||||
        self._key_edges = [self.EDGE_HIGH] * _NEO_TRELLIS_NUM_KEYS     # Keys edges
 | 
			
		||||
        self._current_events = bytearray()
 | 
			
		||||
        self.callbacks = [None] * 16
 | 
			
		||||
 | 
			
		||||
    @property
 | 
			
		||||
    def interrupt_enabled(self):
 | 
			
		||||
        """Only for compatibility with neotrellis module
 | 
			
		||||
        interrupts are disable on trellis M4 keypad"""
 | 
			
		||||
        return False
 | 
			
		||||
 | 
			
		||||
    # pylint: disable=unused-argument, no-self-use
 | 
			
		||||
    @interrupt_enabled.setter
 | 
			
		||||
    def interrupt_enabled(self, value):
 | 
			
		||||
        """Only for compatibility with neotrellis module
 | 
			
		||||
        interrupts are disable on trellis M4 keypad
 | 
			
		||||
        """
 | 
			
		||||
        print("Warning: no interrupt with Trellis M4 keypad (method does nothing)")
 | 
			
		||||
    # pylint: enable=unused-argument, no-self-use
 | 
			
		||||
 | 
			
		||||
    @property
 | 
			
		||||
    def count(self):
 | 
			
		||||
        """Return the pressed keys count
 | 
			
		||||
        """
 | 
			
		||||
        self._read_keypad()
 | 
			
		||||
        return len(self._current_events)
 | 
			
		||||
 | 
			
		||||
    # pylint: disable=unused-argument, no-self-use
 | 
			
		||||
    @count.setter
 | 
			
		||||
    def count(self, value):
 | 
			
		||||
        """Only for compatibility with neotrellis module
 | 
			
		||||
        """
 | 
			
		||||
        raise AttributeError("count is read only")
 | 
			
		||||
    # pylint: enable=unused-argument, no-self-use
 | 
			
		||||
 | 
			
		||||
    def set_event(self, key, edge, enable):
 | 
			
		||||
        """Set event on a key
 | 
			
		||||
        """
 | 
			
		||||
        if enable not in (True, False):
 | 
			
		||||
            raise ValueError("event enable must be True or False")
 | 
			
		||||
        if edge > 3 or edge < 0:
 | 
			
		||||
            raise ValueError("invalid edge")
 | 
			
		||||
 | 
			
		||||
        # Pas besoin de l'écriture sur I2C mais de l'enregistrer dans self._events
 | 
			
		||||
        if enable:
 | 
			
		||||
            self._events[key] = self._events[key] | (1 << edge)
 | 
			
		||||
        else:
 | 
			
		||||
            self._events[key] = self._events[key] & (0xF ^ (1 << edge))
 | 
			
		||||
 | 
			
		||||
    def read_keypad(self, num):
 | 
			
		||||
        """Give the n events in the keypad buffer
 | 
			
		||||
        """
 | 
			
		||||
        while num > len(self._current_events):
 | 
			
		||||
            self._current_events.append(0xFF)
 | 
			
		||||
        return self._current_events[:num]
 | 
			
		||||
 | 
			
		||||
    def _read_keypad(self):
 | 
			
		||||
        """Read keypad and update _key_edges and _current_events"""
 | 
			
		||||
        pressed = set(self.keypad.pressed_keys)
 | 
			
		||||
        #default : not pressed => EDGE_HIGH
 | 
			
		||||
        self._key_edges = [self.EDGE_HIGH] * _NEO_TRELLIS_NUM_KEYS
 | 
			
		||||
        for k in pressed:
 | 
			
		||||
            self._key_edges[k] = self.EDGE_LOW
 | 
			
		||||
        for k in pressed - self._current_press:
 | 
			
		||||
            self._key_edges[k] = self.EDGE_RISING
 | 
			
		||||
        for k in self._current_press - pressed:
 | 
			
		||||
            self._key_edges[k] = self.EDGE_FALLING
 | 
			
		||||
 | 
			
		||||
        self._current_press = pressed
 | 
			
		||||
        self._current_events = bytearray()
 | 
			
		||||
 | 
			
		||||
        for k in range(_NEO_TRELLIS_NUM_KEYS):
 | 
			
		||||
            if (self._events[k] >> self._key_edges[k]) & 0x1:
 | 
			
		||||
                raw_evt = (_to_seesaw_key(k) << 2) | self._key_edges[k]
 | 
			
		||||
                self._current_events.append(raw_evt)
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
    def activate_key(self, key, edge, enable=True):
 | 
			
		||||
        """Activate or deactivate a key on the trellis. Key is the key number from
 | 
			
		||||
           0 to 15. Edge specifies what edge to register an event on and can be
 | 
			
		||||
           NeoTrellis.EDGE_FALLING or NeoTrellis.EDGE_RISING. enable should be set
 | 
			
		||||
           to True if the event is to be enabled, or False if the event is to be
 | 
			
		||||
           disabled.
 | 
			
		||||
           """
 | 
			
		||||
        self.set_event(key, edge, enable)
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
    def sync(self):
 | 
			
		||||
        """Read any events from the Trellis hardware and call associated
 | 
			
		||||
           callbacks
 | 
			
		||||
           """
 | 
			
		||||
        available = self.count
 | 
			
		||||
        if available > 0:
 | 
			
		||||
            available = available + 2
 | 
			
		||||
            buf = self.read_keypad(available)
 | 
			
		||||
            for raw in buf:
 | 
			
		||||
                evt = KeyEvent(_seesaw_key((raw >> 2) & 0x3F), raw & 0x3)
 | 
			
		||||
                if evt.number < _NEO_TRELLIS_NUM_KEYS and self.callbacks[evt.number] is not None:
 | 
			
		||||
                    self.callbacks[evt.number](evt)
 | 
			
		||||
							
								
								
									
										
											BIN
										
									
								
								docs/_static/favicon.ico
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										
											BIN
										
									
								
								docs/_static/favicon.ico
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
										
											Binary file not shown.
										
									
								
							| 
		 After Width: | Height: | Size: 4.3 KiB  | 
							
								
								
									
										8
									
								
								docs/api.rst
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										8
									
								
								docs/api.rst
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,8 @@
 | 
			
		||||
 | 
			
		||||
.. If you created a package, create one automodule per module in the package.
 | 
			
		||||
 | 
			
		||||
.. If your library file(s) are nested in a directory (e.g. /adafruit_foo/foo.py)
 | 
			
		||||
.. use this format as the module name: "adafruit_foo.foo"
 | 
			
		||||
 | 
			
		||||
.. automodule:: circuitpython_neotrellism4
 | 
			
		||||
   :members:
 | 
			
		||||
							
								
								
									
										160
									
								
								docs/conf.py
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										160
									
								
								docs/conf.py
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,160 @@
 | 
			
		||||
# -*- coding: utf-8 -*-
 | 
			
		||||
 | 
			
		||||
import os
 | 
			
		||||
import sys
 | 
			
		||||
sys.path.insert(0, os.path.abspath('..'))
 | 
			
		||||
 | 
			
		||||
# -- General configuration ------------------------------------------------
 | 
			
		||||
 | 
			
		||||
# Add any Sphinx extension module names here, as strings. They can be
 | 
			
		||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 | 
			
		||||
# ones.
 | 
			
		||||
extensions = [
 | 
			
		||||
    'sphinx.ext.autodoc',
 | 
			
		||||
    'sphinx.ext.intersphinx',
 | 
			
		||||
    'sphinx.ext.napoleon',
 | 
			
		||||
    'sphinx.ext.todo',
 | 
			
		||||
]
 | 
			
		||||
 | 
			
		||||
# TODO: Please Read!
 | 
			
		||||
# 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"]
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None),'BusDevice': ('https://circuitpython.readthedocs.io/projects/busdevice/en/latest/', None),'CircuitPython': ('https://circuitpython.readthedocs.io/en/latest/', None)}
 | 
			
		||||
 | 
			
		||||
# Add any paths that contain templates here, relative to this directory.
 | 
			
		||||
templates_path = ['_templates']
 | 
			
		||||
 | 
			
		||||
source_suffix = '.rst'
 | 
			
		||||
 | 
			
		||||
# The master toctree document.
 | 
			
		||||
master_doc = 'index'
 | 
			
		||||
 | 
			
		||||
# General information about the project.
 | 
			
		||||
project = u'Circuitpython NeoTrellisM4 Library'
 | 
			
		||||
copyright = u'2019 arofarn'
 | 
			
		||||
author = u'arofarn'
 | 
			
		||||
 | 
			
		||||
# The version info for the project you're documenting, acts as replacement for
 | 
			
		||||
# |version| and |release|, also used in various other places throughout the
 | 
			
		||||
# built documents.
 | 
			
		||||
#
 | 
			
		||||
# The short X.Y version.
 | 
			
		||||
version = u'1.0'
 | 
			
		||||
# The full version, including alpha/beta/rc tags.
 | 
			
		||||
release = u'1.0'
 | 
			
		||||
 | 
			
		||||
# The language for content autogenerated by Sphinx. Refer to documentation
 | 
			
		||||
# for a list of supported languages.
 | 
			
		||||
#
 | 
			
		||||
# This is also used if you do content translation via gettext catalogs.
 | 
			
		||||
# Usually you set "language" from the command line for these cases.
 | 
			
		||||
language = None
 | 
			
		||||
 | 
			
		||||
# List of patterns, relative to source directory, that match files and
 | 
			
		||||
# directories to ignore when looking for source files.
 | 
			
		||||
# This patterns also effect to html_static_path and html_extra_path
 | 
			
		||||
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '.env', 'CODE_OF_CONDUCT.md']
 | 
			
		||||
 | 
			
		||||
# The reST default role (used for this markup: `text`) to use for all
 | 
			
		||||
# documents.
 | 
			
		||||
#
 | 
			
		||||
default_role = "any"
 | 
			
		||||
 | 
			
		||||
# If true, '()' will be appended to :func: etc. cross-reference text.
 | 
			
		||||
#
 | 
			
		||||
add_function_parentheses = True
 | 
			
		||||
 | 
			
		||||
# The name of the Pygments (syntax highlighting) style to use.
 | 
			
		||||
pygments_style = 'sphinx'
 | 
			
		||||
 | 
			
		||||
# If true, `todo` and `todoList` produce output, else they produce nothing.
 | 
			
		||||
todo_include_todos = False
 | 
			
		||||
 | 
			
		||||
# If this is True, todo emits a warning for each TODO entries. The default is False.
 | 
			
		||||
todo_emit_warnings = True
 | 
			
		||||
 | 
			
		||||
napoleon_numpy_docstring = False
 | 
			
		||||
 | 
			
		||||
# -- Options for HTML output ----------------------------------------------
 | 
			
		||||
 | 
			
		||||
# The theme to use for HTML and HTML Help pages.  See the documentation for
 | 
			
		||||
# a list of builtin themes.
 | 
			
		||||
#
 | 
			
		||||
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
 | 
			
		||||
 | 
			
		||||
if not on_rtd:  # only import and set the theme if we're building docs locally
 | 
			
		||||
    try:
 | 
			
		||||
        import sphinx_rtd_theme
 | 
			
		||||
        html_theme = 'sphinx_rtd_theme'
 | 
			
		||||
        html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), '.']
 | 
			
		||||
    except:
 | 
			
		||||
        html_theme = 'default'
 | 
			
		||||
        html_theme_path = ['.']
 | 
			
		||||
else:
 | 
			
		||||
    html_theme_path = ['.']
 | 
			
		||||
 | 
			
		||||
# Add any paths that contain custom static files (such as style sheets) here,
 | 
			
		||||
# relative to this directory. They are copied after the builtin static files,
 | 
			
		||||
# so a file named "default.css" will overwrite the builtin "default.css".
 | 
			
		||||
html_static_path = ['_static']
 | 
			
		||||
 | 
			
		||||
# The name of an image file (relative to this directory) to use as a favicon of
 | 
			
		||||
# the docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 | 
			
		||||
# pixels large.
 | 
			
		||||
#
 | 
			
		||||
html_favicon = '_static/favicon.ico'
 | 
			
		||||
 | 
			
		||||
# Output file base name for HTML help builder.
 | 
			
		||||
htmlhelp_basename = 'CircuitpythonNeotrellism4Librarydoc'
 | 
			
		||||
 | 
			
		||||
# -- Options for LaTeX output ---------------------------------------------
 | 
			
		||||
 | 
			
		||||
latex_elements = {
 | 
			
		||||
     # The paper size ('letterpaper' or 'a4paper').
 | 
			
		||||
     #
 | 
			
		||||
     # 'papersize': 'letterpaper',
 | 
			
		||||
 | 
			
		||||
     # The font size ('10pt', '11pt' or '12pt').
 | 
			
		||||
     #
 | 
			
		||||
     # 'pointsize': '10pt',
 | 
			
		||||
 | 
			
		||||
     # Additional stuff for the LaTeX preamble.
 | 
			
		||||
     #
 | 
			
		||||
     # 'preamble': '',
 | 
			
		||||
 | 
			
		||||
     # Latex figure (float) alignment
 | 
			
		||||
     #
 | 
			
		||||
     # 'figure_align': 'htbp',
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
# Grouping the document tree into LaTeX files. List of tuples
 | 
			
		||||
# (source start file, target name, title,
 | 
			
		||||
#  author, documentclass [howto, manual, or own class]).
 | 
			
		||||
latex_documents = [
 | 
			
		||||
    (master_doc, 'CircuitpythonNeoTrellisM4Library.tex', u'CircuitpythonNeoTrellisM4 Library Documentation',
 | 
			
		||||
     author, 'manual'),
 | 
			
		||||
]
 | 
			
		||||
 | 
			
		||||
# -- Options for manual page output ---------------------------------------
 | 
			
		||||
 | 
			
		||||
# One entry per manual page. List of tuples
 | 
			
		||||
# (source start file, name, description, authors, manual section).
 | 
			
		||||
man_pages = [
 | 
			
		||||
    (master_doc, 'CircuitpythonNeoTrellisM4library', u'Circuitpython NeoTrellisM4 Library Documentation',
 | 
			
		||||
     [author], 1)
 | 
			
		||||
]
 | 
			
		||||
 | 
			
		||||
# -- Options for Texinfo output -------------------------------------------
 | 
			
		||||
 | 
			
		||||
# Grouping the document tree into Texinfo files. List of tuples
 | 
			
		||||
# (source start file, target name, title, author,
 | 
			
		||||
#  dir menu entry, description, category)
 | 
			
		||||
texinfo_documents = [
 | 
			
		||||
    (master_doc, 'CircuitpythonNeoTrellisM4Library', u'Circuitpython NeoTrellisM4 Library Documentation',
 | 
			
		||||
     author, 'CircuitpythonNeoTrellisM4Library', 'One line description of project.',
 | 
			
		||||
     'Miscellaneous'),
 | 
			
		||||
]
 | 
			
		||||
							
								
								
									
										8
									
								
								docs/examples.rst
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										8
									
								
								docs/examples.rst
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,8 @@
 | 
			
		||||
Simple test
 | 
			
		||||
------------
 | 
			
		||||
 | 
			
		||||
Ensure your device works with this simple test.
 | 
			
		||||
 | 
			
		||||
.. literalinclude:: ../examples/neotrellism4_simpletest.py
 | 
			
		||||
    :caption: examples/neotrellism4_simpletest.py
 | 
			
		||||
    :linenos:
 | 
			
		||||
							
								
								
									
										51
									
								
								docs/index.rst
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										51
									
								
								docs/index.rst
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,51 @@
 | 
			
		||||
.. include:: ../README.rst
 | 
			
		||||
 | 
			
		||||
Table of Contents
 | 
			
		||||
=================
 | 
			
		||||
 | 
			
		||||
.. toctree::
 | 
			
		||||
    :maxdepth: 4
 | 
			
		||||
    :hidden:
 | 
			
		||||
 | 
			
		||||
    self
 | 
			
		||||
 | 
			
		||||
.. toctree::
 | 
			
		||||
    :caption: Examples
 | 
			
		||||
 | 
			
		||||
    examples
 | 
			
		||||
 | 
			
		||||
.. toctree::
 | 
			
		||||
    :caption: API Reference
 | 
			
		||||
    :maxdepth: 3
 | 
			
		||||
 | 
			
		||||
    api
 | 
			
		||||
 | 
			
		||||
.. 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.
 | 
			
		||||
 | 
			
		||||
.. toctree::
 | 
			
		||||
    :caption: Other Links
 | 
			
		||||
 | 
			
		||||
    Download <https://github.com/arofarn/CircuitPython_CircuitPython_NeoTrellisM4/releases/latest>
 | 
			
		||||
    CircuitPython Reference Documentation <https://circuitpython.readthedocs.io>
 | 
			
		||||
    CircuitPython Support Forum <https://forums.adafruit.com/viewforum.php?f=60>
 | 
			
		||||
    Discord Chat <https://adafru.it/discord>
 | 
			
		||||
    Adafruit Learning System <https://learn.adafruit.com>
 | 
			
		||||
    Adafruit Blog <https://blog.adafruit.com>
 | 
			
		||||
    Adafruit Store <https://www.adafruit.com>
 | 
			
		||||
 | 
			
		||||
Indices and tables
 | 
			
		||||
==================
 | 
			
		||||
 | 
			
		||||
* :ref:`genindex`
 | 
			
		||||
* :ref:`modindex`
 | 
			
		||||
* :ref:`search`
 | 
			
		||||
							
								
								
									
										65
									
								
								examples/neotrellism4_multitrellis_simpletest.py
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										65
									
								
								examples/neotrellism4_multitrellis_simpletest.py
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,65 @@
 | 
			
		||||
import time
 | 
			
		||||
 | 
			
		||||
from board import SCL, SDA
 | 
			
		||||
import busio
 | 
			
		||||
from adafruit_neotrellis.neotrellism4 import NeoTrellisM4
 | 
			
		||||
from adafruit_neotrellis.neotrellis import NeoTrellis
 | 
			
		||||
from adafruit_neotrellis.multitrellis import MultiTrellis
 | 
			
		||||
 | 
			
		||||
#create the i2c object for the trellis
 | 
			
		||||
I2C = busio.I2C(SCL, SDA)
 | 
			
		||||
 | 
			
		||||
"""create the trellis. This is for a 2x2 array of TrellisM4 (first row) with
 | 
			
		||||
2 Neotrellis (second row).
 | 
			
		||||
 | 
			
		||||
 [ NeoM4_left | NeoM4_right ]
 | 
			
		||||
  neotrellis0 | neotrellis1
 | 
			
		||||
"""
 | 
			
		||||
 | 
			
		||||
trellim4_left = NeoTrellisM4()
 | 
			
		||||
trellim4_right = NeoTrellisM4(left_part=trellim4_left)
 | 
			
		||||
trelli = [
 | 
			
		||||
    [trellim4_left, trellim4_right],
 | 
			
		||||
    [NeoTrellis(I2C, False, addr=0x2F), NeoTrellis(I2C, False, addr=0x2E)]
 | 
			
		||||
    ]
 | 
			
		||||
 | 
			
		||||
trellis = MultiTrellis(trelli)
 | 
			
		||||
 | 
			
		||||
#some color definitions
 | 
			
		||||
OFF = (0, 0, 0)
 | 
			
		||||
RED = (127, 0, 0)
 | 
			
		||||
YELLOW = (127, 75, 0)
 | 
			
		||||
GREEN = (0, 127, 0)
 | 
			
		||||
CYAN = (0, 127, 127)
 | 
			
		||||
BLUE = (0, 0, 127)
 | 
			
		||||
PURPLE = (90, 0, 127)
 | 
			
		||||
 | 
			
		||||
#this will be called when button events are received
 | 
			
		||||
def blink(xcoord, ycoord, edge):
 | 
			
		||||
    #turn the LED on when a rising edge is detected
 | 
			
		||||
    if edge == NeoTrellis.EDGE_RISING:
 | 
			
		||||
        trellis.color(xcoord, ycoord, BLUE)
 | 
			
		||||
    #turn the LED off when a rising edge is detected
 | 
			
		||||
    elif edge == NeoTrellis.EDGE_FALLING:
 | 
			
		||||
        trellis.color(xcoord, ycoord, OFF)
 | 
			
		||||
 | 
			
		||||
for y in range(8):
 | 
			
		||||
    for x in range(8):
 | 
			
		||||
        #activate rising edge events on all keys
 | 
			
		||||
        print(x, y)
 | 
			
		||||
        trellis.activate_key(x, y, NeoTrellis.EDGE_RISING)
 | 
			
		||||
        #activate falling edge events on all keys
 | 
			
		||||
        trellis.activate_key(x, y, NeoTrellis.EDGE_FALLING)
 | 
			
		||||
        trellis.set_callback(x, y, blink)
 | 
			
		||||
        trellis.color(x, y, PURPLE)
 | 
			
		||||
        time.sleep(.05)
 | 
			
		||||
 | 
			
		||||
for y in range(8):
 | 
			
		||||
    for x in range(8):
 | 
			
		||||
        trellis.color(x, y, OFF)
 | 
			
		||||
        time.sleep(.05)
 | 
			
		||||
 | 
			
		||||
while True:
 | 
			
		||||
    #the trellis can only be read every 17 millisecons or so
 | 
			
		||||
    trellis.sync()
 | 
			
		||||
    time.sleep(.02)
 | 
			
		||||
							
								
								
									
										68
									
								
								examples/neotrellism4_simpletest.py
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										68
									
								
								examples/neotrellism4_simpletest.py
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,68 @@
 | 
			
		||||
import time
 | 
			
		||||
 | 
			
		||||
from adafruit_neotrellis.neotrellism4 import NeoTrellisM4
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
#create the trellis
 | 
			
		||||
trellis_left = NeoTrellisM4()
 | 
			
		||||
trellis_right = NeoTrellisM4(left_part=trellis_left)
 | 
			
		||||
 | 
			
		||||
#some color definitions
 | 
			
		||||
OFF = (0, 0, 0)
 | 
			
		||||
RED = (255, 0, 0)
 | 
			
		||||
YELLOW = (255, 150, 0)
 | 
			
		||||
GREEN = (0, 255, 0)
 | 
			
		||||
CYAN = (0, 255, 255)
 | 
			
		||||
BLUE = (0, 0, 255)
 | 
			
		||||
PURPLE = (180, 0, 255)
 | 
			
		||||
 | 
			
		||||
#this will be called when button events are received
 | 
			
		||||
def blink(event):
 | 
			
		||||
    #turn the LED on when a rising edge is detected
 | 
			
		||||
    if event.edge == NeoTrellisM4.EDGE_RISING:
 | 
			
		||||
        trellis_left.pixels[event.number] = CYAN
 | 
			
		||||
    #turn the LED off when a rising edge is detected
 | 
			
		||||
    elif event.edge == NeoTrellisM4.EDGE_FALLING:
 | 
			
		||||
        trellis_left.pixels[event.number] = OFF
 | 
			
		||||
 | 
			
		||||
for i in range(16):
 | 
			
		||||
    #activate rising edge events on all keys
 | 
			
		||||
    trellis_left.activate_key(i, NeoTrellisM4.EDGE_RISING)
 | 
			
		||||
    #activate falling edge events on all keys
 | 
			
		||||
    trellis_left.activate_key(i, NeoTrellisM4.EDGE_FALLING)
 | 
			
		||||
    #set all keys to trigger the blink callback
 | 
			
		||||
    trellis_left.callbacks[i] = blink
 | 
			
		||||
 | 
			
		||||
    #cycle the LEDs on startup
 | 
			
		||||
    trellis_left.pixels[i] = PURPLE
 | 
			
		||||
    time.sleep(.05)
 | 
			
		||||
 | 
			
		||||
for i in range(16):
 | 
			
		||||
    trellis_left.pixels[i] = OFF
 | 
			
		||||
    time.sleep(.05)
 | 
			
		||||
 | 
			
		||||
for i in range(16):
 | 
			
		||||
    #activate rising edge events on all keys
 | 
			
		||||
    trellis_right.activate_key(i, NeoTrellisM4.EDGE_RISING)
 | 
			
		||||
    #activate falling edge events on all keys
 | 
			
		||||
    trellis_right.activate_key(i, NeoTrellisM4.EDGE_FALLING)
 | 
			
		||||
    #set all keys to trigger the blink callback
 | 
			
		||||
    trellis_right.callbacks[i] = blink
 | 
			
		||||
 | 
			
		||||
    #cycle the LEDs on startup
 | 
			
		||||
    trellis_right.pixels[i] = PURPLE
 | 
			
		||||
    time.sleep(.05)
 | 
			
		||||
 | 
			
		||||
for i in range(16):
 | 
			
		||||
    trellis_right.pixels[i] = OFF
 | 
			
		||||
    time.sleep(.05)
 | 
			
		||||
 | 
			
		||||
#print(trellis.callbacks)
 | 
			
		||||
time.sleep(2)
 | 
			
		||||
 | 
			
		||||
while True:
 | 
			
		||||
    #call the sync function call any triggered callbacks
 | 
			
		||||
    trellis_left.sync()
 | 
			
		||||
    trellis_right.sync()
 | 
			
		||||
    #the trellis can only be read every 17 millisecons or so
 | 
			
		||||
    time.sleep(.02)
 | 
			
		||||
							
								
								
									
										3
									
								
								requirements.txt
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										3
									
								
								requirements.txt
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,3 @@
 | 
			
		||||
Adafruit-Blinka
 | 
			
		||||
adafruit-circuitpython-busdevice
 | 
			
		||||
neopixel
 | 
			
		||||
							
								
								
									
										65
									
								
								setup.py
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										65
									
								
								setup.py
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,65 @@
 | 
			
		||||
"""A setuptools based setup module.
 | 
			
		||||
 | 
			
		||||
See:
 | 
			
		||||
https://packaging.python.org/en/latest/distributing.html
 | 
			
		||||
https://github.com/pypa/sampleproject
 | 
			
		||||
"""
 | 
			
		||||
 | 
			
		||||
from setuptools import setup, find_packages
 | 
			
		||||
# To use a consistent encoding
 | 
			
		||||
from codecs import open
 | 
			
		||||
from os import path
 | 
			
		||||
 | 
			
		||||
here = path.abspath(path.dirname(__file__))
 | 
			
		||||
 | 
			
		||||
# Get the long description from the README file
 | 
			
		||||
with open(path.join(here, 'README.rst'), encoding='utf-8') as f:
 | 
			
		||||
    long_description = f.read()
 | 
			
		||||
 | 
			
		||||
setup(
 | 
			
		||||
    name='adafruit-circuitpython-neotrellism4',
 | 
			
		||||
 | 
			
		||||
    use_scm_version=True,
 | 
			
		||||
    setup_requires=['setuptools_scm'],
 | 
			
		||||
 | 
			
		||||
    description='Use Adafruit TrellisM4 Express board as 2 Neotrellis board. You can you use this to extend TrellisM4 with Neotrellis (seesaw) boards.',
 | 
			
		||||
    long_description=long_description,
 | 
			
		||||
    long_description_content_type='text/x-rst',
 | 
			
		||||
 | 
			
		||||
    # The project's main homepage.
 | 
			
		||||
    url='https://github.com/adafruit/Adafruit_CircuitPython_NeoTrellisM4',
 | 
			
		||||
 | 
			
		||||
    # Author details
 | 
			
		||||
    author='Adafruit Industries',
 | 
			
		||||
    author_email='circuitpython@adafruit.com',
 | 
			
		||||
 | 
			
		||||
    install_requires=[
 | 
			
		||||
        'Adafruit-Blinka',
 | 
			
		||||
        'adafruit-circuitpython-busdevice',
 | 
			
		||||
        'neopixel'
 | 
			
		||||
    ],
 | 
			
		||||
 | 
			
		||||
    # Choose your license
 | 
			
		||||
    license='MIT',
 | 
			
		||||
 | 
			
		||||
    # See https://pypi.python.org/pypi?%3Aaction=list_classifiers
 | 
			
		||||
    classifiers=[
 | 
			
		||||
        'Development Status :: 3 - Alpha',
 | 
			
		||||
        'Intended Audience :: Developers',
 | 
			
		||||
        'Topic :: Software Development :: Libraries',
 | 
			
		||||
        'Topic :: System :: Hardware',
 | 
			
		||||
        'License :: OSI Approved :: MIT License',
 | 
			
		||||
        'Programming Language :: Python :: 3',
 | 
			
		||||
        'Programming Language :: Python :: 3.4',
 | 
			
		||||
        'Programming Language :: Python :: 3.5',
 | 
			
		||||
    ],
 | 
			
		||||
 | 
			
		||||
    # What does your project relate to?
 | 
			
		||||
    keywords='adafruit blinka circuitpython micropython neotrellism4 neotrellis trellisM4',
 | 
			
		||||
 | 
			
		||||
    # You can just specify the packages manually here if your project is
 | 
			
		||||
    # simple. Or you can use find_packages().
 | 
			
		||||
    # TODO: IF LIBRARY FILES ARE A PACKAGE FOLDER,
 | 
			
		||||
    #       CHANGE `py_modules=['...']` TO `packages=['...']`
 | 
			
		||||
    py_modules=['circuitpython_neotrellism4'],
 | 
			
		||||
)
 | 
			
		||||
		Reference in New Issue
	
	Block a user