jepler/Adafruit_CircuitPython_DRV2605
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Ran black, updated to pylint 2.x

Browse source
This commit is contained in:
dherrada 2020-03-15 16:31:35 -04:00
parent 68eff0bd7c
commit 05118df6b5
5 changed files with 161 additions and 146 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
.github/workflows/build.yml vendored
View file

@ -40,7 +40,7 @@ jobs:
source actions-ci/install.sh
- name: Pip install pylint, black, & Sphinx
run: |
pip install --force-reinstall pylint==1.9.2 black==19.10b0 Sphinx sphinx-rtd-theme
pip install --force-reinstall pylint black==19.10b0 Sphinx sphinx-rtd-theme
- name: Library version
run: git describe --dirty --always --tags
- name: PyLint

135
adafruit_drv2605.py
View file

@ -38,57 +38,58 @@ __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_DRV2605.git"
# pylint: disable=bad-whitespace
# Internal constants:
_DRV2605_ADDR = const(0x5A)
_DRV2605_REG_STATUS = const(0x00)
_DRV2605_REG_MODE = const(0x01)
_DRV2605_REG_RTPIN = const(0x02)
_DRV2605_REG_LIBRARY = const(0x03)
_DRV2605_REG_WAVESEQ1 = const(0x04)
_DRV2605_REG_WAVESEQ2 = const(0x05)
_DRV2605_REG_WAVESEQ3 = const(0x06)
_DRV2605_REG_WAVESEQ4 = const(0x07)
_DRV2605_REG_WAVESEQ5 = const(0x08)
_DRV2605_REG_WAVESEQ6 = const(0x09)
_DRV2605_REG_WAVESEQ7 = const(0x0A)
_DRV2605_REG_WAVESEQ8 = const(0x0B)
_DRV2605_REG_GO = const(0x0C)
_DRV2605_REG_OVERDRIVE = const(0x0D)
_DRV2605_REG_SUSTAINPOS = const(0x0E)
_DRV2605_REG_SUSTAINNEG = const(0x0F)
_DRV2605_REG_BREAK = const(0x10)
_DRV2605_REG_AUDIOCTRL = const(0x11)
_DRV2605_REG_AUDIOLVL = const(0x12)
_DRV2605_REG_AUDIOMAX = const(0x13)
_DRV2605_REG_RATEDV = const(0x16)
_DRV2605_REG_CLAMPV = const(0x17)
_DRV2605_REG_AUTOCALCOMP = const(0x18)
_DRV2605_REG_AUTOCALEMP = const(0x19)
_DRV2605_REG_FEEDBACK = const(0x1A)
_DRV2605_REG_CONTROL1 = const(0x1B)
_DRV2605_REG_CONTROL2 = const(0x1C)
_DRV2605_REG_CONTROL3 = const(0x1D)
_DRV2605_REG_CONTROL4 = const(0x1E)
_DRV2605_REG_VBAT = const(0x21)
_DRV2605_REG_LRARESON = const(0x22)
_DRV2605_ADDR = const(0x5A)
_DRV2605_REG_STATUS = const(0x00)
_DRV2605_REG_MODE = const(0x01)
_DRV2605_REG_RTPIN = const(0x02)
_DRV2605_REG_LIBRARY = const(0x03)
_DRV2605_REG_WAVESEQ1 = const(0x04)
_DRV2605_REG_WAVESEQ2 = const(0x05)
_DRV2605_REG_WAVESEQ3 = const(0x06)
_DRV2605_REG_WAVESEQ4 = const(0x07)
_DRV2605_REG_WAVESEQ5 = const(0x08)
_DRV2605_REG_WAVESEQ6 = const(0x09)
_DRV2605_REG_WAVESEQ7 = const(0x0A)
_DRV2605_REG_WAVESEQ8 = const(0x0B)
_DRV2605_REG_GO = const(0x0C)
_DRV2605_REG_OVERDRIVE = const(0x0D)
_DRV2605_REG_SUSTAINPOS = const(0x0E)
_DRV2605_REG_SUSTAINNEG = const(0x0F)
_DRV2605_REG_BREAK = const(0x10)
_DRV2605_REG_AUDIOCTRL = const(0x11)
_DRV2605_REG_AUDIOLVL = const(0x12)
_DRV2605_REG_AUDIOMAX = const(0x13)
_DRV2605_REG_RATEDV = const(0x16)
_DRV2605_REG_CLAMPV = const(0x17)
_DRV2605_REG_AUTOCALCOMP = const(0x18)
_DRV2605_REG_AUTOCALEMP = const(0x19)
_DRV2605_REG_FEEDBACK = const(0x1A)
_DRV2605_REG_CONTROL1 = const(0x1B)
_DRV2605_REG_CONTROL2 = const(0x1C)
_DRV2605_REG_CONTROL3 = const(0x1D)
_DRV2605_REG_CONTROL4 = const(0x1E)
_DRV2605_REG_VBAT = const(0x21)
_DRV2605_REG_LRARESON = const(0x22)
# User-facing mode value constants:
MODE_INTTRIG = 0x00
MODE_EXTTRIGEDGE = 0x01
MODE_EXTTRIGLVL = 0x02
MODE_PWMANALOG = 0x03
MODE_AUDIOVIBE = 0x04
MODE_REALTIME = 0x05
MODE_DIAGNOS = 0x06
MODE_AUTOCAL = 0x07
LIBRARY_EMPTY = 0x00
LIBRARY_TS2200A = 0x01
LIBRARY_TS2200B = 0x02
LIBRARY_TS2200C = 0x03
LIBRARY_TS2200D = 0x04
LIBRARY_TS2200E = 0x05
LIBRARY_LRA = 0x06
MODE_INTTRIG = 0x00
MODE_EXTTRIGEDGE = 0x01
MODE_EXTTRIGLVL = 0x02
MODE_PWMANALOG = 0x03
MODE_AUDIOVIBE = 0x04
MODE_REALTIME = 0x05
MODE_DIAGNOS = 0x06
MODE_AUTOCAL = 0x07
LIBRARY_EMPTY = 0x00
LIBRARY_TS2200A = 0x01
LIBRARY_TS2200B = 0x02
LIBRARY_TS2200C = 0x03
LIBRARY_TS2200D = 0x04
LIBRARY_TS2200E = 0x05
LIBRARY_LRA = 0x06
# pylint: enable=bad-whitespace
class DRV2605:
"""TI DRV2605 haptic feedback motor driver module."""
@ -103,13 +104,13 @@ class DRV2605:
status = self._read_u8(_DRV2605_REG_STATUS)
device_id = (status >> 5) & 0x07
if device_id not in (3, 7):
raise RuntimeError('Failed to find DRV2605, check wiring!')
raise RuntimeError("Failed to find DRV2605, check wiring!")
# Configure registers to initialize chip.
self._write_u8(_DRV2605_REG_MODE, 0x00) # out of standby
self._write_u8(_DRV2605_REG_RTPIN, 0x00) # no real-time-playback
self._write_u8(_DRV2605_REG_WAVESEQ1, 1) # strong click
self._write_u8(_DRV2605_REG_MODE, 0x00) # out of standby
self._write_u8(_DRV2605_REG_RTPIN, 0x00) # no real-time-playback
self._write_u8(_DRV2605_REG_WAVESEQ1, 1) # strong click
self._write_u8(_DRV2605_REG_WAVESEQ2, 0)
self._write_u8(_DRV2605_REG_OVERDRIVE, 0) # no overdrive
self._write_u8(_DRV2605_REG_OVERDRIVE, 0) # no overdrive
self._write_u8(_DRV2605_REG_SUSTAINPOS, 0)
self._write_u8(_DRV2605_REG_SUSTAINNEG, 0)
self._write_u8(_DRV2605_REG_BREAK, 0)
@ -168,7 +169,7 @@ class DRV2605:
@mode.setter
def mode(self, val):
if not 0 <= val <= 7:
raise ValueError('Mode must be a value within 0-7!')
raise ValueError("Mode must be a value within 0-7!")
self._write_u8(_DRV2605_REG_MODE, val)
@property
@ -193,7 +194,7 @@ class DRV2605:
@library.setter
def library(self, val):
if not 0 <= val <= 6:
raise ValueError('Library must be a value within 0-6!')
raise ValueError("Library must be a value within 0-6!")
self._write_u8(_DRV2605_REG_LIBRARY, val)
@property
@ -215,9 +216,9 @@ class DRV2605:
waveform / effect.
"""
if not 0 <= effect_id <= 123:
raise ValueError('Effect ID must be a value within 0-123!')
raise ValueError("Effect ID must be a value within 0-123!")
if not 0 <= slot <= 6:
raise ValueError('Slot must be a value within 0-6!')
raise ValueError("Slot must be a value within 0-6!")
self._write_u8(_DRV2605_REG_WAVESEQ1 + slot, effect_id)
# pylint: disable=invalid-name
@ -233,9 +234,9 @@ class DRV2605:
self._write_u8(_DRV2605_REG_FEEDBACK, feedback | 0x80)
class Effect:
"""DRV2605 waveform sequence effect."""
def __init__(self, effect_id):
self._effect_id = 0
# pylint: disable=invalid-name
@ -257,16 +258,16 @@ class Effect:
def id(self, effect_id):
"""Set the effect ID."""
if not 0 <= effect_id <= 123:
raise ValueError('Effect ID must be a value within 0-123!')
raise ValueError("Effect ID must be a value within 0-123!")
self._effect_id = effect_id
def __repr__(self):
return "{}({})".format(type(self).__qualname__, self.id)
class Pause:
"""DRV2605 waveform sequence timed delay."""
def __init__(self, duration):
# Bit 7 must be set for a slot to be interpreted as a delay
self._duration = 0x80
@ -281,13 +282,13 @@ class Pause:
def duration(self):
"""Pause duration in seconds."""
# Remove wait time flag bit and convert duration to seconds
return (self._duration & 0x7f) / 100.0
return (self._duration & 0x7F) / 100.0
@duration.setter
def duration(self, duration):
"""Set the pause duration in seconds."""
if not 0.0 <= duration <= 1.27:
raise ValueError('Pause duration must be a value within 0.0-1.27!')
raise ValueError("Pause duration must be a value within 0.0-1.27!")
# Add wait time flag bit and convert duration to centiseconds
self._duration = 0x80 | round(duration * 100.0)
@ -295,29 +296,29 @@ class Pause:
return "{}({})".format(type(self).__qualname__, self.duration)
class _DRV2605_Sequence:
"""Class to enable List-like indexing of the waveform sequence slots."""
def __init__(self, DRV2605_instance):
self._drv2605 = DRV2605_instance
def __setitem__(self, slot, effect):
"""Write an Effect or Pause to a slot."""
if not 0 <= slot <= 6:
raise IndexError('Slot must be a value within 0-6!')
raise IndexError("Slot must be a value within 0-6!")
if not isinstance(effect, (Effect, Pause)):
raise TypeError('Effect must be either an Effect() or Pause()!')
raise TypeError("Effect must be either an Effect() or Pause()!")
# pylint: disable=protected-access
self._drv2605._write_u8(_DRV2605_REG_WAVESEQ1 + slot, effect.raw_value)
def __getitem__(self, slot):
"""Read an effect ID from a slot. Returns either a Pause or Effect class."""
if not 0 <= slot <= 6:
raise IndexError('Slot must be a value within 0-6!')
raise IndexError("Slot must be a value within 0-6!")
# pylint: disable=protected-access
slot_contents = self._drv2605._read_u8(_DRV2605_REG_WAVESEQ1 + slot)
if slot_contents & 0x80:
return Pause((slot_contents & 0x7f) / 100.0)
return Pause((slot_contents & 0x7F) / 100.0)
return Effect(slot_contents)
def __iter__(self):
@ -327,4 +328,4 @@ class _DRV2605_Sequence:
def __repr__(self):
"""Return a string representation of all slot's effects."""
return repr([effect for effect in self])
return repr(list(effect for effect in self))

