diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index fff3aa9..1dad804 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -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 diff --git a/adafruit_tlc5947.py b/adafruit_tlc5947.py index 8ec40f5..d56e1d8 100644 --- a/adafruit_tlc5947.py +++ b/adafruit_tlc5947.py @@ -48,10 +48,11 @@ # Globally disable protected access. Ppylint can't figure out the # context for using internal decorate classes below. In these cases protectected # access is by design for the internal class. -#pylint: disable=protected-access +# pylint: disable=protected-access _CHANNELS = 24 -_STOREBYTES = _CHANNELS + _CHANNELS//2 +_STOREBYTES = _CHANNELS + _CHANNELS // 2 + class TLC5947: """TLC5947 12-bit 24 channel LED PWM driver. Create an instance of this by @@ -105,7 +106,9 @@ def duty_cycle(self): @duty_cycle.setter def duty_cycle(self, val): if val < 0 or val > 65535: - raise ValueError("PWM intensity {0} outside supported range [0;65535]".format(val)) + raise ValueError( + "PWM intensity {0} outside supported range [0;65535]".format(val) + ) # Convert to 12-bit value (quantization error will occur!). val = (val >> 4) & 0xFFF self._tlc5947._set_gs_value(self._channel, val) @@ -121,16 +124,18 @@ def frequency(self): # pylint bug misidentifies the following as a regular function instead # of the associated setter: https://github.com/PyCQA/pylint/issues/870 # Must disable a few checks to make pylint happy (ugh). - #pylint: disable=no-self-use,unused-argument + # pylint: disable=no-self-use,unused-argument @frequency.setter def frequency(self, val): - raise RuntimeError('Cannot set TLC5947 PWM frequency!') - #pylint: enable=no-self-use,unused-argument + raise RuntimeError("Cannot set TLC5947 PWM frequency!") + # pylint: enable=no-self-use,unused-argument def __init__(self, spi, latch, *, auto_write=True, num_drivers=1): if num_drivers < 1: - raise ValueError("Need at least one driver; {0} is not supported.".format(num_drivers)) + raise ValueError( + "Need at least one driver; {0} is not supported.".format(num_drivers) + ) self._spi = spi self._latch = latch self._latch.switch_to_output(value=False) @@ -157,7 +162,7 @@ def write(self): # First ensure latch is low. self._latch.value = False # Write out the bits. - self._spi.write(self._shift_reg, start=0, end=_STOREBYTES*self._n +1) + self._spi.write(self._shift_reg, start=0, end=_STOREBYTES * self._n + 1) # Then toggle latch high and low to set the value. self._latch.value = True self._latch.value = False @@ -170,7 +175,8 @@ def _get_gs_value(self, channel): # Disable should be removed when refactor can be tested if channel < 0 or channel >= _CHANNELS * self._n: raise ValueError( - "Channel {0} not available with {1} board(s).".format(channel, self._n)) + "Channel {0} not available with {1} board(s).".format(channel, self._n) + ) # Invert channel position as the last channel needs to be written first. # I.e. is in the first position of the shift registr. channel = _CHANNELS * self._n - 1 - channel @@ -182,7 +188,7 @@ def _get_gs_value(self, channel): start_offset = bit_offset % 8 # Grab the high and low bytes. high_byte = self._shift_reg[byte_start] - low_byte = self._shift_reg[byte_start+1] + low_byte = self._shift_reg[byte_start + 1] if start_offset == 4: # Value starts in the lower 4 bits of the high bit so you can # just concat high with low byte and return the 12-bit value. @@ -192,14 +198,17 @@ def _get_gs_value(self, channel): # 4 bits of low byte. Shift low byte and concat values. return ((high_byte << 4) | (low_byte >> 4)) & 0xFFF else: - raise RuntimeError('Unsupported bit offset!') + raise RuntimeError("Unsupported bit offset!") def _set_gs_value(self, channel, val): if channel < 0 or channel >= _CHANNELS * self._n: raise ValueError( - "Channel {0} not available with {1} board(s).".format(channel, self._n)) + "Channel {0} not available with {1} board(s).".format(channel, self._n) + ) if val < 0 or val > 4095: - raise ValueError("PWM intensity {0} outside supported range [0;4095]".format(val)) + raise ValueError( + "PWM intensity {0} outside supported range [0;4095]".format(val) + ) # Invert channel position as the last channel needs to be written first. # I.e. is in the first position of the shift registr. @@ -212,11 +221,11 @@ def _set_gs_value(self, channel, val): start_offset = bit_offset % 8 # Grab the high and low bytes. high_byte = self._shift_reg[byte_start] - low_byte = self._shift_reg[byte_start+1] + low_byte = self._shift_reg[byte_start + 1] if start_offset == 4: # Value starts in the lower 4 bits of the high bit. high_byte &= 0b11110000 - high_byte |= (val >> 8) + high_byte |= val >> 8 low_byte = val & 0xFF elif start_offset == 0: # Value starts in the entire high byte and spills into upper @@ -225,9 +234,9 @@ def _set_gs_value(self, channel, val): low_byte &= 0b00001111 low_byte |= (val << 4) & 0xFF else: - raise RuntimeError('Unsupported bit offset!') + raise RuntimeError("Unsupported bit offset!") self._shift_reg[byte_start] = high_byte - self._shift_reg[byte_start+1] = low_byte + self._shift_reg[byte_start + 1] = low_byte # Write the updated shift register values if required. if self.auto_write: self.write() @@ -256,7 +265,7 @@ def __getitem__(self, key): """ if key < 0: # allow reverse adressing with negative index key = key + _CHANNELS * self._n - return self._get_gs_value(key) # does parameter checking + return self._get_gs_value(key) # does parameter checking def __setitem__(self, key, val): """Set the 12-bit PWM value (0-4095) for the specified channel (0-max). @@ -267,4 +276,4 @@ def __setitem__(self, key, val): """ if key < 0: # allow reverse adressing with negative index key = key + _CHANNELS * self._n - self._set_gs_value(key, val) # does parameter checking + self._set_gs_value(key, val) # does parameter checking diff --git a/docs/conf.py b/docs/conf.py index 752c665..cd3d31c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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 @@ # 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,32 @@ # 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),'CircuitPython': ('https://circuitpython.readthedocs.io/en/latest/', None)} +intersphinx_mapping = { + "python": ("https://docs.python.org/3.4", 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 TLC5947 Library' -copyright = u'2017 Tony DiCola' -author = u'Tony DiCola' +project = u"Adafruit TLC5947 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 +58,7 @@ # 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 +70,7 @@ 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 +84,62 @@ # 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 = 'AdafruitTlc5947Librarydoc' +htmlhelp_basename = "AdafruitTlc5947Librarydoc" # -- 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, 'AdafruitTLC5947Library.tex', u'AdafruitTLC5947 Library Documentation', - author, 'manual'), + ( + master_doc, + "AdafruitTLC5947Library.tex", + u"AdafruitTLC5947 Library Documentation", + author, + "manual", + ), ] # -- Options for manual page output --------------------------------------- @@ -140,8 +147,13 @@ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - (master_doc, 'AdafruitTLC5947library', u'Adafruit TLC5947 Library Documentation', - [author], 1) + ( + master_doc, + "AdafruitTLC5947library", + u"Adafruit TLC5947 Library Documentation", + [author], + 1, + ) ] # -- Options for Texinfo output ------------------------------------------- @@ -150,7 +162,13 @@ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'AdafruitTLC5947Library', u'Adafruit TLC5947 Library Documentation', - author, 'AdafruitTLC5947Library', 'One line description of project.', - 'Miscellaneous'), + ( + master_doc, + "AdafruitTLC5947Library", + u"Adafruit TLC5947 Library Documentation", + author, + "AdafruitTLC5947Library", + "One line description of project.", + "Miscellaneous", + ), ] diff --git a/examples/tlc5947_chain.py b/examples/tlc5947_chain.py index c4fb273..3f3922d 100644 --- a/examples/tlc5947_chain.py +++ b/examples/tlc5947_chain.py @@ -12,7 +12,7 @@ spi = busio.SPI(clock=board.SCK, MOSI=board.MOSI) # Initialize TLC5947 -DRIVER_COUNT = 2 # change this to the number of drivers you have chained +DRIVER_COUNT = 2 # change this to the number of drivers you have chained LATCH = digitalio.DigitalInOut(board.D5) tlc5947 = adafruit_tlc5947.TLC5947(spi, LATCH, num_drivers=DRIVER_COUNT) @@ -21,7 +21,7 @@ # will automatically write out changes as soon as they happen to a channel, but # if you need more control or atomic updates of multiple channels then disable # and manually call write as shown below. -#tlc5947 = adafruit_tlc5947.TLC5947(spi, LATCH, num_drivers=DRIVER_COUNT, auto_write=False) +# tlc5947 = adafruit_tlc5947.TLC5947(spi, LATCH, num_drivers=DRIVER_COUNT, auto_write=False) # There are two ways to set channel PWM values. The first is by getting # a PWMOut object that acts like the built-in PWMOut and can be used anywhere @@ -29,6 +29,7 @@ # (note this is NOT the 12-bit value supported by the chip natively) and the # PWM channel will be updated. + def first_last(): """Cycles the red pin of LED one up, then the other LED; now dims the LEDs both down. Repeats with green and blue pins. Then starts all over again. @@ -39,13 +40,13 @@ def first_last(): redA = tlc5947.create_pwm_out(0) greenA = tlc5947.create_pwm_out(1) blueA = tlc5947.create_pwm_out(2) - redZ = tlc5947.create_pwm_out(DRIVER_COUNT*24-3) - greenZ = tlc5947.create_pwm_out(DRIVER_COUNT*24-2) - blueZ = tlc5947.create_pwm_out(DRIVER_COUNT*24-1) + redZ = tlc5947.create_pwm_out(DRIVER_COUNT * 24 - 3) + greenZ = tlc5947.create_pwm_out(DRIVER_COUNT * 24 - 2) + blueZ = tlc5947.create_pwm_out(DRIVER_COUNT * 24 - 1) step = 10 start_pwm = 0 - end_pwm = 32767 # 50% (32767, or half of the maximum 65535): + end_pwm = 32767 # 50% (32767, or half of the maximum 65535): while True: for (pinA, pinZ) in ((redA, redZ), (greenA, greenZ), (blueA, blueZ)): @@ -72,7 +73,8 @@ def first_last(): # auto_write you probably want to use the direct 12-bit raw access instead, # shown next). -#---------- + +# ---------- # The other way to read and write channels is directly with each channel 12-bit # value and an item accessor syntax. Index into the TLC5947 with the channel # number (0-max) and get or set its 12-bit value (0-4095). @@ -85,23 +87,24 @@ def test_all_channels(step): """ start_pwm = 0 - end_pwm = 3072 # 75% of the maximum 4095 + end_pwm = 3072 # 75% of the maximum 4095 while True: - for pin in range(DRIVER_COUNT*24): + for pin in range(DRIVER_COUNT * 24): # Brighten: for pwm in range(start_pwm, end_pwm, step): tlc5947[pin] = pwm # Again be sure to call write if you disabled auto_write. - #tlc5947.write() + # tlc5947.write() # Dim: - for pwm in range(end_pwm, start_pwm, 0 -step): + for pwm in range(end_pwm, start_pwm, 0 - step): tlc5947[pin] = pwm # Again be sure to call write if you disabled auto_write. - #tlc5947.write() + # tlc5947.write() + -#---------- +# ---------- # Choose here which function to try: -#first_last() +# first_last() test_all_channels(16) diff --git a/examples/tlc5947_simpletest.py b/examples/tlc5947_simpletest.py index cf758b2..faee7b4 100644 --- a/examples/tlc5947_simpletest.py +++ b/examples/tlc5947_simpletest.py @@ -23,7 +23,7 @@ # will automatically write out changes as soon as they happen to a channel, but # if you need more control or atomic updates of multiple channels then disable # and manually call write as shown below. -#tlc5947 = adafruit_tlc5947.TLC5947(spi, LATCH, auto_write=False) +# tlc5947 = adafruit_tlc5947.TLC5947(spi, LATCH, auto_write=False) # There are two ways to channel channel PWM values. The first is by getting # a PWMOut object that acts like the built-in PWMOut and can be used anywhere @@ -40,7 +40,7 @@ step = 10 start_pwm = 0 -end_pwm = 32767 # 50% (32767, or half of the maximum 65535): +end_pwm = 32767 # 50% (32767, or half of the maximum 65535): while True: for pin in (red, green, blue): @@ -63,8 +63,8 @@ # value and an item accessor syntax. Index into the TLC5947 with the channel # number (0-23) and get or set its 12-bit value (0-4095). # For example set channel 1 to 50% duty cycle. -#tlc5947[1] = 2048 +# tlc5947[1] = 2048 # Or set channel 23 (first channel from the end) to 2/3 duty cycle. -#tlc5947[-1] = 2730 +# tlc5947[-1] = 2730 # Again be sure to call write if you disabled auto_write. -#tlc5947.write() +# tlc5947.write() diff --git a/setup.py b/setup.py index 97bb7a2..5718930 100644 --- a/setup.py +++ b/setup.py @@ -7,6 +7,7 @@ # 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 @@ 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-tlc5947', - + name="adafruit-circuitpython-tlc5947", use_scm_version=True, - setup_requires=['setuptools_scm'], - - description='CircuitPython library for TLC5947 12-bit 24 channel LED PWM driver.', + setup_requires=["setuptools_scm"], + description="CircuitPython library for TLC5947 12-bit 24 channel LED PWM driver.", 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_TLC5947', - + url="https://github.com/adafruit/Adafruit_CircuitPython_TLC5947", # Author details - author='Adafruit Industries', - author_email='circuitpython@adafruit.com', - + author="Adafruit Industries", + author_email="circuitpython@adafruit.com", install_requires=[], - # 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 tlc5947 12-bit 24-channel led pwm hardware micropython circuitpython', - + keywords="adafruit tlc5947 12-bit 24-channel led pwm 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_tlc5947'], + py_modules=["adafruit_tlc5947"], )