diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index fff3aa9..97fe64d 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 pylint black==19.10b0 Sphinx sphinx-rtd-theme - name: Library version run: git describe --dirty --always --tags - name: PyLint diff --git a/adafruit_dymoscale.py b/adafruit_dymoscale.py index 3951304..800fef8 100644 --- a/adafruit_dymoscale.py +++ b/adafruit_dymoscale.py @@ -41,8 +41,8 @@ from pulseio import PulseIn from micropython import const -OUNCES = const(0x0B) # data in weight is in ounces -GRAMS = const(0x02) # data in weight is in grams +OUNCES = const(0x0B) # data in weight is in ounces +GRAMS = const(0x02) # data in weight is in grams PULSE_WIDTH = 72.5 __version__ = "0.0.0-auto.0" @@ -51,13 +51,16 @@ # pylint: disable=too-few-public-methods class ScaleReading: """Dymo Scale Data""" - units = None # what units we're measuring - stable = None # is the measurement stable? - weight = None # the weight! + + units = None # what units we're measuring + stable = None # is the measurement stable? + weight = None # the weight! + class DYMOScale: """Interface to a DYMO postal scale. """ + def __init__(self, data_pin, units_pin, timeout=1.0): """Sets up a DYMO postal scale. :param ~pulseio.PulseIn data_pin: The data pin from the Dymo scale. @@ -84,9 +87,9 @@ def toggle_unit_button(self, switch_units=False): :param bool switch_units: Simulates pressing the units button. """ toggle_times = 0 - if switch_units: # press the button once + if switch_units: # press the button once toggle_amt = 2 - else: # toggle and preserve current unit state + else: # toggle and preserve current unit state toggle_amt = 4 while toggle_times < toggle_amt: self.units_pin.value ^= 1 @@ -103,34 +106,38 @@ def _read_pulse(self): self.dymo.resume() while len(self.dymo) < 35: if (time.monotonic() - timestamp) > self.timeout: - raise RuntimeError("Timed out waiting for data - is the scale turned on?") + raise RuntimeError( + "Timed out waiting for data - is the scale turned on?" + ) self.dymo.pause() def get_scale_data(self): """Reads a pulse of SPI data and analyzes the resulting data. """ self._read_pulse() - bits = [0] * 96 # there are 12 bytes = 96 bits of data - bit_idx = 0 # we will count a bit at a time - bit_val = False # first pulses will be LOW + bits = [0] * 96 # there are 12 bytes = 96 bits of data + bit_idx = 0 # we will count a bit at a time + bit_val = False # first pulses will be LOW for i in range(len(self.dymo)): - if self.dymo[i] == 65535: # check for the pulse between transmits + if self.dymo[i] == 65535: # check for the pulse between transmits break - num_bits = int(self.dymo[i] / PULSE_WIDTH + 0.5) # ~14KHz == ~7.5us per clock + num_bits = int( + self.dymo[i] / PULSE_WIDTH + 0.5 + ) # ~14KHz == ~7.5us per clock bit = 0 while bit < num_bits: bits[bit_idx] = bit_val bit_idx += 1 - if bit_idx == 96: # we have read all the data we wanted + if bit_idx == 96: # we have read all the data we wanted break bit += 1 bit_val = not bit_val - data_bytes = [0] * 12 # alllocate data array + data_bytes = [0] * 12 # alllocate data array for byte_n in range(12): the_byte = 0 for bit_n in range(8): the_byte <<= 1 - the_byte |= bits[byte_n*8 + bit_n] + the_byte |= bits[byte_n * 8 + bit_n] data_bytes[byte_n] = the_byte # do some very basic data checking if data_bytes[0] != 3 and data_bytes[0] != 2: diff --git a/docs/conf.py b/docs/conf.py index 8d8052e..76f15ce 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,32 @@ autodoc_mock_imports = ["pulseio", "micropython"] -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 DymoScale Library' -copyright = u'2019 ladyada' -author = u'ladyada' +project = "Adafruit DymoScale Library" +copyright = "2019 ladyada" +author = "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 = "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 +61,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 +73,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 +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 = 'AdafruitDymoscaleLibrarydoc' +htmlhelp_basename = "AdafruitDymoscaleLibrarydoc" # -- 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, 'AdafruitDymoScaleLibrary.tex', u'AdafruitDymoScale Library Documentation', - author, 'manual'), + ( + master_doc, + "AdafruitDymoScaleLibrary.tex", + "AdafruitDymoScale Library Documentation", + author, + "manual", + ), ] # -- Options for manual page output --------------------------------------- @@ -144,8 +151,13 @@ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - (master_doc, 'AdafruitDymoScalelibrary', u'Adafruit DymoScale Library Documentation', - [author], 1) + ( + master_doc, + "AdafruitDymoScalelibrary", + "Adafruit DymoScale Library Documentation", + [author], + 1, + ) ] # -- Options for Texinfo output ------------------------------------------- @@ -154,7 +166,13 @@ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'AdafruitDymoScaleLibrary', u'Adafruit DymoScale Library Documentation', - author, 'AdafruitDymoScaleLibrary', 'One line description of project.', - 'Miscellaneous'), + ( + master_doc, + "AdafruitDymoScaleLibrary", + "Adafruit DymoScale Library Documentation", + author, + "AdafruitDymoScaleLibrary", + "One line description of project.", + "Miscellaneous", + ), ] diff --git a/examples/dymoscale_simpletest.py b/examples/dymoscale_simpletest.py index c9808bd..c51834d 100644 --- a/examples/dymoscale_simpletest.py +++ b/examples/dymoscale_simpletest.py @@ -17,7 +17,7 @@ print(text) # to avoid sleep mode, toggle the units pin every 2 mins. if (time.monotonic() - time_stamp) > 120: - print('toggling units button...') + print("toggling units button...") dymo.toggle_unit_button() # reset the time time_stamp = time.monotonic() diff --git a/setup.py b/setup.py index 362b02a..9f56b07 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,51 +14,40 @@ 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-dymoscale', - + name="adafruit-circuitpython-dymoscale", use_scm_version=True, - setup_requires=['setuptools_scm'], - - description='CircuitPython interface for DYMO scales.', + setup_requires=["setuptools_scm"], + description="CircuitPython interface for DYMO scales.", 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_DymoScale', - + url="https://github.com/adafruit/Adafruit_CircuitPython_DymoScale", # Author details - author='Adafruit Industries', - author_email='circuitpython@adafruit.com', - - install_requires=[ - 'Adafruit-Blinka' - ], - + author="Adafruit Industries", + author_email="circuitpython@adafruit.com", + install_requires=["Adafruit-Blinka"], # 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 dymoscale dymo scale', - + keywords="adafruit blinka circuitpython micropython dymoscale dymo scale", # You can just specify the packages manually here if your project is # simple. Or you can use find_packages(). # TODO: IF LIBRARY FILES ARE A PACKAGE FOLDER, # CHANGE `py_modules=['...']` TO `packages=['...']` - py_modules=['adafruit_dymoscale'], + py_modules=["adafruit_dymoscale"], )