From 3e6ec5087b6da1b42330ba87ac0234ed62050bfe Mon Sep 17 00:00:00 2001 From: Mihai Tudor Panu Date: Tue, 16 Jun 2015 11:58:00 -0700 Subject: [PATCH] docs: made a few modifications in known limitations, changelog and building instructions Signed-off-by: Mihai Tudor Panu --- docs/building.md | 12 ++++++++---- docs/changelog.md | 10 +++++----- docs/knownlimitations.md | 6 ++++++ 3 files changed, 19 insertions(+), 9 deletions(-) diff --git a/docs/building.md b/docs/building.md index 1e340dfe..869f2d10 100644 --- a/docs/building.md +++ b/docs/building.md @@ -3,8 +3,7 @@ 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: @@ -25,7 +24,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 +61,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++, diff --git a/docs/changelog.md b/docs/changelog.md index 8efa262e..fced95f0 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -9,19 +9,19 @@ from earlier versions: * Updated index pages for API documentation and cross-linked them * More images were added for Grove, Adafruit and Sparkfun sensors along with licensing information - * Addressed several issues reported by static code analysis tools + * Addressed several issues regarding code robustness * Added support for Grove NFC Tag sensor * Fixed several typos in library and sensor names ### 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 ### v0.2.0 diff --git a/docs/knownlimitations.md b/docs/knownlimitations.md index 2d799c7b..35d0e91a 100644 --- a/docs/knownlimitations.md +++ b/docs/knownlimitations.md @@ -16,6 +16,9 @@ such sensors and known workarounds if they exist. 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 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 @@ -40,6 +43,9 @@ such sensors and known workarounds if they exist. #### Other Sensors * **MPU9150** might return inaccurate data. + * **SM130** driver might not be fully functional. + * **NRF24L01** might not handle data packets as expected. + * **NRF8001** based devices do not initialize properly with provided examples. #### General