114
docs/conf.py
View file

@ -2,7 +2,8 @@
import os
import sys
sys.path.insert(0, os.path.abspath('..'))
sys.path.insert(0, os.path.abspath(".."))
# -- General configuration ------------------------------------------------
@ -10,9 +11,9 @@ sys.path.insert(0, os.path.abspath('..'))
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.intersphinx',
'sphinx.ext.viewcode',
"sphinx.ext.autodoc",
"sphinx.ext.intersphinx",
"sphinx.ext.viewcode",
]
# Uncomment the below if you use native CircuitPython modules such as
@ -20,29 +21,36 @@ extensions = [
# autodoc module docs will fail to generate with a warning.
# autodoc_mock_imports = ["micropython", "adafruit_bus_device"]
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)}
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']
templates_path = ["_templates"]
source_suffix = '.rst'
source_suffix = ".rst"
# The master toctree document.
master_doc = 'index'
master_doc = "index"
# General information about the project.
project = u'Adafruit DRV2605 Library'
copyright = u'2017 Tony DiCola'
author = u'Tony DiCola'
project = u"Adafruit DRV2605 Library"
copyright = u"2017 Tony DiCola"
author = u"Tony DiCola"
# 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'
version = u"1.0"
# The full version, including alpha/beta/rc tags.
release = u'1.0'
release = u"1.0"
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
@ -54,7 +62,7 @@ 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']
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.
@ -66,7 +74,7 @@ default_role = "any"
add_function_parentheses = True
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
pygments_style = "sphinx"
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False
@ -80,59 +88,62 @@ todo_emit_warnings = True
# 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'
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(), '.']
html_theme = "sphinx_rtd_theme"
html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."]
except:
html_theme = 'default'
html_theme_path = ['.']
html_theme = "default"
html_theme_path = ["."]
else:
html_theme_path = ['.']
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']
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'
html_favicon = "_static/favicon.ico"
# Output file base name for HTML help builder.
htmlhelp_basename = 'AdafruitDrv2605Librarydoc'
htmlhelp_basename = "AdafruitDrv2605Librarydoc"
# -- 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',
# 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, 'AdafruitDRV2605Library.tex', u'AdafruitDRV2605 Library Documentation',
author, 'manual'),
(
master_doc,
"AdafruitDRV2605Library.tex",
u"AdafruitDRV2605 Library Documentation",
author,
"manual",
),
]
# -- Options for manual page output ---------------------------------------
@ -140,8 +151,13 @@ latex_documents = [
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'AdafruitDRV2605library', u'Adafruit DRV2605 Library Documentation',
[author], 1)
(
master_doc,
"AdafruitDRV2605library",
u"Adafruit DRV2605 Library Documentation",
[author],
1,
)
]
# -- Options for Texinfo output -------------------------------------------
@ -150,7 +166,13 @@ man_pages = [
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'AdafruitDRV2605Library', u'Adafruit DRV2605 Library Documentation',
author, 'AdafruitDRV2605Library', 'One line description of project.',
'Miscellaneous'),
(
master_doc,
"AdafruitDRV2605Library",
u"Adafruit DRV2605 Library Documentation",
author,
"AdafruitDRV2605Library",
"One line description of project.",
"Miscellaneous",
),
]

