Merge pull request #6 from DrGFreeman/GP2Y0A710K0F

Add GPY0A710K0F sensor model

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.1  
+Version 1.2.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)
 
@@ -38,7 +38,7 @@ Constructor: `pin` is the analog pin to which the sensor is connected, `size` is
 Returns the measured distance. Distance units are in millimeters (mm) if using the library default settings or pre-defined sensor models. If using custom calibration, units depend on the calibration used.  
 
 * `void setModel(const byte model)`
-Sets the calibration based on pre-defined sensor model fit functions.  
+Sets the calibration based on pre-defined sensor model fit functions. Note that the model argument must be preceded by the SharpDistSensor namespace, i.e.: `setModel(SharpDistSensor::Model_Name)`
 
 * `void setPolyFitCoeffs(const byte nbCoeffs, const float* coeffs, const uint16_t valMin, const uint16_t valMax)`  
 Sets the polynomial fit function coefficients _C0_ to _C5_ in the relation:  
@@ -54,17 +54,20 @@ where _A_ is the analog value read from the sensor. `valMin` and `valMax` define
 Sets the range of analog values for which the polynomial or power fit is valid (`valMin` and `valMax`). Analog values outside this range will be set to the respective min or max values.
 
 ## Pre-defined sensor models
-* `GP2Y0A60SZLF_5V` - GP2Y0A60SZLF Analog Distance Sensor 10-150cm, 5V  
+* `GP2Y0A60SZLF_5V` - GP2Y0A60SZLF Analog Distance Sensor 10-150cm, 5V
+* `GP2Y0A710K0F_5V_DS` - GP2Y0A710K0F Analog Distance Sensor 100-500cm, 5V (data sheet)
 
 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
+**GP2Y0A710K0F_5V_DS** | mm | 178506 | -1607.72 | 5.5239 | -8.47601E-3 | 4.87819E-6 | |  284 | 507
 
 **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.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.
 * 1.0.0 (2017-03-29): Initial major release for Arduino Library Manager (no change rel. to 0.3.2)

SharpDistSensor.cpp

@@ -87,11 +87,18 @@ void SharpDistSensor::setModel(const models model)
   {
     case GP2Y0A60SZLF_5V:
     {
-      // Set default coefficients and range for Sharp GP2Y0A60SZLF 5V
+      // Set coefficients and range for Sharp GP2Y0A60SZLF 5V
       float coeffs[] = {1734, -9.005, 2.023E-2, -2.251E-5, 1.167E-8, -2.037E-12};
       setPolyFitCoeffs(6, coeffs, 30, 875);
       break;
     }
+    case GP2Y0A710K0F_5V_DS:
+    {
+      // Set coefficients and range for Sharp GP2Y0A710K0F 5V
+      float coeffs[] = {178506, -1607.72, 5.5239, -8.47601E-3, 4.87819E-6};
+      setPolyFitCoeffs(5, coeffs, 284, 507);
+      break;
+    }
   }
 }
 

SharpDistSensor.h

@@ -43,6 +43,7 @@ coefficients may be required.
 Use the setModel method to change the sensor model calibration. The following
 models are currently supported:
 -GP2Y0A60SZLF_5V (GP2Y0A60SZLF Analog Distance Sensor 10-150cm, 5V)
+-GP2Y0A710K0F_5V_DS (GP2Y0A710K0F Analog Distance Sensor 100-500cm, 5V)
 
 Use the setPolyFitCoeffs method to define custom polynomial coefficients.
 
@@ -67,7 +68,9 @@ class SharpDistSensor
   enum models
   {
     // Constant for GP2Y0A60SZLF 5V model
-    GP2Y0A60SZLF_5V
+    GP2Y0A60SZLF_5V,
+    // Constant for GP2Y0A710K0F 5V model
+    GP2Y0A710K0F_5V_DS
   };
 
   /** Constructor

examples/SharpDistSensorByModel/SharpDistSensorByModel.ino

@@ -47,7 +47,7 @@ void setup() {
   Serial.begin(9600);
 
   // Set sensor model
-  sensor.setModel(SharpDistSensor::GP2Y0A60SZLF_5V);
+  sensor.setModel(SharpDistSensor::GP2Y0A710K0F_5V_DS);
 }
 
 void loop() {

keywords.txt

@@ -5,4 +5,4 @@ setPolyFitCoeffs	KEYWORD2
 setPowerFitCoeffs	KEYWORD2
 setValMinMax	KEYWORD2
 GP2Y0A60SZLF_5V	LITERAL1
-GP2Y0A60SZLF_3V	LITERAL1
+GP2Y0A710K0F_5V_DS	LITERAL1

library.properties

@@ -1,5 +1,5 @@
 name=SharpDistSensor
-version=1.1.1
+version=1.2.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