upm: update to version 0.3.0

Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>

.clang-format

@@ -0,0 +1,122 @@
+Language: Cpp
+
+# Access modifiers in the middle
+AccessModifierOffset: -2
+
+# Align escaped newlines as far left as possible
+AlignEscapedNewlinesLeft: true
+
+# Align all trailing comments
+AlignTrailingComments: true
+
+# Don't allow parameters to be placed on the next line, even though BinPackParameters is false
+AllowAllParametersOfDeclarationOnNextLine: false
+
+# Do not allow short functions/if statements/loops on a single line
+AllowShortFunctionsOnASingleLine: false
+AllowShortIfStatementsOnASingleLine: false
+AllowShortLoopsOnASingleLine: false
+
+# Don't force breaks before multiline strings
+AlwaysBreakBeforeMultilineStrings: false
+
+# Don't force breaks before template declarations
+AlwaysBreakTemplateDeclarations: false
+
+# Force breaks after definition return type
+AlwaysBreakAfterDefinitionReturnType: true
+
+# Arguments and parameters are either on one line or on one line each
+BinPackArguments: false
+BinPackParameters: false
+
+# Do not break before binary operators
+BreakBeforeBinaryOperators: None
+
+# Use the linux brace breaking style: Attach braces to context except for braces on functions,
+# namespaces and class definitions
+BreakBeforeBraces: Linux
+
+# Do not place ternary operators after line breaks
+BreakBeforeTernaryOperators: false
+
+# In the constructor initializers do not align the comma with the colon
+BreakConstructorInitializersBeforeComma: false
+
+# Force columns to be less than 100 characters
+ColumnLimit: 100
+
+# Constructor initializer all in one line or all on their own line
+ConstructorInitializerAllOnOneLineOrOnePerLine: true
+
+# Indent constructor initializers
+ConstructorInitializerIndentWidth: 8
+
+# Do not indent continuations
+ContinuationIndentWidth: 0
+
+# Do not use braced lists in c++11 style
+Cpp11BracedListStyle: false
+
+# Do not derive pointer alignment
+DerivePointerAlignment: false
+
+# Case labes are indented
+IndentCaseLabels: true
+
+# Do not indent function declarations
+IndentFunctionDeclarationAfterType: false
+
+# Indentation is 4 characters
+IndentWidth: 4
+
+# Do not keep empty lines at start of blocks
+KeepEmptyLinesAtTheStartOfBlocks: false
+
+# Keep at most 2 consecutive empty lines
+MaxEmptyLinesToKeep: 2
+
+# Do not indent namespaces
+NamespaceIndentation: None
+
+# Spaces for ObjC properties and protocol lists
+ObjCSpaceAfterProperty: true
+ObjCSpaceBeforeProtocolList: true
+
+# Penalties
+PenaltyBreakBeforeFirstCallParameter: 100
+PenaltyBreakComment: 10
+PenaltyBreakFirstLessLess: 0
+PenaltyBreakString: 100
+PenaltyExcessCharacter: 20
+PenaltyReturnTypeOnItsOwnLine: 20
+
+# Force pointers to typename (i.e. char* a instead of char *a)
+PointerAlignment: Left
+
+# Spaces after C-style casts and before assignments
+SpaceAfterCStyleCast: true
+SpaceBeforeAssignmentOperators: true
+
+# Only space before parentheses if they are control statements
+SpaceBeforeParens: ControlStatements
+
+# Single space before trailing comments
+SpacesBeforeTrailingComments: 1
+
+# No spaces in parentheses, angles, or square brackets
+SpaceInEmptyParentheses: false
+SpacesInAngles: false
+SpacesInCStyleCastParentheses: false
+SpacesInParentheses: false
+SpacesInSquareBrackets: false
+
+# Use c++11 as the language standard
+Standard: Cpp11
+
+# Tabs are 4 characters wide
+TabWidth: 4
+
+# Don't use tabs for indentation :-(
+UseTab: Never
+

CMakeLists.txt

@@ -12,8 +12,10 @@ endif ()
 
 find_package (Threads REQUIRED)
 find_package (PkgConfig REQUIRED)
-# force the libmraa version to be the required version
-pkg_check_modules (MRAA REQUIRED mraa>=0.5.4)
+
+# 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}")
 
 # Appends the cmake/modules path to MAKE_MODULE_PATH variable.
@@ -28,7 +30,7 @@ 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.1.9-dirty")
+  set (VERSION "v0.3.0-dirty")
 endif ()
 
 message (INFO " - UPM Version ${VERSION}")
@@ -56,18 +58,62 @@ option (BUILDDOC "Build all doc." OFF)
 option (BUILDSWIG "Build swig modules." ON)
 option (BUILDSWIGPYTHON "Build swig python modules." ON)
 option (BUILDSWIGNODE "Build swig node modules." ON)
+option (BUILDEXAMPLES "Build C++ example binaries" OFF)
 
 if (BUILDDOC)
   # add a target to generate API documentation with Doxygen
   find_package (Doxygen)
   if (DOXYGEN_FOUND)
-    configure_file (${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile @ONLY)
+    configure_file (${CMAKE_CURRENT_SOURCE_DIR}/doxy/Doxyfile.in ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile @ONLY)
     add_custom_target (doc
       ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
       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
+  find_package (Sphinx)
+  if(SPHINX_FOUND AND BUILDSWIG AND BUILDSWIGPYTHON)
+    # python required for Sphinx build
+    find_package (PythonLibs)
+    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
+      COMMAND rm -r -f ${CMAKE_BINARY_DIR}/pyupm && mkdir -p ${CMAKE_BINARY_DIR}/pyupm
+      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
+      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
+      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
+  find_package(Yuidoc)
+  if(YUIDOC_FOUND AND BUILDSWIGNODE)
+    # 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 ${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
+      DEPENDS doc
+      WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
+      COMMENT "Generating API documentation with Yuidoc" VERBATIM
+    )
+  endif()
 endif()
 
 if (IPK)
@@ -98,4 +144,7 @@ if (IPK)
 endif()
 
 add_subdirectory (src)
-add_subdirectory (examples)
+
+if(BUILDEXAMPLES)
+  add_subdirectory (examples/c++)
+endif()

README.md

@@ -1,12 +1,12 @@
-UPM - Sensor/Actuator repository for Mraa
+UPM - Sensor/Actuator repository for libmraa
 ==============
 
-UPM is a high level repository for sensors that use mraa. 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 instanciated.
+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 constructor is expected to initialise the sensor and paramters may be used
+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
@@ -14,77 +14,54 @@ sensor in order to reduce load when doing multiple reads to sensor data.
 
 ### Example
 
-A sensor/acturo is expected to work as such (here is the servo ES08A api):
+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 compeltely up to the developer, some
-enumerable sensors for example may provide much clever instanciation. Displays
+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).
+
 ### Supported Sensors
 
