Sphinx doc set up

This commit is contained in:
James Bowman 2019-04-25 06:45:21 -07:00
parent a26b5dd9ad
commit 39ce40b545
5 changed files with 633 additions and 81 deletions

177
python/Makefile.sphinx Normal file
View File

@ -0,0 +1,177 @@
# Makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = _build
# User-friendly check for sphinx-build
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
endif
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
@echo " pickle to make pickle files"
@echo " json to make JSON files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " qthelp to make HTML files and a qthelp project"
@echo " devhelp to make HTML files and a Devhelp project"
@echo " epub to make an epub"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " latexpdf to make LaTeX files and run them through pdflatex"
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
@echo " text to make text files"
@echo " man to make manual pages"
@echo " texinfo to make Texinfo files"
@echo " info to make Texinfo files and run them through makeinfo"
@echo " gettext to make PO message catalogs"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " xml to make Docutils-native XML files"
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
clean:
rm -rf $(BUILDDIR)/*
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
singlehtml:
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
pickle:
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
@echo
@echo "Build finished; now you can process the pickle files."
json:
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
@echo
@echo "Build finished; now you can process the JSON files."
htmlhelp:
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in $(BUILDDIR)/htmlhelp."
qthelp:
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/i2cdriver.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/i2cdriver.qhc"
devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/i2cdriver"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/i2cdriver"
@echo "# devhelp"
epub:
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
@echo
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
latex:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
@echo "Run \`make' in that directory to run these through (pdf)latex" \
"(use \`make latexpdf' here to do that automatically)."
latexpdf:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through pdflatex..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
latexpdfja:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through platex and dvipdfmx..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
text:
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
@echo
@echo "Build finished. The text files are in $(BUILDDIR)/text."
man:
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
@echo
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
texinfo:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
@echo "Run \`make' in that directory to run these through makeinfo" \
"(use \`make info' here to do that automatically)."
info:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo "Running Texinfo files through makeinfo..."
make -C $(BUILDDIR)/texinfo info
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
gettext:
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
@echo
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
changes:
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
@echo
@echo "The overview file is in $(BUILDDIR)/changes."
linkcheck:
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
"or in $(BUILDDIR)/linkcheck/output.txt."
doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."
xml:
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
@echo
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
pseudoxml:
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
@echo
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

252
python/conf.py Normal file
View File

@ -0,0 +1,252 @@
# -*- coding: utf-8 -*-
#
# i2cdriver documentation build configuration file, created by
# sphinx-quickstart on Tue Apr 23 09:48:39 2019.
#
# This file is execfile()d with the current directory set to its containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
import sys, os
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#sys.path.insert(0, os.path.abspath('.'))
# -- General configuration -----------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx']
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix of source filenames.
source_suffix = '.rst'
# The encoding of source files.
#source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = u'i2cdriver'
copyright = u'2019, Excamera Labs'
# 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 = '0.0.4'
# The full version, including alpha/beta/rc tags.
release = '0.0.4'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['_build']
# The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
# If true, keep warnings as "system message" paragraphs in the built documents.
#keep_warnings = False
# -- Options for HTML output ---------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'default'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
#html_title = None
# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#html_favicon = None
# 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']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}
# If false, no module index is generated.
#html_domain_indices = True
# If false, no index is generated.
#html_use_index = True
# If true, the index is split into individual pages for each letter.
#html_split_index = False
# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None
# Output file base name for HTML help builder.
htmlhelp_basename = 'i2cdriverdoc'
# -- 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': '',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
('index', 'i2cdriver.tex', u'i2cdriver Documentation',
u'JCB', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False
# If true, show page references after internal links.
#latex_show_pagerefs = False
# If true, show URL addresses after external links.
#latex_show_urls = False
# Documents to append as an appendix to all manuals.
#latex_appendices = []
# If false, no module index is generated.
#latex_domain_indices = True
# -- Options for manual page output --------------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'i2cdriver', u'i2cdriver Documentation',
[u'JCB'], 1)
]
# If true, show URL addresses after external links.
#man_show_urls = False
# -- Options for Texinfo output ------------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
('index', 'i2cdriver', u'i2cdriver Documentation',
u'JCB', 'i2cdriver', 'One line description of project.',
'Miscellaneous'),
]
# Documents to append as an appendix to all manuals.
#texinfo_appendices = []
# If false, no module index is generated.
#texinfo_domain_indices = True
# How to display URL addresses: 'footnote', 'no', or 'inline'.
#texinfo_show_urls = 'footnote'
# If true, do not generate a @detailmenu in the "Top" node's menu.
#texinfo_no_detailmenu = False
intersphinx_mapping = {'python': ('https://docs.python.org/3', None)}

View File

@ -1,5 +1,7 @@
set -e
python2 setup.py install --user
python setup.py install # --user
# python samples/i2cgui.py /dev/ttyUSB0
make -f Makefile.sphinx latexpdf
exit
echo Python3:

View File

@ -25,25 +25,32 @@ class STOP:
class I2CDriver:
"""
I2CDriver interface.
A connected I2CDriver.
The following variables are available:
product product code e.g. 'i2cdriver1'
serial serial string of I2CDriver
uptime time since I2CDriver boot, in seconds
voltage USB voltage, in V
current current used by attached device, in mA
temp temperature, in degrees C
scl state of SCL
sda state of SDA
speed current device speed in KHz (100 or 400)
mode IO mode (I2C or bitbang)
pullups programmable pullup enable pins
ccitt_crc CCITT-16 CRC of all transmitted and received bytes
:ivar product: product code e.g. 'i2cdriver1'
:ivar serial: serial string of I2CDriver
:ivar uptime: time since I2CDriver boot, in seconds
:ivar voltage: USB voltage, in V
:ivar current: current used by attached device, in mA
:ivar temp: temperature, in degrees C
:ivar scl: state of SCL
:ivar sda: state of SDA
:ivar speed: current device speed in KHz (100 or 400)
:ivar mode: IO mode (I2C or bitbang)
:ivar pullups: programmable pullup enable pins
:ivar ccitt_crc: CCITT-16 CRC of all transmitted and received bytes
"""
def __init__(self, port = "/dev/ttyUSB0", reset = True):
"""
Connect to a hardware i2cdriver.
:param port: The USB port to connect to
:type port: str
:param reset: Issue an I2C bus reset on connection
:type reset: bool
"""
self.ser = serial.Serial(port, 1000000, timeout = 1)
# May be in capture or monitor mode, send char and wait for 50 ms
@ -92,17 +99,81 @@ class I2CDriver:
return r[0]
def setspeed(self, s):
"""
Set the I2C bus speed.
:param s: speed in KHz, either 100 or 400
:type s: int
"""
assert s in (100, 400)
c = {100:b'1', 400:b'4'}[s]
self.__ser_w(c)
def setpullups(self, s):
"""
Set the I2CDriver pullup resistors
:param s: 6-bit pullup mask
"""
assert 0 <= s < 64
self.__ser_w([ord('u'), s])
def start(self, b, rw):
""" start the i2c transaction """
self.__ser_w([ord('s'), (b << 1) | rw])
def scan(self, silent = False):
""" Performs an I2C bus scan.
If silent is False, prints a map of devices.
Returns a list of the device addresses.
>>> i2c.scan()
-- -- -- -- -- -- -- --
-- -- -- -- -- -- -- --
-- -- -- -- 1C -- -- --
-- -- -- -- -- -- -- --
-- -- -- -- -- -- -- --
-- -- -- -- -- -- -- --
-- -- -- -- -- -- -- --
-- -- -- -- -- -- -- --
48 -- -- -- -- -- -- --
-- -- -- -- -- -- -- --
-- -- -- -- -- -- -- --
-- -- -- -- -- -- -- --
68 -- -- -- -- -- -- --
-- -- -- -- -- -- -- --
[28, 72, 104]
"""
self.ser.write(b'd')
d = struct.unpack("112c", self.ser.read(112))
if not silent:
for a,p in enumerate(d, 8):
if p == b"1":
st = "%02X" % a
else:
st = "--"
sys.stdout.write(st + " ")
if (a % 8) == 7:
sys.stdout.write("\n")
return [a for a,p in enumerate(d, 8) if p == b"1"]
def reset(self):
""" Send an I2C bus reset """
self.__ser_w(b'x')
return struct.unpack("B", self.ser.read(1))[0] & 3
def start(self, dev, rw):
"""
Start an I2C transaction
:param dev: 7-bit I2C device address
:param rw: read (1) or write (0)
To write bytes ``[0x12,0x34]`` to device ``0x75``:
>>> i2c.start(0x75, 0)
>>> i2c.write([0x12,034])
>>> i2c.stop()
"""
self.__ser_w([ord('s'), (dev << 1) | rw])
return self.ack()
def ack(self):
@ -111,10 +182,6 @@ class I2CDriver:
raise I2CTimeout
return (a & 1) != 0
def stop(self):
""" stop the i2c transaction """
self.ser.write(b'p')
def read(self, l):
""" Read l bytes from the I2C device, and NAK the last byte """
r = []
@ -130,7 +197,11 @@ class I2CDriver:
return b''.join(r)
def write(self, bb):
""" Write bb to the I2C device """
"""
Write bytes to the selected I2C device
:param bb: sequence to write
"""
ack = True
for i in range(0, len(bb), 64):
sub = bb[i:i + 64]
@ -139,24 +210,28 @@ class I2CDriver:
ack = self.ack()
return ack
def monitor(self, s):
if s:
self.__ser_w(b'm')
time.sleep(.1)
else:
self.__ser_w(b' ')
time.sleep(.1)
self.__echo(0x40)
def stop(self):
""" stop the i2c transaction """
self.ser.write(b'p')
def reboot(self):
self.__ser_w(b'_')
time.sleep(.5)
def reset(self):
self.__ser_w(b'x')
return struct.unpack("B", self.ser.read(1))[0] & 3
def regrd(self, dev, reg, fmt = "B"):
"""
Read a register from a device.
:param dev: 7-bit I2C device address
:param reg: register address 0-255
:param fmt: :py:func:`struct.unpack` format string for the register contents
If device 0x75 has a 16-bit register 102, it can be read with:
>>> i2c.regrd(0x75, 102, ">H")
4999
"""
if isinstance(fmt, str):
n = struct.calcsize(fmt)
self.__ser_w(b'r' + struct.pack("BBB", dev, reg, n))
@ -171,6 +246,21 @@ class I2CDriver:
return self.ser.read(n)
def regwr(self, dev, reg, *vv):
"""Write a device's register.
:param dev: 7-bit I2C device address
:param reg: register address 0-255
:param vv: sequence of values to write
To set device 0x34 byte register 7 to 0xA1:
>>> i2c.regwr(0x34, 7, [0xa1])
If device 0x75 has a big-endian 16-bit register 102 you can set it to 4999 with:
>>> i2c.regwr(0x75, 102, struct.pack(">H", 4999))
"""
r = self.start(dev, 0)
if r:
r = self.write(struct.pack("B", reg))
@ -179,34 +269,19 @@ class I2CDriver:
self.stop()
return r
def getstatus(self):
""" Update all status variables """
self.ser.write(b'?')
r = self.ser.read(80)
body = r[1:-1].decode() # remove [ and ]
(self.product,
self.serial,
uptime,
voltage,
current,
temp,
mode,
sda,
scl,
speed,
pullups,
ccitt_crc) = body.split()
self.uptime = int(uptime)
self.voltage = float(voltage)
self.current = float(current)
self.temp = float(temp)
self.mode = mode
self.scl = int(scl)
self.sda = int(sda)
self.speed = int(speed)
self.pullups = int(pullups, 16)
self.ccitt_crc = int(ccitt_crc, 16)
return repr(self)
def monitor(self, s):
""" Enter or leave monitor mode
:param s: ``True`` to enter monitor mode, ``False`` to leave
"""
if s:
self.__ser_w(b'm')
time.sleep(.1)
else:
self.__ser_w(b' ')
time.sleep(.1)
self.__echo(0x40)
def introspect(self):
""" Update all status variables """
@ -233,23 +308,6 @@ class I2CDriver:
self.scl,
self.sda)
def scan(self, silent = False):
""" Performs an I2C bus scan.
If silent is False, prints a map of devices.
Returns a list of the device addresses. """
self.ser.write(b'd')
d = struct.unpack("112c", self.ser.read(112))
if not silent:
for a,p in enumerate(d, 8):
if p == b"1":
st = "%02X" % a
else:
st = "--"
sys.stdout.write(st + " ")
if (a % 8) == 7:
sys.stdout.write("\n")
return [a for a,p in enumerate(d, 8) if p == b"1"]
def capture_start(self):
self.__ser_w([ord('c')])
def nstream():
@ -321,3 +379,32 @@ class I2CDriver:
bits = []
else:
assert 0, "unexpected token"
def getstatus(self):
""" Update all status variables """
self.ser.write(b'?')
r = self.ser.read(80)
body = r[1:-1].decode() # remove [ and ]
(self.product,
self.serial,
uptime,
voltage,
current,
temp,
mode,
sda,
scl,
speed,
pullups,
ccitt_crc) = body.split()
self.uptime = int(uptime)
self.voltage = float(voltage)
self.current = float(current)
self.temp = float(temp)
self.mode = mode
self.scl = int(scl)
self.sda = int(sda)
self.speed = int(speed)
self.pullups = int(pullups, 16)
self.ccitt_crc = int(ccitt_crc, 16)
return repr(self)

34
python/index.rst Normal file
View File

@ -0,0 +1,34 @@
.. i2cdriver documentation master file, created by
sphinx-quickstart on Tue Apr 23 09:48:39 2019.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to i2cdriver's documentation!
=====================================
.. toctree::
:maxdepth: 2
AAAAAAAA
.. autoclass:: i2cdriver.I2CDriver
:member-order: bysource
:members:
__init__,
setspeed, setpullups,
scan, reset,
start, stop, read, write,
getstatus,
regwr, regrd,
monitor
BBBBBBBB
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`