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

clean up; pylint

Browse source
This commit is contained in:
Dan Halbert 2020-03-18 14:15:03 -04:00
parent 14de7c10c8
commit 0fcf841db3
4 changed files with 113 additions and 110 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

48
adafruit_ble_ibbq.py
View file

@ -92,14 +92,14 @@ class IBBQService(Service):
_UNITS_CELSIUS_MSG = b"\x02\x00\x00\x00\x00\x00"
_REQUEST_BATTERY_LEVEL_MSG = b"\x08\x24\x00\x00\x00\x00"
@staticmethod
def target_temp_msg(low, high):
return struct.pack("<HH", low, high)
def __init__(self, service=None):
super().__init__(service=service)
self._settings_result_buf = bytearray(self.settings_result.packet_size)
self._realtime_data_buf = bytearray(self.realtime_data.packet_size)
self._settings_result_buf = bytearray(
self.settings_result.packet_size # pylint: disable=no-member
)
self._realtime_data_buf = bytearray(
self.realtime_data.packet_size # pylint: disable=no-member
)
uuid = StandardUUID(0xFFF0)
@ -127,16 +127,6 @@ class IBBQService(Service):
)
"""Send control messages here."""
@property
def settings_result_bytes(self):
length = self.settings_result.readinto(self._settings_result_buf)
return self._settings_result_buf[:length]
@property
def realtime_data_bytes(self):
length = self.realtime_data.readinto(self._realtime_data_buf)
return self._realtime_data_buf[:length]
def init(self):
"""Perform initial "pairing", which is not regular BLE pairing."""
self.account_and_verify = self._CREDENTIALS_MSG
@ -161,13 +151,15 @@ class IBBQService(Service):
"""Return a tuple of temperatures for all the possible temperature probes on the device.
Temperatures are in degrees Celsius. Unconnected probes return 0.0.
"""
data = self.realtime_data_bytes
if not data:
return None
return tuple(
struct.unpack_from("<H", data, offset=offset)[0] / 10
for offset in range(0, len(data), 2)
)
data = self._realtime_data_buf
length = self.realtime_data.readinto(data) # pylint: disable=no-member
if length > 0:
return tuple(
struct.unpack_from("<H", data, offset=offset)[0] / 10
for offset in range(0, length, 2)
)
# No data.
return None
@property
def battery_level(self):
@ -176,10 +168,10 @@ class IBBQService(Service):
actual battery voltage by 0.1v or so.
"""
self.settings_data = self._REQUEST_BATTERY_LEVEL_MSG
result = self.settings_result_bytes
if len(result) >= 5:
# There can be at least one extra byte at the end, so use unpack_from().
header, current_voltage, max_voltage = struct.unpack_from("<BHH", result)
results = self._settings_result_buf
length = self.settings_result.readinto(results) # pylint: disable=no-member
if length >= 5:
header, current_voltage, max_voltage = struct.unpack_from("<BHH", results)
if header == 0x24:
# Calibration was determined empirically, by comparing
# the returned values with actual measurements of battery voltage,
@ -188,5 +180,5 @@ class IBBQService(Service):
current_voltage / 2000 - 0.3,
(6550 if max_voltage == 0 else max_voltage) / 2000,
)
# Unexpected response.
# Unexpected response or no data.
return None

112
docs/conf.py
View file

@ -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 @@ sys.path.insert(0, os.path.abspath('..'))
# 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 @@ extensions = [
# autodoc_mock_imports = ["digitalio", "busio"]
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 BLE_iBBQ Library'
copyright = u'2020 Adafruit Industries'
author = u'Adafruit Industries'
project = "Adafruit BLE_iBBQ Library"
copyright = "2020 Adafruit Industries"
author = "Adafruit Industries"
# 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 @@ language = None
# 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 @@ default_role = "any"
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 @@ napoleon_numpy_docstring = False
# 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 = 'AdafruitBle_ibbqLibrarydoc'
htmlhelp_basename = "AdafruitBle_ibbqLibrarydoc"
# -- 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, 'AdafruitBLE_iBBQLibrary.tex', u'AdafruitBLE_iBBQ Library Documentation',
author, 'manual'),
(
master_doc,
"AdafruitBLE_iBBQLibrary.tex",
"AdafruitBLE_iBBQ Library Documentation",
author,
"manual",
),
]
# -- Options for manual page output ---------------------------------------
@ -144,8 +151,13 @@ latex_documents = [
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'AdafruitBLE_iBBQlibrary', u'Adafruit BLE_iBBQ Library Documentation',
[author], 1)
(
master_doc,
"AdafruitBLE_iBBQlibrary",
"Adafruit BLE_iBBQ Library Documentation",
[author],
1,
)
]
# -- Options for Texinfo output -------------------------------------------
@ -154,7 +166,13 @@ man_pages = [
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'AdafruitBLE_iBBQLibrary', u'Adafruit BLE_iBBQ Library Documentation',
author, 'AdafruitBLE_iBBQLibrary', 'One line description of project.',
'Miscellaneous'),
(
master_doc,
"AdafruitBLE_iBBQLibrary",
"Adafruit BLE_iBBQ Library Documentation",
author,
"AdafruitBLE_iBBQLibrary",
"One line description of project.",
"Miscellaneous",
),
]

10
examples/ble_ibbq_simpletest.py
View file

@ -2,7 +2,6 @@ import time
import adafruit_ble
from adafruit_ble.advertising.standard import ProvideServicesAdvertisement
from adafruit_ble.services.standard.device_info import DeviceInfoService
from adafruit_ble_ibbq import IBBQService
# PyLint can't find BLERadio for some reason so special case it here.
@ -26,5 +25,10 @@ while True:
ibbq_service = ibbq_connection[IBBQService]
ibbq_service.init()
while ibbq_connection.connected:
print(ibbq_service.temperatures, ibbq_service.battery_level)
time.sleep(1)
print(
"Temperatures:",
ibbq_service.temperatures,
"; Battery:",
ibbq_service.battery_level,
)
time.sleep(2)

53
setup.py
View file

@ -6,6 +6,7 @@ https://github.com/pypa/sampleproject
"""
from setuptools import setup, find_packages
# To use a consistent encoding
from codecs import open
from os import path
@ -13,52 +14,40 @@ from os import path
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-ble-ibbq',
name="adafruit-circuitpython-ble-ibbq",
use_scm_version=True,
setup_requires=['setuptools_scm'],
description='BLE support for iBBQ thermometers',
setup_requires=["setuptools_scm"],
description="BLE support for iBBQ thermometers",
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_BLE_iBBQ',
url="https://github.com/adafruit/Adafruit_CircuitPython_BLE_iBBQ",
# Author details
author='Adafruit Industries',
author_email='circuitpython@adafruit.com',
install_requires=[
'Adafruit-Blinka',
'adafruit-circuitpython-ble'
],
author="Adafruit Industries",
author_email="circuitpython@adafruit.com",
install_requires=["Adafruit-Blinka", "adafruit-circuitpython-ble"],
# 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 ble_ibbq ble ibbq thermometer',
keywords="adafruit blinka circuitpython micropython ble_ibbq ble ibbq thermometer",
# 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_ble_ibbq'],
py_modules=["adafruit_ble_ibbq"],
)