Merge pull request #5 from DrGFreeman/in_work

Improved documentation

Author: DrGFreeman

README.md

@@ -1,7 +1,7 @@
 # SharpDistSensor
 A library for the Arduino IDE that helps interface with Sharp analog distance sensors.  
 
-Version 1.1.0  
+Version 1.1.1  
 [![Build Status](https://travis-ci.org/DrGFreeman/SharpDistSensor.svg?branch=master)](https://travis-ci.org/DrGFreeman/SharpDistSensor)  
 By Julien de la Bruère-Terreault (drgfreeman@tuta.io)
 
@@ -60,7 +60,12 @@ Model | Units | C0 | C1 | C2 | C3 | C4 | C5 | valMin | valMax
 ------|-------|----|----|----|----|----|----|--------|--------
 **GP2Y0A60SZLF_5V** | mm | 1734 | -9.005 | 2.032E-2 | -2.251E-5 | 1.167E-8 | -2.037E-12 | 30 | 875
 
+**Important Note:** The analog voltage returned by the sensor is largely dependent of the reflected object size and reflectivity. The distance returned by these pre-defined calibration functions can therefore vary significantly from the real distance depending on the object detected. Where accuracy is required by the application, it is recommended to perform calibration with the object to be detected and use custom calibration fit functions instead.
+
+This library has been designed so that it is easy to add sensor models. Contributions are therefore welcome. Adding models to the library can be done by either submitting a pull request or providing me the proposed fit function and associated calibration data by email so I can add it myself. Thank you for contributing!
+
 ## Version history
+* 1.1.1 (2017-05-01): Clarified comments and fixed typos in examples, improved README.
 * 1.1.0 (2017-04-05): Added support of power fit functions.
 * 1.0.0 (2017-03-29): Initial major release for Arduino Library Manager (no change rel. to 0.3.2)
 * 0.3.2 (2017-03-29): Modified models enum and related type in setModel method arguments.

examples/SharpDistSensorBasic/SharpDistSensorBasic.ino

@@ -33,12 +33,8 @@ in mm.
 The library default values corresponding to the Sharp GP2Y0A60SZLF 5V sensor
 are used.
 
-For how to use a different sensor model pre-defined in this library, see the
-SharpDistSensorByModel.ino example sketch in this library.
-
-For how to use different sensor model, units, range or calibration with a
-custom calibration curve, see the SharpDistSensorCustom.ino example sketch in
-this library.
+See the library README for how to use pre-defined sensor models or custom
+fit functions.
 */
 
 #include <SharpDistSensor.h>

examples/SharpDistSensorByModel/SharpDistSensorByModel.ino

@@ -29,11 +29,7 @@ SOFTWARE.
 This example shows how to use the SharpDistSensor library to continuously
 read the sensor and display the distance in mm using a pre-defined sensor model.
 See the library README page for the list of available models and corresponding
-constants.
-
-For how to use different sensor model, units, range or calibration with a
-custom calibration curve, see the SharpDistSensorCustom.ino example sketch in
-this library.
+constants or for how to use custom defined fit functions.
 */
 
 #include <SharpDistSensor.h>

examples/SharpDistSensorCustomPoly/SharpDistSensorCustomPoly.ino

@@ -27,7 +27,7 @@ SOFTWARE.
 
 /*
 This example shows how to use the SharpDistSensor library to continuously
-read the sensor and display the analog value and the corrseponding distance
+read the sensor and display the analog value and the corresponding distance
 using custom polynomial fit curve and range.
 
 The same values as the library default values for the Sharp GP2Y0A60SZLF 5V

examples/SharpDistSensorCustomPower/SharpDistSensorCustomPower.ino

@@ -27,7 +27,7 @@ SOFTWARE.
 
 /*
 This example shows how to use the SharpDistSensor library to continuously
-read the sensor and display the analog value and the corrseponding distance
+read the sensor and display the analog value and the corresponding distance
 using custom power fit curve and range.
 */
 

library.properties

@@ -1,5 +1,5 @@
 name=SharpDistSensor
-version=1.1.0
+version=1.1.1
 author=Julien de la Bruere-Terreault (drgfreeman@tuta.io)
 maintainer=Julien de la Bruere-Terreault (drgfreeman@tuta.io)
 sentence=Sharp analog distance sensor library