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_tlv493d.py b/adafruit_tlv493d.py index 9f758ad..e2e5837 100644 --- a/adafruit_tlv493d.py +++ b/adafruit_tlv493d.py @@ -46,9 +46,11 @@ import struct import adafruit_bus_device.i2c_device as i2cdevice + __version__ = "0.0.0-auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_TLV493D.git" + class TLV493D: """Driver for the TLV493D 3-axis Magnetometer. @@ -70,21 +72,21 @@ class TLV493D: "POWERDOWNFLAG": (5, 0x10, 4), "RES1": (7, 0x18, 3), "RES2": (8, 0xFF, 0), - "RES3": (9, 0x1F, 0) + "RES3": (9, 0x1F, 0), } write_masks = { - "PARITY":(1, 0x80, 7), - "ADDR":(1, 0x60, 5), - "INT":(1, 0x04, 2), - "FAST":(1, 0x02, 1), - "LOWPOWER":(1, 0x01, 0), - "TEMP_DISABLE":(3, 0x80, 7), - "LP_PERIOD":(3, 0x40, 6), - "POWERDOWN":(3, 0x20, 5), - "RES1":(1, 0x18, 3), - "RES2":(2, 0xFF, 0), - "RES3":(3, 0x1F, 0) + "PARITY": (1, 0x80, 7), + "ADDR": (1, 0x60, 5), + "INT": (1, 0x04, 2), + "FAST": (1, 0x02, 1), + "LOWPOWER": (1, 0x01, 0), + "TEMP_DISABLE": (3, 0x80, 7), + "LP_PERIOD": (3, 0x40, 6), + "POWERDOWN": (3, 0x20, 5), + "RES1": (1, 0x18, 3), + "RES2": (2, 0xFF, 0), + "RES3": (3, 0x1F, 0), } def __init__(self, i2c_bus): @@ -96,10 +98,10 @@ def __init__(self, i2c_bus): self._setup_write_buffer() # setup MASTERCONTROLLEDMODE which takes a measurement for every read - self._set_write_key('PARITY', 1) - self._set_write_key('PARITY', 1) - self._set_write_key('LOWPOWER', 1) - self._set_write_key('LP_PERIOD', 1) + self._set_write_key("PARITY", 1) + self._set_write_key("PARITY", 1) + self._set_write_key("LOWPOWER", 1) + self._set_write_key("LP_PERIOD", 1) self._write_i2c() def _read_i2c(self): @@ -113,21 +115,21 @@ def _write_i2c(self): def _setup_write_buffer(self): self._read_i2c() - for key in ['RES1', 'RES2', 'RES3']: + for key in ["RES1", "RES2", "RES3"]: write_value = self._get_read_key(key) self._set_write_key(key, write_value) def _get_read_key(self, key): read_byte_num, read_mask, read_shift = self.read_masks[key] raw_read_value = self.read_buffer[read_byte_num] - write_value = (raw_read_value & read_mask)>>read_shift + write_value = (raw_read_value & read_mask) >> read_shift return write_value def _set_write_key(self, key, value): write_byte_num, write_mask, write_shift = self.write_masks[key] current_write_byte = self.write_buffer[write_byte_num] current_write_byte &= ~write_mask - current_write_byte |= value<h", bytearray([top, bottom]))[0] - binval = binval >>4 + binval = binval >> 4 return binval * 0.098 diff --git a/docs/conf.py b/docs/conf.py index ea6b2bf..7e19e22 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,10 +11,10 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'sphinx.ext.autodoc', - 'sphinx.ext.intersphinx', - 'sphinx.ext.napoleon', - 'sphinx.ext.todo', + "sphinx.ext.autodoc", + "sphinx.ext.intersphinx", + "sphinx.ext.napoleon", + "sphinx.ext.todo", ] # TODO: Please Read! @@ -23,29 +24,40 @@ autodoc_mock_imports = ["adafruit_register", "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 TLV493D Library' -copyright = u'2019 Bryan Siepert' -author = u'Bryan Siepert' +project = "Adafruit TLV493D Library" +copyright = "2019 Bryan Siepert" +author = "Bryan Siepert" # 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 = "1.0" # The full version, including alpha/beta/rc tags. -release = u'1.0' +release = "1.0" # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -57,7 +69,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. @@ -69,7 +81,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 @@ -84,59 +96,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 = 'AdafruitTlv493dLibrarydoc' +htmlhelp_basename = "AdafruitTlv493dLibrarydoc" # -- 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, 'AdafruitTLV493DLibrary.tex', u'AdafruitTLV493D Library Documentation', - author, 'manual'), + ( + master_doc, + "AdafruitTLV493DLibrary.tex", + "AdafruitTLV493D Library Documentation", + author, + "manual", + ), ] # -- Options for manual page output --------------------------------------- @@ -144,8 +159,13 @@ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - (master_doc, 'AdafruitTLV493Dlibrary', u'Adafruit TLV493D Library Documentation', - [author], 1) + ( + master_doc, + "AdafruitTLV493Dlibrary", + "Adafruit TLV493D Library Documentation", + [author], + 1, + ) ] # -- Options for Texinfo output ------------------------------------------- @@ -154,7 +174,13 @@ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'AdafruitTLV493DLibrary', u'Adafruit TLV493D Library Documentation', - author, 'AdafruitTLV493DLibrary', 'One line description of project.', - 'Miscellaneous'), + ( + master_doc, + "AdafruitTLV493DLibrary", + "Adafruit TLV493D Library Documentation", + author, + "AdafruitTLV493DLibrary", + "One line description of project.", + "Miscellaneous", + ), ] diff --git a/examples/tlv493d_simpletest.py b/examples/tlv493d_simpletest.py index 00ec86b..e907022 100644 --- a/examples/tlv493d_simpletest.py +++ b/examples/tlv493d_simpletest.py @@ -7,5 +7,5 @@ tlv = adafruit_tlv493d.TLV493D(i2c) while True: - print("X: %s, Y: %s, Z: %s mT"%tlv.magnetic) + print("X: %s, Y: %s, Z: %s mT" % tlv.magnetic) time.sleep(1) diff --git a/setup.py b/setup.py index 4cffe23..907f0f2 100644 --- a/setup.py +++ b/setup.py @@ -6,6 +6,7 @@ """ from setuptools import setup, find_packages + # To use a consistent encoding from codecs import open from os import path @@ -13,52 +14,42 @@ 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-tlv493d', - + name="adafruit-circuitpython-tlv493d", use_scm_version=True, - setup_requires=['setuptools_scm'], - - description='CircuitPython helper library for the TLV493D 3-axis magnetometer', + setup_requires=["setuptools_scm"], + description="CircuitPython helper library for the TLV493D 3-axis magnetometer", 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_TLV493D', - + url="https://github.com/adafruit/Adafruit_CircuitPython_TLV493D", # Author details - author='Adafruit Industries', - author_email='circuitpython@adafruit.com', - + author="Adafruit Industries", + author_email="circuitpython@adafruit.com", install_requires=[ - 'Adafruit-Blinka', - 'adafruit-circuitpython-busdevice', - 'adafruit-circuitpython-register' + "Adafruit-Blinka", + "adafruit-circuitpython-busdevice", + "adafruit-circuitpython-register", ], - # 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 blinka circuitpython micropython tlv493d tlv sensor magnetometer', - + keywords="adafruit blinka circuitpython micropython tlv493d tlv sensor magnetometer", # You can just specify the packages manually here if your project is # simple. Or you can use find_packages(). - - py_modules=['adafruit_tlv493d'], + py_modules=["adafruit_tlv493d"], )