jepler/Adafruit_CircuitPython_AM2320
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Ran black, updated to pylint 2.x

Browse source
This commit is contained in:
dherrada 2020-03-15 17:26:50 -04:00
parent 9c45226540
commit a7ff0f6c28
4 changed files with 95 additions and 87 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
.github/workflows/build.yml vendored
View file

@ -40,7 +40,7 @@ jobs:
source actions-ci/install.sh source actions-ci/install.sh
- name: Pip install pylint, black, & Sphinx - name: Pip install pylint, black, & Sphinx
run: | 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 - name: Library version
run: git describe --dirty --always --tags run: git describe --dirty --always --tags
- name: PyLint - name: PyLint

18
adafruit_am2320.py
View file

@ -65,7 +65,7 @@ AM2320_REG_HUM_H = const(0x00)
def _crc16(data): def _crc16(data):
crc = 0xffff crc = 0xFFFF
for byte in data: for byte in data:
crc ^= byte crc ^= byte
for _ in range(8): for _ in range(8):
@ -79,12 +79,10 @@ def _crc16(data):
class AM2320Exception(Exception): class AM2320Exception(Exception):
"""Base class for exceptions.""" """Base class for exceptions."""
pass
class AM2320DeviceNotFound(AM2320Exception, ValueError): class AM2320DeviceNotFound(AM2320Exception, ValueError):
"""Indicates that a device couldn't be found.""" """Indicates that a device couldn't be found."""
pass
class AM2320ReadError(AM2320Exception, RuntimeError): class AM2320ReadError(AM2320Exception, RuntimeError):
@ -92,7 +90,6 @@ class AM2320ReadError(AM2320Exception, RuntimeError):
This may be due to a regular I2C read failure, or due to a checksum This may be due to a regular I2C read failure, or due to a checksum
mismatch.""" mismatch."""
pass
class AM2320: class AM2320:
@ -102,6 +99,7 @@ class AM2320:
:param int address: (optional) The I2C address of the device. :param int address: (optional) The I2C address of the device.
""" """
def __init__(self, i2c_bus, address=AM2320_DEFAULT_ADDR): def __init__(self, i2c_bus, address=AM2320_DEFAULT_ADDR):
for _ in range(3): for _ in range(3):
# retry since we have to wake up the devices # retry since we have to wake up the devices
@ -111,7 +109,7 @@ class AM2320:
except ValueError: except ValueError:
pass pass
time.sleep(0.25) time.sleep(0.25)
raise AM2320DeviceNotFound('AM2320 not found') raise AM2320DeviceNotFound("AM2320 not found")
def _read_register(self, register, length): def _read_register(self, register, length):
with self._i2c as i2c: with self._i2c as i2c:
@ -127,17 +125,17 @@ class AM2320:
# print("cmd: %s" % [hex(i) for i in cmd]) # print("cmd: %s" % [hex(i) for i in cmd])
i2c.write(bytes(cmd)) i2c.write(bytes(cmd))
time.sleep(0.002) # wait 2 ms for reply time.sleep(0.002) # wait 2 ms for reply
result = bytearray(length+4) # 2 bytes pre, 2 bytes crc result = bytearray(length + 4) # 2 bytes pre, 2 bytes crc
i2c.readinto(result) i2c.readinto(result)
# print("$%02X => %s" % (register, [hex(i) for i in result])) # print("$%02X => %s" % (register, [hex(i) for i in result]))
# Check preamble indicates correct readings # Check preamble indicates correct readings
if result[0] != 0x3 or result[1] != length: if result[0] != 0x3 or result[1] != length:
raise AM2320ReadError('I2C read failure') raise AM2320ReadError("I2C read failure")
# Check CRC on all but last 2 bytes # Check CRC on all but last 2 bytes
crc1 = struct.unpack("<H", bytes(result[-2:]))[0] crc1 = struct.unpack("<H", bytes(result[-2:]))[0]
crc2 = _crc16(result[0:-2]) crc2 = _crc16(result[0:-2])
if crc1 != crc2: if crc1 != crc2:
raise AM2320ReadError('CRC failure 0x%04X vs 0x%04X' % (crc1, crc2)) raise AM2320ReadError("CRC failure 0x%04X vs 0x%04X" % (crc1, crc2))
return result[2:-2] return result[2:-2]
@property @property
@ -146,10 +144,10 @@ class AM2320:
temperature = struct.unpack(">H", self._read_register(AM2320_REG_TEMP_H, 2))[0] temperature = struct.unpack(">H", self._read_register(AM2320_REG_TEMP_H, 2))[0]
if temperature >= 32768: if temperature >= 32768:
temperature = 32768 - temperature temperature = 32768 - temperature
return temperature/10.0 return temperature / 10.0
@property @property
def relative_humidity(self): def relative_humidity(self):
"""The measured relative humidity in percent.""" """The measured relative humidity in percent."""
humidity = struct.unpack(">H", self._read_register(AM2320_REG_HUM_H, 2))[0] humidity = struct.unpack(">H", self._read_register(AM2320_REG_HUM_H, 2))[0]
return humidity/10.0 return humidity / 10.0

