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_lidarlite.py b/adafruit_lidarlite.py index 8493d70..15854d9 100644 --- a/adafruit_lidarlite.py +++ b/adafruit_lidarlite.py @@ -74,12 +74,15 @@ STATUS_SYS_ERROR = 0x40 # The various configuration register values, from arduino library -_LIDAR_CONFIGS = ((0x80, 0x08, 0x00), # default - (0x1D, 0x08, 0x00), # short range, high speed - (0x80, 0x00, 0x00), # default range, higher speed short range - (0xFF, 0x08, 0x00), # maximum range - (0x80, 0x08, 0x80), # high sensitivity & error - (0x80, 0x08, 0xb0)) # low sensitivity & error +_LIDAR_CONFIGS = ( + (0x80, 0x08, 0x00), # default + (0x1D, 0x08, 0x00), # short range, high speed + (0x80, 0x00, 0x00), # default range, higher speed short range + (0xFF, 0x08, 0x00), # maximum range + (0x80, 0x08, 0x80), # high sensitivity & error + (0x80, 0x08, 0xB0), +) # low sensitivity & error + class LIDARLite: """ @@ -89,8 +92,14 @@ class LIDARLite: :param int address: (optional) The I2C address of the device to set after initialization. """ - def __init__(self, i2c_bus, *, reset_pin=None, - configuration=CONFIG_DEFAULT, address=_ADDR_DEFAULT): + def __init__( + self, + i2c_bus, + *, + reset_pin=None, + configuration=CONFIG_DEFAULT, + address=_ADDR_DEFAULT + ): """Initialize the hardware for the LIDAR over I2C. You can pass in an optional reset_pin for when you call reset(). There are a few common configurations Garmin suggests: CONFIG_DEFAULT, CONFIG_SHORTFAST, @@ -121,7 +130,7 @@ def reset(self): try: self._write_reg(_REG_ACQ_COMMAND, _CMD_RESET) except OSError: - pass # it doesnt respond well once reset + pass # it doesnt respond well once reset time.sleep(1) # take 100 readings to 'flush' out sensor! for _ in range(100): @@ -138,7 +147,7 @@ def configure(self, config): settings = _LIDAR_CONFIGS[config] self._write_reg(0x02, settings[0]) self._write_reg(0x04, settings[1]) - self._write_reg(0x1c, settings[2]) + self._write_reg(0x1C, settings[2]) def read_distance(self, bias=False): """Perform a distance reading with or without 'bias'. It's recommended @@ -159,7 +168,7 @@ def distance(self): """The measured distance in cm. Will take a bias reading every 100 calls""" self._bias_count -= 1 if self._bias_count < 0: - self._bias_count = 100 # every 100 reads, check bias + self._bias_count = 100 # every 100 reads, check bias return self.read_distance(self._bias_count <= 0) @property @@ -174,7 +183,7 @@ def _write_reg(self, reg, value): self._buf[0] = reg self._buf[1] = value with self.i2c_device as i2c: - #print("Writing: ", [hex(i) for i in self._buf]) + # print("Writing: ", [hex(i) for i in self._buf]) i2c.write(self._buf) time.sleep(0.001) # there's a delay in arduino library @@ -187,5 +196,5 @@ def _read_reg(self, reg, num): self._buf[0] = reg with self.i2c_device as i2c: i2c.write_then_readinto(self._buf, self._buf, out_end=1, in_end=num) - #print("Read from ", hex(reg), [hex(i) for i in self._buf]) + # print("Read from ", hex(reg), [hex(i) for i in self._buf]) return self._buf diff --git a/docs/conf.py b/docs/conf.py index 4a78956..db95a1d 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,36 @@ # autodoc_mock_imports = ["digitalio", "busio"] -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 LIDARLite Library' -copyright = u'2018 ladyada' -author = u'ladyada' +project = u"Adafruit LIDARLite Library" +copyright = u"2018 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. @@ -57,7 +65,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 +77,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 +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 = 'AdafruitLidarliteLibrarydoc' +htmlhelp_basename = "AdafruitLidarliteLibrarydoc" # -- 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, 'AdafruitLIDARLiteLibrary.tex', u'AdafruitLIDARLite Library Documentation', - author, 'manual'), + ( + master_doc, + "AdafruitLIDARLiteLibrary.tex", + u"AdafruitLIDARLite Library Documentation", + author, + "manual", + ), ] # -- Options for manual page output --------------------------------------- @@ -144,8 +155,13 @@ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - (master_doc, 'AdafruitLIDARLitelibrary', u'Adafruit LIDARLite Library Documentation', - [author], 1) + ( + master_doc, + "AdafruitLIDARLitelibrary", + u"Adafruit LIDARLite Library Documentation", + [author], + 1, + ) ] # -- Options for Texinfo output ------------------------------------------- @@ -154,7 +170,13 @@ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'AdafruitLIDARLiteLibrary', u'Adafruit LIDARLite Library Documentation', - author, 'AdafruitLIDARLiteLibrary', 'One line description of project.', - 'Miscellaneous'), + ( + master_doc, + "AdafruitLIDARLiteLibrary", + u"Adafruit LIDARLite Library Documentation", + author, + "AdafruitLIDARLiteLibrary", + "One line description of project.", + "Miscellaneous", + ), ] diff --git a/examples/lidarlite_simpletest.py b/examples/lidarlite_simpletest.py index 2c51e12..7f51fee 100644 --- a/examples/lidarlite_simpletest.py +++ b/examples/lidarlite_simpletest.py @@ -11,9 +11,9 @@ sensor = adafruit_lidarlite.LIDARLite(i2c) # Optionally, we can pass in a hardware reset pin, or custom config -#import digitalio -#reset = digitalio.DigitalInOut(board.D5) -#sensor = adafruit_lidarlite.LIDARLite(i2c, reset_pin=reset, +# import digitalio +# reset = digitalio.DigitalInOut(board.D5) +# sensor = adafruit_lidarlite.LIDARLite(i2c, reset_pin=reset, # configuration=adafruit_lidarlite.CONFIG_MAXRANGE) # If you want to reset, you can do so, note that it can take 10-20 seconds @@ -27,4 +27,4 @@ except RuntimeError as e: # If we get a reading error, just print it and keep truckin' print(e) - time.sleep(0.01) # you can remove this for ultra-fast measurements! + time.sleep(0.01) # you can remove this for ultra-fast measurements! diff --git a/setup.py b/setup.py index a9c9762..b5d29c5 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-lidarlite', - + name="adafruit-circuitpython-lidarlite", use_scm_version=True, - setup_requires=['setuptools_scm'], - - description='A CircuitPython & Python library for Garmin LIDAR Lite sensors over I2C.', + setup_requires=["setuptools_scm"], + description="A CircuitPython & Python library for Garmin LIDAR Lite sensors over I2C.", 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_LIDARLite', - + url="https://github.com/adafruit/Adafruit_CircuitPython_LIDARLite", # 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 lidarlite lidar garmin i2c hardware sensor micropython circuitpython', - + keywords="adafruit lidarlite lidar garmin i2c hardware sensor micropython circuitpython", # You can just specify the packages manually here if your project is # simple. Or you can use find_packages(). - py_modules=['adafruit_lidarlite'], + py_modules=["adafruit_lidarlite"], )