-Temperature Sensors:
-  * upm::MAX31723
-  * upm::MAX31855
-  * upm::TH02
-  * upm::GroveTemp
+Supported [sensor list](http://iotdk.intel.com/docs/master/upm/modules.html) from API documentation.
 
-Compass/Gyro/Magnometer Sensors:
-  * upm::Hmc5883l
-  * upm::MPU9150
-  * upm::LSM303
+You can also refer to the [Intel® IoT Developer Zone](https://software.intel.com/iot/sensors).
 
-Atmospheric Pressure Sensors:
-  * upm::GY65
+### IDE Integration
 
-Light/Proximity Sensors:
-  * upm::MAXDS3231M
-  * upm::MAX44000
-  * upm::HCSR04
-  * upm::GroveLight
-
-Gas Sensors:
-  * upm::MQ2
-  * upm::MQ3
-  * upm::MQ5
-  * upm::MQ9
-
-Displays:
-  * upm::Jhd1313m1
-  * upm::Lcm1602
-  * upm::ST7735
-  * upm::SSD1308
-  * upm::SSD1327
-
-LED controllers/segment displays:
-  * upm::TM1637
-  * upm::MY9221
-
-RFID:
-  * upm::SM130
-
-Wireless Communication:
-  * upm::NRF24l01
-
-Servo/motors:
-  * upm::ES08A
-  * upm::StepMotor
-
-Digital potentiometer
-  * upm::MAX5487
-
-Electricity sensor
-  * upm::ECS1030
+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.
 
 ### Building UPM
 
-See @ref building
+See @ref building [here](docs/building.md).
 
 ### Making your own UPM module
 
-@ref porting has more information on making new UPM modules
+@ref 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).
+
+### Naming conventions and rules for new UPM contributions
+
+Before you begin development, take a look at our @ref naming [conventions](docs/naming.md).
+
+Also, please read the guidelines for @ref contributions [to UPM](docs/contributions.md).
+
+Don't forget to check the @ref 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
-===========
+==============
 
-The C/C++ documentation is available [here](http://iotdk.intel.com/docs/master/upm/)
+The C/C++ documentation is available [here](http://iotdk.intel.com/docs/master/upm/).
+
+Version @ref changelog [here](docs/changelog.md).
+
+List of @ref knownlimitations [here](docs/knownlimitations.md).

TODO

@@ -1,34 +0,0 @@
-** FIXES **
-- LPD8806 & MAX5487 SPI constructor needs bus number etc...
-- MAX44000 i2c bus number required...
-- TCS3414CS & TH-2 i2c params required
-
-** SENSORS **
-
-Easy:
-MAX7221 - SPI 8 digit LED
-- https://mbed.org/components/MAX7221/
-- 
-SCA61T - inclinometer SPI
-- https://mbed.org/components/SCA61T-Inclinometer/
-DS1721 - i2c temperature/thermostat
-- https://mbed.org/components/DS1721/
-MPL3115A2 - i2c altimeter
-- https://mbed.org/components/MPL3115A2/
-- http://www.ebay.co.uk/itm/Barometric-Pressure-Altitude-Temperature-Sensor-I2C-MPL3115A2-/221499210102?pt=UK_BOI_Electrical_Test_Measurement_Equipment_ET&hash=item339261b976
-TEMT6200 - Ambient light sensor
-- https://mbed.org/components/TEMT6200/
-CMPS03 - i2c digital compass
-- https://mbed.org/components/CMPS03-Digital-Compass/
-- http://www.ebay.co.uk/itm/Magnetic-Compass-CMPS03-/221437925374?pt=UK_BOI_Electrical_Test_Measurement_Equipment_ET&hash=item338eba97fe
-- http://www.robot-italy.com/it/cmps03-robot-compass-module.html
-
-Medium
-E-ink sharp 1.3" LCD
-- https://mbed.org/components/13-SHARP-Memory-LCD/
-LCD-S401
-- https://mbed.org/components/Lumex-LCD-S401/
-
-Hard:
-RA8875 - 480x272 SPI 4 wire
-- https://mbed.org/components/RA8875-Based-Display/

cmake/modules/FindNode.cmake

@@ -0,0 +1,60 @@
+find_program (NODE_EXECUTABLE NAMES node
+    HINTS
+    $ENV{NODE_DIR}
+    PATH_SUFFIXES bin
+    DOC "Node.js interpreter"
+)
+
+include (FindPackageHandleStandardArgs)
+
+find_path (NODE_ROOT_DIR "node/node.h" "src/node.h"
+  PATHS /usr/include/nodejs /usr/local/include/nodejs)
+
+set (NODE_INCLUDE_DIRS
+  ${NODE_ROOT_DIR}/src
+  ${NODE_ROOT_DIR}/node
+  ${NODE_ROOT_DIR}/deps/v8/include
+  ${NODE_ROOT_DIR}/deps/uv/include
+)
+
+find_package_handle_standard_args (Node DEFAULT_MSG
+    NODE_EXECUTABLE
+    NODE_INCLUDE_DIRS
+)
+
+if (NODE_EXECUTABLE)
+    execute_process(COMMAND ${NODE_EXECUTABLE} --version
+                    OUTPUT_VARIABLE _VERSION
+                    RESULT_VARIABLE _NODE_VERSION_RESULT)
+    execute_process(COMMAND ${NODE_EXECUTABLE} -e "console.log(process.versions.v8)"
+                    OUTPUT_VARIABLE _V8_VERSION
+                    RESULT_VARIABLE _V8_RESULT)
+    if (NOT _NODE_VERSION_RESULT AND NOT _V8_RESULT)
+        string (REPLACE "v" "" NODE_VERSION_STRING "${_VERSION}")
+        string (REPLACE "." ";" _VERSION_LIST "${NODE_VERSION_STRING}")
+        list (GET _VERSION_LIST 0 NODE_VERSION_MAJOR)
+        list (GET _VERSION_LIST 1 NODE_VERSION_MINOR)
+        list (GET _VERSION_LIST 2 NODE_VERSION_PATCH)
+        set (V8_VERSION_STRING ${_V8_VERSION})
+        string (REPLACE "." ";" _V8_VERSION_LIST "${_V8_VERSION}")
+        string (REPLACE "." "" V8_DEFINE_STRING "${_V8_VERSION}")
+        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)
+        # we end up with a nasty newline so strip everything that isn't a number
+        string (REGEX MATCH "^[0-9]*" V8_VERSION_PATCH ${V8_VERSION_PATCH})
+    else ()
+        set (NODE_VERSION_STRING "0.10.30")
+        set (NODE_VERSION_MAJOR "0")
+        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_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})
+endif ()
+
+mark_as_advanced (NODE_EXECUTABLE)

cmake/modules/FindSphinx.cmake

