Merge pull request #9 from DrGFreeman/in_work

Adding SharpDistSensorArray example

Author: DrGFreeman

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017 
+Copyright (c) 2017-2018
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,7 +1,7 @@
 # SharpDistSensor
 A library for the Arduino IDE that helps interface with Sharp analog distance sensors.  
 
-Version 1.2.0  
+Version 1.3.0  
 [![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)
 
@@ -16,7 +16,8 @@ For different accuracy, range, sensor model or units, different coefficients may
 The distance output is filtered using real-time median filtering (sliding window of ajustable size). The MedianFilter class from the following library is used: https://github.com/daPhoosa/MedianFilter.
 
 ## Examples
-Four example sketches are provided with the library:
+Five example sketches are provided with the library:
+
 * _SharpDistSensorBasic.ino_  
 This example shows how to use the library with the default calibration function for the Sharp GP2Y0A60SZLF 5V sensor.
 
@@ -30,6 +31,9 @@ This example shows how to use the library with a custom, user defined polynomial
 * _SharpDistSensorCustomPower.ino_  
 This example shows how to use the library with a custom, user defined power calibration function.
 
+* _SharpDistSensorArray.ino_  
+This example shows how to use the library with an array of multiple sensors.
+
 ## Library Reference
 * `SharpDistSensor(const byte pin, const byte size = 1)`  
 Constructor: `pin` is the analog pin to which the sensor is connected, `size` is the size of the median filter window and should be an odd positive integer (default = 1 = no filtering).  
@@ -67,6 +71,7 @@ Model | Units | C0 | C1 | C2 | C3 | C4 | C5 | valMin | valMax
 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.3.0 (2018-05-20): Added SharpDistSensorArray example.
 * 1.2.0 (2017-05-10): Added GP2Y0A710K0F_5V_DS model.
 * 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.

examples/SharpDistSensorArray/SharpDistSensorArray.ino

@@ -0,0 +1,71 @@
+/*
+SharpDistSensorArray.ino
+
+Source: https://github.com/DrGFreeman/SharpDistSensor
+
+MIT License
+
+Copyright (c) 2018 Julien de la Bruere-Terreault <drgfreeman@tuta.io>
+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.
+*/
+
+/*
+This example shows how to use the SharpDistSensor library with an array of
+multiple sensors.
+
+See the library README for how to use pre-defined sensor models or  custom fit
+functions.
+*/
+
+#include <SharpDistSensor.h>
+
+// Define the number of sensors in the array as a constant
+const byte nbSensors = 2;
+
+// Window size of the median filter (odd number, 1 = no filtering)
+const byte medianFilterWindowSize = 5;
+
+// Define the array of SharpDistSensor objects
+SharpDistSensor sensorArray[] = {
+  SharpDistSensor(A1, medianFilterWindowSize), // First sensor using pin A1
+  SharpDistSensor(A2, medianFilterWindowSize), // Second sensor using pin A2
+  // Add as many sensors as required
+};
+
+// Alternatively, the array can be defined this way
+// SharpDistSensor sensorArray[nbSensors] = {{A1, medianFilterWindowSize},
+//                                           {A2, medianFilterWindowSize}};
+
+// Define an array of integers that will store the measured distances
+uint16_t distArray[nbSensors];
+
+void setup() {
+  // Set some parameters for each sensor in array
+  for (byte i = 0; i < nbSensors; i++) {
+    sensorArray[i].setModel(SharpDistSensor::GP2Y0A710K0F_5V_DS);  // Set sensor model
+    // Set other parameters as required
+  }
+}
+
+void loop() {
+  // Read distance for each sensor in array into an array of distances
+  for (byte i = 0; i < nbSensors; i++) {
+    distArray[i] = sensorArray[i].getDist();
+  }
+}

examples/SharpDistSensorBasic/SharpDistSensorBasic.ino

@@ -27,8 +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
-in mm.
+read the sensor and display the measured distance in mm to the serial monitor.
 
 The library default values corresponding to the Sharp GP2Y0A60SZLF 5V sensor
 are used.
@@ -43,10 +42,10 @@ fit functions.
 const byte sensorPin = A0;
 
 // Window size of the median filter (odd number, 1 = no filtering)
-const byte mediumFilterWindowSize = 5;
+const byte medianFilterWindowSize = 5;
 
 // Create an object instance of the SharpDistSensor class
-SharpDistSensor sensor(sensorPin, mediumFilterWindowSize);
+SharpDistSensor sensor(sensorPin, medianFilterWindowSize);
 
 
 void setup() {

examples/SharpDistSensorByModel/SharpDistSensorByModel.ino

@@ -38,10 +38,10 @@ constants or for how to use custom defined fit functions.
 const byte sensorPin = A0;
 
 // Window size of the median filter (odd number, 1 = no filtering)
-const byte mediumFilterWindowSize = 5;
+const byte medianFilterWindowSize = 5;
 
 // Create an object instance of the SharpDistSensor class
-SharpDistSensor sensor(sensorPin, mediumFilterWindowSize);
+SharpDistSensor sensor(sensorPin, medianFilterWindowSize);
 
 void setup() {
   Serial.begin(9600);

examples/SharpDistSensorCustomPoly/SharpDistSensorCustomPoly.ino

@@ -41,10 +41,10 @@ for different sensors, units, calibration or range.
 const byte sensorPin = A0;
 
 // Window size of the median filter (odd number, 1 = no filtering)
-const byte mediumFilterWindowSize = 5;
+const byte medianFilterWindowSize = 5;
 
 // Create an object instance of the SharpDistSensor class
-SharpDistSensor sensor(sensorPin, mediumFilterWindowSize);
+SharpDistSensor sensor(sensorPin, medianFilterWindowSize);
 
 /*
  * Polynomial fit curve coefficients C0 to C5 in relation:

examples/SharpDistSensorCustomPower/SharpDistSensorCustomPower.ino

@@ -37,10 +37,10 @@ using custom power fit curve and range.
 const byte sensorPin = A0;
 
 // Window size of the median filter (odd number, 1 = no filtering)
-const byte mediumFilterWindowSize = 5;
+const byte medianFilterWindowSize = 5;
 
 // Create an object instance of the SharpDistSensor class
-SharpDistSensor sensor(sensorPin, mediumFilterWindowSize);
+SharpDistSensor sensor(sensorPin, medianFilterWindowSize);
 
 /* Set the power fit curve coefficients and range
  * C and P: Coefficients in Distance = C*A^P relation

library.properties

@@ -1,7 +1,7 @@
 name=SharpDistSensor
-version=1.2.0
-author=Julien de la Bruere-Terreault (drgfreeman@tuta.io)
-maintainer=Julien de la Bruere-Terreault (drgfreeman@tuta.io)
+version=1.3.0
+author=Julien de la Bruere-Terreault, drgfreeman@tuta.io
+maintainer=Julien de la Bruere-Terreault, drgfreeman@tuta.io
 sentence=Sharp analog distance sensor library
 paragraph=This is a library for the Arduino IDE that helps interface with Sharp IR analog distance sensors. It supports polynomial and power fit functions as well as real-time median filtering (sliding window of ajustable size).
 category=Sensors