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/.pylintrc b/.pylintrc index cd65e95..d8f0ee8 100644 --- a/.pylintrc +++ b/.pylintrc @@ -119,7 +119,8 @@ 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,TODO +notes=FIXME,XXX [TYPECHECK] diff --git a/adafruit_tsl2561.py b/adafruit_tsl2561.py index aced40f..8322606 100644 --- a/adafruit_tsl2561.py +++ b/adafruit_tsl2561.py @@ -54,28 +54,29 @@ __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_TSL2561.git" # pylint: disable=bad-whitespace -_DEFAULT_ADDRESS = const(0x39) -_COMMAND_BIT = const(0x80) -_WORD_BIT = const(0x20) - -_CONTROL_POWERON = const(0x03) -_CONTROL_POWEROFF = const(0x00) - -_REGISTER_CONTROL = const(0x00) -_REGISTER_TIMING = const(0x01) -_REGISTER_TH_LOW = const(0x02) -_REGISTER_TH_HIGH = const(0x04) -_REGISTER_INT_CTRL = const(0x06) -_REGISTER_CHAN0_LOW = const(0x0C) -_REGISTER_CHAN1_LOW = const(0x0E) -_REGISTER_ID = const(0x0A) +_DEFAULT_ADDRESS = const(0x39) +_COMMAND_BIT = const(0x80) +_WORD_BIT = const(0x20) + +_CONTROL_POWERON = const(0x03) +_CONTROL_POWEROFF = const(0x00) + +_REGISTER_CONTROL = const(0x00) +_REGISTER_TIMING = const(0x01) +_REGISTER_TH_LOW = const(0x02) +_REGISTER_TH_HIGH = const(0x04) +_REGISTER_INT_CTRL = const(0x06) +_REGISTER_CHAN0_LOW = const(0x0C) +_REGISTER_CHAN1_LOW = const(0x0E) +_REGISTER_ID = const(0x0A) _GAIN_SCALE = (16, 1) _TIME_SCALE = (1 / 0.034, 1 / 0.252, 1) _CLIP_THRESHOLD = (4900, 37000, 65000) # pylint: enable=bad-whitespace -class TSL2561(): + +class TSL2561: """Class which provides interface to TSL2561 light sensor.""" def __init__(self, i2c, address=_DEFAULT_ADDRESS): @@ -84,15 +85,17 @@ def __init__(self, i2c, address=_DEFAULT_ADDRESS): partno, revno = self.chip_id # data sheet says TSL2561 = 0001, reality says 0101 if not partno == 5: - raise RuntimeError('Failed to find TSL2561! Part 0x%x Rev 0x%x' % (partno, revno)) + raise RuntimeError( + "Failed to find TSL2561! Part 0x%x Rev 0x%x" % (partno, revno) + ) self.enabled = True @property def chip_id(self): """A tuple containing the part number and the revision number.""" chip_id = self._read_register(_REGISTER_ID) - partno = (chip_id >> 4) & 0x0f - revno = chip_id & 0x0f + partno = (chip_id >> 4) & 0x0F + revno = chip_id & 0x0F return (partno, revno) @property @@ -141,7 +144,7 @@ def gain(self, value): value <<= 4 current = self._read_register(_REGISTER_TIMING) self.buf[0] = _COMMAND_BIT | _REGISTER_TIMING - self.buf[1] = (current & 0xef) | value + self.buf[1] = (current & 0xEF) | value with self.i2c_device as i2c: i2c.write(self.buf, end=2) @@ -157,7 +160,7 @@ def integration_time(self, value): value &= 0x03 current = self._read_register(_REGISTER_TIMING) self.buf[0] = _COMMAND_BIT | _REGISTER_TIMING - self.buf[1] = (current & 0xfc) | value + self.buf[1] = (current & 0xFC) | value with self.i2c_device as i2c: i2c.write(self.buf, end=2) @@ -170,8 +173,8 @@ def threshold_low(self): @threshold_low.setter def threshold_low(self, value): self.buf[0] = _COMMAND_BIT | _WORD_BIT | _REGISTER_TH_LOW - self.buf[1] = value & 0xff - self.buf[2] = (value >> 8) & 0xff + self.buf[1] = value & 0xFF + self.buf[2] = (value >> 8) & 0xFF with self.i2c_device as i2c: i2c.write(self.buf) @@ -184,8 +187,8 @@ def threshold_high(self): @threshold_high.setter def threshold_high(self, value): self.buf[0] = _COMMAND_BIT | _WORD_BIT | _REGISTER_TH_HIGH - self.buf[1] = value & 0xff - self.buf[2] = (value >> 8) & 0xff + self.buf[1] = value & 0xFF + self.buf[2] = (value >> 8) & 0xFF with self.i2c_device as i2c: i2c.write(self.buf) @@ -194,13 +197,13 @@ def cycles(self): """The number of integration cycles for which an out of bounds value must persist to cause an interrupt.""" value = self._read_register(_REGISTER_INT_CTRL) - return value & 0x0f + return value & 0x0F @cycles.setter def cycles(self, value): current = self._read_register(_REGISTER_INT_CTRL) self.buf[0] = _COMMAND_BIT | _REGISTER_INT_CTRL - self.buf[1] = current | (value & 0x0f) + self.buf[1] = current | (value & 0x0F) with self.i2c_device as i2c: i2c.write(self.buf, end=2) @@ -224,13 +227,13 @@ def interrupt_mode(self): def interrupt_mode(self, value): current = self._read_register(_REGISTER_INT_CTRL) self.buf[0] = _COMMAND_BIT | _REGISTER_INT_CTRL - self.buf[1] = (current & 0x0f) | ((value & 0x03) << 4) + self.buf[1] = (current & 0x0F) | ((value & 0x03) << 4) with self.i2c_device as i2c: i2c.write(self.buf, end=2) def clear_interrupt(self): """Clears any pending interrupt.""" - self.buf[0] = 0xc0 + self.buf[0] = 0xC0 with self.i2c_device as i2c: i2c.write(self.buf, end=1) @@ -244,8 +247,8 @@ def _compute_lux(self): if ch1 > _CLIP_THRESHOLD[self.integration_time]: return None ratio = ch1 / ch0 - if ratio >= 0 and ratio <= 0.50: - lux = 0.0304 * ch0 - 0.062 * ch0 * ratio**1.4 + if 0 <= ratio <= 0.50: + lux = 0.0304 * ch0 - 0.062 * ch0 * ratio ** 1.4 elif ratio <= 0.61: lux = 0.0224 * ch0 - 0.031 * ch1 elif ratio <= 0.80: @@ -253,7 +256,7 @@ def _compute_lux(self): elif ratio <= 1.30: lux = 0.00146 * ch0 - 0.00112 * ch1 else: - lux = 0. + lux = 0.0 # Pretty sure the floating point math formula on pg. 23 of datasheet # is based on 16x gain and 402ms integration time. Need to scale # result for other settings. diff --git a/docs/conf.py b/docs/conf.py index 075b686..d84dc06 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,40 @@ # 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),'Register': ('https://circuitpython.readthedocs.io/projects/register/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, + ), + "Register": ( + "https://circuitpython.readthedocs.io/projects/register/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 CIRCUITPYTHON_TSL2561 Library' -copyright = u'2017 Carter Nelson' -author = u'Carter Nelson' +project = u"Adafruit CIRCUITPYTHON_TSL2561 Library" +copyright = u"2017 Carter Nelson" +author = u"Carter Nelson" # 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 +66,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 +78,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 +92,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 = 'AdafruitCIRCUITPYTHON_TSL2561Librarydoc' +htmlhelp_basename = "AdafruitCIRCUITPYTHON_TSL2561Librarydoc" # -- 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, 'AdafruitCIRCUITPYTHON_TSL2561Library.tex', u'Adafruit CIRCUITPYTHON_TSL2561 Library Documentation', - author, 'manual'), + ( + master_doc, + "AdafruitCIRCUITPYTHON_TSL2561Library.tex", + u"Adafruit CIRCUITPYTHON_TSL2561 Library Documentation", + author, + "manual", + ), ] # -- Options for manual page output --------------------------------------- @@ -140,8 +155,13 @@ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - (master_doc, 'AdafruitCIRCUITPYTHON_TSL2561library', u'Adafruit CIRCUITPYTHON_TSL2561 Library Documentation', - [author], 1) + ( + master_doc, + "AdafruitCIRCUITPYTHON_TSL2561library", + u"Adafruit CIRCUITPYTHON_TSL2561 Library Documentation", + [author], + 1, + ) ] # -- Options for Texinfo output ------------------------------------------- @@ -150,7 +170,13 @@ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'AdafruitCIRCUITPYTHON_TSL2561Library', u'Adafruit CIRCUITPYTHON_TSL2561 Library Documentation', - author, 'AdafruitCIRCUITPYTHON_TSL2561Library', 'One line description of project.', - 'Miscellaneous'), + ( + master_doc, + "AdafruitCIRCUITPYTHON_TSL2561Library", + u"Adafruit CIRCUITPYTHON_TSL2561 Library Documentation", + author, + "AdafruitCIRCUITPYTHON_TSL2561Library", + "One line description of project.", + "Miscellaneous", + ), ] diff --git a/examples/tsl2561_simpletest.py b/examples/tsl2561_simpletest.py index 49549c0..de282a0 100644 --- a/examples/tsl2561_simpletest.py +++ b/examples/tsl2561_simpletest.py @@ -34,7 +34,7 @@ infrared = tsl.infrared # Get raw (luminosity) readings using tuple unpacking -#broadband, infrared = tsl.luminosity +# broadband, infrared = tsl.luminosity # Get computed lux value (tsl.lux can return None or a float) lux = tsl.lux diff --git a/setup.py b/setup.py index e70bd92..bcb2185 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-tsl2561', - + name="adafruit-circuitpython-tsl2561", use_scm_version=True, - setup_requires=['setuptools_scm'], - - description='CircuitPython library for TSL2561 Light Sensor.', + setup_requires=["setuptools_scm"], + description="CircuitPython library for TSL2561 Light Sensor.", 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_TSL2561', - + url="https://github.com/adafruit/Adafruit_CircuitPython_TSL2561", # 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 tsl2561 light sensor hardware micropython circuitpython', - + keywords="adafruit tsl2561 light sensor 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_tsl2561'], + py_modules=["adafruit_tsl2561"], )