@@ -0,0 +1,31 @@
+find_program (SPHINX_EXECUTABLE NAMES sphinx-build
+    HINTS $ENV{SPHINX_DIR}
+    PATH_SUFFIXES bin
+    DOC "Sphinx documentation html generator"
+)
+
+find_program (SPHINX_API_EXECUTABLE NAMES sphinx-apidoc
+    HINTS $ENV{SPHINX_DIR}
+    PATH_SUFFIXES bin
+    DOC "Sphinx documentation rst generator"
+)
+
+include (FindPackageHandleStandardArgs)
+
+find_package_handle_standard_args (Sphinx DEFAULT_MSG
+    SPHINX_EXECUTABLE
+    SPHINX_API_EXECUTABLE
+)
+
+# Get Sphinx version
+if (SPHINX_EXECUTABLE)
+    execute_process(COMMAND ${SPHINX_EXECUTABLE} --version
+                    OUTPUT_VARIABLE SPHINX_VERSION)
+    if(SPHINX_VERSION)
+      string(REGEX MATCH "([0-9]\\.[0-9]\\.[0-9])" SPHINX_VERSION_STR ${SPHINX_VERSION})
+      message ("INFO - Sphinx version is " ${SPHINX_VERSION_STR})
+    endif()
+endif ()
+
+mark_as_advanced (SPHINX_EXECUTABLE)
+mark_as_advanced (SPHINX_API_EXECUTABLE)

cmake/modules/FindYuidoc.cmake

@@ -0,0 +1,23 @@
+find_program (YUIDOC_EXECUTABLE NAMES yuidoc
+    HINTS $ENV{YUIDOC_DIR}
+    PATHS usr usr/local
+    PATH_SUFFIXES bin
+    DOC "Yuidoc documentation generator"
+)
+
+include (FindPackageHandleStandardArgs)
+
+find_package_handle_standard_args (Yuidoc DEFAULT_MSG
+    YUIDOC_EXECUTABLE
+)
+
+# Get Yuidoc version
+if (YUIDOC_EXECUTABLE)
+    execute_process(COMMAND ${YUIDOC_EXECUTABLE} --version
+                    ERROR_VARIABLE YUIDOC_VERSION)
+    if(YUIDOC_VERSION)
+      message ("INFO - Yuidoc version is " ${YUIDOC_VERSION})
+    endif()
+endif ()
+
+mark_as_advanced (YUIDOC_EXECUTABLE)

docs/building.md

@@ -3,7 +3,15 @@ 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.
+directory. Failure to do an out-of-source build may cause issues when
+rebuilding later on.
+
+This project depends on libmraa, so that needs to be installed first. Use the
+following environment variables to configure the paths:
+
+    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.
@@ -13,33 +21,70 @@ mkdir build
 cd build
 cmake ..
 make
+make install
 ~~~~~~~~~~~~~
 
-Our cmake configure has a number of options, cmake-gui or ccmake can show you
-all the options. The interesting ones are detailed below:
+The last command will create the include/ and lib/ directories with a copy of
+the headers and library objects respectively in your build location.
+
+Our cmake configure has a number of options, *cmake-gui* or *ccmake* can show
+you all the options. The interesting ones are detailed below:
 
 Changing install path from /usr/local to /usr
- -DCMAKE_INSTALL_PREFIX:PATH=/usr
-
+~~~~~~~~~~~~~
+-DCMAKE_INSTALL_PREFIX:PATH=/usr
+~~~~~~~~~~~~~
 Building debug build:
- -DCMAKE_BUILD_TYPE=DEBUG
-
+~~~~~~~~~~~~~
+-DCMAKE_BUILD_TYPE=DEBUG
+~~~~~~~~~~~~~
 Using clang instead of gcc:
- -DCMAKE_C_COMPILER=/usr/bin/clang -DCMAKE_CXX_COMPILER=/usr/bin/clang++
-
+~~~~~~~~~~~~~
+-DCMAKE_C_COMPILER=/usr/bin/clang -DCMAKE_CXX_COMPILER=/usr/bin/clang++
+~~~~~~~~~~~~~
+Cross-compiling on a different system:
+~~~~~~~~~~~~~
+-DCMAKE_CXX_FLAGS:STRING=-m32 -march=i586
+-DCMAKE_C_FLAGS:STRING=-m32 -march=i586
+~~~~~~~~~~~~~
 Building with an older version of swig (swig 2.0+) requires the disabling of javascript:
- -DBUILDSWIGNODE=OFF
-
+~~~~~~~~~~~~~
+-DBUILDSWIGNODE=OFF
+~~~~~~~~~~~~~
 Disabling python module building
- -DBUILDSWIGPYTHON=OFF
-
+~~~~~~~~~~~~~
+-DBUILDSWIGPYTHON=OFF
+~~~~~~~~~~~~~
+Setting the python library to use:
+~~~~~~~~~~~~~
+-DPYTHON_LIBRARY:FILEPATH=/usr/lib/libpython2.7.so.1.0
+~~~~~~~~~~~~~
 Building doxygen doc
- -BUILDDOC=ON
+~~~~~~~~~~~~~
+-BUILDDOC=ON
+~~~~~~~~~~~~~
+
+If you intend to turn on all the options and build everything at once (C++,
+Node, Python and Documentation) you will have to edit the src/doxy2swig.py file
+and change the line endings from Windows style to Linux format. This has to be
+repeated every time to sync with the master branch since our Github repository
+stores files using CR LF line breaks.
+
+You can also generate the include and lib directories containing all the sensor
+headers and library files respectively with *make install*. Further, you may
+choose to generate these only for a specific sensor you modified, and this can
+be achieved by building from the individual makefile of the sensor. Assuming
+you're in the build directory, to make the lcd module you would:
+
+~~~~~~~~~~~~~
+cd src/lcd
+make install
+~~~~~~~~~~~~~
 
 Often developers are only interested in building one module or even just the
 python/node module to do some quick testing using scripting. In order to do
 this you need to use the target name for the python or node module you want to
-rebuild. For example the lcd module target name is i2clcd. Therfore the python
+rebuild. For example the lcd module target name is i2clcd. Therefore the python
 module target name will be prefixed by _pyupm_. Just do the following to build
 only that module. Modules not using the UPM cmake macros may have different
 naming.
@@ -49,12 +94,12 @@ make _pyupm_i2clcd
 ~~~~~~~~~~~~~
 
 Sometimes you want to build a small C++ example against an installed library.
-This is fairly easy if installed systemwide. Just link against the correct
-librar (in this case libupm-tm1637) and then add /usr/include/upm to the loader
-path:
+This is fairly easy if installed system-wide. Just link against the correct
+library (in this case libupm-i2clcd) and then add /usr/include/upm to the
+loader path:
 
 ~~~~~~~~~~~~
-g++ test.cxx -lupm_tm1637 -I/usr/include/upm
+g++ test.cxx -lupm-i2clcd -I/usr/include/upm
 ~~~~~~~~~~~~
 
 You can also use pkg-config to return the information to you, which is
@@ -62,5 +107,5 @@ considered the correct way if including UPM in a build system like cmake or
 autotools on linux.
 
 ~~~~~~~~~~~
-pkg-config --cflags --libs upm-tm1637
+pkg-config --cflags --libs upm-i2clcd
 ~~~~~~~~~~~

docs/changelog.md

