Changed getDistance() to getDistanceCentimeters()

Changed the name of the ScanPacket method getDistance() to
getDistanceCentimeters() to indicate the unit of measurement of the
returned value. This name is also parallel with the method
getAngleDegrees(). Also, updated keywords.txt, the readme, and the
Arduino sketches accordingly.

Author: johnsonb2

README.md

@@ -223,7 +223,7 @@ uint16_t getAngleRaw() const
 Returns the angle of this reading as the raw 16-bit fixed point value. The scaling factor of this value is 16; this means that the angle in degrees is obtained by dividing the raw value by 16.
 
 ```c++
-uint16_t getDistance() const
+uint16_t getDistanceCentimeters() const
 ```
 
 Returns the distance of this reading, in centimeters.

Sweep/Examples/MegaDistanceBlink/MegaDistanceBlink.ino

@@ -192,11 +192,12 @@ bool gatherDistanceInfo()
     if (reading.getAngleDegrees() > 360 - FOV)
     {
       // only consider valid readings (sensor will report distance of 1 for failed readings)
-      if (reading.getDistance() > 1)
+      uint16_t dist = reading.getDistanceCentimeters();
+      if (dist > 1)
       {
         // check if this reading is closer than anything seen so far
-        if (reading.getDistance() < closestDistanceInSpecifiedFOV)
-          closestDistanceInSpecifiedFOV = reading.getDistance();
+        if (dist < closestDistanceInSpecifiedFOV)
+          closestDistanceInSpecifiedFOV = dist;
       }
     }
   }
@@ -244,4 +245,4 @@ void reset()
   ledState = LOW;
   digitalWrite(LED_BUILTIN, ledState); // turn the LED off by making the voltage LOW
   device.reset();
-}
+}

Sweep/Examples/MegaSerialPrinter/MegaSerialPrinter.ino

@@ -206,7 +206,7 @@ void gatherSensorReading()
     // store the info for this sample
     syncValues[sampleCount] = reading.isSync();
     angles[sampleCount] = reading.getAngleDegrees();
-    distances[sampleCount] = reading.getDistance();
+    distances[sampleCount] = reading.getDistanceCentimeters();
     signalStrengths[sampleCount] = reading.getSignalStrength();
 
     // increment sample count

Sweep/ScanPacket.cpp

@@ -20,7 +20,7 @@ uint16_t ScanPacket::getAngleRaw() const
     return _rawAngle;
 }
 
-uint16_t ScanPacket::getDistance() const
+uint16_t ScanPacket::getDistanceCentimeters() const
 {
     return _distance;
 }

Sweep/ScanPacket.h

@@ -22,8 +22,8 @@ class ScanPacket
     // Returns the angle as a raw fixed point value
     uint16_t getAngleRaw() const;
 
-    // Returns the range measurement
-    uint16_t getDistance() const;
+    // Returns the range measurement in centimeters
+    uint16_t getDistanceCentimeters() const;
 
     // Returns the signal strength as an integer value between 0 and 255
     uint8_t getSignalStrength() const;

Sweep/keywords.txt

@@ -26,7 +26,7 @@ reset	KEYWORD2
 isSync	KEYWORD2
 getAngleDegrees	KEYWORD2
 getAngleRaw	KEYWORD2
-getDistance	KEYWORD2
+getDistanceCentimeters	KEYWORD2
 getSignalStrength	KEYWORD2
 
 #######################################