112
docs/conf.py
View file

@ -2,7 +2,8 @@
import os import os
import sys import sys
sys.path.insert(0, os.path.abspath('..'))
sys.path.insert(0, os.path.abspath(".."))
# -- General configuration ------------------------------------------------ # -- General configuration ------------------------------------------------
@ -10,35 +11,38 @@ sys.path.insert(0, os.path.abspath('..'))
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones. # ones.
extensions = [ extensions = [
'sphinx.ext.autodoc', "sphinx.ext.autodoc",
'sphinx.ext.intersphinx', "sphinx.ext.intersphinx",
'sphinx.ext.napoleon', "sphinx.ext.napoleon",
'sphinx.ext.todo', "sphinx.ext.todo",
] ]
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. # 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. # The master toctree document.
master_doc = 'index' master_doc = "index"
# General information about the project. # General information about the project.
project = u'Adafruit am2320 Library' project = u"Adafruit am2320 Library"
copyright = u'2017 Limor Fried' copyright = u"2017 Limor Fried"
author = u'Limor Fried' author = u"Limor Fried"
# The version info for the project you're documenting, acts as replacement for # The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the # |version| and |release|, also used in various other places throughout the
# built documents. # built documents.
# #
# The short X.Y version. # The short X.Y version.
version = u'1.0' version = u"1.0"
# The full version, including alpha/beta/rc tags. # 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 # The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages. # for a list of supported languages.
@ -50,7 +54,7 @@ language = None
# List of patterns, relative to source directory, that match files and # List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files. # directories to ignore when looking for source files.
# This patterns also effect to html_static_path and html_extra_path # 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 # The reST default role (used for this markup: `text`) to use for all
# documents. # documents.
@ -62,7 +66,7 @@ default_role = "any"
add_function_parentheses = True add_function_parentheses = True
# The name of the Pygments (syntax highlighting) style to use. # 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. # If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False todo_include_todos = False
@ -77,59 +81,62 @@ napoleon_numpy_docstring = False
# The theme to use for HTML and HTML Help pages. See the documentation for # The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes. # 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 if not on_rtd: # only import and set the theme if we're building docs locally
try: try:
import sphinx_rtd_theme 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: except:
html_theme = 'default' html_theme = "default"
html_theme_path = ['.'] html_theme_path = ["."]
else: else:
html_theme_path = ['.'] html_theme_path = ["."]
# Add any paths that contain custom static files (such as style sheets) here, # 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, # relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css". # 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 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 # the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large. # pixels large.
# #
html_favicon = '_static/favicon.ico' html_favicon = "_static/favicon.ico"
# Output file base name for HTML help builder. # Output file base name for HTML help builder.
htmlhelp_basename = 'AdafruitAm2320Librarydoc' htmlhelp_basename = "AdafruitAm2320Librarydoc"
# -- Options for LaTeX output --------------------------------------------- # -- Options for LaTeX output ---------------------------------------------
latex_elements = { latex_elements = {
# The paper size ('letterpaper' or 'a4paper'). # The paper size ('letterpaper' or 'a4paper').
# #
# 'papersize': 'letterpaper', # 'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
# The font size ('10pt', '11pt' or '12pt'). #
# # 'pointsize': '10pt',
# 'pointsize': '10pt', # Additional stuff for the LaTeX preamble.
#
# Additional stuff for the LaTeX preamble. # 'preamble': '',
# # Latex figure (float) alignment
# 'preamble': '', #
# 'figure_align': 'htbp',
# Latex figure (float) alignment
#
# 'figure_align': 'htbp',
} }
# Grouping the document tree into LaTeX files. List of tuples # Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, # (source start file, target name, title,
# author, documentclass [howto, manual, or own class]). # author, documentclass [howto, manual, or own class]).
latex_documents = [ latex_documents = [
(master_doc, 'Adafruitam2320Library.tex', u'Adafruitam2320 Library Documentation', (
author, 'manual'), master_doc,
"Adafruitam2320Library.tex",
u"Adafruitam2320 Library Documentation",
author,
"manual",
),
] ]
# -- Options for manual page output --------------------------------------- # -- Options for manual page output ---------------------------------------
@ -137,8 +144,13 @@ latex_documents = [
# One entry per manual page. List of tuples # One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section). # (source start file, name, description, authors, manual section).
man_pages = [ man_pages = [
(master_doc, 'Adafruitam2320library', u'Adafruit am2320 Library Documentation', (
[author], 1) master_doc,
"Adafruitam2320library",
u"Adafruit am2320 Library Documentation",
[author],
1,
)
] ]
# -- Options for Texinfo output ------------------------------------------- # -- Options for Texinfo output -------------------------------------------
@ -147,7 +159,13 @@ man_pages = [
# (source start file, target name, title, author, # (source start file, target name, title, author,
# dir menu entry, description, category) # dir menu entry, description, category)
texinfo_documents = [ texinfo_documents = [
(master_doc, 'Adafruitam2320Library', u'Adafruit am2320 Library Documentation', (
author, 'Adafruitam2320Library', 'One line description of project.', master_doc,
'Miscellaneous'), "Adafruitam2320Library",
u"Adafruit am2320 Library Documentation",
author,
"Adafruitam2320Library",
"One line description of project.",
"Miscellaneous",
),
] ]

50
setup.py
View file

@ -7,6 +7,7 @@ https://github.com/pypa/sampleproject
# Always prefer setuptools over distutils # Always prefer setuptools over distutils
from setuptools import setup, find_packages from setuptools import setup, find_packages
# To use a consistent encoding # To use a consistent encoding
from codecs import open from codecs import open
from os import path from os import path
@ -14,47 +15,38 @@ from os import path
here = path.abspath(path.dirname(__file__)) here = path.abspath(path.dirname(__file__))
# Get the long description from the README 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() long_description = f.read()
setup( setup(
name='adafruit-circuitpython-am2320', name="adafruit-circuitpython-am2320",
use_scm_version=True, use_scm_version=True,
setup_requires=['setuptools_scm'], setup_requires=["setuptools_scm"],
description="CircuitPython driver for the AM2320 temperature and humidity sensor.",
description='CircuitPython driver for the AM2320 temperature and humidity sensor.',
long_description=long_description, long_description=long_description,
long_description_content_type='text/x-rst', long_description_content_type="text/x-rst",
# The project's main homepage. # The project's main homepage.
url='https://github.com/adafruit/Adafruit_CircuitPython_AM2320', url="https://github.com/adafruit/Adafruit_CircuitPython_AM2320",
# Author details # Author details
author='Adafruit Industries', author="Adafruit Industries",
author_email='circuitpython@adafruit.com', author_email="circuitpython@adafruit.com",
install_requires=["Adafruit-Blinka", "adafruit-circuitpython-busdevice"],
install_requires=['Adafruit-Blinka', 'adafruit-circuitpython-busdevice'],
# Choose your license # Choose your license
license='MIT', license="MIT",
# See https://pypi.python.org/pypi?%3Aaction=list_classifiers # See https://pypi.python.org/pypi?%3Aaction=list_classifiers
classifiers=[ classifiers=[
'Development Status :: 3 - Alpha', "Development Status :: 3 - Alpha",
'Intended Audience :: Developers', "Intended Audience :: Developers",
'Topic :: Software Development :: Libraries', "Topic :: Software Development :: Libraries",
'Topic :: System :: Hardware', "Topic :: System :: Hardware",
'License :: OSI Approved :: MIT License', "License :: OSI Approved :: MIT License",
'Programming Language :: Python :: 3', "Programming Language :: Python :: 3",
'Programming Language :: Python :: 3.4', "Programming Language :: Python :: 3.4",
'Programming Language :: Python :: 3.5', "Programming Language :: Python :: 3.5",
], ],
# What does your project relate to? # What does your project relate to?
keywords='adafruit am2320 temperature humidity hardware micropython circuitpython', keywords="adafruit am2320 temperature humidity hardware micropython circuitpython",
# You can just specify the packages manually here if your project is # You can just specify the packages manually here if your project is
# simple. Or you can use find_packages(). # simple. Or you can use find_packages().
py_modules=['adafruit_am2320'], py_modules=["adafruit_am2320"],
) )