upm: v0.7.1

Signed-off-by: Noel Eck <noel.eck@intel.com>

.travis.yml

@@ -0,0 +1,46 @@
+language: cpp
+env:
+  global:
+    - MRAA_ROOT=/tmp/mraa
+    - MRAA_BUILD=$MRAA_ROOT/build
+    - MRAA_INSTALL=$MRAA_ROOT/install
+    - UPM_ROOT=$TRAVIS_BUILD_DIR
+    - UPM_BUILD=$UPM_ROOT/build
+    - UPM_INSTALL=$UPM_ROOT/install
+    - JAVA_HOME=/usr/lib/jvm/java-8-oracle
+  matrix:
+    - NODE010=true
+    - NODE012=true
+    - NODE4=true
+    - NODE5=true
+compiler:
+  - clang
+  - gcc
+install:
+  - sudo add-apt-repository --yes ppa:fenics-packages/fenics-exp/swig
+  - sudo apt-get update -qq
+  - sudo apt-get install -y -qq swig3.0 git
+  - sudo ln -s /usr/bin/swig3.0 /usr/bin/swig
+  - sudo update-java-alternatives -s java-8-oracle
+before_script:
+  # Turn off JAVA SWIG for clang++, use 4.8 for all g++ builds
+  - if [ "$CC" == "gcc" ]; then export BUILDJAVA=ON; export CC=gcc-4.8; export CXX=g++-4.8; else export BUILDJAVA=OFF; fi
+  - if [ "${NODE012}" ]; then nvm install 0.12; fi
+  - if [ "${NODE4}" ]; then nvm install 4.1; fi
+  - if [ "${NODE5}" ]; then nvm install 5; fi
+  # Handle 0.10 NODE_ROOT_DIR differently than other versions
+  - if [ -z ${NODE010} ]; then export NODE_ROOT_DIR="/home/travis/.nvm/versions/node/`nvm version`"; else export NODE_ROOT_DIR=/home/travis/.nvm/v0.10.36; fi
+script:
+  - echo "CC=$CC BUILDJAVA=$BUILDJAVA NODE010=$NODE010 NODE012=$NODE012 NODE4=$NODE4 NODE5=$NODE5 NODE_ROOT_DIR=$NODE_ROOT_DIR"
+  - git clone https://github.com/intel-iot-devkit/mraa.git $MRAA_ROOT
+  - mkdir -p $MRAA_BUILD && cd $_ && cmake -DBUILDSWIGJAVA=$BUILDJAVA -DBUILDSWIGNODE=OFF -DBUILDSWIGPYTHON=OFF -DFIRMATA=ON -DENABLEEXAMPLES=OFF -DCMAKE_INSTALL_PREFIX:PATH=$MRAA_INSTALL $MRAA_ROOT && make install
+  - cd $UPM_ROOT && mkdir $UPM_BUILD && cd $_ && PKG_CONFIG_PATH=$MRAA_INSTALL/lib/pkgconfig cmake -DNODE_ROOT_DIR:PATH="${NODE_ROOT_DIR}" -DBUILDSWIGJAVA=$BUILDJAVA -DBUILDEXAMPLES=ON -DBUILDJAVAEXAMPLES=$BUILDJAVA -DCMAKE_INSTALL_PREFIX:PATH=$UPM_INSTALL .. && make install
+addons:
+  apt:
+    sources:
+      - ubuntu-toolchain-r-test
+      - george-edison55-precise-backports
+    packages:
+      - cmake
+      - cmake-data
+      - g++-4.8

CMakeLists.txt

@@ -5,37 +5,32 @@ if ("${CMAKE_SOURCE_DIR}" STREQUAL "${CMAKE_BINARY_DIR}")
 message("WARNING: building into sources dir can be risky, prefer other directory")
 endif ()
 
-find_package (SWIG)
-if (SWIG_FOUND)
-  include (${SWIG_USE_FILE})
-endif ()
-
 find_package (Threads REQUIRED)
 find_package (PkgConfig REQUIRED)
 
-# force a libmraa search and minimum required version every time a config is generated
+# Force a libmraa search and minimum required version every time a config is generated
 unset(MRAA_FOUND CACHE)
-pkg_check_modules (MRAA REQUIRED mraa>=0.6.0)
-message (INFO " found libmraa version: ${MRAA_VERSION}")
+pkg_check_modules (MRAA REQUIRED mraa>=1.0.0)
+message (INFO " found mraa version: ${MRAA_VERSION}")
 
 # Appends the cmake/modules path to MAKE_MODULE_PATH variable.
 set (CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake/modules ${CMAKE_MODULE_PATH})
-set (LIB_INSTALL_DIR "lib${LIB_SUFFIX}" CACHE PATH "Installation path for libraries")
 
-# Set CMAKE_LIB_INSTALL_DIR if not defined
+# Set CMAKE_INSTALL_LIBDIR if not defined
 include(GNUInstallDirs)
+set (LIB_INSTALL_DIR "${CMAKE_INSTALL_LIBDIR}" CACHE PATH "Installation path for libraries")
 
 # Make a version file containing the current version from git.
 include (GetGitRevisionDescription)
 git_describe (VERSION "--tags")
-if ("x_${VERSION}" STREQUAL "x_GIT-NOTFOUND")
-  message (WARNING " - Install git to compile a production libmraa!")
-  set (VERSION "v0.3.0-dirty")
+if ("x_${VERSION}" STREQUAL "x_GIT-NOTFOUND" OR "x_${VERSION}" STREQUAL "x_-128-NOTFOUND")
+  message (WARNING " - Install git to compile a production UPM!")
+  set (VERSION "v0.7.1-dirty")
 endif ()
 
 message (INFO " - UPM Version ${VERSION}")
 
-#parse the version information into pieces.
+# Parse the version information into pieces.
 string (REGEX REPLACE "^v([0-9]+)\\..*" "\\1" VERSION_MAJOR "${VERSION}")
 string (REGEX REPLACE "^v[0-9]+\\.([0-9]+).*" "\\1" VERSION_MINOR "${VERSION}")
 string (REGEX REPLACE "^v[0-9]+\\.[0-9]+\\.([0-9]+).*" "\\1" VERSION_PATCH "${VERSION}")
