python: Support building of both python2 & python3 bindings

Signed-off-by: Brendan Le Foll <brendan.le.foll@intel.com>

src/python/python2/CMakeLists.txt

@@ -0,0 +1,39 @@
+set_source_files_properties (mraa2.i PROPERTIES CPLUSPLUS ON)
+set_source_files_properties (mraa2.i PROPERTIES SWIG_FLAGS "-I${CMAKE_BINARY_DIR}/src")
+
+if (PYTHON2_LIBRARY)
+    message ("PYTHON2 attempting to build!")
+
+    swig_add_module (python2-mraa python mraa2.i ../mraapy.c)
+    swig_link_libraries (python2-mraa ${PYTHON2_LIBRARIES} mraa)
+    
+    target_include_directories(${SWIG_MODULE_python2-mraa_REAL_NAME}
+      PUBLIC
+      "${CMAKE_CURRENT_SOURCE_DIR}/../.."
+      "${PYTHON2_INCLUDE_DIR}"
+    )
+
+    if (DOXYGEN_FOUND AND PYTHON2_EXECUTABLE)
+      foreach (_file ${DOCCLASSES})
+        add_dependencies (${SWIG_MODULE_python2-mraa_REAL_NAME} ${_file}class_doc_i)
+      endforeach ()
+      add_dependencies (${SWIG_MODULE_python2-mraa_REAL_NAME} common_hpp_doc_i)
+
+      add_custom_target (pydoc
+        pydoc -w ${CMAKE_CURRENT_BINARY_DIR}/mraa.py ${CMAKE_CURRENT_BINARY_DIR}/
+        WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
+        COMMENT "Generating API documentation with pydoc" VERBATIM
+      )
+    endif ()
+
+    set_target_properties (${SWIG_MODULE_python2-mraa_REAL_NAME} PROPERTIES
+      OUTPUT_NAME _mraa
+      COMPILE_FLAGS "${CMAKE_C_FLAGS} -DSWIGPYTHON=${SWIG_FOUND}"
+    )
+
+    install (FILES ${CMAKE_CURRENT_BINARY_DIR}/_mraa.so
+             ${CMAKE_CURRENT_BINARY_DIR}/mraa.py
+             DESTINATION ${CMAKE_INSTALL_PREFIX}/${PYTHON2_PACKAGES_PATH})
+endif()
+
+add_subdirectory (docs)

src/python/python2/docs/CMakeLists.txt

@@ -0,0 +1,41 @@
+if (DOXYGEN_FOUND)
+  find_package (Sphinx)
+  if (SPHINX_FOUND)
+    if (NOT DEFINED SPHINX_THEME)
+      set (SPHINX_THEME default)
+    endif ()
+
+    if (NOT DEFINED SPHINX_THEME_DIR)
+      set (SPHINX_THEME_DIR)
+    endif ()
+
+    # configured documentation tools and intermediate build results
+    set (BINARY_BUILD_DIR "${CMAKE_CURRENT_BINARY_DIR}")
+
+    # Sphinx cache with pickled ReST documents
+    set (SPHINX_CACHE_DIR "${CMAKE_CURRENT_BINARY_DIR}/doctrees")
+
+    # HTML output directory
+    set (SPHINX_HTML_DIR "${CMAKE_CURRENT_BINARY_DIR}/html")
+
+    # doc .rst locations
+    set (SPHINX_DOC_LOATION "${CMAKE_CURRENT_SOURCE_DIR}")
+
+    configure_file(
+      "${CMAKE_CURRENT_SOURCE_DIR}/conf.py.in"
+      "${BINARY_BUILD_DIR}/conf.py"
+      @ONLY
+    )
+
+    add_custom_target(sphinx ALL
+      ${SPHINX_EXECUTABLE} -b html
+      -c "${BINARY_BUILD_DIR}"
+      -d "${SPHINX_CACHE_DIR}"
+      "${SPHINX_DOC_LOATION}"
+      "${SPHINX_HTML_DIR}"
+      COMMENT "Building HTML documentation with Sphinx"
+    )
+
+    add_dependencies (sphinx ${SWIG_MODULE_python2-mraa_REAL_NAME})
+  endif ()
+endif ()

src/python/python2/docs/conf.py.in

