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_sgp30.py b/adafruit_sgp30.py index f32fc4a..cb92f3b 100755 --- a/adafruit_sgp30.py +++ b/adafruit_sgp30.py @@ -50,14 +50,15 @@ # pylint: disable=bad-whitespace -_SGP30_DEFAULT_I2C_ADDR = const(0x58) -_SGP30_FEATURESETS = (0x0020, 0x0022) +_SGP30_DEFAULT_I2C_ADDR = const(0x58) +_SGP30_FEATURESETS = (0x0020, 0x0022) -_SGP30_CRC8_POLYNOMIAL = const(0x31) -_SGP30_CRC8_INIT = const(0xFF) -_SGP30_WORD_LEN = const(2) +_SGP30_CRC8_POLYNOMIAL = const(0x31) +_SGP30_CRC8_INIT = const(0xFF) +_SGP30_WORD_LEN = const(2) # pylint: enable=bad-whitespace + class Adafruit_SGP30: """ A driver for the SGP30 gas sensor. @@ -70,40 +71,35 @@ def __init__(self, i2c, address=_SGP30_DEFAULT_I2C_ADDR): # get unique serial, its 48 bits so we store in an array self.serial = self._i2c_read_words_from_cmd([0x36, 0x82], 0.01, 3) # get featureset - featureset = self._i2c_read_words_from_cmd([0x20, 0x2f], 0.01, 1) + featureset = self._i2c_read_words_from_cmd([0x20, 0x2F], 0.01, 1) if featureset[0] not in _SGP30_FEATURESETS: - raise RuntimeError('SGP30 Not detected') + raise RuntimeError("SGP30 Not detected") self.iaq_init() - @property # pylint: disable=invalid-name def TVOC(self): """Total Volatile Organic Compound in parts per billion.""" return self.iaq_measure()[1] - @property # pylint: disable=invalid-name def baseline_TVOC(self): """Total Volatile Organic Compound baseline value""" return self.get_iaq_baseline()[1] - @property # pylint: disable=invalid-name def eCO2(self): """Carbon Dioxide Equivalent in parts per million""" return self.iaq_measure()[0] - @property # pylint: disable=invalid-name def baseline_eCO2(self): """Carbon Dioxide Equivalent baseline value""" return self.get_iaq_baseline()[0] - def iaq_init(self): """Initialize the IAQ algorithm""" # name, command, signals, delay @@ -119,18 +115,18 @@ def get_iaq_baseline(self): # name, command, signals, delay return self._run_profile(["iaq_get_baseline", [0x20, 0x15], 2, 0.01]) - def set_iaq_baseline(self, eCO2, TVOC): # pylint: disable=invalid-name + def set_iaq_baseline(self, eCO2, TVOC): # pylint: disable=invalid-name """Set the previously recorded IAQ algorithm baseline for eCO2 and TVOC""" if eCO2 == 0 and TVOC == 0: - raise RuntimeError('Invalid baseline') + raise RuntimeError("Invalid baseline") buffer = [] for value in [TVOC, eCO2]: arr = [value >> 8, value & 0xFF] arr.append(self._generate_crc(arr)) buffer += arr - self._run_profile(["iaq_set_baseline", [0x20, 0x1e] + buffer, 0, 0.01]) + self._run_profile(["iaq_set_baseline", [0x20, 0x1E] + buffer, 0, 0.01]) - def set_iaq_humidity(self, gramsPM3): # pylint: disable=invalid-name + def set_iaq_humidity(self, gramsPM3): # pylint: disable=invalid-name """Set the humidity in g/m3 for eCO2 and TVOC compensation algorithm""" tmp = int(gramsPM3 * 256) buffer = [] @@ -148,11 +144,10 @@ def _run_profile(self, profile): name, command, signals, delay = profile # pylint: enable=unused-variable - #print("\trunning profile: %s, command %s, %d, delay %0.02f" % + # print("\trunning profile: %s, command %s, %d, delay %0.02f" % # (name, ["0x%02x" % i for i in command], signals, delay)) return self._i2c_read_words_from_cmd(command, delay, signals) - def _i2c_read_words_from_cmd(self, command, delay, reply_size): """Run an SGP command query, get a reply and CRC results if necessary""" with self._device: @@ -160,17 +155,17 @@ def _i2c_read_words_from_cmd(self, command, delay, reply_size): time.sleep(delay) if not reply_size: return None - crc_result = bytearray(reply_size * (_SGP30_WORD_LEN +1)) + crc_result = bytearray(reply_size * (_SGP30_WORD_LEN + 1)) self._device.readinto(crc_result) - #print("\tRaw Read: ", crc_result) + # print("\tRaw Read: ", crc_result) result = [] for i in range(reply_size): - word = [crc_result[3*i], crc_result[3*i+1]] - crc = crc_result[3*i+2] + word = [crc_result[3 * i], crc_result[3 * i + 1]] + crc = crc_result[3 * i + 2] if self._generate_crc(word) != crc: - raise RuntimeError('CRC Error') + raise RuntimeError("CRC Error") result.append(word[0] << 8 | word[1]) - #print("\tOK Data: ", [hex(i) for i in result]) + # print("\tOK Data: ", [hex(i) for i in result]) return result # pylint: disable=no-self-use diff --git a/docs/conf.py b/docs/conf.py index fa7f715..997f5b4 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,36 @@ # autodoc module docs will fail to generate with a warning. # autodoc_mock_imports = ["adafruit_bus_device", "micropython"] -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 sgp30 Library' -copyright = u'2017 Ladyada' -author = u'Ladyada' +project = u"Adafruit sgp30 Library" +copyright = u"2017 Ladyada" +author = u"Ladyada" # 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 @@ # 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 @@ 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 @@ # 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 = 'AdafruitSgp30Librarydoc' +htmlhelp_basename = "AdafruitSgp30Librarydoc" # -- 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, 'Adafruitsgp30Library.tex', u'Adafruitsgp30 Library Documentation', - author, 'manual'), + ( + master_doc, + "Adafruitsgp30Library.tex", + u"Adafruitsgp30 Library Documentation", + author, + "manual", + ), ] # -- Options for manual page output --------------------------------------- @@ -140,8 +151,13 @@ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - (master_doc, 'Adafruitsgp30library', u'Adafruit sgp30 Library Documentation', - [author], 1) + ( + master_doc, + "Adafruitsgp30library", + u"Adafruit sgp30 Library Documentation", + [author], + 1, + ) ] # -- Options for Texinfo output ------------------------------------------- @@ -150,7 +166,13 @@ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'Adafruitsgp30Library', u'Adafruit sgp30 Library Documentation', - author, 'Adafruitsgp30Library', 'One line description of project.', - 'Miscellaneous'), + ( + master_doc, + "Adafruitsgp30Library", + u"Adafruit sgp30 Library Documentation", + author, + "Adafruitsgp30Library", + "One line description of project.", + "Miscellaneous", + ), ] diff --git a/examples/sgp30_simpletest.py b/examples/sgp30_simpletest.py index 89ffe16..882b25d 100644 --- a/examples/sgp30_simpletest.py +++ b/examples/sgp30_simpletest.py @@ -13,7 +13,7 @@ print("SGP30 serial #", [hex(i) for i in sgp30.serial]) sgp30.iaq_init() -sgp30.set_iaq_baseline(0x8973, 0x8aae) +sgp30.set_iaq_baseline(0x8973, 0x8AAE) elapsed_sec = 0 @@ -23,5 +23,7 @@ elapsed_sec += 1 if elapsed_sec > 10: elapsed_sec = 0 - print("**** Baseline values: eCO2 = 0x%x, TVOC = 0x%x" - % (sgp30.baseline_eCO2, sgp30.baseline_TVOC)) + print( + "**** Baseline values: eCO2 = 0x%x, TVOC = 0x%x" + % (sgp30.baseline_eCO2, sgp30.baseline_TVOC) + ) diff --git a/setup.py b/setup.py index f3d5003..45bcd11 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-sgp30', - + name="adafruit-circuitpython-sgp30", use_scm_version=True, - setup_requires=['setuptools_scm'], - - description='CircuitPython library for Sensirion SGP30 gas sensor with eCO2 and TVOC.', + setup_requires=["setuptools_scm"], + description="CircuitPython library for Sensirion SGP30 gas sensor with eCO2 and TVOC.", 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_SGP30', - + url="https://github.com/adafruit/Adafruit_CircuitPython_SGP30", # 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 sensiron sgp30 gas sensor eco2 tvoc i2c hardware micropython circuitpython', - + keywords="adafruit sensiron sgp30 gas sensor eco2 tvoc i2c 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_sgp30'], + py_modules=["adafruit_sgp30"], )