@@ -53,33 +48,89 @@ set (upm_VERSION_STRING ${upm_VERSION_MAJOR}.${upm_VERSION_MINOR}.${upm_VERSION_
 
 set (CMAKE_SWIG_FLAGS "")
 
-option (IPK "Generate IPK using CPack" OFF)
 option (BUILDDOC "Build all doc." OFF)
 option (BUILDSWIG "Build swig modules." ON)
 option (BUILDSWIGPYTHON "Build swig python modules." ON)
+option (BUILDPYTHON3 "Use python3 for building/installing/testing" OFF)
 option (BUILDSWIGNODE "Build swig node modules." ON)
 option (BUILDEXAMPLES "Build C++ example binaries" OFF)
+option (BUILDJAVAEXAMPLES "Build java example jars" OFF)
+option (BUILDSWIGJAVA "Build swig java modules" OFF)
+option (IPK "Generate IPK using CPack" OFF)
+option (RPM "Generate RPM using CPack" OFF)
+option (BUILDTESTS "Generate check-ups for upm" ON)
+option (ENABLECXX11 "Enable C++11 standards support" ON)
+
+# Find swig
+if (BUILDSWIG)
+    if (BUILDSWIGNODE)
+        find_package (SWIG 3.0.5 REQUIRED)
+    else ()
+        find_package (SWIG REQUIRED)
+    endif ()
+    if (SWIG_FOUND)
+        include (${SWIG_USE_FILE})
+    endif ()
+endif ()
+
+# Detect arch
+include (TargetArch)
+target_architecture (DETECTED_ARCH)
+message( INFO " - Target arch is ${DETECTED_ARCH}")
+
+#-march=native for ARM when not defined/forced
+if (DETECTED_ARCH MATCHES "arm.*" AND NOT CMAKE_CXX_FLAGS MATCHES "-march")
+  set (CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -march=native")
+endif()
+
+# enable c++11 standards support
+if (ENABLECXX11)
+  include(CheckCXXCompilerFlag)
+  if (CMAKE_VERSION VERSION_LESS "3.1")
+    CHECK_CXX_COMPILER_FLAG("-std=c++11" COMPILER_SUPPORTS_CXX11)
+    CHECK_CXX_COMPILER_FLAG("-std=c++0x" COMPILER_SUPPORTS_CXX0X)
+    if (COMPILER_SUPPORTS_CXX11)
+      set (CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11")
+    elseif (COMPILER_SUPPORTS_CXX0X)
+      set (CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++0x")
+    else()
+      message(WARNING "The compiler ${CMAKE_CXX_COMPILER} has no C++11 support. Please update your C++ compiler.")
+    endif()
+  else()
+    # 3.1+ uses this generic method to enable c++11
+    set (CMAKE_CXX_STANDARD 11)
+  endif()
+else()
+  message(WARNING "Some modules require C++11 support, and may not build without it.")
+endif()
 
 if (BUILDDOC)
-  # add a target to generate API documentation with Doxygen
+  # Add a target to generate API documentation with Doxygen
   find_package (Doxygen)
   if (DOXYGEN_FOUND)
     configure_file (${CMAKE_CURRENT_SOURCE_DIR}/doxy/Doxyfile.in ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile @ONLY)
+    if (BUILDSWIGJAVA)
+        configure_file (${CMAKE_CURRENT_SOURCE_DIR}/doxy/Doxyfile.java.in ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile-java @ONLY)
+    endif()
+    file(GLOB PNG_FILES RELATIVE ${CMAKE_CURRENT_SOURCE_DIR}/docs docs/icons/*.png)
+    foreach(PNG_FILE ${PNG_FILES})
+      configure_file(${CMAKE_CURRENT_SOURCE_DIR}/docs/${PNG_FILE} ${CMAKE_CURRENT_BINARY_DIR}/html/docs/${PNG_FILE} COPYONLY)
+    endforeach()
     add_custom_target (doc
       ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
+      COMMAND tar -czf html/xml.tar.gz -C xml .
       WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
       COMMENT "Generating API documentation with Doxygen" VERBATIM
     )
   endif (DOXYGEN_FOUND)
-  # check if Sphinx is installed and add target to generate API documentation
+  # Check if Sphinx is installed and add target to generate API documentation
   find_package (Sphinx)
   if(SPHINX_FOUND AND BUILDSWIG AND BUILDSWIGPYTHON)
-    # python required for Sphinx build
-    find_package (PythonLibs)
+    # Python required for Sphinx build
+    find_package (PythonLibs ${PYTHONBUILD_VERSION} REQUIRED)
     string (REPLACE "." ";" PYTHON_VERSION_LIST ${PYTHONLIBS_VERSION_STRING})
     list (GET PYTHON_VERSION_LIST 0 PYTHON_VERSION_MAJOR)
     list (GET PYTHON_VERSION_LIST 1 PYTHON_VERSION_MINOR)
-    set (SITE_PACKAGES ${CMAKE_INSTALL_PREFIX}/${LIB_INSTALL_DIR}/python${PYTHON_VERSION_MAJOR}.${PYTHON_VERSION_MINOR}/site-packages)
     configure_file (${CMAKE_CURRENT_SOURCE_DIR}/doxy/conf.py.in ${CMAKE_CURRENT_BINARY_DIR}/pydoc/conf.py @ONLY)
     configure_file (${CMAKE_CURRENT_SOURCE_DIR}/doxy/index.rst ${CMAKE_CURRENT_BINARY_DIR}/pydoc/index.rst COPYONLY)
     add_custom_target (pydoc ALL
@@ -87,28 +138,28 @@ if (BUILDDOC)
       COMMAND find ${CMAKE_BINARY_DIR}/src -name "_pyupm_*.so" -exec cp {} ${CMAKE_BINARY_DIR}/pyupm \;
       COMMAND find ${CMAKE_BINARY_DIR}/src -name "pyupm_*.py" -exec cp {} ${CMAKE_BINARY_DIR}/pyupm \;
       COMMAND ${SPHINX_API_EXECUTABLE} -f -o pydoc  ${CMAKE_BINARY_DIR}/pyupm
-      # todo: use a separate cmake FILE module for string replacement instead
+      # TODO: use a separate cmake FILE module for string replacement instead
       COMMAND ${SPHINX_EXECUTABLE} -b html pydoc html/python
       COMMAND sed -i.bak s|\">pyupm_|\">|g html/python/index.html html/python/modules.html
-      COMMAND sed -i.bak s|[[:space:]]module</a>|</a>|g html/python/index.html html/python/modules.html
+      COMMAND sed -i.bak s|[[:space:]][mM]odule</a>|</a>|g html/python/index.html html/python/modules.html
       DEPENDS doc
       WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
       COMMENT "Generating API documentation with Sphinx" VERBATIM
     )
   endif ()
-  # check if Yuidoc is installed and add target for API documentation
+  # Check if Yuidoc is installed and add target for API documentation
   find_package(Yuidoc)
   if(YUIDOC_FOUND AND BUILDSWIGNODE)
-    # node required for Yuidoc documentation
+    # Node required for Yuidoc documentation
     find_package(Node)
     file(GLOB_RECURSE JSDOC_FILES RELATIVE ${CMAKE_CURRENT_SOURCE_DIR}/doxy/node doxy/node/*)
     foreach(JSDOC_FILE ${JSDOC_FILES})
       configure_file(${CMAKE_CURRENT_SOURCE_DIR}/doxy/node/${JSDOC_FILE} ${CMAKE_CURRENT_BINARY_DIR}/${JSDOC_FILE} COPYONLY)
     endforeach()
     add_custom_target(jsdoc ALL
-      COMMAND ${NODE_EXECUTABLE} docgen -m upm -i xml -t ${CMAKE_CURRENT_SOURCE_DIR}/src -g ../../../../docs/images/
+      COMMAND ${NODEJS_EXECUTABLE} docgen -m upm -i xml -t ${CMAKE_CURRENT_SOURCE_DIR}/src -g ../../
       COMMAND ${YUIDOC_EXECUTABLE} -C --no-sort --helpers generators/yuidoc/helper.js --themedir generators/yuidoc/tmpl -o html/node jsdoc/yuidoc/upm
-      COMMAND ${NODE_EXECUTABLE} tolower -i html/node
+      COMMAND ${NODEJS_EXECUTABLE} tolower -i html/node
       DEPENDS doc
       WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
       COMMENT "Generating API documentation with Yuidoc" VERBATIM
@@ -117,12 +168,23 @@ if (BUILDDOC)
 endif()
 
 if (IPK)
-  include (TargetArch)
-  target_architecture (DETECTED_ARCH)
-  message( INFO " - Target arch is ${DETECTED_ARCH}")
 
-  set(CPACK_GENERATOR "DEB" "TGZ")
-  set(OPKG_ARCH ${DETECTED_ARCH})
+ # Get target package arch from Yocto ADT sysroot if set or host OS, mapping to Ubuntu name if necessary
+  if (DEFINED ENV{OECORE_TARGET_SYSROOT})
+    GET_FILENAME_COMPONENT (DETECTED_SYSROOT $ENV{OECORE_TARGET_SYSROOT} NAME)
+    string (REGEX REPLACE "-poky-linux" "" TARGET_ARCH "${DETECTED_SYSROOT}")
+  else ()
+    # Debian uses amd64 to denote x86_64
+    if (DETECTED_ARCH STREQUAL "x86_64")
+      set (TARGET_ARCH "amd64")
+    else ()
+      set (TARGET_ARCH ${DETECTED_ARCH})
+    endif ()
+  endif ()
+  message (INFO " - Package arch is ${TARGET_ARCH}")
+
+  set(CPACK_GENERATOR "DEB")
+  set(OPKG_ARCH ${TARGET_ARCH})
   set(CPACK_BINARY_DIR ${CMAKE_BINARY_DIR})
   set(CPACK_DEBIAN_PACKAGE_MAINTAINER "Intel IoT-Devkit") #required
   set(upm_PACKAGE_ON_TAG ".")
@@ -133,9 +195,9 @@ if (IPK)
       "${upm_VERSION_MAJOR}.${upm_VERSION_MINOR}.${upm_VERSION_PATCH}${upm_PACKAGE_ON_TAG}${VERSION_COMMIT}")
   set(CPACK_PACKAGE_NAME "upm")
   set(CPACK_DEBIAN_PACKAGE_SECTION "libs")
-  set(CPACK_DEBIAN_PACKAGE_ARCHITECTURE ${DETECTED_ARCH})
-  set(CPACK_SYSTEM_NAME ${DETECTED_ARCH})
-  set(CPACK_DEBIAN_PACKAGE_DEPENDS "libmraa0 (>= ${MRAA_VERSION})")
+  set(CPACK_DEBIAN_PACKAGE_ARCHITECTURE ${TARGET_ARCH})
+  set(CPACK_SYSTEM_NAME ${TARGET_ARCH})
+  set(CPACK_DEBIAN_PACKAGE_DEPENDS "mraa (>= ${MRAA_VERSION})")
   set(CPACK_DEBIAN_PACKAGE_PROVIDES "upm-dev, upm-dbg, upm-doc")
   set(CPACK_DEBIAN_PACKAGE_REPLACES ${CPACK_DEBIAN_PACKAGE_PROVIDES})
   set(CPACK_DEBIAN_PACKAGE_CONFLICTS ${CPACK_DEBIAN_PACKAGE_PROVIDES})
@@ -143,8 +205,52 @@ if (IPK)
   include (CPack)
 endif()
 
-add_subdirectory (src)
+if (RPM)
+  message (INFO " - RPM packaging enabled for ${DETECTED_ARCH}")
+  set(CPACK_PACKAGE_VERSION ${VERSION})
+  set(CPACK_GENERATOR "RPM")
+  set(CPACK_PACKAGE_NAME "upm")
+  set(upm_PACKAGE_ON_TAG ".")
+  if ("${VERSION_COMMIT}" STREQUAL "")
+    set(upm_PACKAGE_ON_TAG "")
+  endif()
+  set(CPACK_PACKAGE_VERSION
+      "${upm_VERSION_MAJOR}.${upm_VERSION_MINOR}.${upm_VERSION_PATCH}${upm_PACKAGE_ON_TAG}${VERSION_COMMIT}")
+  set(CPACK_PACKAGE_CONTACT "Intel IoT-Devkit")
+  set(CPACK_PACKAGE_VENDOR "Intel IoT-Devkit")
+  set(CPACK_RPM_PACKAGE_REQUIRES "mraa >= ${MRAA_VERSION}")
+  set(CPACK_RPM_PACKAGE_PROVIDES "${CPACK_PACKAGE_NAME}-devel")
+  set(CPACK_RPM_PACKAGE_LICENSE "MIT")
+  EXECUTE_PROCESS(COMMAND rpm --showrc
+    COMMAND grep -E "dist[[:space:]]*\\."
+    COMMAND sed -e "s/^.*dist\\s*\\.//"
+    COMMAND tr \\n \\t
+    COMMAND sed  -e s/\\t//
+    OUTPUT_VARIABLE DIST_TAG)
+  set(CPACK_PACKAGE_FILE_NAME "${CPACK_PACKAGE_NAME}-${CPACK_PACKAGE_VERSION}.${DIST_TAG}.${DETECTED_ARCH}")
+  include(CPack)
+endif()
 
 if(BUILDEXAMPLES)
   add_subdirectory (examples/c++)
 endif()
+
+if(BUILDJAVAEXAMPLES)
+  add_subdirectory (examples/java)
+endif()
+
+if (BUILDSWIGPYTHON OR BUILDTESTS)
+  if (BUILDPYTHON3)
+    set (PYTHONBUILD_VERSION 3)
+  else ()
+    set (PYTHONBUILD_VERSION 2.7)
+  endif ()
+endif ()
+
+add_subdirectory (src)
+
+if (BUILDTESTS)
+  find_package (PythonInterp ${PYTHONBUILD_VERSION} REQUIRED)
+  enable_testing ()
+  add_subdirectory (tests)
+endif()

LICENSE

@@ -1,4 +1,4 @@
-Copyright © 2014 Intel Corporation
+Copyright © 2014-2015 Intel Corporation
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

README.md

@@ -1,28 +1,74 @@
-UPM - Sensor/Actuator repository for libmraa
+UPM (Useful Packages & Modules) Sensor/Actuator repository for MRAA
 ==============
 
-UPM is a high level repository for sensors that use libmraa. Each sensor links
-to libmraa and are not meant to be interlinked although some groups of sensors
-may be. Each sensor contains a header which allows to interface with it.
-Typically a sensor is represented as a class and instantiated.
+The UPM repository provides software drivers for a wide variety of commonly
+used sensors and actuators. These software drivers interact with the
+underlying hardware platform (or microcontroller), as well as with the attached
+sensors, through calls to [MRAA](https://github.com/intel-iot-devkit/mraa) APIs.
 
-The constructor is expected to initialise the sensor and parameters may be used
-to provide identification/pin location on the board.
+Programmers can access the interfaces for each sensor by including the sensor’s
+corresponding header file and instantiating the associated sensor class. In the
+typical use case, a constructor initializes the sensor based on parameters that
+identify the sensor, the I/O protocol used and the pin location of the sensor.
 
-Typically an update() function will be called in order to get new data from the
-sensor in order to reduce load when doing multiple reads to sensor data.
+C++ interfaces have been defined for the following sensor/actuator types, but
+they are subject to change:
+
+* Light controller 
+* Light sensor
+* Temperature sensor
+* Humidity sensor
+* Pressure sensor
+* Gas sensor
+* Analog to digital converter
+
+The developer community is encouraged to help expand the list of supported
+sensors and actuators and provide feedback on interface design.
 
 ### Example
 
-A sensor/actuator is expected to work as such (here is the servo ES08A API):
-@snippet es08a.cxx Interesting
+A sensor/actuator is expected to work as such (here is the MMA7660 accelerometer API):
+```C++
+  // Instantiate an MMA7660 on I2C bus 0
+  upm::MMA7660 *accel = new upm::MMA7660(MMA7660_I2C_BUS,
+                                         MMA7660_DEFAULT_I2C_ADDR);
 
-However implementation and API design is completely up to the developer, some
-enumerable sensors for example may provide much clever instantiation. Displays
-may also create more complex structures in order to interface with them.
+  // place device in standby mode so we can write registers
+  accel->setModeStandby();
+
+  // enable 64 samples per second
+  accel->setSampleRate(upm::MMA7660::AUTOSLEEP_64);
+  
+  // place device into active mode
+  accel->setModeActive();
+
+  while (shouldRun)
+    {
+      int x, y, z;
+      
+      accel->getRawValues(&x, &y, &z);
+      cout << "Raw values: x = " << x 
+           << " y = " << y
+           << " z = " << z
+           << endl;
+      
+      float ax, ay, az;
+      
+      accel->getAcceleration(&ax, &ay, &az);
+      cout << "Acceleration: x = " << ax 
+           << "g y = " << ay
+           << "g z = " << az
+           << "g" << endl;
+      
+      usleep(500000);
+    }
+```
 
 Browse through the list of all [examples](https://github.com/intel-iot-devkit/upm/tree/master/examples).
 
+Multi-sensor samples for the starter and specialized kits can be found in the
+[iot-devkit-samples](https://github.com/intel-iot-devkit/iot-devkit-samples) repository.
+
 ### Supported Sensors
 
 Supported [sensor list](http://iotdk.intel.com/docs/master/upm/modules.html) from API documentation.
@@ -31,37 +77,53 @@ You can also refer to the [Intel® IoT Developer Zone](https://software.intel.co
 
 ### IDE Integration
 
-If you would like to create Eclipse IDE projects using the UPM C++ samples,
-please follow the instructions posted [here](https://software.intel.com/en-us/node/551014).
-This will show you how to import the code and configure your project.
+If you would like to create projects and run the UPM samples using an Intel recommended IDE,
+please refer to the Intel Developer Zone IDE page.
+
+<a href="https://software.intel.com/iot/software/ide"><img src="docs/icons/allides.png"/></a>
 
 ### Building UPM
 
-See @ref building [here](docs/building.md).
+See building documentation [here](docs/building.md).
 
 ### Making your own UPM module
 
-@ref porting [link](docs/porting.md) has more information on making new UPM modules.
+Porting [link](docs/porting.md) has more information on making new UPM modules.
 
-There is also an example available for @ref max31855 [sensor](docs/max31855.md).
+There is also an example available gfor max31855 [sensor](docs/max31855.md).
+
+Guide on creating Java [bindings](docs/creating_java_bindings.md).
 
 ### Naming conventions and rules for new UPM contributions
 
-Before you begin development, take a look at our @ref naming [conventions](docs/naming.md).
+Before you begin development, take a look at our naming [conventions](docs/naming.md).
 
-Also, please read the guidelines for @ref contributions [to UPM](docs/contributions.md).
+Also, please read the guidelines for contributions [to UPM](docs/contributions.md).
 
-Don't forget to check the @ref documentation [section](docs/documentation.md).
+Don't forget to check the documentation [section](docs/documentation.md).
 
 Make sure you add yourself as an author on every new code file submitted.
 If you are providing a fix with significant changes, feel free to add yourself
 as a contributor. Signing-off your commits is mandatory.
 
-C/C++ API Documentation
+API Documentation
 ==============
 
-The C/C++ documentation is available [here](http://iotdk.intel.com/docs/master/upm/).
+<a href="http://iotdk.intel.com/docs/master/upm"><img src="docs/icons/c++.png"/></a>
+<a href="http://iotdk.intel.com/docs/master/upm/java"><img src="docs/icons/java.png"/></a>
+<a href="http://iotdk.intel.com/docs/master/upm/python"><img src="docs/icons/python.png"/></a>
+<a href="http://iotdk.intel.com/docs/master/upm/node"><img src="docs/icons/node.png"/></a>
 
-Version @ref changelog [here](docs/changelog.md).
+### API Compatibility
+Even if we try our best not to, every once in a while we are forced to modify
+our API in a way that will break backwards compatibility. If you find yourself
+unable to compile code that was working fine before a library update, make sure
+you check the [API changes](docs/apichanges.md) section first.
 
-List of @ref knownlimitations [here](docs/knownlimitations.md).
+**NOTE** - Our **C++ header files** changed extension from *.h* to *.hpp*!
+
+### Changelog
+Version changelog [here](docs/changelog.md).
+
+### Known Limitations
+List of known limitations [here](docs/knownlimitations.md).

cmake/Toolchains/oe-sdk_cross.cmake

@@ -0,0 +1,25 @@
+# this toolchain file comes from gnuradio project
+
+set( CMAKE_SYSTEM_NAME Linux )
+#set( CMAKE_C_COMPILER  $ENV{CC} )
+#set( CMAKE_CXX_COMPILER  $ENV{CXX} )
+string(REGEX MATCH "sysroots/([a-zA-Z0-9]+)" CMAKE_SYSTEM_PROCESSOR $ENV{SDKTARGETSYSROOT})
+string(REGEX REPLACE "sysroots/" "" CMAKE_SYSTEM_PROCESSOR ${CMAKE_SYSTEM_PROCESSOR})
+set( CMAKE_CXX_FLAGS $ENV{CXXFLAGS}  CACHE STRING "" FORCE )
+set( CMAKE_C_FLAGS $ENV{CFLAGS} CACHE STRING "" FORCE ) #same flags for C sources
+set( CMAKE_LDFLAGS_FLAGS ${CMAKE_CXX_FLAGS} CACHE STRING "" FORCE ) #same flags for C sources
+set( CMAKE_LIBRARY_PATH ${OECORE_TARGET_SYSROOT}/usr/lib )
+set( CMAKE_FIND_ROOT_PATH $ENV{OECORE_TARGET_SYSROOT} $ENV{OECORE_NATIVE_SYSROOT} )
+set( CMAKE_FIND_ROOT_PATH_MODE_PROGRAM NEVER )
+set( CMAKE_FIND_ROOT_PATH_MODE_LIBRARY ONLY )
+set( CMAKE_FIND_ROOT_PATH_MODE_INCLUDE ONLY )
+set( CMAKE_INSTALL_PREFIX $ENV{OECORE_TARGET_SYSROOT}/usr CACHE STRING "" FORCE)
+set( ORC_INCLUDE_DIRS $ENV{OECORE_TARGET_SYSROOT}/usr/include/orc-0.4 )
+set( ORC_LIBRARY_DIRS $ENV{OECORE_TARGET_SYSROOT}/usr/lib )
+
+# for java
+set( JAVA_AWT_INCLUDE_PATH $ENV{JAVA_HOME}/include CACHE PATH "" FORCE)
+set( JAVA_AWT_LIBRARY $ENV{JAVA_HOME}/jre/lib/amd64/libjawt.so CACHE FILEPATH "" FORCE)
+set( JAVA_INCLUDE_PATH $ENV{JAVA_HOME}/include CACHE PATH "" FORCE)
+set( JAVA_INCLUDE_PATH2 $ENV{JAVA_HOME}/include/linux CACHE PATH "" FORCE)
+set( JAVA_JVM_LIBRARY $ENV{JAVA_HOME}/jre/lib/amd64/libjvm.so CACHE FILEPATH "" FORCE)

cmake/modules/FindNode.cmake

@@ -1,4 +1,12 @@
-find_program (NODE_EXECUTABLE NAMES node
+ # Macro to add directory to NODEJS_INCLUDE_DIRS if it exists and is not /usr/include
+ macro(add_include_dir dir)
+    if (IS_DIRECTORY ${dir} AND NOT ${dir} STREQUAL "/usr/include")
+      set(NODEJS_INCLUDE_DIRS ${NODEJS_INCLUDE_DIRS} ${dir})
+    endif()
+endmacro()
+
+
+find_program (NODEJS_EXECUTABLE NAMES node nodejs
     HINTS
     $ENV{NODE_DIR}
     PATH_SUFFIXES bin
@@ -7,26 +15,50 @@ find_program (NODE_EXECUTABLE NAMES node
 
 include (FindPackageHandleStandardArgs)
 
-find_path (NODE_ROOT_DIR "node/node.h" "src/node.h"
-  PATHS /usr/include/nodejs /usr/local/include/nodejs)
+# If compat-libuv package exists, it must be at start of include path
+find_path (UV_ROOT_DIR "uv.h" PATHS /usr/include/compat-libuv010 NO_DEFAULT_PATH)
+if (UV_ROOT_DIR)
+  # set (NODEJS_INCLUDE_DIRS ${UV_ROOT_DIR})
+  add_include_dir(${UV_ROOT_DIR})
+endif()
 
-set (NODE_INCLUDE_DIRS
-  ${NODE_ROOT_DIR}/src
-  ${NODE_ROOT_DIR}/node
-  ${NODE_ROOT_DIR}/deps/v8/include
-  ${NODE_ROOT_DIR}/deps/uv/include
+# Now look for node. Flag an error if not found
+find_path (NODE_ROOT_DIR "include/node/node.h" "include/src/node.h"
+  PATHS /usr/include/nodejs /usr/local/include/nodejs /usr/local/include)
+if (NODE_ROOT_DIR)
+  add_include_dir(${NODE_ROOT_DIR}/include/src)
+  add_include_dir(${NODE_ROOT_DIR}/include/node)
+  add_include_dir(${NODE_ROOT_DIR}/include/deps/v8/include)
+  add_include_dir(${NODE_ROOT_DIR}/include/deps/uv/include)
+else()
+  unset(NODEJS_INCLUDE_DIRS)
+  message(ERROR " - node.h not found")
+endif()
+
+# Check that v8.h is in NODEJS_INCLUDE_DIRS
+find_path (V8_ROOT_DIR "v8.h" PATHS ${NODEJS_INCLUDE_DIRS})
+if (NOT V8_ROOT_DIR)
+  unset(NODEJS_INCLUDE_DIRS)
+  message(ERROR " - v8.h not found")
+endif()
+
+# Check that uv.h is in NODEJS_INCLUDE_DIRS
+find_path (UV_ROOT_DIR "uv.h" PATHS ${NODEJS_INCLUDE_DIRS})
+if (NOT UV_ROOT_DIR)
+  unset(NODEJS_INCLUDE_DIRS)
+  message(ERROR " - uv.h not found")
+endif()
+
+find_package_handle_standard_args (Nodejs DEFAULT_MSG
+    NODEJS_EXECUTABLE
+    NODEJS_INCLUDE_DIRS
 )
 
-find_package_handle_standard_args (Node DEFAULT_MSG
-    NODE_EXECUTABLE
-    NODE_INCLUDE_DIRS
-)
-
-if (NODE_EXECUTABLE)
-    execute_process(COMMAND ${NODE_EXECUTABLE} --version
+if (NODEJS_EXECUTABLE)
+    execute_process(COMMAND ${NODEJS_EXECUTABLE} --version
                     OUTPUT_VARIABLE _VERSION
                     RESULT_VARIABLE _NODE_VERSION_RESULT)
-    execute_process(COMMAND ${NODE_EXECUTABLE} -e "console.log(process.versions.v8)"
+    execute_process(COMMAND ${NODEJS_EXECUTABLE} -e "console.log(process.versions.v8)"
                     OUTPUT_VARIABLE _V8_VERSION
                     RESULT_VARIABLE _V8_RESULT)
     if (NOT _NODE_VERSION_RESULT AND NOT _V8_RESULT)
@@ -38,6 +70,7 @@ if (NODE_EXECUTABLE)
         set (V8_VERSION_STRING ${_V8_VERSION})
         string (REPLACE "." ";" _V8_VERSION_LIST "${_V8_VERSION}")
         string (REPLACE "." "" V8_DEFINE_STRING "${_V8_VERSION}")
+        string (STRIP ${V8_DEFINE_STRING} V8_DEFINE_STRING)
         list (GET _V8_VERSION_LIST 0 V8_VERSION_MAJOR)
         list (GET _V8_VERSION_LIST 1 V8_VERSION_MINOR)
         list (GET _V8_VERSION_LIST 2 V8_VERSION_PATCH)
@@ -49,12 +82,16 @@ if (NODE_EXECUTABLE)
         set (NODE_VERSION_MINOR "10")
         set (NODE_VERSION_PATCH "30")
         set (V8_VERSION_MAJOR "3")
-        set (V8_VERSION_MAJOR "14")
-        set (V8_VERSION_MAJOR "5")
+        set (V8_VERSION_MINOR "28")
+        set (V8_VERSION_PATCH "72")
         set (V8_VERSION_STRING "3.28.72")
         message ("defaulted to node 0.10.30")
     endif ()
-    message ("INFO - Node version is " ${NODE_VERSION_STRING} "INFO - Node using v8 " ${V8_VERSION_STRING})
+    string (REGEX REPLACE "\n" "" NODE_VERSION_STRING ${NODE_VERSION_STRING})
+    string (REGEX REPLACE "\n" "" V8_VERSION_STRING ${V8_VERSION_STRING})
+    message ("INFO - Node version is " ${NODE_VERSION_STRING})
+    message ("INFO - Node using v8 " ${V8_VERSION_STRING})
+    mark_as_advanced (NODEJS_EXECUTABLE)
 endif ()
 
-mark_as_advanced (NODE_EXECUTABLE)
+mark_as_advanced (NODEJS_EXECUTABLE)

docs/apichanges.md

@@ -0,0 +1,15 @@
+API Changes                       {#apichanges}
+===============
+
+Here's a list of other API changes made to the library that break source/binary
+compatibility between releases:
+
+ * Our **C++ header files** changed their extension from *.h* to *.hpp* in
+ version 0.7.0, Intel provided examples and code samples also reflect this
+ change but you will need to modify your `#include` directives in existing code
+ * **my9221**, **groveledbar** and **grovecircularled** are now all part of the
+ same library (my9221) and new functionality was added going to v.0.5.1
+ * **stepmotor** driver API was changed significantly from v.0.4.1 to v.0.5.0
+ * **eboled** library was greatly improved in version 0.4.0 and the `draw()`
+ function was removed in favor of a more complete GFX library implementation
+ 

docs/building.md

@@ -3,15 +3,12 @@ Building UPM                         {#building}
 
 UPM uses cmake in order to make compilation relatively painless. Cmake runs
 build out of tree so the recommended way is to clone from git and make a build/
-directory. Failure to do an out-of-source build may cause issues when
-rebuilding later on.
+directory.
 
-This project depends on libmraa, so that needs to be installed first. Use the
-following environment variables to configure the paths:
+This project depends on libmraa, so that needs to be installed first. Append
+the install location of mraa pkgconfig to the following environment variable:
 
     PKG_CONFIG_PATH=$PKG_CONFIG_PATH:.../mraa/build/lib/pkgconfig
-    CPLUS_INCLUDE_PATH=$CPLUS_INCLUDE_PATH:.../mraa/build/include
-    LIBRARY_PATH=$LIBRARY_PATH:.../mraa/build/lib
 
 UPM will attempt to build all directories inside src/ and they must contain
 individual CMakeLists.txt files.
@@ -25,7 +22,8 @@ make install
 ~~~~~~~~~~~~~
 
 The last command will create the include/ and lib/ directories with a copy of
-the headers and library objects respectively in your build location.
+the headers and library objects respectively in your build location. Note that
+doing an out-of-source build may cause issues when rebuilding later on.
 
 Our cmake configure has a number of options, *cmake-gui* or *ccmake* can show
 you all the options. The interesting ones are detailed below:
@@ -61,7 +59,11 @@ Setting the python library to use:
 ~~~~~~~~~~~~~
 Building doxygen doc
 ~~~~~~~~~~~~~
--BUILDDOC=ON
+-DBUILDDOC=ON
+~~~~~~~~~~~~~
+Build C++ example binaries
+~~~~~~~~~~~~~
+-DBUILDEXAMPLES=ON
 ~~~~~~~~~~~~~
 
 If you intend to turn on all the options and build everything at once (C++,

docs/changelog.md

@@ -4,15 +4,141 @@ Changelog                         {#changelog}
 Here's a list summarizing some of the key undergoing changes to our library
 from earlier versions:
 
+### v0.7.1
+
+ * Fix for building python2 vs python3 bindings
+ * Fixes for jhd1313m1 row/font size and reset
+ * Added bacnet utility class
+ * New sensors: bmx055, bmi055, bmc160, bma250e, bmg150, bmm150, t8100, tb7300
+
+### v0.7.0
+
+ * C++ header files have been renamed from *.h to *.hpp along with all Intel
+ provided examples and code samples to allow for native C drivers
+ * Updated driver compatibility to new MRAA 1.0 API
+ * First sensor implementations for our newly added Dallas One Wire support
+ * Several fixes based on issues reported on Github
+ * Changed SWIG linking strategy, more robust Travis CI build checks
+ * New sensors: ds2413, ds18b20, bmp280, bno055, l3gd20
+
+### v0.6.2
+
+ * Added a generic driver for taking snapshots from an USB camera device
+ * New API changes section in documentation to let users know when the UPM API
+ gets modified
+ * Fixed some spelling errors and improved JavaScript documentation builds with
+ newer versions of YUI and Node
+ * Enhanced Cmake scripts and the build process
+ * New sensors: vcap, e50hx
+
+### v0.6.1
+
+ * Fixed library build process for different configurations across multiple
+ environments reported by users.
+ * Fixed multiple GFX library header clash and improved SSD1351 compatibility
+ by changing SPI mode
+ * Added Node and Python array typemaps for nrf24l01
+ * Added 2 new JAVA examples
+
+### v0.6.0
+
+ * Introduced C++ Interfaces for several sensor categories that will help
+ consolidate the sensor APIs with uniform function names upon implementation
+ * Greatly improved Node.js detection and handling during build and install,
+ and should be now compatible with all major versions
+ * Added a driver for the Curie IMU (accelerometer + gyroscope) that works with
+ the new Firmata support implemented by MRAA
+ * Continued to provide several JAVA fixes and examples
+ * Many new industrial and maker sensors: cwlsxxa, teams, tex00, h803x, apa102,
+ smartdrive, bmi160, bme280, ds1808lc, hlg150, lp8860, max44009, si1132, t6713,
+ si7005, ssd1351
+
+### v0.5.1
+
+ * Updated the API and added new functionality for the MY9221 class and derived
+ sensors: grovecircularled and groveledbar, along with new code samples that
+ show these changes
+ * Provided a fix for one JAVA example that uses interrupts and updated library
+ install paths
+ * Several documentation improvements and pictures were added for new sensors
+ * A few other sensors received minor patches
+
+### v0.5.0
+
+ * First implementations for industrial grade Modbus sensors, along with first
+ sensor examples that use the new iio system driver in MRAA
+ * Significant improvements to the stepmotor driver that will now allow precise
+ control using any GPIO pin and extended the API with new functionality
+ * Further improved JAVA bindings and sensor ISRs have been modified to
+ implement Runnable objects
+ * Improved Python typemaps and error checking, documentation now includes
+ detailed function descriptions
+ * Simplified the build process by eliminating the need to define redundant
+ MRAA related environment variables
+ * New sensors: nlgpio16, ads1x15, t3311, hdxxvxta, hwxpxx, rhusb, ili9341,
+ apds9930, kxcjk1013
+
+### v0.4.1
+
+ * Over 150 supported sensor drivers including some industrial grade devices
+ * Improved the JAVA bindings, added a large number of examples for sensors,
+ enabled JAVA builds in Travis CI, and introduced automatic loading for the
+ JAVA shared libraries
+ * Continued to improve existing sensor drivers and to enhance them with the
+ new C++ coding style and exception types
+ * Several cmake improvements to allow building on various Linux distributions
+ and with a newer version of Node.JS
+ * Simplified adding and building of C++ sensor examples via cmake
+ * New sensors: micsv89, xbee, urm37, adxrs610, bma220, dfrph, mcp9808, sx1276,
+ groveultrasonic, ozw
+
+### v0.4.0
+
+ * Fully functional and documented JAVA language bindings for sensors with
+ several examples also available
+ * Added standardized exception handling support across all language bindings
+ and updated sensors to use this feature
+ * Sensor drivers are now available and can be installed individually using NPM
+ for Node.js users
+ * Continuous Integration with Travis CI ensures new contributions are built
+ automatically once they are received
+ * API rewrite and improvements for hcsr04, sm130, eboled, loudness
+ * Documentation improvements and code style changes from C to C++
+ * New sensors: hyld9767, mg811, wheelencoder, grovegprs, mpu9250, ssd1306,
+ es9257, lm35, mq4, mq6, mq7, mq8
+
+### v0.3.2
+
+ * Introduced RPM package generation feature from cmake via cpack
+ * Performed a thorough documentation review and merged resulting changes,
+ includes last remaining images and grouping sensors by kits
+ * Added support for Sparkfun Sensor Blocks (OLED & IMU)
+ * Fully reworked API for at42qt1070, mpu9150 and lcd classes, while
+ maintaining backwards compatibility for existing lcd displays
+ * Extended doxygen tags for better integration with automated documentation
+ generators
+ * New sensors: rgbringcoder, hp20x, pn532, sainsmartks, lsm9ds0, eboled
+
+### v0.3.1
+
+ * Updated index pages for API documentation and cross-linked them
+ * More images were added for Grove, Adafruit and Sparkfun sensors along with
+ licensing information
+ * Applied a set of patches to improve code robustness
+ * Added support for Grove NFC Tag sensor
+ * Fixed several typos in library and sensor names
+ * New sensor: m24lr64e
+
 ### v0.3.0
 
- * New CMake targets to build python and node documentation with Sphinx and
- Yuidoc
+ * Provided automated, updated and comprehensive sensor API documentation for
+ C++, Python and JavaScript
  * Edited sensor names, library descriptions and doxygen tags for consistency
- * Added support for several new sensors
  * Fixed the TH02 sensor driver and made major improvements to i2clcd driver
- * Updated and added new images for a lot of the existing sensors
- * Added this changelog
+ * Added new and updated images for numerous new and existing sensors
+ * Started this changelog
+ * New sensors: sx6119, si114x, maxsonarez, hm11, ht9170, h3lis331dl, ad8232,
+ grovescam
 
 ### v0.2.0
 
@@ -23,6 +149,10 @@ from earlier versions:
  * Fixed the buzzer and servo drivers for the Intel Edison
  * Renamed bmp and gp2y sensor classes to be more generic
  * Completely revamped implementation for tm1637
+ * New sensors: mma7660, cjq4435, adxl335, hmtrp, nunchuck, otp538u, l298,
+ groveelectromagnet, grovecollision, adis16448, at42qt1070, grovemd, ina132,
+ grovegsr, groveo2, groveemg, pca9685, pca9685ss, adafruitms1438, hx711, flex,
+ groveeldriver, mhz16, apds9002, waterlevel, zfm20, uln200xa, grovewfs, isd1820
 
 ### v0.1.9
 
@@ -31,6 +161,12 @@ from earlier versions:
  * Several examples and documentation updates submitted
  * Wrote new proper SWIG typemaps for arrays
  * Fixed the i2clcd write function, improved several other sensors
+ * New sensors: rpr220, rotaryencoder, biss0001, rfr359f, grovespeaker, mq303a,
+ ppd42ns, wt5001, yg1006, ublox6, mpr121, groveloudness, guvas12d, grovewater,
+ grovevdiv, grovelinefinder, ta12200, groveehr, grovemoisture, gp2y0a, a110x,
+ ds1307, adc121c021, enc03r, ttp223, itg3200, am2315, tp401, ldt0028, htu21d,
+ mpl3115a2, lsm303, joystick12, tsl2561, groverotary, groveslider, adxl345,
+ grovebutton, lol, groverelay
 
 ### v0.1.8
 

docs/creating_java_bindings.md

@@ -0,0 +1,353 @@
+Creating Java Bindings Guide
+==============
+* [Overview](#overview)
+* [Tools of trade](#tools-of-trade)
+* [Recommendations for the native API](#recommendations-for-the-native-api)
+  * [Pointers](#pointers)
+  * [Throwing Exceptions in Java](#throwing-exceptions-in-java)
+* [Caveats & Challenges](#caveats--challenges)
+  * [Wrapping C arrays with Java arrays](#wrapping-c-arrays-with-java-arrays)
+  * [Wrapping unbound C arrays with Java arrays if array is output](#wrapping-unbound-c-arrays-with-java-arrays-if-array-is-output)
+  * [Wrapping unbound C arrays with Java arrays if array is input](#wrapping-unbound-c-arrays-with-java-arrays-if-array-is-input)
+  * [Implementing callbacks in Java](#implementing-callbacks-in-java)
+
+
+##Overview
+
+The "Creating Java Bindings Guide" serves as a basic tutorial for using the SWIG software development tool to create 'glue code' required for Java to call into C/C++ code. It contains: guides for dealing with type conversions, exception handling, callbacks; recommendations on how to write/modify the native API to avoid issues on the Java side, and also workarounds for those issues that can't be avoided.
+
+This guide was created with the [upm](https://github.com/intel-iot-devkit/upm/) and [mraa](https://github.com/intel-iot-devkit/mraa) libraries in mind, and uses examples taken from these sources, but its usage can be extended to any project of creating Java bindings for C/C++ libraries.
+
+##Tools of trade
+
+[SWIG General Documentation](http://www.swig.org/Doc3.0/SWIGDocumentation.html)
+
+[SWIG Java-specific Documentation](http://www.swig.org/Doc3.0/Java.html)
+
+
+##Recommendations for the native API
+
+###Pointers
+As much as possible, avoid passing values/returning values through pointers given as as arguments to methods. As the Java language does not have pointers, SWIG provides a [workaround](http://www.swig.org/Doc3.0/Java.html#Java_tips_techniques) in the typemaps.i library.
+
+####Alternatives:
+1. Functions that read data from a driver, return it through a pointer given as argument, and return a bool value, should be __replaced by__ functions that return the value directly and throw a std::runtime_error if a read error occurs. E.g.:
+  ```c++
+  /*  
+   * Function reads from sensor, places read value in variable bar and  
+   * returns true if succesful. Function returns false if read failed.  
+   */  
+  bool func(int *bar); 
+  ```
+  __Replaced by:__
+  ```c++
+  /*  
+   * Function reads from sensor and returns read value.  
+   * Or throws std::runtime_error if a read error occurs  
+   */  
+  int func();  
+  ```
+
+2. Functions that return multiple values through pointers, that make sense to be grouped together into an array<sup>1</sup> (e.g. speed values, acceleration values), should be __replaced by__ functions that return a pointer to an array in which the elements are the returned values. Afterwards, [wrap the C array with a Java array](#wrapping-unbound-c-arrays-with-java-arrays-if-array-is-output). E.g.:
+  ```c++
+  /*  
+  * Function returns the acceleration on the three  
+  * axis in the given variables.  
+  */  
+  void getAccel(int *accelX, int *accelY, int *accelZ);  
+  ```
+
+  __Replaced by:__  
+  ```c++
+  /*  
+   * Function returns the acceleration on the three  
+   * axis as elements of a 3-element array.  
+   */  
+  int *getAccel();  
+  ```
+
+3. Functions that return N values through pointers, that do not make sense to grouped together (e.g. a general purpose function that returns both the light intensity and air pollution), should be __replaced by__ N functions (one for each value) that read only one specific value. E.g.:
+
+  ```c++
+  /*  
+   * Function returns the light intensity and air pollution  
+   */  
+  void getData(int *light, int *air);  
+  ```
+
+  __Replaced by:__  
+  ```c++
+  int getLight();  
+  int getAir();  
+  ```
+
+4. Functions that return N values through pointers; values that do not make sense to be grouped together, but are time dependent, and make sense to be read at the same time. For example, a sensor that reads air humidity and temperature. A user may want to know the temperature value _temp_ read at the exact moment the humidity value _humid_ was read. These should be __replaced by__ N+1 functions: a _getData()_ function that reads all values at the same time and stores them in global variables; and N getter functions, one for each value. E.g.
+
+  ```c++
+  /*  
+   * Function returns the light intensity and air pollution  
+   */  
+  void getData(int *temp, int *humid);  
+  ```
+
+  __Replaced by:__  
+  ```c++
+  void getData();  
+  int getTemp();  
+  int getHumid();   
+  ```
+
+  <sup>1</sup>this depends on the interpretation of the returned data. For example, arguments that return the temperature and light intensity, don't make sense to be grouped into an array of size 2. But acceleration on the three axis can be grouped together in an array of size 3. where accelX is accel[0], accelY is accel[1], accelZ is accel[2].
+
+__Notice:__
+Sometimes, you may be required to write JNI code. Be aware of the difference between the C JNI calling syntax and the C++ JNI calling syntax.The C++ calling syntax will not compile as C and also vice versa. It is however possible to write JNI calls which will compile under both C and C++ and is covered in the [Typemaps for both C and C++ compilation](http://www.swig.org/Doc3.0/Java.html#Java_typemaps_for_c_and_cpp) section of the SWIG Documentation.
+
+
+###Throwing Exceptions in Java
+####Language independent:
+The %exception directive allows you to define a general purpose exception handler. For example, you can specify the following:
+
+```c++
+%exception [method_name] {
+    try {
+        $action
+    }
+    catch (std::invalid_argument& e) {
+        ... handle error ...
+    }
+}
+```
+
+If [method_name] is not specified then the directive is applied to all methods in its scope.
+
+The usual thing you'd want to do is catch the C++ exception and throw an equivalent exception in your language.
+
+The exception.i library file provides support for creating language independent exceptions in your interfaces. To use it, simply put an "%include exception.i" in your interface file. This provides a function SWIG_exception() that can be used to raise common language exceptions in a portable manner. For example :
+
+
+```c++
+// Language independent exception handler  
+%include exception.i  
+
+%exception {  
+    try {  
+            $action  
+        } catch(OutOfMemory) {  
+            SWIG_exception(SWIG_MemoryError, "Out of memory");  
+    } catch(...) {  
+            SWIG_exception(SWIG_RuntimeError,"Unknown exception");  
+    }  
+}  
+```
+
+In the upm library, the upm_exception.i interface file provides the functionality to catch common exceptions and propagate them through SWIG. It uses the exception.i library file and is language independent.
+
+The upm_exception.i interface file is included in the upm.i file, therefor SWIG wraps all generated methods' body in a try-catch statement for the following exceptions:
+
+* std::invalid_argument
+* std::domain_error
+* std::overflow_error
+* std::out_of_range
+* std::length_error
+* std::logic_error
+* std::bad_alloc
+* std::runtime_error
+* std::exception
+
+
+####Java specific:
+To throw a specific Java exception:
+
+```c++
+%exception {  
+    try {  
+        $action  
+    } catch (std::out_of_range &e) {  
+        jclass clazz = jenv->FindClass("java/lang/Exception");  
+        jenv->ThrowNew(clazz, "Range error");  
+        return $null;  
+    }  
+}  
+```
+
+Where FindClass and ThrowNew are [JNI functions](http://docs.oracle.com/javase/8/docs/technotes/guides/jni/spec/functions.html).
+
+Java defines two tipes of exceptions: checked exception and unchecked exceptions (errors and runtime exceptions). Checked exceptions are subject to the [Catch or Specify Requirement](https://docs.oracle.com/javase/tutorial/essential/exceptions/catchOrDeclare.html).
+
+The C++ compiler does not force the code to catch any exception.
+
+The %exception directive does not specify if a method throws a checked exception (does not add classes to the throws clause). For this, the  %javaexception(classes) directive is used; where classes is a string containing one or more comma separated Java classes.
+
+```c++
+%javaexception("java.lang.Exception") {  
+    try {  
+        $action  
+    } catch (std::out_of_range &e) {  
+        jclass clazz = jenv->FindClass("java/lang/Exception");  
+        jenv->ThrowNew(clazz, "Range error");  
+        return $null;  
+    }  
+}  
+```
+
+In the upm library, the java_exceptions.i library file provides the functionality to catch exceptions and propagate them through SWIG as Java checked exceptions. The file provides SWIG wrappers, in the form of macros, that can be applied to methods.E.g. use the __READDATA_EXCEPTION(function)__ macro for functions that read data from a sensor and throw a std::runtime_error in case of a read failure. This will result in:
+
+```java
+void function throws IOException ();  
+```
+
+##Caveats & Challenges
+
+###Wrapping C arrays with Java arrays
+SWIG can wrap arrays in a more natural Java manner than the default by using the arrays_java.i library file. Just include this file into your SWIG interface file.
+
+###Wrapping unbound C arrays with Java arrays if array is output
+Functions that return arrays, return a pointer to that array. E.g.:
+
+```c++
+/*  
+ * Function returns the acceleration on the three  
+ * axis as elements of a 3-element array.  
+ */  
+
+int *getAccel();  
+```
+
+__SWIG:__  
+```c++
+%typemap(jni) int* "jintArray"  
+%typemap(jstype) int* "int[]"  
+%typemap(jtype) int* "int[]"  
+
+%typemap(javaout) int* {  
+    return $jnicall;  
+}  
+
+%typemap(out) int *getAccel {  
+    $result = JCALL1(NewIntArray, jenv, 3);  
+    JCALL4(SetIntArrayRegion, jenv, $result, 0, 3, (const signed int*)$1);  
+}  
+```
+
+###Wrapping unbound C arrays with Java arrays if array is input
+In C, arrays are tipically passed as pointers, with an integer value representig the length of the array. In Java, the length of an array is always known, so the length argument is redundant. This example shows how to wrap the C array and also get rid the length argument. E.g.:
+
+```c++
+void func(uint8_t *buffer, int length);  
+```
+
+__SWIG:__  
+```c++
+%typemap(jtype) (uint8_t *buffer, int length) "byte[]"  
+%typemap(jstype) (uint8_t *buffer, int length) "byte[]"  
+%typemap(jni) (uint8_t *buffer, int length) "jbyteArray"  
+%typemap(javain) (uint8_t *buffer, int length) "$javainput"  
+
+%typemap(in,numinputs=1) (uint8_t *buffer, int length) {  
+	$1 = JCALL2(GetByteArrayElements, jenv, $input, NULL);  
+	$2 = JCALL1(GetArrayLength, jenv, $input);  
+}  
+```
+
+!!!! There is a difference between TYPE *name and TYPE * name in typemaps!!!!!
+
+
+###Implementing callbacks in Java
+Callbacks in the UPM Java library (as well as the MRAA Java library) make use of the _void mraa\_java\_isr\_callback(void\* data\)_ method from MRAA.  
+
+__Callbacks in the UPM Java library are implemented as follows (we use the a110x Hall Effect sensors as example):__
+
+We extend the sensor class with another method, _installISR\(jobject runnable\)_, which is a wrapper over the original _installISR\(void \(\*isr\)\(void \*\), void \*arg\)_ method. This will install the _mraa\_java\_isr\_callback\(\)_ method as the interrupt service routine \(ISR\) to be called, with _jobject runnable_ as argument.
+
+SWIGJAVA is a symbol that is always defined by SWIG when using Java. We enclose the _installISR\(jobject runnable\)_ method in a _\#if defined(SWIGJAVA)_ check, to ensure the code only exists when creating a wrapper for Java.
+
+```c++
+#if defined(SWIGJAVA)
+void A110X::installISR(jobject runnable)
+{
+    installISR(mraa_java_isr_callback, runnable);
+}
+#endif
+```
+
+We hide the underlying method, _installISR\(void \(\*isr\)\(void \*\), void \*arg\)_ , and expose only the _installISR\(jobject runnable\)_ to SWIG, through the use of the SWIGJAVA symbol. When SWIGJAVA is defined, we change the access modifier of the underlying method to private.
+
+```c++
+public:
+#if defined(SWIGJAVA)
+    void installISR(jobject runnable);
+#else
+    void installISR(void (*isr)(void *), void *arg);
+#endif
+private:
+#if defined(SWIGJAVA)
+    void installISR(void (*isr)(void *), void *arg);
+#endif
+```
+
+To use callback in java, we create a ISR class, which implements the Java Runnable interface, and we override the _run\(\)_ method with the code to be executed when the interrupt is received. An example for the a110x Hall sensor that increments a counter each time an interrupt is received:
+
+```java
+public class A110X_intrSample {
+    public static int counter=0;
+        
+    public static void main(String[] args) throws InterruptedException {
+        upm_a110x.A110X hall = new upm_a110x.A110X(2);
+
+        A110XISR callback = new A110XISR();
+        hall.installISR(callback);
+        
+        while(true){
+            System.out.println("Counter: " + counter);
+            Thread.sleep(1000);
+        }
+    }
+}
+
+class A110XISR implements Runnable {
+    public A110XISR(){
+        super();
+    }
+    public void run(){
+        A110X_intrSample.counter++;
+    }
+}
+```
+####Issues with java callbacks and workarounds
+
+__SWIGJAVA not defined at compile time__
+
+Consider the following files:
+* example.h - Header file for our source file
+* example.cxx - Source file containing the class Example, for which we build java bindings
+* example.i - The SWIG interface, that includes the example.h header file
+
+The build process of a java module using SWIG is split into two steps:
+
+1. Generating the intermediate files, from the SWIG interface file. This will produce the java class file (Example.java), the JNI file (exampleJNI.java) and wrapper file (example_wrap.cxx). The source file (example.cxx) is not needed in the first step.
+
+  ```
+swig -c++ -java example.i
+  ```
+
+2. Generating the shared library from the C++ sources and wrapper file
+  ```
+g++ -fPIC -c example.cxx example_wrap.cxx -I/usr/lib/jvm/java-1.8.0/include -I/usr/lib/jvm/java-1.8.0/include/linux
+g++ -shared example_wrap.o sensor.o -o libexample.so
+  ```
+
+
+SWIGJAVA is always defined when SWIG parses the interface file, meaning it will be defined when it parses the header file (example.h) that is included in the interface file (example.i).
+SWIG also adds the "#define SWIGJAVA" directive in the wrapper file (example_wrap.cxx).
+However, in generating the shared library the SWIGJAVA symbol is only defined in the example_wrap.cxx file, because of the added "#define SWIGJAVA" directive. But we have also used the "#if defined(SWIGJAVA)" check in the source file (example.cxx), and thus need to define SWIGJAVA for it too. If we define the SWIGJAVA symbol as a compile flag, when compiling the source code to object code, the SWIGJAVA compile flag and #define SWIGJAVA" directive will clash and give a double definition warning (only a warning).
+
+In this example it is simple to compile the two source codes separately, one with the compile flag, the other without, and then create the shared library (libexample.so).
+But in a big automatic build like the java upm libraries, this may prove too hard or too complicated to do. A workaround to this would be to define a custom symbol (e.q. JAVACALLBACK in the upm library) and also test for it. In short, replace:
+```c++
+#if defined(SWIGJAVA)
+```
+by
+```c++
+#if defined(SWIGJAVA) || defined(JAVACALLBACK)
+```
+

docs/documentation.md

@@ -28,6 +28,7 @@ Here's an example (disregard the "@verbatim" tags in your actual code):
  * @sensor <chip-id>
  * @comname <component-name>
  * @altname <alt-name>
+ * @altid <alt-id>
  * @type <component-category>
  * @man <component-manufacturer>
  * @web <component-weblinks>
@@ -49,11 +50,13 @@ Here's an example (disregard the "@verbatim" tags in your actual code):
   library's "@defgroup", otherwise this is a new library name, generally the
   same as chip id. *Mandatory*
 - `<chip-id>` Usually the chip number used by the sensor. When this is not
-  available or relevant, use a unique descriptor that makes sense. *Mandatory*
-- `<component-name>` A short name for your sensor, can include manufacturer
-  name. *Mandatory*
-- `<alt-name>` Alternative names or chip-ids that your sensor driver might
-  have or support respectively. *Optional*
+  available or relevant, use a unique descriptor that makes sense. Must match
+  class name. *Mandatory*
+- `<component-name>` A short name for your sensor, try to avoid including the
+  manufacturer's name here. *Mandatory*
+- `<alt-name>` Alternative names that your sensor driver might have. This may
+  include manufacturer's name. *Optional*
+- `<alt-id>` Alternative chip-ids that your sensor driver supports. *Optional*
 - `<component-category>` Mention one or more categories the sensor fits in. Can
   be 'other'. *Mandatory*
 - `<component-manufacturer>` Sensor manufacturer. Can be 'generic'. *Mandatory*

docs/images/LICENSE_CC_3_0.txt

@@ -0,0 +1,361 @@
+Creative Commons Legal Code
+
+Attribution-NonCommercial-ShareAlike 3.0 Unported
+
+    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
+    LEGAL SERVICES. DISTRIBUTION OF THIS LICENSE DOES NOT CREATE AN
+    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
+    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
+    REGARDING THE INFORMATION PROVIDED, AND DISCLAIMS LIABILITY FOR
+    DAMAGES RESULTING FROM ITS USE.
+
+License
+
+THE WORK (AS DEFINED BELOW) IS PROVIDED UNDER THE TERMS OF THIS CREATIVE
+COMMONS PUBLIC LICENSE ("CCPL" OR "LICENSE"). THE WORK IS PROTECTED BY
+COPYRIGHT AND/OR OTHER APPLICABLE LAW. ANY USE OF THE WORK OTHER THAN AS
+AUTHORIZED UNDER THIS LICENSE OR COPYRIGHT LAW IS PROHIBITED.
+
+BY EXERCISING ANY RIGHTS TO THE WORK PROVIDED HERE, YOU ACCEPT AND AGREE
+TO BE BOUND BY THE TERMS OF THIS LICENSE. TO THE EXTENT THIS LICENSE MAY
+BE CONSIDERED TO BE A CONTRACT, THE LICENSOR GRANTS YOU THE RIGHTS
+CONTAINED HERE IN CONSIDERATION OF YOUR ACCEPTANCE OF SUCH TERMS AND
+CONDITIONS.
+
+1. Definitions
+
+ a. "Adaptation" means a work based upon the Work, or upon the Work and
+    other pre-existing works, such as a translation, adaptation,
+    derivative work, arrangement of music or other alterations of a
+    literary or artistic work, or phonogram or performance and includes
+    cinematographic adaptations or any other form in which the Work may be
+    recast, transformed, or adapted including in any form recognizably
+    derived from the original, except that a work that constitutes a
+    Collection will not be considered an Adaptation for the purpose of
+    this License. For the avoidance of doubt, where the Work is a musical
+    work, performance or phonogram, the synchronization of the Work in
+    timed-relation with a moving image ("synching") will be considered an
+    Adaptation for the purpose of this License.
+ b. "Collection" means a collection of literary or artistic works, such as
+    encyclopedias and anthologies, or performances, phonograms or
+    broadcasts, or other works or subject matter other than works listed
+    in Section 1(g) below, which, by reason of the selection and
+    arrangement of their contents, constitute intellectual creations, in
+    which the Work is included in its entirety in unmodified form along
+    with one or more other contributions, each constituting separate and
+    independent works in themselves, which together are assembled into a
+    collective whole. A work that constitutes a Collection will not be
+    considered an Adaptation (as defined above) for the purposes of this
+    License.
+ c. "Distribute" means to make available to the public the original and
+    copies of the Work or Adaptation, as appropriate, through sale or
+    other transfer of ownership.
+ d. "License Elements" means the following high-level license attributes
+    as selected by Licensor and indicated in the title of this License:
+    Attribution, Noncommercial, ShareAlike.
+ e. "Licensor" means the individual, individuals, entity or entities that
+    offer(s) the Work under the terms of this License.
+ f. "Original Author" means, in the case of a literary or artistic work,
+    the individual, individuals, entity or entities who created the Work
+    or if no individual or entity can be identified, the publisher; and in
+    addition (i) in the case of a performance the actors, singers,
+    musicians, dancers, and other persons who act, sing, deliver, declaim,
+    play in, interpret or otherwise perform literary or artistic works or
+    expressions of folklore; (ii) in the case of a phonogram the producer
+    being the person or legal entity who first fixes the sounds of a
+    performance or other sounds; and, (iii) in the case of broadcasts, the
+    organization that transmits the broadcast.
+ g. "Work" means the literary and/or artistic work offered under the terms
+    of this License including without limitation any production in the
+    literary, scientific and artistic domain, whatever may be the mode or
+    form of its expression including digital form, such as a book,
+    pamphlet and other writing; a lecture, address, sermon or other work
+    of the same nature; a dramatic or dramatico-musical work; a
+    choreographic work or entertainment in dumb show; a musical
+    composition with or without words; a cinematographic work to which are
+    assimilated works expressed by a process analogous to cinematography;
+    a work of drawing, painting, architecture, sculpture, engraving or
+    lithography; a photographic work to which are assimilated works
+    expressed by a process analogous to photography; a work of applied
+    art; an illustration, map, plan, sketch or three-dimensional work
+    relative to geography, topography, architecture or science; a
+    performance; a broadcast; a phonogram; a compilation of data to the
+    extent it is protected as a copyrightable work; or a work performed by
+    a variety or circus performer to the extent it is not otherwise
+    considered a literary or artistic work.
+ h. "You" means an individual or entity exercising rights under this
+    License who has not previously violated the terms of this License with
+    respect to the Work, or who has received express permission from the
+    Licensor to exercise rights under this License despite a previous
+    violation.
+ i. "Publicly Perform" means to perform public recitations of the Work and
+    to communicate to the public those public recitations, by any means or
+    process, including by wire or wireless means or public digital
+    performances; to make available to the public Works in such a way that
+    members of the public may access these Works from a place and at a
+    place individually chosen by them; to perform the Work to the public
+    by any means or process and the communication to the public of the
+    performances of the Work, including by public digital performance; to
+    broadcast and rebroadcast the Work by any means including signs,
+    sounds or images.
+ j. "Reproduce" means to make copies of the Work by any means including
+    without limitation by sound or visual recordings and the right of
+    fixation and reproducing fixations of the Work, including storage of a
+    protected performance or phonogram in digital form or other electronic
+    medium.
+
+2. Fair Dealing Rights. Nothing in this License is intended to reduce,
+limit, or restrict any uses free from copyright or rights arising from
+limitations or exceptions that are provided for in connection with the
+copyright protection under copyright law or other applicable laws.
+
+3. License Grant. Subject to the terms and conditions of this License,
+Licensor hereby grants You a worldwide, royalty-free, non-exclusive,
+perpetual (for the duration of the applicable copyright) license to
+exercise the rights in the Work as stated below:
+
+ a. to Reproduce the Work, to incorporate the Work into one or more
+    Collections, and to Reproduce the Work as incorporated in the
+    Collections;
+ b. to create and Reproduce Adaptations provided that any such Adaptation,
+    including any translation in any medium, takes reasonable steps to
+    clearly label, demarcate or otherwise identify that changes were made
+    to the original Work. For example, a translation could be marked "The
+    original work was translated from English to Spanish," or a
+    modification could indicate "The original work has been modified.";
+ c. to Distribute and Publicly Perform the Work including as incorporated
+    in Collections; and,
+ d. to Distribute and Publicly Perform Adaptations.
+
+The above rights may be exercised in all media and formats whether now
+known or hereafter devised. The above rights include the right to make
+such modifications as are technically necessary to exercise the rights in
+other media and formats. Subject to Section 8(f), all rights not expressly
+granted by Licensor are hereby reserved, including but not limited to the
+rights described in Section 4(e).
+
+4. Restrictions. The license granted in Section 3 above is expressly made
+subject to and limited by the following restrictions:
+
+ a. You may Distribute or Publicly Perform the Work only under the terms
+    of this License. You must include a copy of, or the Uniform Resource
+    Identifier (URI) for, this License with every copy of the Work You
+    Distribute or Publicly Perform. You may not offer or impose any terms
+    on the Work that restrict the terms of this License or the ability of
+    the recipient of the Work to exercise the rights granted to that
+    recipient under the terms of the License. You may not sublicense the
+    Work. You must keep intact all notices that refer to this License and
+    to the disclaimer of warranties with every copy of the Work You
+    Distribute or Publicly Perform. When You Distribute or Publicly
+    Perform the Work, You may not impose any effective technological
+    measures on the Work that restrict the ability of a recipient of the
+    Work from You to exercise the rights granted to that recipient under
+    the terms of the License. This Section 4(a) applies to the Work as
+    incorporated in a Collection, but this does not require the Collection
+    apart from the Work itself to be made subject to the terms of this
+    License. If You create a Collection, upon notice from any Licensor You
+    must, to the extent practicable, remove from the Collection any credit
+    as required by Section 4(d), as requested. If You create an
+    Adaptation, upon notice from any Licensor You must, to the extent
+    practicable, remove from the Adaptation any credit as required by
+    Section 4(d), as requested.
+ b. You may Distribute or Publicly Perform an Adaptation only under: (i)
+    the terms of this License; (ii) a later version of this License with
+    the same License Elements as this License; (iii) a Creative Commons
+    jurisdiction license (either this or a later license version) that
+    contains the same License Elements as this License (e.g.,
+    Attribution-NonCommercial-ShareAlike 3.0 US) ("Applicable License").
+    You must include a copy of, or the URI, for Applicable License with
+    every copy of each Adaptation You Distribute or Publicly Perform. You
+    may not offer or impose any terms on the Adaptation that restrict the
+    terms of the Applicable License or the ability of the recipient of the
+    Adaptation to exercise the rights granted to that recipient under the
+    terms of the Applicable License. You must keep intact all notices that
+    refer to the Applicable License and to the disclaimer of warranties
+    with every copy of the Work as included in the Adaptation You
+    Distribute or Publicly Perform. When You Distribute or Publicly
+    Perform the Adaptation, You may not impose any effective technological
+    measures on the Adaptation that restrict the ability of a recipient of
+    the Adaptation from You to exercise the rights granted to that
+    recipient under the terms of the Applicable License. This Section 4(b)
+    applies to the Adaptation as incorporated in a Collection, but this
+    does not require the Collection apart from the Adaptation itself to be
+    made subject to the terms of the Applicable License.
+ c. You may not exercise any of the rights granted to You in Section 3
+    above in any manner that is primarily intended for or directed toward
+    commercial advantage or private monetary compensation. The exchange of
+    the Work for other copyrighted works by means of digital file-sharing
+    or otherwise shall not be considered to be intended for or directed
+    toward commercial advantage or private monetary compensation, provided
+    there is no payment of any monetary compensation in con-nection with
+    the exchange of copyrighted works.
+ d. If You Distribute, or Publicly Perform the Work or any Adaptations or
+    Collections, You must, unless a request has been made pursuant to
+    Section 4(a), keep intact all copyright notices for the Work and
+    provide, reasonable to the medium or means You are utilizing: (i) the
+    name of the Original Author (or pseudonym, if applicable) if supplied,
+    and/or if the Original Author and/or Licensor designate another party
+    or parties (e.g., a sponsor institute, publishing entity, journal) for
+    attribution ("Attribution Parties") in Licensor's copyright notice,
+    terms of service or by other reasonable means, the name of such party
+    or parties; (ii) the title of the Work if supplied; (iii) to the
+    extent reasonably practicable, the URI, if any, that Licensor
+    specifies to be associated with the Work, unless such URI does not
+    refer to the copyright notice or licensing information for the Work;
+    and, (iv) consistent with Section 3(b), in the case of an Adaptation,
+    a credit identifying the use of the Work in the Adaptation (e.g.,
+    "French translation of the Work by Original Author," or "Screenplay
+    based on original Work by Original Author"). The credit required by
+    this Section 4(d) may be implemented in any reasonable manner;
+    provided, however, that in the case of a Adaptation or Collection, at
+    a minimum such credit will appear, if a credit for all contributing
+    authors of the Adaptation or Collection appears, then as part of these
+    credits and in a manner at least as prominent as the credits for the
+    other contributing authors. For the avoidance of doubt, You may only
+    use the credit required by this Section for the purpose of attribution
+    in the manner set out above and, by exercising Your rights under this
+    License, You may not implicitly or explicitly assert or imply any
+    connection with, sponsorship or endorsement by the Original Author,
+    Licensor and/or Attribution Parties, as appropriate, of You or Your
+    use of the Work, without the separate, express prior written
+    permission of the Original Author, Licensor and/or Attribution
+    Parties.
+ e. For the avoidance of doubt:
+
+     i. Non-waivable Compulsory License Schemes. In those jurisdictions in
+        which the right to collect royalties through any statutory or
+        compulsory licensing scheme cannot be waived, the Licensor
+        reserves the exclusive right to collect such royalties for any
+        exercise by You of the rights granted under this License;
+    ii. Waivable Compulsory License Schemes. In those jurisdictions in
+        which the right to collect royalties through any statutory or
+        compulsory licensing scheme can be waived, the Licensor reserves
+        the exclusive right to collect such royalties for any exercise by
+        You of the rights granted under this License if Your exercise of
+        such rights is for a purpose or use which is otherwise than
+        noncommercial as permitted under Section 4(c) and otherwise waives
+        the right to collect royalties through any statutory or compulsory
+        licensing scheme; and,
+   iii. Voluntary License Schemes. The Licensor reserves the right to
+        collect royalties, whether individually or, in the event that the
+        Licensor is a member of a collecting society that administers
+        voluntary licensing schemes, via that society, from any exercise
+        by You of the rights granted under this License that is for a
+        purpose or use which is otherwise than noncommercial as permitted
+        under Section 4(c).
+ f. Except as otherwise agreed in writing by the Licensor or as may be
+    otherwise permitted by applicable law, if You Reproduce, Distribute or
+    Publicly Perform the Work either by itself or as part of any
+    Adaptations or Collections, You must not distort, mutilate, modify or
+    take other derogatory action in relation to the Work which would be
+    prejudicial to the Original Author's honor or reputation. Licensor
+    agrees that in those jurisdictions (e.g. Japan), in which any exercise
+    of the right granted in Section 3(b) of this License (the right to
+    make Adaptations) would be deemed to be a distortion, mutilation,
+    modification or other derogatory action prejudicial to the Original
+    Author's honor and reputation, the Licensor will waive or not assert,
+    as appropriate, this Section, to the fullest extent permitted by the
+    applicable national law, to enable You to reasonably exercise Your
+    right under Section 3(b) of this License (right to make Adaptations)
+    but not otherwise.
+
+5. Representations, Warranties and Disclaimer
+
+UNLESS OTHERWISE MUTUALLY AGREED TO BY THE PARTIES IN WRITING AND TO THE
+FULLEST EXTENT PERMITTED BY APPLICABLE LAW, LICENSOR OFFERS THE WORK AS-IS
+AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE
+WORK, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT
+LIMITATION, WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR
+PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS,
+ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT
+DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED
+WARRANTIES, SO THIS EXCLUSION MAY NOT APPLY TO YOU.
+
+6. Limitation on Liability. EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE
+LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR
+ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES
+ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS
+BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
+
+7. Termination
+
+ a. This License and the rights granted hereunder will terminate
+    automatically upon any breach by You of the terms of this License.
+    Individuals or entities who have received Adaptations or Collections
+    from You under this License, however, will not have their licenses
+    terminated provided such individuals or entities remain in full
+    compliance with those licenses. Sections 1, 2, 5, 6, 7, and 8 will
+    survive any termination of this License.
+ b. Subject to the above terms and conditions, the license granted here is
+    perpetual (for the duration of the applicable copyright in the Work).
+    Notwithstanding the above, Licensor reserves the right to release the
+    Work under different license terms or to stop distributing the Work at
+    any time; provided, however that any such election will not serve to
+    withdraw this License (or any other license that has been, or is
+    required to be, granted under the terms of this License), and this
+    License will continue in full force and effect unless terminated as
+    stated above.
+
+8. Miscellaneous
+
+ a. Each time You Distribute or Publicly Perform the Work or a Collection,
+    the Licensor offers to the recipient a license to the Work on the same
+    terms and conditions as the license granted to You under this License.
+ b. Each time You Distribute or Publicly Perform an Adaptation, Licensor
+    offers to the recipient a license to the original Work on the same
+    terms and conditions as the license granted to You under this License.
+ c. If any provision of this License is invalid or unenforceable under
+    applicable law, it shall not affect the validity or enforceability of
+    the remainder of the terms of this License, and without further action
+    by the parties to this agreement, such provision shall be reformed to
+    the minimum extent necessary to make such provision valid and
+    enforceable.
+ d. No term or provision of this License shall be deemed waived and no
+    breach consented to unless such waiver or consent shall be in writing
+    and signed by the party to be charged with such waiver or consent.
+ e. This License constitutes the entire agreement between the parties with
+    respect to the Work licensed here. There are no understandings,
+    agreements or representations with respect to the Work not specified
+    here. Licensor shall not be bound by any additional provisions that
+    may appear in any communication from You. This License may not be
+    modified without the mutual written agreement of the Licensor and You.
+ f. The rights granted under, and the subject matter referenced, in this
+    License were drafted utilizing the terminology of the Berne Convention
+    for the Protection of Literary and Artistic Works (as amended on
+    September 28, 1979), the Rome Convention of 1961, the WIPO Copyright
+    Treaty of 1996, the WIPO Performances and Phonograms Treaty of 1996
+    and the Universal Copyright Convention (as revised on July 24, 1971).
+    These rights and subject matter take effect in the relevant
+    jurisdiction in which the License terms are sought to be enforced
+    according to the corresponding provisions of the implementation of
+    those treaty provisions in the applicable national law. If the
+    standard suite of rights granted under applicable copyright law
+    includes additional rights not granted under this License, such
+    additional rights are deemed to be included in the License; this
+    License is not intended to restrict the license of any rights under
+    applicable law.
+
+
+Creative Commons Notice
+
+    Creative Commons is not a party to this License, and makes no warranty
+    whatsoever in connection with the Work. Creative Commons will not be
+    liable to You or any party on any legal theory for any damages
+    whatsoever, including without limitation any general, special,
+    incidental or consequential damages arising in connection to this
+    license. Notwithstanding the foregoing two (2) sentences, if Creative
+    Commons has expressly identified itself as the Licensor hereunder, it
+    shall have all rights and obligations of Licensor.
+
+    Except for the limited purpose of indicating to the public that the
+    Work is licensed under the CCPL, Creative Commons does not authorize
+    the use by either party of the trademark "Creative Commons" or any
+    related trademark or logo of Creative Commons without the prior
+    written consent of Creative Commons. Any permitted use will be in
+    compliance with Creative Commons' then-current trademark usage
+    guidelines, as may be published on its website or otherwise made
+    available upon request from time to time. For the avoidance of doubt,
+    this trademark restriction does not form part of this License.
+
+    Creative Commons may be contacted at https://creativecommons.org/.
+   

docs/knownlimitations.md

@@ -7,30 +7,48 @@ such sensors and known workarounds if they exist.
 
 #### Grove Sensors
 
- * **Grove I2C Touch Sensor** v1.3 is incompatible with the Intel Edison using
- the Arduino board, but will work with the Mini-breakout if supplied with at
- least 4V. Revision v1.2 works well on all Intel boards.
+ * **Grove LCD RGB Backlit** (JHD1313M1) requires 5V and should be used with an
+ external power supply connected to the board to function properly. Although
+ some high powered USB ports might be enough, in most cases you will encounter
+ dropped characters, washed out text and/or failed I2C writes while using USB
+ power alone.
+ * **Grove I2C Touch Sensor** (MPR121) v1.3 is incompatible with the Intel
+ Edison using the Arduino board, but will work with the Mini-breakout if
+ supplied with at least 4V. Revision v1.2 works well on all Intel boards.
  * **Grove Nunchuck** only works with the Intel Galileo boards and is unusable
  on the Intel Edison boards.
  * **Grove 3-Axis Digital Gyroscope** (ITG-3200) is not compatible with the
  Intel Edison Arduino board but will work with the Mini-breakout.
- * **Grove 3-Axis Digital Accelerometer** (ADXL345) only works with the Intel
- Edison Arduino board when powered from the 3.3V line.
+ * **Grove 3-Axis Digital Accelerometer +/-16g** (ADXL345) only works with the
+ Intel Edison Arduino board when powered from the 3.3V line.
+ * **Grove 3-Axis Digital Compass** (HMC5883L) reports inaccurate values at 5V
+ on the Intel Edison Arduino board and newer revisions might not work at all.
+ Use 3.3V or the Mini-breakout.
  * **Grove 96x96 OLED Display** will not work on the Intel Edison with Arduino
  breakout.
  * **Grove 128x64 OLED Display** will not work on the Intel Edison with Arduino
  breakout.
  * **Grove Barometer** (BMP085) has an unstable connection on the Intel Edison
- using the Arduino breakout and does not run properly.
+ using the Arduino breakout and may drop read data. The Xadow version of this
+ sensor (BMP180) is also dropping data packets occasionally.
  * **Grove 6-Axis Accelerometer & Compass** (LSM303) fails to write to the
  configuration register properly and returns invalid data.
  * **Grove I2C ADC Converter** does not show up on the I2C bus on the Intel
  Edison with the Arduino board.
  * **Grove I2C Motor Driver** is not compatible with the Intel Galileo due to
  the inability to change the I2C bus speed to 100 KHz.
+ * **Grove Digital Light Sensor** (TSL2561) may have an unstable connection on
+ the Intel Edison using the Arduino breakout that results in missed I2C reads.
+ This is usually applicable when the I2C lines are pulled-up to 5V. Works as
+ expected with the Mini-breakout.
  * **Grove CO2 Sensor** will return zeroed data and is unusable on the Intel
  Galileo.
- * **Grove BLE** (HM-11) does not return data on the Intel Galileo board.
+ * **Grove BLE** (HM-11) does not return data on the Intel Galileo board due to
+ known UART limitation.
+ * **Grove Hall Sensor** (A11X) if the base shield is set to 3V on Intel Edison,
+ it will trigger continous callbacks when the sensor is not reading anything.
+ * **Grove RTC** (DS1307) is not compatible with the Intel Edison Arduino board
+ but will work with the Mini-breakout.
 
 #### Adafruit Sensors
 
@@ -39,13 +57,27 @@ such sensors and known workarounds if they exist.
 
 #### Other Sensors
 
- * **MPU9150** might return inaccurate data.
+ * **NRF24L01** corrupted data packets are sent to the device due to the Intel
+ Edison SPI bus limitation. Sensor works as expected with the Intel Galileo
+ boards.
+ * **NRF8001** based devices do not initialize properly with provided examples
+ on Intel Edison boards also due to SPI bus limitation and data corruption.
+ Works on Intel Galileo.
 
 #### General
 
-Some I2C sensors add too much capacitance to the SDA line of the Intel Edison
+Some *I2C* sensors add too much capacitance to the SDA line of the Intel Edison
 Arduino breakout board, thus the signal sticks to a logic 1. When this happens,
 other sensors connected to the I2C bus are unusable. While there is no generic
 solution for this limitation, in most cases the sensor works on the Intel
 Edison Mini-breakout. When this board is not an option, the sensor can be
 sometimes replaced with the same model from a different vendor.
+
+The Intel Edison *SPI* bus can corrupt data being sent across when certain
+sensors are connected to it. Based on the sensor, this can affect functionality
+slightly or make the sensor entirely unusable. Unlike the I2C bus limitation,
+different boards are not likely to resolve this. A kernel update on the other
+hand might help alleviate this.
+
+On the Intel Galileo boards, the *UART* bus might drop data if several bytes
+are read at once.

docs/max31855.md

@@ -13,7 +13,7 @@ This is a spi module so we will use the mraa spi functions to build our module.
 First thing to do is to create a tree structure like this in upm/src/max31855:
 
 * max31855.cxx
-* max31855.h
+* max31855.hpp
 * jsupm_max31855.i
 * pyupm_max31855.i
 * CMakeLists.txt
@@ -36,11 +36,11 @@ used swig wrappers for UPM sensors, it's not obligatory but recommended.
 
 ### API
 
-Then we create the header (max31855.h) , a very simple header in our case we
+Then we create the header (max31855.hpp) , a very simple header in our case we
 will have only a very basic api. We provide a getTemp() function which will
 return the same type as in the arduino library, a double.
 
-@snippet max31855.h Interesting
+@snippet max31855.hpp Interesting
 
 Note that the header contains both the io that we will use, the gpio is in this
 case used as the chip select pin.
@@ -80,7 +80,7 @@ useful to us and converting it to a double.
 
 Our final example, very easy to use API!
 
-@snippet examples/max31855.cxx Interesting
+@snippet examples/c++/max31855.cxx Interesting
 
 ### Building
 

docs/naming.md

@@ -26,8 +26,5 @@ sensor can inherit your class if they only have minor changes.
 ### Doubt
 
 If ever, give either of us a ping via email:
- mihai.tudor.panu@intel.com
- john.r.van.drasek@intel.com
- brendan.le.foll@intel.com
+mihai.tudor.panu@intel.com or brendan.le.foll@intel.com
 and we'll try suggest decent names for your module.
-

docs/porting.md

@@ -14,16 +14,16 @@ example is explained in detail on @ref max31855
 
 ### CmakeLists.txt
 
-By default you need a header called modulename.h and a C++ file called
+By default you need a header called modulename.hpp and a C++ file called
 modulename.cxx. You can have multiple headers and source files. Only public
-headers need to be added to module_h and all source files need to be in
+headers need to be added to module_hpp and all source files need to be in
 module_src.
 
 ~~~~~~~~~~~
 set (libname "modulename")
 set (libdescription "Module Description")
 set (module_src ${libname}.cxx)
-set (module_h ${libname}.h)
+set (module_hpp ${libname}.hpp)
 upm_module_init()
 ~~~~~~~~~~~
 

doxy/Doxyfile.in

@@ -236,6 +236,7 @@ ALIASES                = library="@ingroup " \
                          sensor="@li **ID:** " \
                          comname="@li **Name:** " \
                          altname="@li **Other Names:** " \
+                         altid="@li **Other Chips:** " \
                          type="@li **Category:** " \
                          man="@li **Manufacturer:** " \
                          web="@li **Link:** " \
@@ -766,7 +767,7 @@ WARN_LOGFILE           =
 INPUT                  = @CMAKE_CURRENT_SOURCE_DIR@/src/upm.h \
                          @CMAKE_CURRENT_SOURCE_DIR@/src \
                          @CMAKE_CURRENT_SOURCE_DIR@/docs \
-                         @CMAKE_CURRENT_SOURCE_DIR@/README.md
+                         @CMAKE_CURRENT_SOURCE_DIR@/doxy/README.cpp.md
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -858,7 +859,10 @@ EXCLUDE_SYMLINKS       = NO
 # Note that the wildcards are matched against the file with absolute path, so to
 # exclude all test directories for example use the pattern */test/*
 
-EXCLUDE_PATTERNS       =
+# bmi160 driver contains code provided by bosch.  This source contains
+# tags which are picked up by doxygen (namely \mainpage) and
+# incorrectly get added to docs.
+EXCLUDE_PATTERNS       = bosch_*
 
 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
 # (namespaces, classes, functions, etc.) that should be excluded from the
@@ -945,7 +949,7 @@ FILTER_SOURCE_PATTERNS =
 # (index.html). This can be useful if you have a project on for instance GitHub
 # and want to reuse the introduction page also for the doxygen output.
 
-USE_MDFILE_AS_MAINPAGE = @CMAKE_CURRENT_SOURCE_DIR@/README.md
+USE_MDFILE_AS_MAINPAGE = @CMAKE_CURRENT_SOURCE_DIR@/doxy/README.cpp.md
 
 #---------------------------------------------------------------------------
 # Configuration options related to source browsing

doxy/README.cpp.md

@@ -0,0 +1,82 @@
+UPM (Useful Packages & Modules) Sensor/Actuator repository for MRAA
+==============
+
+UPM is a high level repository for sensors that use MRAA. Each sensor links
+to MRAA and are not meant to be interlinked although some groups of sensors
+may be. Each sensor contains a header which allows to interface with it.
+Typically a sensor is represented as a class and instantiated.
+
+The constructor is expected to initialise the sensor and parameters may be used
+to provide identification/pin location on the board.
+
+Typically an update() function will be called in order to get new data from the
+sensor in order to reduce load when doing multiple reads to sensor data.
+
+### Example
+
+A sensor/actuator is expected to work as such (here is the servo ES08A API):
+@snippet es08a.cxx Interesting
+
+However implementation and API design is completely up to the developer, some
+enumerable sensors for example may provide much clever instantiation. Displays
+may also create more complex structures in order to interface with them.
+
+Browse through the list of all [examples](https://github.com/intel-iot-devkit/upm/tree/master/examples/c%2B%2B).
+
+Multi-sensor samples for the starter and specialized kits can be found in the
+[iot-devkit-samples](https://github.com/intel-iot-devkit/iot-devkit-samples) repository.
+
+### Supported Sensors
+
+Supported [sensor list](http://iotdk.intel.com/docs/master/upm/modules.html) from API documentation.
+
+You can also refer to the [Intel IoT Developer Zone](https://software.intel.com/iot/sensors).
+
+### IDE Compatibility
+
+If you would like to create Eclipse IDE projects using the UPM C++ samples,
+please follow the instructions provided on the Intel Developer Zone IDE page.
+
+@htmlonly
+<a href="https://software.intel.com/iot/software/ide"><img src="docs/icons/eclipse.png"/></a>
+@endhtmlonly
+
+### Building UPM
+
+See @ref building here.
+
+### Making your own UPM module
+
+@ref porting link has more information on making new UPM modules.
+
+There is also an example available for @ref max31855 sensor.
+
+### Naming conventions and rules for new UPM contributions
+
+Before you begin development, take a look at our @ref naming conventions.
+
+Also, please read the guidelines for @ref contributions to UPM.
+
+Don't forget to check the @ref documentation section.
+
+Make sure you add yourself as an author on every new code file submitted.
+If you are providing a fix with significant changes, feel free to add yourself
+as a contributor. Signing-off your commits is mandatory.
+
+API Documentation
+==============
+
+@htmlonly
+
+<a href="http://iotdk.intel.com/docs/master/upm"><img src="docs/icons/c++.png"/></a>
+<a href="http://iotdk.intel.com/docs/master/upm/java"><img src="docs/icons/java.png"/></a>
+<a href="http://iotdk.intel.com/docs/master/upm/python"><img src="docs/icons/python.png"/></a>
+<a href="http://iotdk.intel.com/docs/master/upm/node"><img src="docs/icons/node.png"/></a>
+
+@endhtmlonly
+
+### Changelog
+Version @ref changelog here.
+
+### Known Limitations
+List of @ref knownlimitations here.

doxy/README.java.md

@@ -0,0 +1,81 @@
+UPM (Useful Packages & Modules) Sensor/Actuator repository for MRAA
+
+UPM is a high level repository for sensors that use MRAA. Each sensor links
+to MRAA and are not meant to be interlinked although some groups of sensors
+may be. Each sensor contains a header which allows to interface with it.
+Typically a sensor is represented as a class and instantiated.
+
+The constructor is expected to initialise the sensor and parameters may be used
+to provide identification/pin location on the board.
+
+Typically an update() function will be called in order to get new data from the
+sensor in order to reduce load when doing multiple reads to sensor data.
+
+### Example
+
+A sensor/actuator is expected to work as such (here is the servo ES08A API):
+@snippet ES08ASample.java Interesting
+
+However implementation and API design is completely up to the developer, some
+enumerable sensors for example may provide much clever instantiation. Displays
+may also create more complex structures in order to interface with them.
+
+Browse through the list of all [examples](https://github.com/intel-iot-devkit/upm/tree/master/examples/java).
+
+Multi-sensor samples for the starter and specialized kits can be found in the
+[iot-devkit-samples](https://github.com/intel-iot-devkit/iot-devkit-samples) repository.
+
+### Supported Sensors
+
+Supported [sensor list](http://iotdk.intel.com/docs/master/upm/java/modules.html) from API documentation.
+
+You can also refer to the [Intel® IoT Developer Zone](https://software.intel.com/iot/sensors).
+
+### IDE Compatibility
+
+If you would like to create Eclipse IDE projects using the UPM Java samples,
+please follow the instructions provided on the Intel Developer Zone IDE page.
+
+@htmlonly
+<a href="https://software.intel.com/iot/software/ide"><img src="../docs/icons/eclipse.png"/></a>
+@endhtmlonly
+
+### Building UPM
+
+See @ref building here.
+
+### Making your own UPM module
+
+@ref porting link has more information on making new UPM modules.
+
+There is also an example available for @ref max31855 sensor.
+
+### Naming conventions and rules for new UPM contributions
+
+Before you begin development, take a look at our @ref naming conventions.
+
+Also, please read the guidelines for @ref contributions to UPM.
+
+Don't forget to check the @ref documentation section.
+
+Make sure you add yourself as an author on every new code file submitted.
+If you are providing a fix with significant changes, feel free to add yourself
+as a contributor. Signing-off your commits is mandatory.
+
+API Documentation
+==============
+
+@htmlonly
+
+<a href="http://iotdk.intel.com/docs/master/upm"><img src="../docs/icons/c++.png"/></a>
+<a href="http://iotdk.intel.com/docs/master/upm/java"><img src="../docs/icons/java.png"/></a>
+<a href="http://iotdk.intel.com/docs/master/upm/python"><img src="../docs/icons/python.png"/></a>
+<a href="http://iotdk.intel.com/docs/master/upm/node"><img src="../docs/icons/node.png"/></a>
+
+@endhtmlonly
+
+### Changelog
+Version @ref changelog here.
+
+### Known Limitations
+List of @ref knownlimitations here.

doxy/index.rst

@@ -3,7 +3,7 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-**Welcome to UPM Python documentation!**
+**Welcome to UPM Python Documentation!**
 =========================================
 
 .. include:: ../../README.md
@@ -14,7 +14,24 @@
 ################
 
 For building UPM, please follow this `link <https://github.com/intel-iot-devkit/upm/blob/master/docs/building.md>`_.
-   
+
+``Examples``
+############
+
+Multi-sensor samples for the starter and specialized kits can be found in the `iot-devkit-samples <https://github.com/intel-iot-devkit/iot-devkit-samples>`_
+repository.
+
+Individual sensor usage examples for Python are available `here <https://github.com/intel-iot-devkit/upm/tree/master/examples/python>`_.
+
+``IDE Compatibility``
+################
+
+While there is no official IDE provided with our Python libraries, we do recommend the web-based IDE Wyliodrin. It can be used with multiple programming
+languages, including Python. More information can be found on the Intel Developer Zone IDE page.
+
+.. image:: ../docs/icons/wyliodrin.png
+   :target: https://software.intel.com/iot/software/ide
+
 ``Making your own UPM Module``
 ##############################
 
@@ -22,7 +39,7 @@ This `link  <https://github.com/intel-iot-devkit/upm/blob/master/docs/porting.md
 
 There is also an example available for max31855 `sensor <https://github.com/intel-iot-devkit/upm/blob/master/docs/max31855.md>`_.
 
-``Naming Conventions and rules for new UPM Contributions``
+``Naming Conventions and Rules for New UPM Contributions``
 ##########################################################
 
 Before you begin development, please take a look at our naming `conventions <https://github.com/intel-iot-devkit/upm/blob/master/docs/naming.md>`_.
@@ -33,32 +50,41 @@ Don't forget to check the documentation `section <https://github.com/intel-iot-d
 
 .. note::
 
-   * Make sure you add yourself as an author on every new code file submitted. 
-   * If you are providing a fix with significant changes, feel free to add yourself as a contributor. 
+   * Make sure you add yourself as an author on every new code file submitted.
+   * If you are providing a fix with significant changes, feel free to add yourself as a contributor.
    * Signing-off your commits is mandatory.
 
-``List of available sensors drivers``
+``List of Available Sensors Drivers``
 ######################################
 
+Click on the library prefix below to expand the full list of sensors:
+
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
 
    modules
 
-``C/C++ API Documentation``
+``Other API Documentation``
 ###########################
 
-The C/C++ API documentation is available `here <http://iotdk.intel.com/docs/master/upm/>`_.
+.. image:: ../docs/icons/c++.png
+   :target: http://iotdk.intel.com/docs/master/upm
+.. image:: ../docs/icons/java.png
+   :target: http://iotdk.intel.com/docs/master/upm/java
+.. image:: ../docs/icons/python.png
+   :target: http://iotdk.intel.com/docs/master/upm/python
+.. image:: ../docs/icons/node.png
+   :target: http://iotdk.intel.com/docs/master/upm/node
 
-``Version``
-###########
+``Version Changelog``
+#####################
 
-For Version Changelog, please see `here <https://github.com/intel-iot-devkit/upm/blob/master/docs/changelog.md>`_.
+For our Version Changelog, please see `here <https://github.com/intel-iot-devkit/upm/blob/master/docs/changelog.md>`_.
 
-``Limitations and List of Changes``
+``Known Limitations``
 ###################################
 
-For List of Known Limitations, please see `here <https://github.com/intel-iot-devkit/upm/blob/master/docs/knownlimitations.md>`_.
+For the List of Known Limitations, please see `here <https://github.com/intel-iot-devkit/upm/blob/master/docs/knownlimitations.md>`_.
 
 ``Indices and tables``
 ######################

doxy/node/docgen.js

@@ -43,20 +43,17 @@ opts
 
 // use promise-style programming rather than spaghetti callbacks
 Promise.promisifyAll(fs);
-
-
-// TODO: create directory structure if doesn't exist
-var formats = opts.formats.split(',');
-formats.forEach(function(format){
-  mkdirp('jsdoc/' + format + '/' + opts.module);
-});
+Promise.promisifyAll(mkdirp);
 
 
 // main
 xml2js.parse().then(function(specjs) {
+  var formats = opts.formats.split(',');
   Promise.all(_.map(formats, function(format) {
     var generateDocs = require(__dirname + '/generators/' + format + '/generator');
-    var outFile = opts.outdir + '/' + format + '/' + specjs.MODULE + '/doc.js';
-    return fs.writeFileAsync(outFile, generateDocs(specjs));
+    var dir = opts.outdir + '/' + format + '/' + specjs.MODULE;
+    return mkdirp.mkdirpAsync(dir).then(function() {
+      return fs.writeFileAsync(dir + '/doc.js', generateDocs(specjs));
+    });
   }));
 });

doxy/node/generators/jsdoc/generator.js

@@ -58,6 +58,7 @@ function GENERATE_MODULE(module) {
 
 // generate method spec with parent module/class
 function GENERATE_METHOD(name, spec, parent) {
+  name = name.replace(/!+$/, '');
   return GENERATE_DOC(spec.description + '\n'
     + '@method ' + name + '\n'
     + '@instance\n'

doxy/node/generators/ternjs/generator.js

@@ -28,44 +28,66 @@ var _ = require('lodash');
 
 // generate json for ternjs input
 function generateDocs(specjs) {
-  var docs = GENERATE_MODULE(specjs.MODULE);
   GENERATE_TYPE = (function(enums) {
     return function(type) {
       return (_.contains(enums, type) ? ('Enum ' + type) : type);
     }
   })(_.keys(specjs.ENUMS_BY_GROUP));
+  var docs = { '!name': specjs.MODULE + 'library' };
+  _.extend(docs, GENERATE_MODULE(specjs.MODULE));
   _.each(specjs.ENUMS, function(enumSpec, enumName) {
     _.extend(docs[specjs.MODULE], GENERATE_ENUM(enumName, enumSpec));
   });
   _.each(specjs.METHODS, function(methodSpec, methodName) {
     _.extend(docs[specjs.MODULE], GENERATE_METHOD(methodName, methodSpec));
   });
-  _.each(specjs.CLASSES, function(classSpec, parentClass) {
-    var constructor =  classSpec.methods[parentClass];
-    _.extend(docs[specjs.MODULE], GENERATE_METHOD(parentClass, constructor ? constructor : { params: {}, return: {}, description: '' } ));
-    _.each(classSpec.enums, function(enumSpec, enumName) {
-      _.extend(docs[specjs.MODULE][parentClass], GENERATE_ENUM(enumName, enumSpec));
+  
+  if (_.isEmpty(specjs.CLASSGROUPS)) {
+    _.extend(docs[specjs.MODULE], GENERATE_CLASSES(specjs.CLASSES));
+  } else {
+    var grouped = _.flatten(_.pluck(_.values(specjs.CLASSGROUPS), 'classes'));
+    var ungrouped = _.difference(_.keys(specjs.CLASSES), grouped);
+    _.extend(docs[specjs.MODULE], GENERATE_CLASSES(_.pick(specjs.CLASSES, ungrouped)));
+    _.each(specjs.CLASSGROUPS, function(groupSpec, groupName) {
+      _.extend(docs, GENERATE_MODULE(groupName));
+      _.extend(docs[groupName], GENERATE_CLASSES(_.pick(specjs.CLASSES, groupSpec.classes), groupName));
     });
-    docs[specjs.MODULE][parentClass].prototype = {};
-    _.each(_.omit(classSpec.methods, parentClass), function(methodSpec, methodName) {
-      _.extend(docs[specjs.MODULE][parentClass].prototype, GENERATE_METHOD(methodName, methodSpec));
-    });
-    _.each(classSpec.variables, function(variableSpec, variableName) {
-      _.extend(docs[specjs.MODULE][parentClass].prototype, GENERATE_VARIABLE(variableName, variableSpec));
-    });
-  });
+  }
   return JSON.stringify(docs, null, 2);
 }
 
 
 // generate module spec
 function GENERATE_MODULE(module) {
-  var docs = { '!name': module + 'library' };
+  var docs = {};
   docs[module] = {};
   return docs;
 }
 
 
+// generate the spec for the given list of classes
+function GENERATE_CLASSES(classes) {
+  var docs = {};
+  _.each(classes, function(classSpec, parentClass) {
+    var constructor =  classSpec.methods[parentClass];
+    _.extend(docs, GENERATE_METHOD(parentClass, constructor ? constructor : { params: {}, return: {}, description: '' } ));
+    if (_.has(docs, parentClass)) {
+      _.each(classSpec.enums, function(enumSpec, enumName) {
+        _.extend(docs[parentClass], GENERATE_ENUM(enumName, enumSpec));
+      });
+      docs[parentClass].prototype = {};
+      _.each(_.omit(classSpec.methods, parentClass), function(methodSpec, methodName) {
+        _.extend(docs[parentClass].prototype, GENERATE_METHOD(methodName, methodSpec));
+      });
+      _.each(classSpec.variables, function(variableSpec, variableName) {
+        _.extend(docs[parentClass].prototype, GENERATE_VARIABLE(variableName, variableSpec));
+      });
+    }
+  });
+  return docs;
+}
+
+
 // generate method spec
 function GENERATE_METHOD(name, spec) {
   var doc = {};

doxy/node/generators/yuidoc/generator.js

@@ -46,7 +46,7 @@ function generateDocs(specjs) {
     docs += GENERATE_MODULE('common', '');
     var grouped = _.flatten(_.pluck(_.values(specjs.CLASSGROUPS), 'classes'));
     var ungrouped = _.difference(_.keys(specjs.CLASSES), grouped);
-    docs += GENERATE_CLASSES(_.pick(specjs.CLASSES, ungrouped), 'common');
+    docs += GENERATE_CLASSES(_.pick(specjs.CLASSES, ungrouped), 'common'); 
     _.each(specjs.CLASSGROUPS, function(groupSpec, groupName) {
       docs += GENERATE_CLASSES(_.pick(specjs.CLASSES, groupSpec.classes), groupName);
     });
@@ -76,7 +76,7 @@ function GENERATE_MODULE(name, description) {
 function GENERATE_CLASSES(classes, parent) {
   return _.reduce(classes, function(memo, classSpec, className) {
     return memo
-      + GENERATE_CLASS(className, classSpec.description, parent)
+      + GENERATE_CLASS(className, classSpec.description, parent, classSpec.parent)
       + _.reduce(classSpec.methods, function(memo, methodSpec, methodName) {
         return memo += GENERATE_METHOD(methodName, methodSpec, className);
       }, '') 
@@ -91,15 +91,21 @@ function GENERATE_CLASSES(classes, parent) {
 
 
 // generate class spec
-function GENERATE_CLASS(name, description, parent) {
+function GENERATE_CLASS(name, description, namespace, parent) {
   return GENERATE_DOC(description + '\n' 
     + '@class ' + name + '\n'
-    + (parent ? ('@module ' + parent + '\n') : ''));
+    + (namespace ? ('@module ' + namespace + '\n') : '')
+    /*
+    TODO: leave out until figure out what swig does with inheritance
+    + (parent ? ('@extends ' + parent + '\n') : '')
+    */
+  );
 }
 
 
 // generate method spec with parent module/class
 function GENERATE_METHOD(name, spec, parent) {
+  name = name.replace(/!+$/, '');
   return GENERATE_DOC(spec.description + '\n'
     + '@method ' + name + '\n'
     + (parent ? ('@for ' + parent + '\n') : '@for common\n')

doxy/node/generators/yuidoc/helper.js

@@ -77,17 +77,15 @@ function listByGroup(modules, classes, field, projectRoot) {
   var groups = Object.keys(modulesByGroup).sort();
   var html = '';
   var pfx = projectRoot + 'modules/';
-  var first = true;
   for (i = 0; i < groups.length; i++) {
     var group = groups[i];
-    html += (first ? '' : '</span>');
     html += '<div class="upmGroup"><div class="right-arrow"></div>' + group + '</div><span class="upmModules" style="display:none">';
     var moduleNames = modulesByGroup[group];
     for (j = 0; j < moduleNames.length; j++) {
       var moduleName = moduleNames[j];
       html += '<a href="' + pfx + moduleName + '.html">' + moduleName + '</a>';
     }
-    first = false;
+    html += '</span>';
   }
   return html;
 }
@@ -117,7 +115,7 @@ var insertStyles = "Y.one(document.head).append('<style> \
     font-size: 0;                                        \
     margin-right: 5px;                                   \
     vertical-align: 5px;                                 \
-    display: inline;                                     \
+    float: left;                                         \
   }                                                      \
   div.down-arrow {                                       \
     width: 0;                                            \
@@ -127,7 +125,7 @@ var insertStyles = "Y.one(document.head).append('<style> \
     border-top: 5px solid #356de4;                       \
     font-size: 0;                                        \
     margin-right: 5px;                                   \
-    display: inline;                                     \
+    float: left;                                         \
   }                                                      \
   div.upmGroup {                                         \
     font-weight: bold;                                   \
@@ -137,7 +135,7 @@ var insertStyles = "Y.one(document.head).append('<style> \
 
 var scripts = "YUI().use('node', 'event', function (Y) {"
   + onClickHandler  
-  + insertStyles
+//  + insertStyles
   + "});";
 
 

doxy/node/generators/yuidoc/tmpl/assets/css/main.css

@@ -311,13 +311,13 @@ abbr {
     cursor: help;
 }
 
-.prettyprint li.L0, 
-.prettyprint li.L1, 
-.prettyprint li.L2, 
-.prettyprint li.L3, 
-.prettyprint li.L5, 
-.prettyprint li.L6, 
-.prettyprint li.L7, 
+.prettyprint li.L0,
+.prettyprint li.L1,
+.prettyprint li.L2,
+.prettyprint li.L3,
+.prettyprint li.L5,
+.prettyprint li.L6,
+.prettyprint li.L7,
 .prettyprint li.L8 {
     list-style: decimal;
 }
@@ -357,7 +357,7 @@ ul li p {
 #hd img {
     margin-right: 10px;
     vertical-align: middle;
-  
+
 }
 
 
@@ -787,3 +787,28 @@ kbd .cmd { font-family: Monaco, Helvetica; }
     font-weight: bold;
 }
 
+div.right-arrow {
+    width: 0;
+    height: 0;
+    border-bottom: 5px solid transparent;
+    border-top: 5px solid transparent;
+    border-left: 5px solid #356de4;
+    font-size: 0;
+    margin-right: 5px;
+    float: left;
+  }
+
+div.down-arrow {
+    width: 0;
+    height: 0;
+    border-left: 5px solid transparent;
+    border-right: 5px solid transparent;
+    border-top: 5px solid #356de4;
+    font-size: 0;
+    margin-right: 5px;
+    float: left;
+}
+
+div.upmGroup {
+    font-weight: bold;
+}

doxy/node/generators/yuidoc/tmpl/layouts/main.handlebars

@@ -17,6 +17,8 @@
           <h1>UPM</h1>
           <p>
           The UPM API is a high level sensor library for IoT devices using MRAA. See examples <a href="https://github.com/intel-iot-devkit/upm/tree/master/examples/javascript">here</a>. 
+          Back to <a href="http://iotdk.intel.com/docs/master/upm/node/"> index </a> page.
+          <br><em>SparkFun sensor images provided under <a href=https://creativecommons.org/licenses/by-nc-sa/3.0/>CC BY-NC-SA-3.0</a>.</em>
           </p>
         </div>
     </div>

doxy/node/generators/yuidoc/tmpl/partials/index.handlebars

@@ -0,0 +1,180 @@
+<div class="apidocs"> 
+  <div class="content" id="docs-main"> 
+    <h1><strong>Welcome to UPM Node.JS Documentation!</strong><a class="headerlink"
+                                                                 href="#welcome-to-upm-python-documentation"></a></h1>
+    
+
+    <p>Browse to a module or class using the sidebar to view its API
+    documentation.</p> 
+
+    <p>UPM is a high level repository for sensors that use MRAA. Each
+    sensor links to MRAA and are not meant to be interlinked although
+    some groups of sensors may be. Each sensor contains a header which
+    allows to interface with it. Typically a sensor is represented as a
+    class and instantiated.</p> 
+
+    <p>The constructor is expected to initialise the sensor and parameters
+    may be used to provide identification/pin location on the board.</p> 
+
+    <p>Typically an update() function will be called in order to get new
+    data from the sensor in order to reduce load when doing multiple reads
+    to sensor data.</p> 
+    <div class="section" id="examples"> 
+      <h3><code class="docutils literal"><span class="pre">Examples</span></code><a class="headerlink"
+                                                                                    href="#examples"
+                                                                                    title="Permalink to this headline">*</a></h3>
+      
+
+      <p>Multi-sensor samples for the starter and specialized kits can be
+      found in the 
+      <a class="reference external"
+         href="https://github.com/intel-iot-devkit/iot-devkit-samples">iot-devkit-samples</a>
+      repository.</p> 
+
+      <p>Individual sensor usage examples for node.js are available 
+      <a class="reference external"
+         href="https://github.com/intel-iot-devkit/upm/tree/master/examples/javascript">here</a>.</p>
+      
+    </div>
+    <div class="section" id="ide"> 
+      <h3><tt class="docutils literal"><span class="pre">IDE Compatibility</span> 
+      <span class="pre">UPM</span></tt><a class="headerlink"
+                                          href="#ide"
+                                          title="Permalink to this headline">*</a></h3>
+      
+
+      <p>Intel&reg; XDK IoT Edition is the recommended IDE for Node.js development.
+      Visit the Intel&reg; Developer Zone IDE page for more information on how to get
+      started.<br>
+      <a href="https://software.intel.com/iot/software/ide"><img src="../docs/icons/xdk.png"/></a>
+      </p>
+    </div>
+    <div class="section" id="building-upm"> 
+      <h3><tt class="docutils literal"><span class="pre">Building</span> 
+      <span class="pre">UPM</span></tt><a class="headerlink"
+                                          href="#building-upm"
+                                          title="Permalink to this headline">*</a></h3>
+      
+
+      <p>For building UPM, please follow this 
+      <a class="reference external"
+         href="https://github.com/intel-iot-devkit/upm/blob/master/docs/building.md">link</a>.</p>
+      
+    </div>
+    <div class="section" id="making-your-own-upm-module"> 
+      <h3><tt class="docutils literal"><span class="pre">Making</span> 
+      <span class="pre">your</span> <span class="pre">own</span> 
+      <span class="pre">UPM</span> <span class="pre">Module</span></tt><a class="headerlink"
+                                                                          href="#making-your-own-upm-module"
+                                                                          title="Permalink to this headline">*</a></h3>
+      
+
+      <p>This 
+      <a class="reference external"
+         href="https://github.com/intel-iot-devkit/upm/blob/master/docs/porting.md">link</a>
+      has more information on making a new UPM module.</p> 
+
+      <p>There is also an example available for max31855 
+      <a class="reference external"
+         href="https://github.com/intel-iot-devkit/upm/blob/master/docs/max31855.md">sensor</a>.</p>
+      
+    </div>
+    <div class="section"
+         id="naming-conventions-and-rules-for-new-upm-contributions"> 
+      <h3><tt class="docutils literal"><span class="pre">Naming</span> 
+      <span class="pre">Conventions</span> <span class="pre">and</span> 
+      <span class="pre">Rules</span> <span class="pre">for</span> 
+      <span class="pre">New</span> <span class="pre">UPM</span> 
+      <span class="pre">Contributions</span></tt><a class="headerlink"
+                                                    href="#naming-conventions-and-rules-for-new-upm-contributions"
+                                                    title="Permalink to this headline">*</a></h3>
+      
+
+      <p>Before you begin development, please take a look at our naming 
+      <a class="reference external"
+         href="https://github.com/intel-iot-devkit/upm/blob/master/docs/naming.md">conventions</a>.</p>
+      
+
+      <p>Also, please read the guidelines for contributions to 
+      <a class="reference external"
+         href="https://github.com/intel-iot-devkit/upm/blob/master/docs/contributions.md">UPM</a>.</p>
+      
+
+      <p>Don&rsquo;t forget to check the documentation 
+      <a class="reference external"
+         href="https://github.com/intel-iot-devkit/upm/blob/master/docs/documentation.md">section</a>.</p>
+      
+      <div class="admonition note"> 
+
+        <p class="first admonition-title">Note</p> 
+        <ul class="last simple">
+          <li>Make sure you add yourself as an author on every new code
+          file submitted.</li> 
+          <li>If you are providing a fix with significant changes, feel
+          free to add yourself as a contributor.</li> 
+          <li>Signing-off your commits is mandatory.</li> 
+        </ul>
+      </div>
+    </div>
+    <div class="section" id="api-documentation"> 
+      <h1><strong>Other API Documentation</strong><a class="headerlink"
+                                               href="#api-documentation"
+                                               title="Permalink to this headline"></a></h1>
+      
+
+      <p><a href="http://iotdk.intel.com/docs/master/upm"><img src="../docs/icons/c++.png" /></a>
+      <a href="http://iotdk.intel.com/docs/master/upm/java"><img src="../docs/icons/java.png" /></a>
+      <a href="http://iotdk.intel.com/docs/master/upm/python"><img src="../docs/icons/python.png" /></a>
+      <a href="http://iotdk.intel.com/docs/master/upm/node"><img src="../docs/icons/node.png" /></a>
+      </p>
+    </div>
+    <div class="section" id="version-changelog"> 
+      <h3><tt class="docutils literal"><span class="pre">Version</span> 
+      <span class="pre">Changelog</span></tt><a class="headerlink"
+                                                href="#version-changelog"
+                                                title="Permalink to this headline">*</a></h3>
+      
+
+      <p>For our Version Changelog, please see 
+      <a class="reference external"
+         href="https://github.com/intel-iot-devkit/upm/blob/master/docs/changelog.md">here</a>.</p>
+      
+    </div>
+    <div class="section" id="known-limitations"> 
+      <h3><tt class="docutils literal"><span class="pre">Known</span> 
+      <span class="pre">Limitations</span></tt><a class="headerlink"
+                                                  href="#known-limitations"
+                                                  title="Permalink to this headline">*</a></h3>
+      
+
+      <p>For the List of Known Limitations, please see 
+      <a class="reference external"
+         href="https://github.com/intel-iot-devkit/upm/blob/master/docs/knownlimitations.md">here</a>.</p>
+      
+    </div>
+    <div class="section" id="keyboard-shortcuts"> 
+      <h3><tt class="docutils literal"><span class="pre">Keyboard</span> 
+      <span class="pre">Shortcuts</span></tt><a class="headerlink"
+                                                href="#keyboard-shortcuts"
+                                                title="Permalink to this headline">*</a></h3>
+      
+      <ul>
+        <li>
+
+        <p>Press <kbd>s</kbd> to focus the API search box.</p> </li>
+        <li>
+
+        <p>Use <kbd>Up</kbd> and <kbd>Down</kbd> to select classes,
+        modules, and search results.</p> </li>
+        <li class="mac-only">
+
+        <p>With the API search box or sidebar focused, use <kbd><span class="cmd">&#8984;</span>-Left</kbd>
+        or <kbd><span class="cmd">&#8984;</span>-Right</kbd> to switch
+        sidebar tabs.</p> </li>
+        <li class="pc-only">
+
+        <p>With the API search box or sidebar focused, use <kbd>Ctrl+Left</kbd>
+        and <kbd>Ctrl+Right</kbd> to switch sidebar tabs.</p> </li>
+      </ul>
+    </div>
+  </div>

doxy/node/xml2js.js

@@ -69,6 +69,8 @@ var xml2js = {
   // CLASSES: {
   //   <class name>: {
   //     description: <class description>,
+  //     parent: <parent class name>,
+  //     group: <group name>,
   //     methods: { ... },
   //     variables: {
   //       <variable name>: {
@@ -83,7 +85,9 @@ var xml2js = {
   // CLASSGROUPS: {
   //   <group name>: {
   //     description: <group description>,
-  //     classes: [ <class name>, ... ]
+  //     classes: [ <class name>, ... ],
+  //     enums: { ... },
+  //     enums_by_group: { ... }
   //   }, ...
   // }
   MODULE: '',
@@ -98,7 +102,8 @@ var xml2js = {
   TYPEMAPS: {
     '^(const)?\\s*(unsigned|signed)?\\s*(int|short|long|float|double|size_t|u?int\\d{1,2}_t)?$': 'Number',
     '^bool$': 'Boolean',
-    '^(const)?\\s*(unsigned|signed)?\\s*(char|char\\s*\\*|std::string)$': 'String'  // TODO: verify that swig does this mapping
+    '^(const)?\\s*(unsigned|signed)?\\s*(char|char\\s*\\*|std::string)$': 'String',  // TODO: verify that swig does this mapping
+    '^void\\s*\\(\\s*\\*\\s*\\)\\s*\\(\\s*void\\s*\\*\\)\\s*$': 'Function'
   },
 
 
@@ -157,13 +162,14 @@ var xml2js = {
           try {
             var spec_c = xmlparser.parse(xml)[0];
             var className = getName(spec_c);
-            xml2js.CLASSES[className] = {
+            _.extend(xml2js.CLASSES[className], {
               description: getDescription(spec_c),
+              parent: getParent(spec_c, className),
               enums: getEnums(spec_c, false, className),
               enums_by_group: getEnums(spec_c, true, className),
               variables: getVariables(spec_c, className),
               methods: getMethods(spec_c, className)
-            };
+            });
           } catch(e) {
             console.log(e.toString() + ': class ' + className + ' was not parsed correctly.');
           }
@@ -177,15 +183,48 @@ var xml2js = {
           return fs.readFileAsync(xml2js.opts.inputdir + '/' + fn, 'utf8').then(function(xml) {
             var spec_c = xmlparser.parse(xml)[0];
             if (_.isEmpty(getSubmodules(spec_c))) {
-              xml2js.CLASSGROUPS[getName(spec_c)] = {
+              var group = getName(spec_c);
+              var classes = getSubclassNames(spec_c);
+              xml2js.CLASSGROUPS[group] = {
                 description: getDescription(spec_c),
-                classes: getSubclassNames(spec_c)
-              }
+                classes: classes
+              };
+              _.each(classes, function(c) {
+                if (_.has(xml2js.CLASSES, c)) {
+                  xml2js.CLASSES[c].group = group;
+                } else {
+                  console.log('Warning: Group ' + group + ' has unknown class ' + c);
+                }
+              });
             }
           });
         }));
       });
       return Promise.all(parseClasses.concat(parseGroups));
+    }).then(function() {
+      if (!_.isEmpty(xml2js.CLASSGROUPS)) {
+        // try to categorize ungrouped classes, if any
+        var grouped = _.flatten(_.pluck(_.values(xml2js.CLASSGROUPS), 'classes'));
+        var ungrouped = _.difference(_.keys(xml2js.CLASSES), grouped);
+        _.each(ungrouped, function(c) {
+          _.each(findUsage(c), function(group) {
+            xml2js.CLASSGROUPS[group].classes.push(c);
+          });
+        });
+        grouped = _.flatten(_.pluck(_.values(xml2js.CLASSGROUPS), 'classes'));
+        ungrouped = _.difference(_.keys(xml2js.CLASSES), grouped);
+        // try to categorize ungrouped enums, if any
+        _.each(xml2js.ENUMS_BY_GROUP, function(enumGroupSpec, enumGroupName) {
+          _.each(findUsage(enumGroupName, true), function(c) {
+            xml2js.CLASSES[c].enums_by_group[enumGroupName] = enumGroupSpec;            
+            _.each(enumGroupSpec.members, function(enumName) {
+              xml2js.CLASSES[c].enums[enumName] = xml2js.ENUMS[enumName];
+              delete xml2js.ENUMS[enumName];
+            });
+            delete xml2js.ENUMS_BY_GROUP[enumGroupName];
+          });
+        });
+      }
     }).then(function() {
       if (xml2js.opts.custom && fs.existsSync(xml2js.opts.custom)) {
         return fs.readFileAsync(xml2js.opts.custom, 'utf8').then(function(custom) {
@@ -199,9 +238,9 @@ var xml2js = {
         console.log(xml2js.opts.custom ? ('Error: No such customization file exists: ' + xml2js.opts.custom) : 'No customizations given.');
       }
     }).then(function() {
+      generateCustomPointerClasses();       
       validateMethods();
       validateVars();
-      generateCustomPointerClasses();
       return _.pick(xml2js, 'MODULE', 'ENUMS', 'ENUMS_BY_GROUP', 'METHODS', 'CLASSES', 'CLASSGROUPS');
     });
   }
@@ -391,7 +430,30 @@ function generateCustomPointerClasses() {
 }
 
 
-// override autogenerated methods with custom configuration
+// search for usage of a type
+function findUsage(type, classOnly) {
+  var filterClasses = function(fn) { return _.without(_.map(xml2js.CLASSES, fn), undefined); };
+  var usesType = function(classSpec, className) {
+    var methodsOfType = (_.find(classSpec.methods, function(methodSpec, methodName) {
+      return ((!_.isEmpty(methodSpec.return) && methodSpec.return.type == type) || 
+              (_.contains(_.pluck(methodSpec.params, 'type'), type)));
+    }) != undefined);
+    var variablesOfType = _.contains(_.pluck(classSpec.variable, 'type'), type);
+    return ((methodsOfType || variablesOfType) ? className : undefined);
+  };
+  var extendsType = function(classSpec, className) {
+    return ((classSpec.parent == type) ? className : undefined);
+  };
+  var classes = _.union(filterClasses(usesType), filterClasses(extendsType));
+  if (classOnly) {
+    return classes;
+  } else {
+    return _.without(_.uniq(_.pluck(_.pick(xml2js.CLASSES, classes), 'group')), undefined);
+  }
+}
+
+
+// override autogenerated methods with custom configuration 
 function customizeMethods(custom) {
   _.each(custom, function(classMethods, className) {
     _.extend(xml2js.CLASSES[className].methods, _.pick(classMethods, function(methodSpec, methodName) {
@@ -527,6 +589,19 @@ function getSubmodules(spec_c) {
 }
 
 
+// get parent class, if any
+function getParent(spec_c, className) {
+  var parent = getChild(spec_c, 'basecompoundref');
+  if (parent) {
+    parent = getText(parent);
+    if (!_.has(xml2js.CLASSES, parent)) {
+      console.log('WARNING: Class ' + className + ' has unknown parent class ' + parent);
+    }
+  }
+  return parent;
+}
+
+
 function hasParams(paramsSpec) {
   return !(_.isEmpty(paramsSpec) ||
            ((_.size(paramsSpec) == 1) && getText(getChild(paramsSpec[0], 'type')) == 'void'));
@@ -559,6 +634,7 @@ function getMethods(spec_c, parent) {
           if (!_.isEmpty(returnSpec)) {
             retval = getReturn(returnSpec, getReturnDetails(description), methodName, parent);
           }
+          methodName = getUniqueMethodName(methodName, spec_js, parent);
           spec_js[methodName] = {
             description: methodDescription,
             params: params,
@@ -575,6 +651,17 @@ function getMethods(spec_c, parent) {
 }
 
 
+// get a unique string to represent the name of an overloaded method
+function getUniqueMethodName(methodName, module, parent) {
+  if (methodName in module) {
+    do {
+      methodName += '!';
+    } while (methodName in module);
+  }
+  return methodName;
+}
+
+
 // get variable specifications for a class
 function getVariables(spec_c, parent) {
   var spec_js = {};

doxy/samples.mapping.txt

@@ -0,0 +1,73 @@
+# Mapping C++ sample files to Java sample files
+a110x-intr.cxx	A110X_intrSample.java
+a110x.cxx	A110XSample.java
+adc121c021.cxx	ADC121C021Sample.java
+adxl345.cxx	Adxl345Sample.java
+biss0001.cxx	BISS0001Sample.java
+bmpx8x.cxx	BMPX8XSample.java
+buzzer-sound.cxx	Buzzer_soundSample.java
+cjq4435.cxx	CJQ4435Sample.java
+ds1307.cxx	DS1307Sample.java
+enc03r.cxx	ENC03RSample.java
+es08a.cxx	ES08ASample.java
+grovebutton.cxx	GroveButtonSample.java
+groveehr.cxx	GroveEHRSample.java
+groveled.cxx	GroveLEDSample.java
+grovelinefinder.cxx	GroveLineFinderSample.java
+grovelight.cxx	GroveLightSample.java
+grovemoisture.cxx	GroveMoistureSample.java
+groverelay.cxx	GroveRelaySample.java
+groverotary.cxx	GroveRotarySample.java
+grovescam.cxx	GROVESCAMSample.java
+groveslide.cxx	GroveSlideSample.java
+grovespeaker.cxx	GroveSpeakerSample.java
+grovevdiv.cxx	GroveVDivSample.java
+grovewater.cxx	GroveWaterSample.java
+grovewfs.cxx	GroveWFSSample.java
+guvas12d.cxx	GUVAS12DSample.java
+h3lis331dl.cxx	H3LIS331DLSample.java
+hcsr04.cxx	HCSR04Sample.java
+hm11.cxx	HM11Sample.java
+hmc5883l.cxx	Hmc5883lSample.java
+htu21d.cxx	HTU21DSample.java
+itg3200.cxx	Itg3200Sample.java
+jhd1313m1-lcd.cxx	Jhd1313m1_lcdSample.java
+joystick12.cxx	Joystick12Sample.java
+lcm1602-i2c.cxx	Lcm1602_i2cSample.java
+ldt0028.cxx	LDT0028Sample.java
+lol.cxx	LoLSample.java
+lsm303.cxx	LSM303Sample.java
+m24lr64e.cxx	M24LR64ESample.java
+max44000.cxx	MAX44000Sample.java
+mic.cxx	MicrophoneSample.java
+mma7455.cxx	MMA7455Sample.java
+mma7660.cxx	MMA7660Sample.java
+mpl3115a2.cxx	MPL3115A2Sample.java
+mpr121.cxx	MPR121Sample.java
+mpu9150.cxx	MPU9150Sample.java
+mq2.cxx	MQ2Sample.java
+mq303a.cxx	MQ303ASample.java
+mq5.cxx	MQ5Sample.java
+groveledbar	GroveLEDBar
+nrf24l01-receiver.cxx	NRF24L01_receiverSample.java
+nrf24l01-transmitter.cxx	NRF24L01_transmitterSample.java
+nunchuck.cxx	NUNCHUCKSample.java
+otp538u.cxx	OTP538USample.java
+ppd42ns.cxx	PPD42NSSample.java
+pulsensor.cxx	PulsensorSample.java
+rfr359f.cxx	RFR359FSample.java
+rotaryencoder.cxx	RotaryEncoderSample.java
+rpr220-intr.cxx	RPR220_intrSample.java
+rpr220.cxx	RPR220Sample.java
+ssd1308-oled.cxx	SSD1308_oledSample.java
+ssd1327-oled.cxx	SSD1327_oledSample.java
+st7735.cxx	ST7735Sample.java
+stepmotor.cxx	StepMotorSample.java
+tm1637.cxx	TM1637Sample.java
+tp401.cxx	TP401Sample.java
+tsl2561.cxx	TSL2561Sample.java
+ttp223.cxx	TTP223Sample.java
+ublox6.cxx	Ublox6Sample.java
+uln200xa.cxx	ULN200XASample.java
+wt5001.cxx	WT5001Sample.java
+yg1006.cxx	YG1006Sample.java

examples/c++/CMakeLists.txt

@@ -1,347 +1,305 @@
+# Extract module name from non-standard example name
+macro(get_module_name example_name module_name)
+  string(LENGTH ${example_name} length)
+  string(FIND ${example_name} "-" index)
+  if (${index} GREATER 1)
+    string(SUBSTRING ${example_name} 0 ${index} substr)
+    set(${module_name} ${substr})
+  elseif (${example_name} MATCHES "^grove")
+    set (${module_name} "grove")
+  elseif ((${example_name} MATCHES "^mq" AND ${length} EQUAL 3) OR ${example_name} STREQUAL "tp401")
+    set (${module_name} "gas")
+  else()
+    set(${module_name} ${example_name})
+  endif()
+endmacro()
+
+# Set source file, include and linker settings for an example
+# If example cannot be built, example_bin is cleared
+macro(add_custom_example example_bin example_src example_module_list)
+  set(found_all_modules TRUE)
+  foreach (module ${example_module_list})
+    if (NOT EXISTS "${PROJECT_SOURCE_DIR}/src/${module}")
+      set(found_all_modules FALSE)
+    endif()
+    if (MODULE_LIST)
+      list(FIND MODULE_LIST ${module} index)
+      if (${index} EQUAL -1)
+        set(found_all_modules FALSE)
+      endif()
+    endif()
+  endforeach()
+  if (found_all_modules)
+    add_executable (${example_bin} ${example_src})
+    target_link_libraries (${example_bin} ${CMAKE_THREAD_LIBS_INIT})
+    foreach (module ${example_module_list})
+      set(module_dir "${PROJECT_SOURCE_DIR}/src/${module}")
+      include_directories (${module_dir})
+      if (${module} STREQUAL "lcd")
+        set(module "i2clcd")
+      endif()
+      target_link_libraries (${example_bin} ${module})
+    endforeach()
+  else()
+   MESSAGE(INFO " Ignored ${example_bin}")
+   set (example_bin "")
+  endif()
+endmacro()
+
+
+# Add specified example by name
+# Note special case for grove based examples
+macro(add_example example_name)
+  set(example_src "${example_name}.cxx")
+  set(example_bin "${example_name}-example")
+  get_module_name(${example_name} module_name)
+  set(module_dir "${PROJECT_SOURCE_DIR}/src/${module_name}")
+  if (EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/${example_src}"
+     AND EXISTS ${module_dir}
+     AND IS_DIRECTORY ${module_dir})
+    add_custom_example(${example_bin} ${example_src} ${module_name})
+    if ((NOT ${example_bin} STREQUAL "") AND (${module_name} STREQUAL "grove"))
+      set(grove_module_path "${PROJECT_SOURCE_DIR}/src/${example_name}")
+      if (EXISTS ${grove_module_path})
+        include_directories(${grove_module_path})
+        target_link_libraries (${example_bin} ${example_name})
+      endif()
+    endif()
+  else()
+   MESSAGE(INFO " Ignored ${example_bin}")
+  endif()
+endmacro()
+
+
 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/examples)
 
-add_executable (hmc5883l-example hmc5883l.cxx)
-add_executable (groveled-example groveled.cxx)
-add_executable (groveled-multi-example groveled-multi.cxx)
-add_executable (groverelay-example groverelay.cxx)
-add_executable (grovelight-example grovelight.cxx)
-add_executable (grovetemp-example grovetemp.cxx)
-add_executable (grovebutton-example grovebutton.cxx)
-add_executable (groverotary-example groverotary.cxx)
-add_executable (groveslide-example groveslide.cxx)
-add_executable (lcm1602-lcd-example lcm1602-lcd.cxx)
-add_executable (jhd1313m1-lcd-example jhd1313m1-lcd.cxx)
-add_executable (buzzer-sound-example buzzer-sound.cxx)
-add_executable (my9221-ledbar-example my9221-ledbar.cxx)
-add_executable (my9221-updown-example my9221-updown.cxx)
-add_executable (nrf24l01-transmitter-example nrf24l01-transmitter.cxx)
-add_executable (nrf24l01-receiver-example nrf24l01-receiver.cxx)
-add_executable (nrf24l01-broadcast-example nrf24l01-broadcast.cxx)
-add_executable (es08a-example es08a.cxx)
-add_executable (son-hcsr04-example hcsr04.cxx)
-add_executable (ssd1308-oled-example ssd1308-oled.cxx)
-add_executable (ssd1327-oled-example ssd1327-oled.cxx)
-add_executable (max44000-example max44000.cxx)
-add_executable (mma7455-example mma7455.cxx)
-add_executable (st7735-example st7735.cxx)
-add_executable (max31855-example max31855.cxx)
-add_executable (bmpx8x-example bmpx8x.cxx)
-add_executable (stepmotor-example stepmotor.cxx)
-add_executable (pulsensor-example pulsensor.cxx)
-add_executable (mic-example mic.cxx)
-add_executable (mpu9150-example mpu9150.cxx)
-add_executable (maxds3231m-example maxds3231m.cxx)
-add_executable (max31723-example max31723.cxx)
-add_executable (max5487-example max5487.cxx)
-add_executable (nrf8001-broadcast-example nrf8001-broadcast.cxx)
-add_executable (nrf8001-helloworld-example nrf8001-helloworld.cxx)
-add_executable (lpd8806-example lpd8806.cxx)
-add_executable (mlx90614-example mlx90614.cxx)
-add_executable (ecs1030-example ecs1030.cxx)
-add_executable (mq2-example mq2.cxx)
-add_executable (mq3-example mq3.cxx)
-add_executable (mq5-example mq5.cxx)
-add_executable (mq9-example mq9.cxx)
-add_executable (tp401-example tp401.cxx)
-add_executable (tcs3414cs-example tcs3414cs.cxx)
-add_executable (th02-example th02.cxx)
-add_executable (ttp223-example ttp223.cxx)
-add_executable (lsm303-example lsm303.cxx)
-add_executable (joystick12-example joystick12-example.cxx)
-add_executable (lol-example lol-example.cxx)
-add_executable (tsl2561-example tsl2561.cxx)
-add_executable (htu21d-example htu21d.cxx)
-add_executable (mpl3115a2-example mpl3115a2.cxx)
-add_executable (ldt0028-example ldt0028.cxx)
-add_executable (am2315-example am2315.cxx)
-add_executable (itg3200-example itg3200.cxx)
-add_executable (enc03r-example enc03r.cxx)
-add_executable (adc121c021-example adc121c021.cxx)
-add_executable (ds1307-example ds1307.cxx)
-add_executable (a110x-example a110x.cxx)
-add_executable (gp2y0a-example gp2y0a.cxx)
-add_executable (grovemoisture-example grovemoisture.cxx)
-add_executable (groveehr-example groveehr.cxx)
-add_executable (ta12200-example ta12200.cxx)
-add_executable (grovelinefinder-example grovelinefinder.cxx)
-add_executable (grovevdiv-example grovevdiv.cxx)
-add_executable (grovewater-example grovewater.cxx)
-add_executable (guvas12d-example guvas12d.cxx)
-add_executable (groveloudness-example groveloudness.cxx)
-add_executable (mpr121-example mpr121.cxx)
-add_executable (ublox6-example ublox6.cxx)
-add_executable (yg1006-example yg1006.cxx)
-add_executable (wt5001-example wt5001.cxx)
-add_executable (ppd42ns-example ppd42ns.cxx)
-add_executable (mq303a-example mq303a.cxx)
-add_executable (grovespeaker-example grovespeaker.cxx)
-add_executable (rfr359f-example rfr359f.cxx)
-add_executable (biss0001-example biss0001.cxx)
-add_executable (rotaryencoder-example rotaryencoder.cxx)
-add_executable (adxl345-example adxl345.cxx)
-add_executable (rpr220-example rpr220.cxx)
-add_executable (rpr220-intr-example rpr220-intr.cxx)
-add_executable (mma7660-example mma7660.cxx)
-add_executable (cjq4435-example cjq4435.cxx)
-add_executable (adxl335-example adxl335.cxx)
-add_executable (hmtrp-example hmtrp.cxx)
-add_executable (nunchuck-example nunchuck.cxx)
-add_executable (otp538u-example otp538u.cxx)
-add_executable (grovecollision-example grovecollision.cxx)
-add_executable (groveelectromagnet-example groveelectromagnet.cxx)
-add_executable (groveemg-example groveemg.cxx)
-add_executable (groveo2-example groveo2.cxx)
-add_executable (grovegsr-example grovegsr.cxx)
-add_executable (ina132-example ina132.cxx)
-add_executable (l298-example l298.cxx)
-add_executable (l298-stepper-example l298-stepper.cxx)
-add_executable (at42qt1070-example at42qt1070.cxx)
-add_executable (grovemd-example grovemd.cxx)
-add_executable (pca9685-example pca9685.cxx)
-add_executable (groveeldriver-example groveeldriver.cxx)
-add_executable (adafruitss-example adafruitss.cxx)
-add_executable (adafruitms1438-example adafruitms1438.cxx)
-add_executable (adafruitms1438-stepper-example adafruitms1438-stepper.cxx)
-add_executable (hx711-example hx711.cxx)
-add_executable (flex-example flex.cxx)
-add_executable (a110x-intr-example a110x-intr.cxx)
-add_executable (mhz16-example mhz16.cxx)
-add_executable (apds9002-example apds9002.cxx)
-add_executable (waterlevel-example waterlevel.cxx)
-add_executable (tm1637-example tm1637.cxx)
-add_executable (zfm20-example zfm20.cxx)
-add_executable (zfm20-register-example zfm20-register.cxx)
-add_executable (uln200xa-example uln200xa.cxx)
-add_executable (grovewfs-example grovewfs.cxx)
-add_executable (isd1820-example isd1820.cxx)
-add_executable (sx6119-example sx6119.cxx)
-add_executable (si114x-example si114x.cxx)
-add_executable (maxsonarez-example maxsonarez.cxx)
-add_executable (hm11-example hm11.cxx)
-add_executable (ht9170-example ht9170.cxx)
-add_executable (h3lis331dl-example h3lis331dl.cxx)
-add_executable (ad8232-example ad8232.cxx)
-add_executable (grovescam-example grovescam.cxx)
+# Set the mraa include and link directories prior to adding examples
+include_directories (${MRAA_INCLUDE_DIRS})
+link_directories (${MRAA_LIBDIR})
 
-include_directories (${PROJECT_SOURCE_DIR}/src/hmc5883l)
-include_directories (${PROJECT_SOURCE_DIR}/src/grove)
-include_directories (${PROJECT_SOURCE_DIR}/src/lcd)
-include_directories (${PROJECT_SOURCE_DIR}/src/buzzer)
-include_directories (${PROJECT_SOURCE_DIR}/src/my9221)
-include_directories (${PROJECT_SOURCE_DIR}/src/nrf24l01)
-include_directories (${PROJECT_SOURCE_DIR}/src/servo)
-include_directories (${PROJECT_SOURCE_DIR}/src/hcsr04)
-include_directories (${PROJECT_SOURCE_DIR}/src/max44000)
-include_directories (${PROJECT_SOURCE_DIR}/src/mma7455)
-include_directories (${PROJECT_SOURCE_DIR}/src/st7735)
-include_directories (${PROJECT_SOURCE_DIR}/src/max31855)
-include_directories (${PROJECT_SOURCE_DIR}/src/bmpx8x)
-include_directories (${PROJECT_SOURCE_DIR}/src/stepmotor)
-include_directories (${PROJECT_SOURCE_DIR}/src/pulsensor)
-include_directories (${PROJECT_SOURCE_DIR}/src/mic)
-include_directories (${PROJECT_SOURCE_DIR}/src/mpu9150)
-include_directories (${PROJECT_SOURCE_DIR}/src/maxds3231m)
-include_directories (${PROJECT_SOURCE_DIR}/src/max31723)
-include_directories (${PROJECT_SOURCE_DIR}/src/max5487)
-include_directories (${PROJECT_SOURCE_DIR}/src/nrf8001)
-include_directories (${PROJECT_SOURCE_DIR}/src/lpd8806)
-include_directories (${PROJECT_SOURCE_DIR}/src/mlx90614)
-include_directories (${PROJECT_SOURCE_DIR}/src/ecs1030)
-include_directories (${PROJECT_SOURCE_DIR}/src/gas)
-include_directories (${PROJECT_SOURCE_DIR}/src/tcs3414cs)
-include_directories (${PROJECT_SOURCE_DIR}/src/th02)
-include_directories (${PROJECT_SOURCE_DIR}/src/ttp223)
-include_directories (${PROJECT_SOURCE_DIR}/src/lsm303)
-include_directories (${PROJECT_SOURCE_DIR}/src/joystick12)
-include_directories (${PROJECT_SOURCE_DIR}/src/lol)
-include_directories (${PROJECT_SOURCE_DIR}/src/tsl2561)
-include_directories (${PROJECT_SOURCE_DIR}/src/htu21d)
-include_directories (${PROJECT_SOURCE_DIR}/src/mpl3115a2)
-include_directories (${PROJECT_SOURCE_DIR}/src/ldt0028)
-include_directories (${PROJECT_SOURCE_DIR}/src/am2315)
-include_directories (${PROJECT_SOURCE_DIR}/src/itg3200)
-include_directories (${PROJECT_SOURCE_DIR}/src/enc03r)
-include_directories (${PROJECT_SOURCE_DIR}/src/adc121c021)
-include_directories (${PROJECT_SOURCE_DIR}/src/ds1307)
-include_directories (${PROJECT_SOURCE_DIR}/src/a110x)
-include_directories (${PROJECT_SOURCE_DIR}/src/gp2y0a)
-include_directories (${PROJECT_SOURCE_DIR}/src/grovemoisture)
-include_directories (${PROJECT_SOURCE_DIR}/src/groveehr)
-include_directories (${PROJECT_SOURCE_DIR}/src/ta12200)
-include_directories (${PROJECT_SOURCE_DIR}/src/grovelinefinder)
-include_directories (${PROJECT_SOURCE_DIR}/src/grovevdiv)
-include_directories (${PROJECT_SOURCE_DIR}/src/grovewater)
-include_directories (${PROJECT_SOURCE_DIR}/src/guvas12d)
-include_directories (${PROJECT_SOURCE_DIR}/src/groveloudness)
-include_directories (${PROJECT_SOURCE_DIR}/src/mpr121)
-include_directories (${PROJECT_SOURCE_DIR}/src/ublox6)
-include_directories (${PROJECT_SOURCE_DIR}/src/yg1006)
-include_directories (${PROJECT_SOURCE_DIR}/src/wt5001)
-include_directories (${PROJECT_SOURCE_DIR}/src/ppd42ns)
-include_directories (${PROJECT_SOURCE_DIR}/src/mq303a)
-include_directories (${PROJECT_SOURCE_DIR}/src/grovespeaker)
-include_directories (${PROJECT_SOURCE_DIR}/src/rfr359f)
-include_directories (${PROJECT_SOURCE_DIR}/src/biss0001)
-include_directories (${PROJECT_SOURCE_DIR}/src/rotaryencoder)
-include_directories (${PROJECT_SOURCE_DIR}/src/adxl345)
-include_directories (${PROJECT_SOURCE_DIR}/src/rpr220)
-include_directories (${PROJECT_SOURCE_DIR}/src/mma7660)
-include_directories (${PROJECT_SOURCE_DIR}/src/cjq4435)
-include_directories (${PROJECT_SOURCE_DIR}/src/adxl335)
-include_directories (${PROJECT_SOURCE_DIR}/src/hmtrp)
-include_directories (${PROJECT_SOURCE_DIR}/src/nunchuck)
-include_directories (${PROJECT_SOURCE_DIR}/src/otp538u)
-include_directories (${PROJECT_SOURCE_DIR}/src/grovecollision)
-include_directories (${PROJECT_SOURCE_DIR}/src/groveelectromagnet)
-include_directories (${PROJECT_SOURCE_DIR}/src/groveemg)
-include_directories (${PROJECT_SOURCE_DIR}/src/groveo2)
-include_directories (${PROJECT_SOURCE_DIR}/src/grovegsr)
-include_directories (${PROJECT_SOURCE_DIR}/src/ina132)
-include_directories (${PROJECT_SOURCE_DIR}/src/l298)
-include_directories (${PROJECT_SOURCE_DIR}/src/at42qt1070)
-include_directories (${PROJECT_SOURCE_DIR}/src/grovemd)
-include_directories (${PROJECT_SOURCE_DIR}/src/pca9685)
-include_directories (${PROJECT_SOURCE_DIR}/src/groveeldriver)
-include_directories (${PROJECT_SOURCE_DIR}/src/adafruitss)
-include_directories (${PROJECT_SOURCE_DIR}/src/adafruitms1438)
-include_directories (${PROJECT_SOURCE_DIR}/src/hx711)
-include_directories (${PROJECT_SOURCE_DIR}/src/flex)
-include_directories (${PROJECT_SOURCE_DIR}/src/mhz16)
-include_directories (${PROJECT_SOURCE_DIR}/src/apds9002)
-include_directories (${PROJECT_SOURCE_DIR}/src/waterlevel)
-include_directories (${PROJECT_SOURCE_DIR}/src/tm1637)
-include_directories (${PROJECT_SOURCE_DIR}/src/zfm20)
-include_directories (${PROJECT_SOURCE_DIR}/src/uln200xa)
-include_directories (${PROJECT_SOURCE_DIR}/src/grovewfs)
-include_directories (${PROJECT_SOURCE_DIR}/src/isd1820)
-include_directories (${PROJECT_SOURCE_DIR}/src/sx6119)
-include_directories (${PROJECT_SOURCE_DIR}/src/si114x)
-include_directories (${PROJECT_SOURCE_DIR}/src/maxsonarez)
-include_directories (${PROJECT_SOURCE_DIR}/src/hm11)
-include_directories (${PROJECT_SOURCE_DIR}/src/ht9170)
-include_directories (${PROJECT_SOURCE_DIR}/src/h3lis331dl)
-include_directories (${PROJECT_SOURCE_DIR}/src/ad8232)
-include_directories (${PROJECT_SOURCE_DIR}/src/grovescam)
+# If your sample source file matches the name of the module it tests, add it here
+# Exceptions are as follows:
+#  string after first '-' is ignored (e.g. nrf24l01-transmitter maps to nrf24l01)
+#  mq? will use module gas
+#  grove* will use module grove
+add_example (hmc5883l)
+add_example (groveled)
+add_example (groverelay)
+add_example (grovelight)
+add_example (grovetemp)
+add_example (grovebutton)
+add_example (groverotary)
+add_example (groveslide)
+add_example (buzzer-sound)
+add_example (nrf24l01-transmitter)
+add_example (nrf24l01-receiver)
+add_example (nrf24l01-broadcast)
+add_example (hcsr04)
+add_example (max44000)
+add_example (mma7455)
+add_example (st7735)
+add_example (max31855)
+add_example (bmpx8x)
+add_example (stepmotor)
+add_example (pulsensor)
+add_example (mic)
+add_example (mpu9150)
+add_example (maxds3231m)
+add_example (max31723)
+add_example (max5487)
+add_example (nrf8001-broadcast)
+add_example (nrf8001-helloworld)
+add_example (lpd8806)
+add_example (mlx90614)
+add_example (ecs1030)
+add_example (mq2)
+add_example (mq3)
+add_example (mq4)
+add_example (mq5)
+add_example (mq6)
+add_example (mq7)
+add_example (mq8)
+add_example (mq9)
+add_example (tp401)
+add_example (tcs3414cs)
+add_example (th02)
+add_example (ttp223)
+add_example (lsm303)
+add_example (joystick12)
+add_example (lol)
+add_example (tsl2561)
+add_example (htu21d)
+add_example (mpl3115a2)
+add_example (ldt0028)
+add_example (am2315)
+add_example (itg3200)
+add_example (enc03r)
+add_example (adc121c021)
+add_example (ds1307)
+add_example (a110x)
+add_example (gp2y0a)
+add_example (grovemoisture)
+add_example (groveehr)
+add_example (ta12200)
+add_example (grovelinefinder)
+add_example (grovevdiv)
+add_example (grovewater)
+add_example (guvas12d)
+add_example (mpr121)
+add_example (ublox6)
+add_example (yg1006)
+add_example (wt5001)
+add_example (ppd42ns)
+add_example (mq303a)
+add_example (grovespeaker)
+add_example (rfr359f)
+add_example (biss0001)
+add_example (rotaryencoder)
+add_example (adxl345)
+add_example (rpr220)
+add_example (rpr220-intr)
+add_example (mma7660)
+add_example (cjq4435)
+add_example (adxl335)
+add_example (hmtrp)
+add_example (nunchuck)
+add_example (otp538u)
+add_example (grovecollision)
+add_example (groveelectromagnet)
+add_example (groveemg)
+add_example (groveo2)
+add_example (grovegsr)
+add_example (ina132)
+add_example (l298)
+add_example (l298-stepper)
+add_example (at42qt1070)
+add_example (grovemd)
+add_example (grovemd-stepper)
+add_example (pca9685)
+add_example (groveeldriver)
+add_example (adafruitss)
+add_example (adafruitms1438)
+add_example (adafruitms1438-stepper)
+add_example (hx711)
+add_example (flex)
+add_example (a110x-intr)
+add_example (mhz16)
+add_example (apds9002)
+add_example (waterlevel)
+add_example (tm1637)
+add_example (zfm20)
+add_example (zfm20-register)
+add_example (uln200xa)
+add_example (grovewfs)
+add_example (isd1820)
+add_example (sx6119)
+add_example (si114x)
+add_example (maxsonarez)
+add_example (hm11)
+add_example (ht9170)
+add_example (h3lis331dl)
+add_example (ad8232)
+add_example (grovescam)
+add_example (m24lr64e)
+add_example (rgbringcoder)
+add_example (hp20x)
+add_example (pn532)
+add_example (pn532-writeurl)
+add_example (lsm9ds0)
+add_example (loudness)
+add_example (mg811)
+add_example (wheelencoder)
+add_example (sm130)
+add_example (grovegprs)
+add_example (lm35)
+add_example (micsv89)
+add_example (xbee)
+add_example (urm37)
+add_example (urm37-uart)
+add_example (adxrs610)
+add_example (bma220)
+add_example (dfrph)
+add_example (mcp9808)
+add_example (groveultrasonic)
+add_example (sx1276-lora)
+add_example (sx1276-fsk)
+add_example (ili9341)
+if (OPENZWAVE_FOUND)
+  include_directories(${OPENZWAVE_INCLUDE_DIRS})
+  add_example (ozw)
+endif()
+add_example (nlgpio16)
+add_example (ads1x15)
+if (MODBUS_FOUND)
+  include_directories(${MODBUS_INCLUDE_DIRS})
+  add_example (t3311)
+  add_example (hwxpxx)
+  add_example (h803x)
+endif()
+add_example (hdxxvxta)
+add_example (rhusb)
+add_example (apds9930)
+add_example (kxcjk1013)
+add_example (ssd1351)
+add_example (ds1808lc)
+add_example (hlg150h)
+add_example (lp8860)
+add_example (max44009)
+add_example (si1132)
+add_example (si7005)
+add_example (t6713)
+add_example (cwlsxxa)
+add_example (teams)
+add_example (apa102)
+add_example (tex00)
+add_example (bmi160)
+add_example (smartdrive)
+if (HAVE_FIRMATA)
+  add_example (curieimu)
+endif ()
+if (BACNET_FOUND)
+  include_directories(${BACNET_INCLUDE_DIRS})
+  # we need access to bacnetmstp headers too
+  include_directories(${PROJECT_SOURCE_DIR}/src/bacnetmstp)
+  add_example (e50hx)
+  add_example (t8100)
+  add_example (tb7300)
+endif()
+add_example (vcap)
+add_example (ds2413)
+add_example (ds18b20)
+add_example (bmp280)
+add_example (bno055)
+add_example (l3gd20)
+add_example (bmx055)
 
-target_link_libraries (hmc5883l-example hmc5883l ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (groveled-example grove ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (groveled-multi-example grove ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (groverelay-example grove ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (grovelight-example grove ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (grovetemp-example grove ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (grovebutton-example grove ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (groverotary-example grove ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (groveslide-example grove ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (lcm1602-lcd-example i2clcd ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (jhd1313m1-lcd-example i2clcd ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (buzzer-sound-example buzzer ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (my9221-ledbar-example my9221 ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (my9221-updown-example my9221 ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (nrf24l01-transmitter-example nrf24l01 ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (nrf24l01-receiver-example nrf24l01 ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (nrf24l01-broadcast-example nrf24l01 ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (es08a-example servo ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (son-hcsr04-example hcsr04 ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (ssd1308-oled-example i2clcd ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (ssd1327-oled-example i2clcd ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (max44000-example max44000 ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (mma7455-example mma7455 ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (st7735-example st7735 ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (max31855-example max31855 ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (bmpx8x-example bmpx8x ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (stepmotor-example stepmotor ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (pulsensor-example pulsensor ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (mic-example mic ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (mpu9150-example mpu9150 ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (maxds3231m-example maxds3231m ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (max31723-example max31723 ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (max5487-example max5487 ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (nrf8001-broadcast-example nrf8001 ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (nrf8001-helloworld-example nrf8001 ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (lpd8806-example lpd8806 ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (mlx90614-example mlx90614 ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (ecs1030-example ecs1030 ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (mq2-example gas ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (mq3-example gas ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (mq5-example gas ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (mq9-example gas ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (tp401-example gas ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (tcs3414cs-example tcs3414cs ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (th02-example th02 ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (ttp223-example ttp223 ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (lsm303-example lsm303 ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (joystick12-example joystick12 ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (lol-example lol ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (tsl2561-example tsl2561 ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (htu21d-example htu21d ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (mpl3115a2-example mpl3115a2 ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (ldt0028-example ldt0028 ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (am2315-example am2315 ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (itg3200-example itg3200 ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (enc03r-example enc03r ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (adc121c021-example adc121c021 ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (ds1307-example ds1307 ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (a110x-example a110x ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (gp2y0a-example gp2y0a ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (grovemoisture-example grovemoisture ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (groveehr-example groveehr ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (ta12200-example ta12200 ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (grovelinefinder-example grovelinefinder ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (grovevdiv-example grovevdiv ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (grovewater-example grovewater ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (guvas12d-example guvas12d ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (groveloudness-example groveloudness ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (mpr121-example mpr121 ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (ublox6-example ublox6 ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (yg1006-example yg1006 ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (wt5001-example wt5001 ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (ppd42ns-example ppd42ns ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (mq303a-example mq303a ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (grovespeaker-example grovespeaker ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (rfr359f-example rfr359f ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (biss0001-example biss0001 ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (rotaryencoder-example rotaryencoder ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (adxl345-example adxl345 ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (rpr220-example rpr220 ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (rpr220-intr-example rpr220 ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (mma7660-example mma7660 ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (cjq4435-example cjq4435 ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (adxl335-example adxl335 ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (hmtrp-example hmtrp ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (nunchuck-example nunchuck ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (otp538u-example otp538u ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (grovecollision-example grovecollision ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (groveelectromagnet-example groveelectromagnet ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (groveemg-example groveemg ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (groveo2-example groveo2 ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (grovegsr-example grovegsr ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (ina132-example ina132 ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (l298-example l298 ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (l298-stepper-example l298 ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (at42qt1070-example at42qt1070 ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (grovemd-example grovemd ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (pca9685-example pca9685 ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (groveeldriver-example groveeldriver ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (adafruitss-example adafruitss ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (adafruitms1438-example adafruitms1438 ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (adafruitms1438-stepper-example adafruitms1438 ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (hx711-example hx711 ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (flex-example flex ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (a110x-intr-example a110x ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (mhz16-example mhz16 ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (apds9002-example apds9002 ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (waterlevel-example waterlevel ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (tm1637-example tm1637 ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (zfm20-example zfm20 ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (zfm20-register-example zfm20 ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (uln200xa-example uln200xa ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (grovewfs-example grovewfs ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (isd1820-example isd1820 ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (sx6119-example sx6119 ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (si114x-example si114x ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (maxsonarez-example maxsonarez ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (hm11-example hm11 ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (ht9170-example ht9170 ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (h3lis331dl-example h3lis331dl ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (ad8232-example ad8232 ${CMAKE_THREAD_LIBS_INIT})
-target_link_libraries (grovescam-example grovescam ${CMAKE_THREAD_LIBS_INIT})
+# These are special cases where you specify example binary, source file and module(s)
+include_directories (${PROJECT_SOURCE_DIR}/src)
+add_custom_example (groveled-multi-example groveled-multi.cxx grove)
+add_custom_example (lcm1602-i2c-example lcm1602-i2c.cxx lcd)
+add_custom_example (lcm1602-parallel-example lcm1602-parallel.cxx lcd)
+add_custom_example (jhd1313m1-lcd-example jhd1313m1-lcd.cxx lcd)
+add_custom_example (es08a-example es08a.cxx servo)
+add_custom_example (ssd1306-oled-example ssd1306-oled.cxx lcd)
+add_custom_example (ssd1308-oled-example ssd1308-oled.cxx lcd)
+add_custom_example (ssd1327-oled-example ssd1327-oled.cxx lcd)
+add_custom_example (sainsmartks-example sainsmartks.cxx lcd)
+add_custom_example (eboled-example eboled.cxx lcd)
+add_custom_example (mpu60x0-example mpu60x0.cxx mpu9150)
+add_custom_example (ak8975-example ak8975.cxx mpu9150)
+add_custom_example (mpu9250-example mpu9250.cxx mpu9150)
+add_custom_example (groveledbar-example groveledbar.cxx my9221)
+add_custom_example (grovecircularled-example grovecircularled.cxx my9221)
+add_custom_example (temperature-sensor-example temperature-sensor.cxx "si7005;bmpx8x;bme280")
+add_custom_example (humidity-sensor-example humidity-sensor.cxx "si7005;bme280")
+add_custom_example (pressure-sensor-example pressure-sensor.cxx "bmpx8x;bme280")
+add_custom_example (co2-sensor-example co2-sensor.cxx "t6713")
+add_custom_example (adc-example adc-sensor.cxx "ads1x15")
+add_custom_example (light-sensor-example light-sensor.cxx "si1132;max44009")
+add_custom_example (light-controller-example light-controller.cxx "lp8860;ds1808lc;hlg150h")
+add_custom_example (bme280-example bme280.cxx bmp280)
+add_custom_example (bma250e-example bma250e.cxx bmx055)
+add_custom_example (bmg160-example bmg160.cxx bmx055)
+add_custom_example (bmm150-example bmm150.cxx bmx055)
+add_custom_example (bmc150-example bmc150.cxx bmx055)
+add_custom_example (bmi055-example bmi055.cxx bmx055)

examples/c++/a110x-intr.cxx

@@ -25,7 +25,7 @@
 #include <unistd.h>
 #include <iostream>
 #include <signal.h>
-#include "a110x.h"
+#include "a110x.hpp"
 
 using namespace std;
 

examples/c++/a110x.cxx

@@ -25,7 +25,7 @@
 #include <unistd.h>
 #include <iostream>
 #include <signal.h>
-#include "a110x.h"
+#include "a110x.hpp"
 
 using namespace std;
 

examples/c++/ad8232.cxx

@@ -25,7 +25,7 @@
 #include <unistd.h>
 #include <iostream>
 #include <signal.h>
-#include "ad8232.h"
+#include "ad8232.hpp"
 
 using namespace std;
 

examples/c++/adafruitms1438-stepper.cxx

@@ -25,7 +25,7 @@
 #include <unistd.h>
 #include <signal.h>
 #include <iostream>
-#include "adafruitms1438.h"
+#include "adafruitms1438.hpp"
 
 using namespace std;
 using namespace upm;

examples/c++/adafruitms1438.cxx

@@ -25,7 +25,7 @@
 #include <unistd.h>
 #include <signal.h>
 #include <iostream>
-#include "adafruitms1438.h"
+#include "adafruitms1438.hpp"
 
 using namespace std;
 using namespace upm;

examples/c++/adafruitss.cxx

@@ -33,7 +33,7 @@
  */
 
 #include <iostream>
-#include "adafruitss.h"
+#include "adafruitss.hpp"
 #include <unistd.h>
 
 using namespace std;

examples/c++/adc-sensor.cxx

@@ -0,0 +1,80 @@
+/*
+ * Author: Henry Bruce <henry.bruce@intel.com>
+ * Copyright (c) 2015 Intel Corporation.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining
+ * a copy of this software and associated documentation files (the
+ * "Software"), to deal in the Software without restriction, including
+ * without limitation the rights to use, copy, modify, merge, publish,
+ * distribute, sublicense, and/or sell copies of the Software, and to
+ * permit persons to whom the Software is furnished to do so, subject to
+ * the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+ * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+ * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+ * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+#include <unistd.h>
+#include <iostream>
+#include "ads1015.hpp"
+#include "mraa/gpio.hpp"
+
+#define EDISON_I2C_BUS 1
+#define FT4222_I2C_BUS 0
+#define EDISON_GPIO_SI7005_CS 20
+
+
+//! [Interesting]
+// Simple example of using IADC to determine
+// which sensor is present and return its name.
+// IADC is then used to get readings from sensor
+
+
+upm::IADC* getADC()
+{
+   upm::IADC* adc = NULL;
+   try {
+      adc = new upm::ADS1015(EDISON_I2C_BUS);
+      mraa::Gpio gpio(EDISON_GPIO_SI7005_CS);
+      gpio.dir(mraa::DIR_OUT_HIGH);
+      return adc;
+   } catch (std::exception& e) {
+      std::cerr << "ADS1015: " << e.what() << std::endl;
+   }
+   return adc;
+}
+
+int main ()
+{
+   upm::IADC* adc = getADC();
+   if (adc == NULL) {
+      std::cout << "ADC not detected" << std::endl;
+      return 1;
+   }
+   std::cout << "ADC " << adc->getModuleName() << " detected. " ;
+   std::cout << adc->getNumInputs() << " inputs available" << std::endl;
+   while (true) {
+      for (unsigned int i=0; i<adc->getNumInputs(); ++i) {
+         std::cout << "Input " << i;
+         try {
+            float voltage = adc->getVoltage(i);
+            std::cout << ": Voltage = " << voltage << "V" << std::endl;
+         } catch (std::exception& e) {
+            std::cerr << e.what() << std::endl;
+         }
+      }
+      sleep(1);
+   }
+   delete adc;
+   return 0;
+}
+
+//! [Interesting]

examples/c++/adc121c021.cxx

@@ -25,7 +25,7 @@
 #include <unistd.h>
 #include <signal.h>
 #include <iostream>
-#include "adc121c021.h"
+#include "adc121c021.hpp"
 
 using namespace std;
 

examples/c++/ads1x15.cxx

@@ -0,0 +1,320 @@
+/*
+ * Author: Marc Graham <marc@m2ag.net>
+ * Copyright (c) 2015 Intel Corporation.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining
+ * a copy of this software and associated documentation files (the
+ * "Software"), to deal in the Software without restriction, including
+ * without limitation the rights to use, copy, modify, merge, publish,
+ * distribute, sublicense, and/or sell copies of the Software, and to
+ * permit persons to whom the Software is furnished to do so, subject to
+ * the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+ * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+ * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+ * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+#include "mraa.hpp"
+
+#include <iostream>
+#include <unistd.h>
+#include "ads1015.hpp"
+#include "ads1115.hpp"
+
+
+
+int main()
+{
+
+     using namespace std;
+     using namespace upm;
+     int command;
+     //Select the device you are testing here and adjust case 6 for the correct sample rates.
+     //upm::ADS1015 *ads = new upm::ADS1015(1);
+     upm::ADS1115 *ads = new upm::ADS1115(1, 0x49);
+     float inputVoltage;
+     int ans;
+
+     do
+     {
+
+          cout << endl;
+          cout << "1 - get Conversion \t" ;
+          cout << "2 - get last conversion" << endl;
+          cout << "3 - get Gain \t\t";
+          cout << "4 - set Gain"  << endl;;
+          cout << "5 - get Data Rate \t";
+          cout << "6 - set Data Rate" << endl;
+          cout << "7 - Set Upper Threshold \t" ;
+          cout << "8 - Set Lower Threshold \t";
+          cout << "9 - Display Thresholds \t";
+          cout << "10 - Set Default Thresholds \t";
+          cout << "11 - Set conversion ready" << endl;
+          cout << "12 - get Comp Que \t" ;
+          cout << "13 - set Comp Que" << endl;
+          cout << "14 - get Comp Pol \t";
+          cout << "15 - set Comp Pol" << endl;
+          cout << "16 - get Comp mode \t";
+          cout << "17 - set Comp mode " << endl;
+          cout << "18 - get Comp Latch\t";
+          cout << "19 - set Comp Latch " << endl;
+          cout << "20 - get Continuous \t";
+          cout << "21 - set Continuous \t" << endl;
+          cout << "-1 - exit" << endl;
+          cout << "Enter a command: ";
+          cin >> command;
+
+
+          switch(command)
+          {
+          case 2:
+               cout << ads->getLastSample() << endl;
+               break;
+          case 3:
+               cout << std::hex << ads->getGain() << endl;
+               break;
+          case 5:
+               cout << std::hex << ads->getSPS() << endl;
+               break;
+          case 4:
+               int gain;
+               ADS1015::ADSGAIN set_gain;
+               cout << "select one of the following:" << endl;
+               cout << "1 -> gain 2/3 \t 2 -> gain1 \t 3 -> gain 2" << endl;
+               cout << "4 -> gain 4 \t 5 -> gain 8 \t 6 -> gain 15" << endl;
+               cin >> gain;
+               switch(gain){
+               case 1:
+                    set_gain = ADS1X15::GAIN_TWOTHIRDS;
+                    break;
+               case 2:
+                    set_gain = ADS1X15::GAIN_ONE;
+                    break;
+               case 3:
+                    set_gain = ADS1X15::GAIN_TWO;
+                    break;
+               case 4:
+                    set_gain = ADS1X15::GAIN_FOUR;
+                    break;
+               case 5:
+                    set_gain = ADS1X15::GAIN_EIGHT;
+                    break;
+               case 6:
+                    set_gain = ADS1X15::GAIN_SIXTEEN;
+                    break;
+               default:
+                    set_gain = ADS1X15::GAIN_ONE;
+               }
+               ads->setGain(set_gain);
+               break;
+          case 6:
+               int rate;
+               /*ADS1015::ADSDATARATE set_rate;
+               cout << "select one of the following:" << endl;
+               cout << "1 -> SPS_120 \t 2 -> SPS_250 \t 3 -> SPS_490 \t 4 -> SPS_920" << endl;
+               cout << "5 -> SPS_1600 \t 6 -> SPS_2400 \t 7 -> SPS_3300" << endl;
+               cin >> rate;
+               switch(rate){
+               case 1:
+                    set_rate = ADS1015::SPS_128;
+                    break;
+               case 2:
+                    set_rate = ADS1015::SPS_250;
+                    break;
+               case 3:
+                    set_rate = ADS1015::SPS_490;
+                    break;
+               case 4:
+                    set_rate = ADS1015::SPS_920;
+                    break;
+               case 5:
+                    set_rate = ADS1015::SPS_1600;
+                    break;
+               case 6:
+                    set_rate = ADS1015::SPS_2400;
+                    break;
+               case 7:
+                    set_rate = ADS1015::SPS_3300;
+                    break;
+               default:
+                    set_rate = ADS1015::SPS_1600;
+               } */
+               ADS1115::ADSDATARATE set_rate;
+               cout << "select one of the following:" << endl;
+               cout << "1 -> SPS_8 \t 2 -> SPS_16 \t 3 -> SPS_32 \t 4 -> SPS_64" << endl;
+               cout << "5 -> SPS_128 \t 6 -> SPS_250 \t 7 -> SPS_475 \t 8-> SPS_860" << endl;
+               cin >> rate;
+               switch(rate){
+               case 1:
+                    set_rate = ADS1115::SPS_8;
+                    break;
+               case 2:
+                    set_rate = ADS1115::SPS_16;
+                    break;
+               case 3:
+                    set_rate = ADS1115::SPS_32;
+                    break;
+               case 4:
+                    set_rate = ADS1115::SPS_64;
+                    break;
+               case 5:
+                    set_rate = ADS1115::SPS_128;
+                    break;
+               case 6:
+                    set_rate = ADS1115::SPS_250;
+                    break;
+               case 7:
+                    set_rate = ADS1115::SPS_475;
+                    break;
+               case 8:
+                    set_rate = ADS1115::SPS_860;
+                    break;
+               default:
+                    set_rate = ADS1115::SPS_128;
+               }
+
+               ads->setSPS(set_rate);
+               break;
+          case 1:
+               int mode;
+               ADS1X15::ADSMUXMODE set_mode;
+               cout << "select one of the following:" << endl;
+               cout << "1 -> MUX_0_1 \t 2 -> MUX_0_3 \t 3 -> MUX_1_3 \t 4 -> MUX_2_3" << endl;
+               cout << "5 -> SINGLE_0 \t 6 -> SINGLE_1 \t 7 -> SINGLE_2 \t 8 -> SINGLE_3" << endl;
+               cin >> mode;
+               switch(mode){
+               case 1:
+                    set_mode = ADS1X15::DIFF_0_1;
+                    break;
+               case 2:
+                    set_mode = ADS1X15::DIFF_0_3;
+                    break;
+               case 3:
+                    set_mode = ADS1X15::DIFF_1_3;
+                    break;
+               case 4:
+                    set_mode = ADS1X15::DIFF_2_3;
+                    break;
+               case 5:
+                    set_mode = ADS1X15::SINGLE_0;
+                    break;
+               case 6:
+                    set_mode = ADS1X15::SINGLE_1;
+                    break;
+               case 7:
+                    set_mode = ADS1X15::SINGLE_2;
+                    break;
+               case 8:
+                    set_mode = ADS1X15::SINGLE_3;
+                    break;
+               default:
+                    set_mode = ADS1X15::DIFF_0_1;
+                    break;
+               }
+               cout << ads->getSample(set_mode) << endl;
+               break;
+          case 7:
+               cout << " enter a float value: " ;
+               cin >> inputVoltage;
+               ads->setThresh(ADS1115::THRESH_HIGH, inputVoltage);
+               break;
+          case 8:
+               cout << " enter a float value: " ;
+               cin >> inputVoltage;
+               ads->setThresh(ADS1115::THRESH_LOW, inputVoltage);
+               break;
+          case 9:
+               cout << "Upper " << ads->getThresh(ADS1X15::THRESH_HIGH) << endl;
+               cout << "Lower " << ads->getThresh(ADS1X15::THRESH_LOW) << endl;
+               break;
+          case 10:
+               ads->setThresh(ADS1115::THRESH_DEFAULT);
+               break;
+          case 11:
+               ads->setThresh(ADS1015::CONVERSION_RDY);
+               break;
+          case 12:
+               cout << ads->getCompQue() << endl;
+               break;
+          case 13:
+               int que;
+               cout << "select one of the following:" << endl;
+               cout << "1 -> CQUE_1CONV \t 2 -> CQUE_2CONV \t 3 -> CQUE_3CONV \t 4 -> CQUE_NONE" << endl;
+               cin >> que;
+               switch(que){
+               case 1:
+                    ads->setCompQue(ADS1X15::CQUE_1CONV);
+                    break;
+               case 2:
+                    ads->setCompQue(ADS1X15::CQUE_2CONV);
+                    break;
+               case 3:
+                    ads->setCompQue(ADS1X15::CQUE_4CONV);
+                    break;
+               case 4:
+               default:
+                    ads->setCompQue(ADS1X15::CQUE_NONE);
+                    break;
+               }
+               break;
+          case 14:
+               cout << ads->getCompPol() << endl;
+               break;
+          case 15:
+               cout << "select one of the following:" << endl;
+               cout << "1 -> active high \t 2 -> active low" << endl;
+               cin >> ans;
+               if(ans == 1) ads->setCompPol(true);
+                else ads->setCompPol(false);
+               break;
+          case 16:
+               cout << ads->getCompMode() << endl;
+               break;
+          case 17:
+               cout << "select one of the following:" << endl;
+               cout << "1 -> Window \t 2 -> Traditional (default)" << endl;
+               cin >> ans;
+               if(ans == 1) ads->setCompMode(true);
+                else ads->setCompMode();
+               break;
+          case 18:
+               cout << ads->getCompLatch() << endl;
+               break;
+          case 19:
+               cout << "select one of the following:" << endl;
+               cout << "1 -> Latching  \t 2 -> Non-latching (default)" << endl;
+               cin >> ans;
+               if(ans == 1) ads->setCompLatch(true);
+                else ads->setCompLatch();
+               break;
+          case 20:
+               cout << ads->getContinuous() << endl;
+               break;
+          case 21:
+               cout << "select one of the following:" << endl;
+               cout << "1 -> Power Down (default)  \t 2 -> Continuous" << endl;
+               cin >> ans;
+               if(ans == 1) ads->setContinuous(true);
+                else ads->setContinuous();
+               break;
+          case -1:
+               break;
+          default:
+
+               break;
+          }
+
+     }while (command != -1 );
+
+     delete ads;
+
+     return MRAA_SUCCESS;
+}

examples/c++/adxl335.cxx

@@ -25,7 +25,7 @@
 #include <unistd.h>
 #include <iostream>
 #include <signal.h>
-#include "adxl335.h"
+#include "adxl335.hpp"
 
 using namespace std;
 

examples/c++/adxl345.cxx

@@ -23,7 +23,7 @@
  */
 
 #include <unistd.h>
-#include "adxl345.h"
+#include "adxl345.hpp"
 
 int
 main(int argc, char **argv)

examples/c++/adxrs610.cxx

@@ -0,0 +1,71 @@
+/*
+ * Author: Jon Trulson <jtrulson@ics.com>
+ * Copyright (c) 2015 Intel Corporation.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining
+ * a copy of this software and associated documentation files (the
+ * "Software"), to deal in the Software without restriction, including
+ * without limitation the rights to use, copy, modify, merge, publish,
+ * distribute, sublicense, and/or sell copies of the Software, and to
+ * permit persons to whom the Software is furnished to do so, subject to
+ * the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+ * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+ * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+ * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+#include <unistd.h>
+#include <iostream>
+#include <signal.h>
+#include "adxrs610.hpp"
+
+using namespace std;
+
+bool shouldRun = true;
+
+void sig_handler(int signo)
+{
+  if (signo == SIGINT)
+    shouldRun = false;
+}
+
+int main()
+{
+  signal(SIGINT, sig_handler);
+
+//! [Interesting]
+
+  // Instantiate a ADXRS610 sensor on analog pin A0 (dataout), and
+  // analog A1 (temp out) with an analog reference voltage of
+  // 5.0
+  upm::ADXRS610 *sensor = new upm::ADXRS610(0, 1, 5.0);
+  
+  // set a deadband region around the zero point to report 0.0 (optional)
+  sensor->setDeadband(0.015);
+
+  // Every tenth of a second, sample the ADXRS610 and output it's
+  // corresponding temperature and angular velocity 
+
+  while (shouldRun)
+    {
+      cout << "Vel (deg/s): " << sensor->getAngularVelocity() << endl;
+      cout << "Temp (C): " << sensor->getTemperature() << endl;
+      
+      usleep(100000);
+    }
+
+//! [Interesting]
+
+  cout << "Exiting" << endl;
+
+  delete sensor;
+  return 0;
+}

examples/c++/ak8975.cxx

@@ -0,0 +1,72 @@
+/*
+ * Author: Jon Trulson <jtrulson@ics.com>
+ * Copyright (c) 2015 Intel Corporation.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining
+ * a copy of this software and associated documentation files (the
+ * "Software"), to deal in the Software without restriction, including
+ * without limitation the rights to use, copy, modify, merge, publish,
+ * distribute, sublicense, and/or sell copies of the Software, and to
+ * permit persons to whom the Software is furnished to do so, subject to
+ * the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+ * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+ * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+ * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+#include <unistd.h>
+#include <iostream>
+#include <signal.h>
+#include "mpu9150.hpp"
+
+using namespace std;
+
+int shouldRun = true;
+
+void sig_handler(int signo)
+{
+  if (signo == SIGINT)
+    shouldRun = false;
+}
+
+
+int main(int argc, char **argv)
+{
+  signal(SIGINT, sig_handler);
+//! [Interesting]
+
+  upm::AK8975 *sensor = new upm::AK8975();
+
+  sensor->init();
+
+  while (shouldRun)
+    {
+      sensor->update();
+      
+      float x, y, z;
+      
+      sensor->getMagnetometer(&x, &y, &z);
+      cout << "Magnetometer:  ";
+      cout << "MX = " << x << " MY = " << y << " MZ = " << z << endl;
+
+      cout << endl;
+
+      usleep(500000);
+    }
+
+//! [Interesting]
+
+  cout << "Exiting..." << endl;
+  
+  delete sensor;
+  
+  return 0;
+}

examples/c++/am2315.cxx

@@ -26,7 +26,7 @@
 #include <iostream>
 #include <signal.h>
 
-#include "am2315.h"
+#include "am2315.hpp"
 
 volatile int doWork = 0;