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 8e9553a..d8f0ee8 100644 --- a/.pylintrc +++ b/.pylintrc @@ -119,7 +119,7 @@ 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 @@ -301,7 +301,7 @@ 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,i,j,k,n,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 @@ -423,7 +423,7 @@ max-returns=6 max-statements=50 # Minimum number of public methods for a class (see R0903). -min-public-methods=2 +min-public-methods=1 [EXCEPTIONS] diff --git a/adafruit_max31865.py b/adafruit_max31865.py index c10e628..ad192cc 100644 --- a/adafruit_max31865.py +++ b/adafruit_max31865.py @@ -58,34 +58,34 @@ import adafruit_bus_device.spi_device as spi_device __version__ = "0.0.0-auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_MAX31865.git" -#pylint: disable=bad-whitespace +# pylint: disable=bad-whitespace # Register and other constant values: -_MAX31865_CONFIG_REG = const(0x00) -_MAX31865_CONFIG_BIAS = const(0x80) -_MAX31865_CONFIG_MODEAUTO = const(0x40) -_MAX31865_CONFIG_MODEOFF = const(0x00) -_MAX31865_CONFIG_1SHOT = const(0x20) -_MAX31865_CONFIG_3WIRE = const(0x10) -_MAX31865_CONFIG_24WIRE = const(0x00) -_MAX31865_CONFIG_FAULTSTAT = const(0x02) -_MAX31865_CONFIG_FILT50HZ = const(0x01) -_MAX31865_CONFIG_FILT60HZ = const(0x00) -_MAX31865_RTDMSB_REG = const(0x01) -_MAX31865_RTDLSB_REG = const(0x02) -_MAX31865_HFAULTMSB_REG = const(0x03) -_MAX31865_HFAULTLSB_REG = const(0x04) -_MAX31865_LFAULTMSB_REG = const(0x05) -_MAX31865_LFAULTLSB_REG = const(0x06) -_MAX31865_FAULTSTAT_REG = const(0x07) -_MAX31865_FAULT_HIGHTHRESH = const(0x80) -_MAX31865_FAULT_LOWTHRESH = const(0x40) -_MAX31865_FAULT_REFINLOW = const(0x20) -_MAX31865_FAULT_REFINHIGH = const(0x10) -_MAX31865_FAULT_RTDINLOW = const(0x08) -_MAX31865_FAULT_OVUV = const(0x04) +_MAX31865_CONFIG_REG = const(0x00) +_MAX31865_CONFIG_BIAS = const(0x80) +_MAX31865_CONFIG_MODEAUTO = const(0x40) +_MAX31865_CONFIG_MODEOFF = const(0x00) +_MAX31865_CONFIG_1SHOT = const(0x20) +_MAX31865_CONFIG_3WIRE = const(0x10) +_MAX31865_CONFIG_24WIRE = const(0x00) +_MAX31865_CONFIG_FAULTSTAT = const(0x02) +_MAX31865_CONFIG_FILT50HZ = const(0x01) +_MAX31865_CONFIG_FILT60HZ = const(0x00) +_MAX31865_RTDMSB_REG = const(0x01) +_MAX31865_RTDLSB_REG = const(0x02) +_MAX31865_HFAULTMSB_REG = const(0x03) +_MAX31865_HFAULTLSB_REG = const(0x04) +_MAX31865_LFAULTMSB_REG = const(0x05) +_MAX31865_LFAULTLSB_REG = const(0x06) +_MAX31865_FAULTSTAT_REG = const(0x07) +_MAX31865_FAULT_HIGHTHRESH = const(0x80) +_MAX31865_FAULT_LOWTHRESH = const(0x40) +_MAX31865_FAULT_REFINLOW = const(0x20) +_MAX31865_FAULT_REFINHIGH = const(0x10) +_MAX31865_FAULT_RTDINLOW = const(0x08) +_MAX31865_FAULT_OVUV = const(0x04) _RTD_A = 3.9083e-3 _RTD_B = -5.775e-7 -#pylint: enable=bad-whitespace +# pylint: enable=bad-whitespace class MAX31865: @@ -99,11 +99,12 @@ class MAX31865: def __init__(self, spi, cs, *, rtd_nominal=100, ref_resistor=430.0, wires=2): self.rtd_nominal = rtd_nominal self.ref_resistor = ref_resistor - self._device = spi_device.SPIDevice(spi, cs, baudrate=500000, - polarity=0, phase=1) + self._device = spi_device.SPIDevice( + spi, cs, baudrate=500000, polarity=0, phase=1 + ) # Set wire config register based on the number of wires specified. if wires not in (2, 3, 4): - raise ValueError('Wires must be a value of 2, 3, or 4!') + raise ValueError("Wires must be a value of 2, 3, or 4!") config = self._read_u8(_MAX31865_CONFIG_REG) if wires == 3: config |= _MAX31865_CONFIG_3WIRE @@ -138,6 +139,7 @@ class MAX31865: self._BUFFER[0] = (address | 0x80) & 0xFF self._BUFFER[1] = val & 0xFF device.write(self._BUFFER, end=2) + # pylint: enable=no-member @property @@ -165,7 +167,7 @@ class MAX31865: def auto_convert(self, val): config = self._read_u8(_MAX31865_CONFIG_REG) if val: - config |= _MAX31865_CONFIG_MODEAUTO # Enable auto convert. + config |= _MAX31865_CONFIG_MODEAUTO # Enable auto convert. else: config &= ~_MAX31865_CONFIG_MODEAUTO # Disable auto convert. self._write_u8(_MAX31865_CONFIG_REG, config) @@ -184,14 +186,14 @@ class MAX31865: - OVUV """ faults = self._read_u8(_MAX31865_FAULTSTAT_REG) - #pylint: disable=bad-whitespace + # pylint: disable=bad-whitespace highthresh = bool(faults & _MAX31865_FAULT_HIGHTHRESH) - lowthresh = bool(faults & _MAX31865_FAULT_LOWTHRESH) - refinlow = bool(faults & _MAX31865_FAULT_REFINLOW) - refinhigh = bool(faults & _MAX31865_FAULT_REFINHIGH) - rtdinlow = bool(faults & _MAX31865_FAULT_RTDINLOW) - ovuv = bool(faults & _MAX31865_FAULT_OVUV) - #pylint: enable=bad-whitespace + lowthresh = bool(faults & _MAX31865_FAULT_LOWTHRESH) + refinlow = bool(faults & _MAX31865_FAULT_REFINLOW) + refinhigh = bool(faults & _MAX31865_FAULT_REFINHIGH) + rtdinlow = bool(faults & _MAX31865_FAULT_RTDINLOW) + ovuv = bool(faults & _MAX31865_FAULT_OVUV) + # pylint: enable=bad-whitespace return (highthresh, lowthresh, refinlow, refinhigh, rtdinlow, ovuv) def clear_faults(self): diff --git a/docs/conf.py b/docs/conf.py index 2e96f1c..50bd0d1 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 @@ 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", ] @@ -21,29 +22,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 MAX31865 Library' -copyright = u'2017 Tony DiCola' -author = u'Tony DiCola' +project = u"Adafruit MAX31865 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. @@ -55,7 +63,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. @@ -67,7 +75,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 @@ -81,59 +89,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 = 'AdafruitMAX31865Librarydoc' +htmlhelp_basename = "AdafruitMAX31865Librarydoc" # -- 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, 'AdafruitMAX31865Library.tex', u'Adafruit MAX31865 Library Documentation', - author, 'manual'), + ( + master_doc, + "AdafruitMAX31865Library.tex", + u"Adafruit MAX31865 Library Documentation", + author, + "manual", + ), ] # -- Options for manual page output --------------------------------------- @@ -141,8 +152,13 @@ latex_documents = [ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - (master_doc, 'adafruitMAX31865library', u'Adafruit MAX31865 Library Documentation', - [author], 1) + ( + master_doc, + "adafruitMAX31865library", + u"Adafruit MAX31865 Library Documentation", + [author], + 1, + ) ] # -- Options for Texinfo output ------------------------------------------- @@ -151,7 +167,13 @@ man_pages = [ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'AdafruitMAX31865Library', u'Adafruit MAX31865 Library Documentation', - author, 'AdafruitMAX31865Library', 'One line description of project.', - 'Miscellaneous'), + ( + master_doc, + "AdafruitMAX31865Library", + u"Adafruit MAX31865 Library Documentation", + author, + "AdafruitMAX31865Library", + "One line description of project.", + "Miscellaneous", + ), ] diff --git a/examples/max31865_simpletest.py b/examples/max31865_simpletest.py index db6c20e..6e83594 100644 --- a/examples/max31865_simpletest.py +++ b/examples/max31865_simpletest.py @@ -16,13 +16,13 @@ sensor = adafruit_max31865.MAX31865(spi, cs) # Note you can optionally provide the thermocouple RTD nominal, the reference # resistance, and the number of wires for the sensor (2 the default, 3, or 4) # with keyword args: -#sensor = adafruit_max31865.MAX31865(spi, cs, rtd_nominal=100, ref_resistor=430.0, wires=2) +# sensor = adafruit_max31865.MAX31865(spi, cs, rtd_nominal=100, ref_resistor=430.0, wires=2) # Main loop to print the temperature every second. while True: # Read temperature. temp = sensor.temperature # Print the value. - print('Temperature: {0:0.3f}C'.format(temp)) + print("Temperature: {0:0.3f}C".format(temp)) # Delay for a second. time.sleep(1.0) diff --git a/setup.py b/setup.py index 4b90dbd..b376a75 100644 --- a/setup.py +++ b/setup.py @@ -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-max31865', - + name="adafruit-circuitpython-max31865", use_scm_version=True, - setup_requires=['setuptools_scm'], - - description='CircuitPython library for MAX31865 thermocouple amplifier.', + setup_requires=["setuptools_scm"], + description="CircuitPython library for MAX31865 thermocouple amplifier.", 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_MAX31865', - + url="https://github.com/adafruit/Adafruit_CircuitPython_MAX31865", # 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 max31865 thermocouple amplifier breakout hardware micropython circuitpython', - + keywords="adafruit max31865 thermocouple amplifier 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_max31865'], + py_modules=["adafruit_max31865"], )