6
examples/drv2605_simpletest.py
View file

@ -18,16 +18,16 @@ drv = adafruit_drv2605.DRV2605(i2c)
# http://www.ti.com/lit/ds/symlink/drv2605.pdf
effect_id = 1
while True:
print('Playing effect #{0}'.format(effect_id))
print("Playing effect #{0}".format(effect_id))
drv.sequence[0] = adafruit_drv2605.Effect(effect_id) # Set the effect on slot 0.
# You can assign effects to up to 7 different slots to combine
# them in interesting ways. Index the sequence property with a
# slot number 0 to 6.
# Optionally, you can assign a pause to a slot. E.g.
# drv.sequence[1] = adafruit_drv2605.Pause(0.5) # Pause for half a second
drv.play() # play the effect
drv.play() # play the effect
time.sleep(0.5) # for 0.5 seconds
drv.stop() # and then stop (if it's still running)
drv.stop() # and then stop (if it's still running)
# Increment effect ID and wrap back around to 1.
effect_id += 1
if effect_id > 123:

50
setup.py
View file

@ -7,6 +7,7 @@ https://github.com/pypa/sampleproject
# Always prefer setuptools over distutils
from setuptools import setup, find_packages
# To use a consistent encoding
from codecs import open
from os import path
@ -14,47 +15,38 @@ 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:
with open(path.join(here, "README.rst"), encoding="utf-8") as f:
long_description = f.read()
setup(
name='adafruit-circuitpython-drv2605',
name="adafruit-circuitpython-drv2605",
use_scm_version=True,
setup_requires=['setuptools_scm'],
description='CircuitPython library for DRV2605 haptic motor controller.',
setup_requires=["setuptools_scm"],
description="CircuitPython library for DRV2605 haptic motor controller.",
long_description=long_description,
long_description_content_type='text/x-rst',
long_description_content_type="text/x-rst",
# The project's main homepage.
url='https://github.com/adafruit/Adafruit_CircuitPython_DRV2605',
url="https://github.com/adafruit/Adafruit_CircuitPython_DRV2605",
# Author details
author='Adafruit Industries',
author_email='circuitpython@adafruit.com',
install_requires=['Adafruit-Blinka', 'adafruit-circuitpython-busdevice'],
author="Adafruit Industries",
author_email="circuitpython@adafruit.com",
install_requires=["Adafruit-Blinka", "adafruit-circuitpython-busdevice"],
# Choose your license
license='MIT',
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',
"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 haptic motor controller buzzer vibration breakout hardware micropython circuitpython',
keywords="adafruit haptic motor controller buzzer vibration breakout hardware micropython circuitpython",
# You can just specify the packages manually here if your project is
# simple. Or you can use find_packages().
py_modules=['adafruit_drv2605'],
py_modules=["adafruit_drv2605"],
)