@@ -0,0 +1,84 @@
+Changelog                         {#changelog}
+===============
+
+Here's a list summarizing some of the key undergoing changes to our library
+from earlier versions:
+
+### v0.3.0
+
+ * New CMake targets to build python and node documentation with Sphinx and
+ Yuidoc
+ * 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
+
+### v0.2.0
+
+ * Passed 100 supported sensor drivers
+ * Updated header files with new doxygen tags for improved API documentation
+ generation
+ * Added python examples for sensors
+ * 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
+
+### v0.1.9
+
+ * Passed 50 supported sensor drivers
+ * Starter Kit and Additional Roadshow and Hackaton sensors added
+ * Several examples and documentation updates submitted
+ * Wrote new proper SWIG typemaps for arrays
+ * Fixed the i2clcd write function, improved several other sensors
+
+### v0.1.8
+
+ * Added MQ series gas sensors and a few others
+ * Generated Doxygen layout file to improve API look and feel
+ * Several sensor documentation updates
+
+### v0.1.7
+
+ * Fixed SWIG node build issues
+ * Added lpd8806 digital led strip
+
+### v0.1.6
+
+ * Fixed SWIG python builds
+ * Extended i2clcd devices with new functions
+ * Made SWIG interface improvements and added extra types
+ * Added nrf8001 BLE support
+ * Few other sensor additions and fixes
+
+### v0.1.5
+
+ * New drivers for microphone and mpu9150
+ * Added generic driver for stepper motors
+ * Updated all code to use MRAA and version dependency
+
+### v0.1.4
+
+ * Added new bmp/gy pressure sensor and updated servo
+ * Started UPM documentation and related pages
+ * Updated MRAA dependencies
+
+### v0.1.3
+
+ * Updated SWIG support for some sensors
+ * New sensor support for mma7455 accelerometer
+
+### v0.1.2
+
+ * Several new sensors added
+ * Documentation fixes
+ * IPK generation
+
+### v0.1.1
+
+ * Updated MRAA dependency
+
+### v0.1.0
+
+ * Initial release with some basic grove sensors and hmc5883
+ * Doxygen and SWIG support implemented

docs/contributions.md

@@ -2,35 +2,57 @@ Contributing a module                         {#contributions}
 =====================
 
 Here are the rules of contribution:
-- Your module must have an example that builds against your UPM library
-- Commits must have a sign-off line by everyone who reviewed them
-- Commits must be named <file/module>: Some decent description
+- Your new module must have an example that builds against your UPM library.
+- Each commit must have a sign-off line by everyone who authored or reviewed
+  them.
+- Commits must be named `<file/module>: Some decent description`.
 - You must license your module under a FOSS license. The recommended license
   is MIT but any permissive license is fine. Please consider that people using
   UPM may want to write proprietary programs with your sensors so we like to
-  avoid GPL. (LGPL is fine). If your license is not MIT please include a
-  LICENSE file in src/mymodule/
+  avoid GPL. If your license is not MIT please include a LICENSE file in
+  src/mymodule/.
+- The top of each source file must contain a comment block containing the
+  license information.
 - Please test your module builds before contributing and make sure it works on
-  the latest version of mraa. If you tested on a specific board/platform please
-  tell us what this was in your PR.
+  the latest version of libmraa. If you tested on a specific board/platform
+  please tell us what this was in your PR.
 - Try not to break master. In any commit.
-- Attempt to have some decent API documentation below are the explicit rules on documentation:
+- Attempt to have some decent API documentation as described in the the @ref
+  documentation [guide](documentation.md).
 
-Documentation
-=============
+Including the MIT license
+=========================
+Choosing the [MIT license](http://opensource.org/licenses/MIT) is preferred for
+the UPM repository.  Below is the comment block needed at the top each source
+file:
 
-- Try to have no warnings in doxygen, this is generally fairly easy
-- Have the specific sensor manufacturer/model & version that you used, if you
-  support multiple versions please list
-- Comments do not need full stops
-- Stick to <80 chars per line even in comments
-- No text is allowed on the same line as the start or end of a comment /** */
-- All classes should have a "@brief" and a "@snippet"
+        /*
+         * The MIT License (MIT)
+         *
+         * Author: <your full name> 
+         * Copyright (c) <year> <copyright holder>
+         *
+         * Author: <contributing author full name - if applicable> 
+         * Copyright (c) <year> <copyright holder>
+         *
+         * 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.
+         */
 
-The example should have an 'Interesting' section which will be highlighted as a
-code sample in doxygen.  Everything in between such tags will show up in the
-class documentation when the following is put at the end of a class docstring
-as show above.
 
 Code signing
 ============
@@ -66,7 +88,7 @@ the below:
             maintained indefinitely and may be redistributed consistent with
             this project or the open source license(s) involved.
 
-then you just add a line saying
+then you just add a line to each of your commits with `--signoff` saying
 
         Signed-off-by: Random J Developer <random@developer.example.org>
 

docs/documentation.md

@@ -0,0 +1,114 @@
+Writing sensor documentation                        {#documentation}
+=====================
+
+It is highly encouraged to provide at least some basic documentation for the
+sensors that you want to add to UPM:
+
+- If you don't add documentation, the code review will take very long and 
+  your contribution could be rejected.
+- Try to have no warnings in doxygen, this is generally fairly easy.
+- Have the specific sensor manufacturer/model & version that you used, if you
+  support multiple versions please list.
+- Simple comments do not need full stops.
+- Stick to <80 chars per line even in comments.
+- No text is allowed on the same line as the start or end of a comment /** */.
+
+####The sensor block
+
+This is added just before the class declaration in your header(.h) file and has 
+mandatory fields. For single sensor libraries, this block will actually
+follow immediately after the library block. If you have multiple physical
+sensors, add this to every one.
+Here's an example (disregard the "@verbatim" tags in your actual code):
+
+```
+@verbatim
+/**
+ * @library <lib-name>
+ * @sensor <chip-id>
+ * @comname <component-name>
+ * @altname <alt-name>
+ * @type <component-category>
+ * @man <component-manufacturer>
+ * @web <component-weblinks>
+ * @con <connection-type>
+ * @kit <component-kit>
+ *
+ * @brief Short class/sensor description
+ * 
+ *   Then add a longer
+ *   description here.
+ *
+ * @image html <component-img.jpeg>
+ * @snippet <example-name.cxx> Interesting
+ */
+@endverbatim
+```
+
+- `<lib-name>` When adding to an existing library this needs to match that
+  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*
+- `<component-category>` Mention one or more categories the sensor fits in. Can
+  be 'other'. *Mandatory*
+- `<component-manufacturer>` Sensor manufacturer. Can be 'generic'. *Mandatory*
+- `<component-weblinks>` Links to vendors or data-sheets. *Optional*
+- `<connection-type>` Specifies how does the sensor connect to the board
+  *Mandatory*
+- `<component-kit>` Specifies if the sensor is part of a kit. *Optional*
+
+Existing groups that can be used for the manufacturer, connection, category and
+kit tags are found in the src/upm.h file.
+
+Optionally, a small representative image can be placed in the "docs/images"
+subfolder and linked with the "@image" tag.
+**Please do not use existing, copyrighted images with your sensors!**
+
+The example should have an 'Interesting' section which will be highlighted as
+a code sample in doxygen. Everything in between such tags will show up in the
+class documentation when "@snippet" is added at the end of a class docstring.
+Tags use this format (in "example-name.cxx"):
+
+```
+@verbatim
+ //! [Interesting]
+
+    ...example code here...
+
+ //! [Interesting]
+@endverbatim
+```
+
+For more examples take a look at the existing headers in our github repository.
+
+####The library block
+
+New libraries must have the "@brief", "@defgroup" and "@ingroup" tags in one
+block. This usually follows the namespace and it is common to have one sensor
+per library.
+
+You should end up with something like this:
+
+```
+@verbatim
+/**
+ * @brief Short description for entire library
+ *
+ * Optional longer description.
+ *
+ * @defgroup <lib-name> libupm-<lib-name>
+ * @ingroup <manufacturer> <connection> <category> (<kit>)
+ */
+@endverbatim
+```
+
+In "@defgroup" use the same `<lib-name>` used in the sensor block. Multiple
+sensors can be added to the same library this way.
+For "@ingroup" add the same values as in the sensor block for manufacturer,
+category, connection type and kit. If you have multiple classes or sensors
+per library, only use the "@ingroup" tags that are common for all of them.

docs/knownlimitations.md

@@ -0,0 +1,51 @@
+Known Limitations                       {#knownlimitations}
+===============
+
+Some sensors do not work seamlessly with a specific board. This means that they
+are either incompatible or work only under specific settings. This is a list of
+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 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 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.
+ * **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 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.
+
+#### Adafruit Sensors
+
+ * **Adafruit Motor Shield** (1438) is not detected on the I2C bus when
+ connected to the Intel Edison with an Arduino breakout.
+
+#### Other Sensors
+
+ * **MPU9150** might return inaccurate data.
+
+#### General
+
+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.

docs/max31855.md

@@ -2,7 +2,7 @@ Making a UPM module for MAX31855                         {#max31855}
 ================================
 
 The Maxim Integrated MAX31855 is a thermocouple amplifier allowing you to read
-from a K type themocouple. My board comes from the Pmod kit form Maxim
+from a K type thermocouple. My board comes from the Pmod kit form Maxim
 (MAX31855PMB1) but you can get this from many different sources. The adafruit
 people made arduino code already so we'll use that as a
 [reference](https://github.com/adafruit/Adafruit-MAX31855-library/blob/master/Adafruit_MAX31855.cpp).
@@ -69,7 +69,7 @@ the implementation of MAX31855::getTemp()
 
 Then using the arduino code as reference we simply reconstruct form the 4
 uint8_t values a 32bit int value and select only the valuable parts of
-information from that. The MAX31855 datahseet explains exactly which bits are
+information from that. The MAX31855 datasheet explains exactly which bits are
 useful, we will just do the same as the adafruit code, first checking the error
 bit and then scrapping everything but the 14bit of thermocouple data that are
 useful to us and converting it to a double.
@@ -78,7 +78,7 @@ useful to us and converting it to a double.
 
 ### Finalizing
 
-Our final example, very easy to use api!
+Our final example, very easy to use API!
 
 @snippet examples/max31855.cxx Interesting
 
@@ -92,6 +92,6 @@ include_directories (${PROJECT_SOURCE_DIR}/src/max31855)
 target_link_libraries (max31855-example max31855 ${CMAKE_THREAD_LIBS_INIT})
 ~~~~~~~~~~~
 
-Note you dont have to rebuild everything, cmake keeps target lists so if you
+Note you don't have to rebuild everything, cmake keeps target lists so if you
 named your example target modulename-example you can simply do make
 max31855-example and both the library & example will build.

docs/naming.md

@@ -1,7 +1,7 @@
 Naming a module                         {#naming}
 ===============
 
-UPM attemps to follow a clear naming pattern. Modules should be sensibly named
+UPM attempts to follow a clear naming pattern. Modules should be sensibly named
 and then placed in ${libdir}/upm and headers in ${includedir}/upm, all modules
 should be prefixed with libupm-<modulename>. The upm_module_init will
 automatically name python UPM modules as pyupm_<modulename> and javascript
@@ -21,9 +21,13 @@ jsupm_grove.
 Other times this does not. Try to pick a generic name so people with a similar
 sensor can inherit your class if they only have minor changes.
 3. Avoid brand names, often your module can be very generic with little effort
+4. Use only lowercase characters in your file names and folder names.
 
 ### Doubt
 
-If ever, give me a ping via email: brendan.le.foll@intel.com and I'll try
-suggest decent names for your module.
+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
+and we'll try suggest decent names for your module.
 

docs/porting.md

@@ -3,7 +3,7 @@ Porting a module from Arduino                         {#porting}
 
 Porting arduino libraries to libmraa as UPM libraries is usually fairly easy.
 The issues typically come from misunderstanding of how a non real time OS deals
-with interupts and timers. It also highly depends on the sensor. A concrete
+with interrupts and timers. It also highly depends on the sensor. A concrete
 example is explained in detail on @ref max31855
 
 ### Adding a new module to UPM
@@ -36,9 +36,9 @@ required to talk to the board's IO. An I2c sensor will create a
 mraa_i2c_context, keep it as a private member and require a bus number and slave
 address in it's constructor.
 
-Typically in sensors a simple object->read() function is prefered, depending on
-your sensor/actuaotr this may or may not be easy or not even make sense. Most
-UPM apis have a simple set of functions.
+Typically in sensors a simple object->read() function is preferred, depending on
+your sensor/actuator this may or may not be easy or not even make sense. Most
+UPM APIs have a simple set of functions.
 
 ### Mapping arduino API to libmraa
 
@@ -59,7 +59,7 @@ the UPM build system.
 The last step is when you're happy with your module and it works send us a pull
 request! We'd love to include your sensor in our repository.
 
-If you don't like github you can also send brendan.le.foll@intel.com a git
-formatted patch if your sensor. More details are on @ref contributions and on
+If you don't like github you can also send mihai.tudor.panu@intel.com a git
+formatted patch of your sensor. More details are on @ref contributions and on
 https://help.github.com/articles/creating-a-pull-request
 

doxy/Doxyfile.in

@@ -51,14 +51,14 @@ PROJECT_BRIEF          = "Sensor/Actuator repository for libmraa (v@MRAA_VERSION
 # and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
 # to the output directory.
 
-PROJECT_LOGO           = 
+PROJECT_LOGO           =
 
 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
 # into which the generated documentation will be written. If a relative path is
 # entered, it will be relative to the location where doxygen was started. If
 # left blank the current directory will be used.
 
-OUTPUT_DIRECTORY       = 
+OUTPUT_DIRECTORY       =
 
 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-
 # directories (in 2 levels) under the output directory of each output format and
@@ -156,7 +156,7 @@ FULL_PATH_NAMES        = YES
 # will be relative from the directory where doxygen is started.
 # This tag requires that the tag FULL_PATH_NAMES is set to YES.
 
-STRIP_FROM_PATH        = 
+STRIP_FROM_PATH        =
 
 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
 # path mentioned in the documentation of a class, which tells the reader which
@@ -165,7 +165,7 @@ STRIP_FROM_PATH        =
 # specify the list of include paths that are normally passed to the compiler
 # using the -I flag.
 
-STRIP_FROM_INC_PATH    = 
+STRIP_FROM_INC_PATH    =
 
 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
 # less readable) file names. This can be useful is your file systems doesn't
@@ -232,13 +232,21 @@ TAB_SIZE               = 4
 # "Side Effects:". You can put \n's in the value part of an alias to insert
 # newlines.
 
-ALIASES                = 
+ALIASES                = library="@ingroup " \
+                         sensor="@li **ID:** " \
+                         comname="@li **Name:** " \
+                         altname="@li **Other Names:** " \
+                         type="@li **Category:** " \
+                         man="@li **Manufacturer:** " \
+                         web="@li **Link:** " \
+                         con="@li **Connection:** " \
+                         kit="@li **Kit:** " \
 
 # This tag can be used to specify a number of word-keyword mappings (TCL only).
 # A mapping has the form "name=value". For example adding "class=itcl::class"
 # will allow you to use the command class in the itcl::class meaning.
 
-TCL_SUBST              = 
+TCL_SUBST              =
 
 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
 # only. Doxygen will then generate output that is more tailored for C. For
@@ -282,7 +290,7 @@ OPTIMIZE_OUTPUT_VHDL   = NO
 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
 # the files are not read by doxygen.
 
-EXTENSION_MAPPING      = 
+EXTENSION_MAPPING      =
 
 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
 # according to the Markdown format, which allows for more readable
@@ -618,7 +626,7 @@ GENERATE_DEPRECATEDLIST= YES
 # sections, marked by \if <section_label> ... \endif and \cond <section_label>
 # ... \endcond blocks.
 
-ENABLED_SECTIONS       = 
+ENABLED_SECTIONS       =
 
 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
 # initial value of a variable or macro / define can have for it to appear in the
@@ -660,7 +668,7 @@ SHOW_NAMESPACES        = YES
 # by doxygen. Whatever the program writes to standard output is used as the file
 # version. For an example see the documentation.
 
-FILE_VERSION_FILTER    = 
+FILE_VERSION_FILTER    =
 
 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
 # by doxygen. The layout file controls the global structure of the generated
@@ -673,7 +681,7 @@ FILE_VERSION_FILTER    =
 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
 # tag is left empty.
 
-LAYOUT_FILE            = @CMAKE_CURRENT_SOURCE_DIR@/DoxygenLayout.xml
+LAYOUT_FILE            = @CMAKE_CURRENT_SOURCE_DIR@/doxy/DoxygenLayout.xml
 
 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
 # the reference definitions. This must be a list of .bib files. The .bib
@@ -684,7 +692,7 @@ LAYOUT_FILE            = @CMAKE_CURRENT_SOURCE_DIR@/DoxygenLayout.xml
 # search path. Do not use file names with spaces, bibtex cannot handle them. See
 # also \cite for info how to create references.
 
-CITE_BIB_FILES         = 
+CITE_BIB_FILES         =
 
 #---------------------------------------------------------------------------
 # Configuration options related to warning and progress messages
@@ -743,7 +751,7 @@ WARN_FORMAT            = "$file:$line: $text"
 # messages should be written. If left blank the output is written to standard
 # error (stderr).
 
-WARN_LOGFILE           = 
+WARN_LOGFILE           =
 
 #---------------------------------------------------------------------------
 # Configuration options related to the input files
@@ -755,7 +763,8 @@ WARN_LOGFILE           =
 # spaces.
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = @CMAKE_CURRENT_SOURCE_DIR@/src \
+INPUT                  = @CMAKE_CURRENT_SOURCE_DIR@/src/upm.h \
+                         @CMAKE_CURRENT_SOURCE_DIR@/src \
                          @CMAKE_CURRENT_SOURCE_DIR@/docs \
                          @CMAKE_CURRENT_SOURCE_DIR@/README.md
 
@@ -849,9 +858,7 @@ 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       = @PROJECT_SOURCE_DIR@/src/nrf8001/aci* \
-                         @PROJECT_SOURCE_DIR@/src/nrf8001/lib* \
-                         @PROJECT_SOURCE_DIR@/src/nrf8001/hal* 
+EXCLUDE_PATTERNS       =
 
 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
 # (namespaces, classes, functions, etc.) that should be excluded from the
@@ -862,15 +869,15 @@ EXCLUDE_PATTERNS       = @PROJECT_SOURCE_DIR@/src/nrf8001/aci* \
 # Note that the wildcards are matched against the file with absolute path, so to
 # exclude all test directories use the pattern */test/*
 
-EXCLUDE_SYMBOLS        = 
+EXCLUDE_SYMBOLS        = aci_*
 
 # The EXAMPLE_PATH tag can be used to specify one or more files or directories
 # that contain example code fragments that are included (see the \include
 # command).
 
-EXAMPLE_PATH           = @CMAKE_CURRENT_SOURCE_DIR@/examples/ \
+EXAMPLE_PATH           = @CMAKE_CURRENT_SOURCE_DIR@/examples/c++ \
                          @CMAKE_CURRENT_SOURCE_DIR@/docs/ \
-			 @CMAKE_CURRENT_SOURCE_DIR@/src/max31855/
+                         @CMAKE_CURRENT_SOURCE_DIR@/src/max31855/
 
 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
@@ -907,7 +914,7 @@ IMAGE_PATH             = @CMAKE_CURRENT_SOURCE_DIR@/docs/images/
 # code is scanned, but not when the output code is generated. If lines are added
 # or removed, the anchors will not be placed correctly.
 
-INPUT_FILTER           = 
+INPUT_FILTER           =
 
 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
 # basis. Doxygen will compare the file name with each pattern and apply the
@@ -916,7 +923,7 @@ INPUT_FILTER           =
 # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
 # patterns match the file name, INPUT_FILTER is applied.
 
-FILTER_PATTERNS        = 
+FILTER_PATTERNS        =
 
 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
 # INPUT_FILTER ) will also be used to filter the input files that are used for
@@ -931,7 +938,7 @@ FILTER_SOURCE_FILES    = NO
 # *.ext= (so without naming a filter).
 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
 
-FILTER_SOURCE_PATTERNS = 
+FILTER_SOURCE_PATTERNS =
 
 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
 # is part of the input, its contents will be placed on the main page
@@ -1050,7 +1057,7 @@ COLS_IN_ALPHA_INDEX    = 5
 # while generating the index headers.
 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
 
-IGNORE_PREFIX          = 
+IGNORE_PREFIX          =
 
 #---------------------------------------------------------------------------
 # Configuration options related to the HTML output
@@ -1094,7 +1101,7 @@ HTML_FILE_EXTENSION    = .html
 # of the possible markers and block names see the documentation.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_HEADER            = 
+HTML_HEADER            =
 
 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
 # generated HTML page. If the tag is left blank doxygen will generate a standard
@@ -1104,7 +1111,7 @@ HTML_HEADER            =
 # that doxygen normally uses.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_FOOTER            = 
+HTML_FOOTER            =
 
 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
 # sheet that is used by each HTML page. It can be used to fine-tune the look of
@@ -1116,7 +1123,7 @@ HTML_FOOTER            =
 # obsolete.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_STYLESHEET        = 
+HTML_STYLESHEET        =
 
 # The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-
 # defined cascading style sheet that is included after the standard style sheets
@@ -1127,7 +1134,7 @@ HTML_STYLESHEET        =
 # see the documentation.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_EXTRA_STYLESHEET  = 
+HTML_EXTRA_STYLESHEET  =
 
 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
 # other source files which should be copied to the HTML output directory. Note
@@ -1137,7 +1144,7 @@ HTML_EXTRA_STYLESHEET  =
 # files will be copied as-is; there are no commands or markers available.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_EXTRA_FILES       = 
+HTML_EXTRA_FILES       =
 
 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
 # will adjust the colors in the stylesheet and background images according to
@@ -1265,7 +1272,7 @@ GENERATE_HTMLHELP      = NO
 # written to the html output directory.
 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
 
-CHM_FILE               = 
+CHM_FILE               =
 
 # The HHC_LOCATION tag can be used to specify the location (absolute path
 # including file name) of the HTML help compiler ( hhc.exe). If non-empty
@@ -1273,7 +1280,7 @@ CHM_FILE               =
 # The file has to be specified with full path.
 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
 
-HHC_LOCATION           = 
+HHC_LOCATION           =
 
 # The GENERATE_CHI flag controls if a separate .chi index file is generated (
 # YES) or that it should be included in the master .chm file ( NO).
@@ -1286,7 +1293,7 @@ GENERATE_CHI           = NO
 # and project file content.
 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
 
-CHM_INDEX_ENCODING     = 
+CHM_INDEX_ENCODING     =
 
 # The BINARY_TOC flag controls whether a binary table of contents is generated (
 # YES) or a normal table of contents ( NO) in the .chm file.
@@ -1316,7 +1323,7 @@ GENERATE_QHP           = NO
 # the HTML output folder.
 # This tag requires that the tag GENERATE_QHP is set to YES.
 
-QCH_FILE               = 
+QCH_FILE               =
 
 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
 # Project output. For more information please see Qt Help Project / Namespace
@@ -1341,7 +1348,7 @@ QHP_VIRTUAL_FOLDER     = doc
 # filters).
 # This tag requires that the tag GENERATE_QHP is set to YES.
 
-QHP_CUST_FILTER_NAME   = 
+QHP_CUST_FILTER_NAME   =
 
 # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
 # custom filter to add. For more information please see Qt Help Project / Custom
@@ -1349,21 +1356,21 @@ QHP_CUST_FILTER_NAME   =
 # filters).
 # This tag requires that the tag GENERATE_QHP is set to YES.
 
-QHP_CUST_FILTER_ATTRS  = 
+QHP_CUST_FILTER_ATTRS  =
 
 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
 # project's filter section matches. Qt Help Project / Filter Attributes (see:
 # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
 # This tag requires that the tag GENERATE_QHP is set to YES.
 
-QHP_SECT_FILTER_ATTRS  = 
+QHP_SECT_FILTER_ATTRS  =
 
 # The QHG_LOCATION tag can be used to specify the location of Qt's
 # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
 # generated .qhp file.
 # This tag requires that the tag GENERATE_QHP is set to YES.
 
-QHG_LOCATION           = 
+QHG_LOCATION           =
 
 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
 # generated, together with the HTML files, they form an Eclipse help plugin. To
@@ -1496,7 +1503,7 @@ MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest
 # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
 # This tag requires that the tag USE_MATHJAX is set to YES.
 
-MATHJAX_EXTENSIONS     = 
+MATHJAX_EXTENSIONS     =
 
 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
 # of code that will be used on startup of the MathJax code. See the MathJax site
@@ -1504,7 +1511,7 @@ MATHJAX_EXTENSIONS     =
 # example see the documentation.
 # This tag requires that the tag USE_MATHJAX is set to YES.
 
-MATHJAX_CODEFILE       = 
+MATHJAX_CODEFILE       =
 
 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
 # the HTML output. The underlying search engine uses javascript and DHTML and
@@ -1564,7 +1571,7 @@ EXTERNAL_SEARCH        = NO
 # Searching" for details.
 # This tag requires that the tag SEARCHENGINE is set to YES.
 
-SEARCHENGINE_URL       = 
+SEARCHENGINE_URL       =
 
 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
 # search data is written to a file for indexing by an external tool. With the
@@ -1580,7 +1587,7 @@ SEARCHDATA_FILE        = searchdata.xml
 # projects and redirect the results back to the right project.
 # This tag requires that the tag SEARCHENGINE is set to YES.
 
-EXTERNAL_SEARCH_ID     = 
+EXTERNAL_SEARCH_ID     =
 
 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
 # projects other than the one defined by this configuration file, but that are
@@ -1590,7 +1597,7 @@ EXTERNAL_SEARCH_ID     =
 # EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
 # This tag requires that the tag SEARCHENGINE is set to YES.
 
-EXTRA_SEARCH_MAPPINGS  = 
+EXTRA_SEARCH_MAPPINGS  =
 
 #---------------------------------------------------------------------------
 # Configuration options related to the LaTeX output
@@ -1651,7 +1658,7 @@ PAPER_TYPE             = a4
 # If left blank no extra packages will be included.
 # This tag requires that the tag GENERATE_LATEX is set to YES.
 
-EXTRA_PACKAGES         = 
+EXTRA_PACKAGES         =
 
 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
 # generated LaTeX document. The header should contain everything until the first
@@ -1667,7 +1674,7 @@ EXTRA_PACKAGES         =
 # PROJECT_NAME), or the project number (see PROJECT_NUMBER).
 # This tag requires that the tag GENERATE_LATEX is set to YES.
 
-LATEX_HEADER           = 
+LATEX_HEADER           =
 
 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
 # generated LaTeX document. The footer should contain everything after the last
@@ -1676,7 +1683,7 @@ LATEX_HEADER           =
 # Note: Only use a user-defined footer if you know what you are doing!
 # This tag requires that the tag GENERATE_LATEX is set to YES.
 
-LATEX_FOOTER           = 
+LATEX_FOOTER           =
 
 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
 # other source files which should be copied to the LATEX_OUTPUT output
@@ -1684,7 +1691,7 @@ LATEX_FOOTER           =
 # markers available.
 # This tag requires that the tag GENERATE_LATEX is set to YES.
 
-LATEX_EXTRA_FILES      = 
+LATEX_EXTRA_FILES      =
 
 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
@@ -1784,14 +1791,14 @@ RTF_HYPERLINKS         = NO
 # default style sheet that doxygen normally uses.
 # This tag requires that the tag GENERATE_RTF is set to YES.
 
-RTF_STYLESHEET_FILE    = 
+RTF_STYLESHEET_FILE    =
 
 # Set optional variables used in the generation of an RTF document. Syntax is
 # similar to doxygen's config file. A template extensions file can be generated
 # using doxygen -e rtf extensionFile.
 # This tag requires that the tag GENERATE_RTF is set to YES.
 
-RTF_EXTENSIONS_FILE    = 
+RTF_EXTENSIONS_FILE    =
 
 #---------------------------------------------------------------------------
 # Configuration options related to the man page output
@@ -1852,13 +1859,13 @@ XML_OUTPUT             = xml
 # validating XML parser to check the syntax of the XML files.
 # This tag requires that the tag GENERATE_XML is set to YES.
 
-XML_SCHEMA             = 
+XML_SCHEMA             =
 
 # The XML_DTD tag can be used to specify a XML DTD, which can be used by a
 # validating XML parser to check the syntax of the XML files.
 # This tag requires that the tag GENERATE_XML is set to YES.
 
-XML_DTD                = 
+XML_DTD                =
 
 # If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
 # listings (including syntax highlighting and cross-referencing information) to
@@ -1935,7 +1942,7 @@ PERLMOD_PRETTY         = YES
 # overwrite each other's variables.
 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
 
-PERLMOD_MAKEVAR_PREFIX = 
+PERLMOD_MAKEVAR_PREFIX =
 
 #---------------------------------------------------------------------------
 # Configuration options related to the preprocessor
@@ -1976,7 +1983,7 @@ SEARCH_INCLUDES        = YES
 # preprocessor.
 # This tag requires that the tag SEARCH_INCLUDES is set to YES.
 
-INCLUDE_PATH           = 
+INCLUDE_PATH           =
 
 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
 # patterns (like *.h and *.hpp) to filter out the header-files in the
@@ -1984,7 +1991,7 @@ INCLUDE_PATH           =
 # used.
 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
 
-INCLUDE_FILE_PATTERNS  = 
+INCLUDE_FILE_PATTERNS  =
 
 # The PREDEFINED tag can be used to specify one or more macro names that are
 # defined before the preprocessor is started (similar to the -D option of e.g.
@@ -1994,7 +2001,7 @@ INCLUDE_FILE_PATTERNS  =
 # recursively expanded use the := operator instead of the = operator.
 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
 
-PREDEFINED             = 
+PREDEFINED             =
 
 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
 # tag can be used to specify a list of macro names that should be expanded. The
@@ -2003,7 +2010,7 @@ PREDEFINED             =
 # definition found in the source code.
 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
 
-EXPAND_AS_DEFINED      = 
+EXPAND_AS_DEFINED      =
 
 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
 # remove all refrences to function-like macros that are alone on a line, have an
@@ -2032,13 +2039,13 @@ SKIP_FUNCTION_MACROS   = YES
 # the path). If a tag file is not located in the directory in which doxygen is
 # run, you must also specify the path to the tagfile here.
 
-TAGFILES               = 
+TAGFILES               =
 
 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
 # tag file that is based on the input files it reads. See section "Linking to
 # external documentation" for more information about the usage of tag files.
 
-GENERATE_TAGFILE       = 
+GENERATE_TAGFILE       =
 
 # If the ALLEXTERNALS tag is set to YES all external class will be listed in the
 # class index. If set to NO only the inherited external classes will be listed.
@@ -2086,14 +2093,14 @@ CLASS_DIAGRAMS         = NO
 # the mscgen tool resides. If left empty the tool is assumed to be found in the
 # default search path.
 
-MSCGEN_PATH            = 
+MSCGEN_PATH            =
 
 # You can include diagrams made with dia in doxygen documentation. Doxygen will
 # then run dia to produce the diagram and insert it in the documentation. The
 # DIA_PATH tag allows you to specify the directory where the dia binary resides.
 # If left empty dia is assumed to be found in the default search path.
 
-DIA_PATH               = 
+DIA_PATH               =
 
 # If set to YES, the inheritance and collaboration graphs will hide inheritance
 # and usage relations if the target is undocumented or is not a class.
@@ -2142,7 +2149,7 @@ DOT_FONTSIZE           = 10
 # the path where dot can find it using this tag.
 # This tag requires that the tag HAVE_DOT is set to YES.
 
-DOT_FONTPATH           = 
+DOT_FONTPATH           =
 
 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
 # each documented class showing the direct and indirect inheritance relations.
@@ -2280,26 +2287,26 @@ INTERACTIVE_SVG        = NO
 # found. If left blank, it is assumed the dot tool can be found in the path.
 # This tag requires that the tag HAVE_DOT is set to YES.
 
-DOT_PATH               = 
+DOT_PATH               =
 
 # The DOTFILE_DIRS tag can be used to specify one or more directories that
 # contain dot files that are included in the documentation (see the \dotfile
 # command).
 # This tag requires that the tag HAVE_DOT is set to YES.
 
-DOTFILE_DIRS           = 
+DOTFILE_DIRS           =
 
 # The MSCFILE_DIRS tag can be used to specify one or more directories that
 # contain msc files that are included in the documentation (see the \mscfile
 # command).
 
-MSCFILE_DIRS           = 
+MSCFILE_DIRS           =
 
 # The DIAFILE_DIRS tag can be used to specify one or more directories that
 # contain dia files that are included in the documentation (see the \diafile
 # command).
 
-DIAFILE_DIRS           = 
+DIAFILE_DIRS           =
 
 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
 # that will be shown in the graph. If the number of nodes in a graph becomes

doxy/DoxygenLayout.xml

@@ -4,17 +4,18 @@
   <navindex>
     <tab type="mainpage" visible="yes" title=""/>
     <tab type="pages" visible="yes" title="" intro=""/>
-    <tab type="modules" visible="yes" title="UPM libraries" intro="Here is a
+    <tab type="modules" visible="yes" title="UPM Libraries" intro="Here is a
     list of UPM libraries that can be used. Note that each of the classes
-    listed in these libraries are completely seperate so you will need to link
-    against all those that you have used in your program"/> <tab
+    listed in these libraries are completely separate so you will need to link
+    against all those that you have used in your program. Use the hierarchical
+    tree to filter between different types of sensors."/> <tab
     type="namespaces" visible="yes" title="">
     <tab type="namespacelist" visible="yes" title="" intro=""/>
     <tab type="namespacemembers" visible="yes" title="" intro=""/>
     </tab>
     <tab type="classes" visible="yes" title="">
     <tab type="classlist" visible="yes" title="" intro=""/>
-    <tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/> 
+    <tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/>
     <tab type="hierarchy" visible="yes" title="" intro=""/>
     <tab type="classmembers" visible="yes" title="" intro=""/>
     </tab>
@@ -22,7 +23,7 @@
     <tab type="filelist" visible="yes" title="" intro=""/>
     <tab type="globals" visible="yes" title="" intro=""/>
     </tab>
-    <tab type="examples" visible="yes" title="" intro=""/>  
+    <tab type="examples" visible="yes" title="" intro=""/>
   </navindex>
 
   <!-- Layout definition for a class page -->
@@ -141,9 +142,8 @@
   <!-- Layout definition for a group page -->
   <group>
     <briefdescription visible="yes"/>
-    <groupgraph visible="$GROUP_GRAPHS"/>
     <memberdecl>
-      <nestedgroups visible="yes" title=""/>
+      <nestedgroups visible="yes" title="Libraries"/>
       <dirs visible="yes" title=""/>
       <files visible="yes" title=""/>
       <namespaces visible="yes" title=""/>
@@ -181,6 +181,7 @@
       <properties title=""/>
       <friends title=""/>
     </memberdef>
+	<groupgraph visible="$GROUP_GRAPHS"/>
     <authorsection visible="yes"/>
   </group>