@@ -0,0 +1,332 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# . documentation build configuration file, created by
+# sphinx-quickstart on Thu May  1 18:34:23 2014.
+#
+# 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
+import 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, "@CMAKE_BINARY_DIR@/src/python")
+
+# -- 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.viewcode',
+]
+
+# 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 = 'mraa'
+copyright = '2014, Intel Corporation'
+
+# 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 = '@mraa_VERSION_STRING@'
+# The full version, including alpha/beta/rc tags.
+release = '@VERSION@'
+
+# 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', '**/.git', '**/CMakeFiles/**', '**/CMakeLists.txt']
+
+# 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 = '@SPHINX_THEME@'
+
+# 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 = ['@SPHINX_THEME_DIR@']
+
+# 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']
+
+# Add any extra paths that contain custom files (such as robots.txt or
+# .htaccess) here, relative to this directory. These files are copied
+# directly to the root of the documentation.
+#html_extra_path = []
+
+# 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 = 'mraadoc'
+
+
+# -- 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, or own class]).
+latex_documents = [
+  ('index', 'sphinx.tex', '. Documentation',
+   'Author', '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', 'sphinx', '. Documentation',
+     ['Author'], 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', 'sphinx', '. Documentation',
+   'Author', 'sphinx', '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
+
+
+# -- Options for Epub output ----------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = '.'
+epub_author = 'Author'
+epub_publisher = 'Author'
+epub_copyright = '2014, Author'
+
+# The basename for the epub file. It defaults to the project name.
+#epub_basename = '.'
+
+# The HTML theme for the epub output. Since the default themes are not optimized
+# for small screen space, using the same theme for HTML and epub output is
+# usually not wise. This defaults to 'epub', a theme designed to save visual
+# space.
+#epub_theme = 'epub'
+
+# The language of the text. It defaults to the language option
+# or en if the language is not set.
+#epub_language = ''
+
+# The scheme of the identifier. Typical schemes are ISBN or URL.
+#epub_scheme = ''
+
+# The unique identifier of the text. This can be a ISBN number
+# or the project homepage.
+#epub_identifier = ''
+
+# A unique identification for the text.
+#epub_uid = ''
+
+# A tuple containing the cover image and cover page html template filenames.
+#epub_cover = ()
+
+# A sequence of (type, uri, title) tuples for the guide element of content.opf.
+#epub_guide = ()
+
+# HTML files that should be inserted before the pages created by sphinx.
+# The format is a list of tuples containing the path and title.
+#epub_pre_files = []
+
+# HTML files shat should be inserted after the pages created by sphinx.
+# The format is a list of tuples containing the path and title.
+#epub_post_files = []
+
+# A list of files that should not be packed into the epub file.
+epub_exclude_files = ['search.html']
+
+# The depth of the table of contents in toc.ncx.
+#epub_tocdepth = 3
+
+# Allow duplicate toc entries.
+#epub_tocdup = True
+
+# Choose between 'default' and 'includehidden'.
+#epub_tocscope = 'default'
+
+# Fix unsupported image types using the PIL.
+#epub_fix_images = False
+
+# Scale large images.
+#epub_max_image_width = 0
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#epub_show_urls = 'inline'
+
+# If false, no index is generated.
+#epub_use_index = True

src/python/python2/docs/example.rst

@@ -0,0 +1,93 @@
+#######
+Example
+#######
+Here are some examples of how to use mraa, common convention is to import mraa
+as mraa to keep it short but feel free to import it globally! As a general rule
+the API is very similar to the C++ API so there are only basic examples to show
+quick usage. The mraa module can be built with python3 or python2. All examples
+may not run on python3 as this is not tested.
+
+Hello GPIO
+==========
+
+Here is the simplest Gpio program in mraa.
+
+.. literalinclude:: ../../../examples/python/hello_gpio.py
+  :prepend: import mraa
+  :start-after: import mraa
+
+GPIO Interrupt (isr)
+===================
+
+The GPIO module allows you to set an interrupt on a GPIO. This interrupt is
+controlled by the mode that the 'edge' is in. Before setting another isr please
+remove the first one, multiple isrs on one pin are not supported. Some
+platforms will not support interrupts on all pins so please check your return
+values.
+
+**Note:** Galileo Gen1 only supports EDGE_BOTH
+
+.. literalinclude:: ../../../examples/python/hello_isr.py
+  :prepend: import mraa
+  :start-after: import mraa
+
+**Note:** If the python script is ended the destructors will run meaning that
+the ISR will not run. The sleep call is there for that function.
+
+**Note:** The python isr module treats only objects. This means that int
+counters will not work inside your isr. Please use the different edge modes.
+
+I2c
+===
+
+The I2c module module has a number of different ways of interacting with the
+i2c bus, including a number of overloaded read() calls and the writeReg()
+helper function.
+
+.. literalinclude:: ../../../examples/python/bmp85.py
+  :prepend: x = m.I2c(0)
+  :start-after: x = m.I2c(0)
+
+.. literalinclude:: ../../../docs/i2c.txt
+
+Pwm
+===
+
+The PWM module is rather simple, note that different hardware support PWM
+generation is various different ways so results may vary.
+
+.. literalinclude:: ../../../examples/python/cycle-pwm3.py
+  :prepend: import mraa
+  :start-after: import mraa
+
+Aio
+===
+
+The ADC is typically provided on a dedicated or shared SPI bus, this is
+abstracted by the Linux kernel as spidev and abstracted again by mraa. It is
+fairly simple in use.
+
+.. literalinclude:: ../../../examples/python/aio.py
+  :prepend: import mraa
+  :start-after: import mraa
+
+Uart
+====
+
+Uart is the Universal asynchronous receiver/transmitter interface in mraa.
+It allows the exposure of UART pins on supported boards, with basic
+configuration operations supported.
+
+Here's a simple pair of programs comprising a sender and receiver pair.
+
+Sender:
+
+.. literalinclude:: ../../../examples/python/uart_sender.py
+  :prepend: import mraa
+  :start-after: import mraa
+
+Receiver:
+
+.. literalinclude:: ../../../examples/python/uart_receiver.py
+  :prepend: import mraa
+  :start-after: import mraa

src/python/python2/docs/index.rst

@@ -0,0 +1,57 @@
+.. . documentation master file, created by
+   sphinx-quickstart on Thu May  1 18:34:23 2014.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to mraa's documentation!
+================================
+
+.. include:: ../../../docs/index.md
+  :start-after: ==============
+  :end-before: ## API
+
+.. toctree::
+   :maxdepth: 2
+
+   mraa
+   example
+
+Supported Platforms
+===================
+
+   * `Galileo Gen 1 - Rev D <../galileorevd.html>`_
+   * `Galileo Gen 2 - Rev H <../galileorevh.html>`_
+   * `Intel Edison <../edison.html>`_
+   * `Intel(R) NUC DE3815tykhe <../de3815.html>`_
+   * `Intel(R) Minnowboard Max <../minnowmax.html>`_
+   * `Raspberry Pi <../rasppi.html>`_
+   * `Banana Pi/Pro <../bananapi.html>`_
+   * `Beaglebone Black <../beaglebone.html>`_
+   * `Intel NUC NUC5i5MYBE <../nuc5.html>`_
+   * `UP <../up.html>`_
+   * `FTDI FT4222H <../ft4222.html>`_
+
+Compiling & Debugging libmraa
+=============================
+
+Libmraa is a C library and SWIG is used to generate bindings therefore to
+debug, you very quickly need to use the same methods as you would for debugging
+a C library. Generally attaching gdb to python works well, build mraa with
+debug symbols and set breakpoints either in the SWIG _wrap functions, the C++
+method/functions or the underlying C function. More info can be found on the
+C/C++ documentation:
+   * `Debugging <../debugging.html>`_
+   * `Building from source <../building.html>`_
+
+API Changelog
+=============
+.. include:: ../../../docs/index.md
+  :start-after: API Changelog
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+

src/python/python2/docs/mraa.rst

@@ -0,0 +1,52 @@
+###
+API
+###
+
+Aio
+===
+.. autoclass:: mraa.Aio
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+I2c
+===
+.. autoclass:: mraa.I2c
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Gpio
+====
+.. autoclass:: mraa.Gpio
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Pwm
+===
+.. autoclass:: mraa.Pwm
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Spi
+===
+.. autoclass:: mraa.Spi
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Uart
+====
+.. autoclass:: mraa.Uart
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Common
+======
+
+.. automodule:: mraa
+   :members:
+   :exclude-members: Gpio, Aio, Uart, Spi, I2c, Pwm, uint8Array, uint8Array_frompointer

src/python/python2/mraa2.i

@@ -0,0 +1,5 @@
+%module(docstring="Python interface to libmraa") mraa                                                                                          
+
+%feature("autodoc", "3");
+
+%include ../mraapython.i