Update examples to freeze on failure

Previous examples would only print success, but then run regardless. This stops on failure and says so. Also added link to lib and changed to 115200bps.

Author: nseidle

examples/Example1_ReadDistance/Example1_ReadDistance.ino

@@ -20,7 +20,7 @@
 */
 
 #include <Wire.h>
-#include "SparkFun_VL53L1X.h"
+#include "SparkFun_VL53L1X.h" //Click here to get the library: http://librarymanager/All#SparkFun_VL53L1X
 
 //Optional interrupt and shutdown pins.
 #define SHUTDOWN_PIN 2
@@ -34,19 +34,23 @@ void setup(void)
 {
   Wire.begin();
 
-  Serial.begin(9600);
+  Serial.begin(115200);
   Serial.println("VL53L1X Qwiic Test");
 
-  if (distanceSensor.begin() == 0) //Begin returns 0 on a good init
+  if (distanceSensor.begin() != 0) //Begin returns 0 on a good init
   {
-    Serial.println("Sensor online!");
+    Serial.println("Sensor failed to begin. Please check wiring. Freezing...");
+    while (1)
+      ;
   }
+  Serial.println("Sensor online!");
 }
 
 void loop(void)
 {
   distanceSensor.startRanging(); //Write configuration bytes to initiate measurement
-  while (!distanceSensor.checkForDataReady()) {
+  while (!distanceSensor.checkForDataReady())
+  {
     delay(1);
   }
   int distance = distanceSensor.getDistance(); //Get the result of the measurement from the sensor
@@ -64,4 +68,3 @@ void loop(void)
 
   Serial.println();
 }
-

examples/Example2_SetDistanceMode/Example2_SetDistanceMode.ino

@@ -15,7 +15,7 @@
 */
 
 #include <Wire.h>
-#include "SparkFun_VL53L1X.h"
+#include "SparkFun_VL53L1X.h" //Click here to get the library: http://librarymanager/All#SparkFun_VL53L1X
 
 //Optional interrupt and shutdown pins.
 #define SHUTDOWN_PIN 2
@@ -29,14 +29,17 @@ void setup(void)
 {
   Wire.begin();
 
-  Serial.begin(9600);
+  Serial.begin(115200);
   Serial.println("VL53L1X Qwiic Test");
 
-  if (distanceSensor.begin() == 0) //Begin returns 0 on a good init
+  if (distanceSensor.begin() != 0) //Begin returns 0 on a good init
   {
-    Serial.println("Sensor online!");
+    Serial.println("Sensor failed to begin. Please check wiring. Freezing...");
+    while (1)
+      ;
   }
-  
+  Serial.println("Sensor online!");
+
   distanceSensor.setDistanceModeShort();
   //distanceSensor.setDistanceModeLong();
 }
@@ -45,12 +48,13 @@ void loop(void)
 {
   distanceSensor.startRanging(); //Write configuration bytes to initiate measurement
 
-  while (!distanceSensor.checkForDataReady()) {
+  while (!distanceSensor.checkForDataReady())
+  {
     delay(1);
   }
   int distance = distanceSensor.getDistance(); //Get the result of the measurement from the sensor
   distanceSensor.clearInterrupt();
-  
+
   distanceSensor.stopRanging();
 
   Serial.print("Distance(mm): ");
@@ -64,4 +68,3 @@ void loop(void)
 
   Serial.println();
 }
-

examples/Example3_StatusAndRate/Example3_StatusAndRate.ino

@@ -14,7 +14,7 @@
 */
 
 #include <Wire.h>
-#include "SparkFun_VL53L1X.h"
+#include "SparkFun_VL53L1X.h" //Click here to get the library: http://librarymanager/All#SparkFun_VL53L1X
 
 //Optional interrupt and shutdown pins.
 #define SHUTDOWN_PIN 2
@@ -33,36 +33,43 @@ void setup(void)
 {
   Wire.begin();
 
-  Serial.begin(9600);
+  Serial.begin(115200);
   Serial.println("VL53L1X Qwiic Test");
 
-  if (distanceSensor.begin() == 0) //Begin returns 0 on a good init
-    Serial.println("Sensor online!");
+  if (distanceSensor.begin() != 0) //Begin returns 0 on a good init
+  {
+    Serial.println("Sensor failed to begin. Please check wiring. Freezing...");
+    while (1)
+      ;
+  }
+  Serial.println("Sensor online!");
 
-  for (int x = 0 ; x < HISTORY_SIZE ; x++)
+  for (int x = 0; x < HISTORY_SIZE; x++)
     history[x] = 0;
 }
 
 void loop(void)
 {
   long startTime = millis();
   distanceSensor.startRanging(); //Write configuration block of 135 bytes to setup a measurement
-  while (!distanceSensor.checkForDataReady()) {
+  while (!distanceSensor.checkForDataReady())
+  {
     delay(1);
   }
   int distance = distanceSensor.getDistance(); //Get the result of the measurement from the sensor
   distanceSensor.clearInterrupt();
   distanceSensor.stopRanging();
   long endTime = millis();
-  
+
   Serial.print("Distance(mm): ");
   Serial.print(distance);
 
   history[historySpot] = distance;
-  if (++historySpot == HISTORY_SIZE) historySpot = 0;
+  if (++historySpot == HISTORY_SIZE)
+    historySpot = 0;
 
   long avgDistance = 0;
-  for (int x = 0 ; x < HISTORY_SIZE ; x++)
+  for (int x = 0; x < HISTORY_SIZE; x++)
     avgDistance += history[x];
 
   avgDistance /= HISTORY_SIZE;
@@ -85,27 +92,26 @@ void loop(void)
   //Make it human readable
   switch (rangeStatus)
   {
-    case 0:
-      Serial.print("Good");
-      break;
-    case 1:
-      Serial.print("Sigma fail");
-      break;
-    case 2:
-      Serial.print("Signal fail");
-      break;
-    case 7:
-      Serial.print("Wrapped target fail");
-      break;
-    default:
-      Serial.print("Unknown: ");
-      Serial.print(rangeStatus);
-      break;
+  case 0:
+    Serial.print("Good");
+    break;
+  case 1:
+    Serial.print("Sigma fail");
+    break;
+  case 2:
+    Serial.print("Signal fail");
+    break;
+  case 7:
+    Serial.print("Wrapped target fail");
+    break;
+  default:
+    Serial.print("Unknown: ");
+    Serial.print(rangeStatus);
+    break;
   }
 
   Serial.print("\tHz: ");
   Serial.print(1000.0 / (float)(endTime - startTime), 2);
 
   Serial.println();
 }
-

examples/Example4_SetIntermeasurementPeriod/Example4_SetIntermeasurementPeriod.ino

@@ -14,7 +14,7 @@
 */
 
 #include <Wire.h>
-#include "SparkFun_VL53L1X.h"
+#include "SparkFun_VL53L1X.h" //Click here to get the library: http://librarymanager/All#SparkFun_VL53L1X
 
 //Optional interrupt and shutdown pins.
 #define SHUTDOWN_PIN 2
@@ -28,12 +28,17 @@ void setup(void)
 {
   Wire.begin();
 
-  Serial.begin(9600);
+  Serial.begin(115200);
   Serial.println("VL53L1X Qwiic Test");
 
-  if (distanceSensor.begin() == 0) //Begin returns 0 on a good init
+  if (distanceSensor.begin() != 0) //Begin returns 0 on a good init
+  {
+    Serial.println("Sensor failed to begin. Please check wiring. Freezing...");
+    while (1)
+      ;
+  }
   Serial.println("Sensor online!");
-    
+
   // Intermeasurement period must be >= timing budget. Default = 100 ms.
   distanceSensor.setIntermeasurementPeriod(200);
   Serial.println(distanceSensor.getIntermeasurementPeriod());
@@ -42,7 +47,8 @@ void setup(void)
 
 void loop(void)
 {
-  while (!distanceSensor.checkForDataReady()) {
+  while (!distanceSensor.checkForDataReady())
+  {
     delay(1);
   }
   int distance = distanceSensor.getDistance(); //Get the result of the measurement from the sensor
@@ -59,4 +65,3 @@ void loop(void)
 
   Serial.println();
 }
-

examples/Example5_LCDDemo/Example5_LCDDemo.ino

@@ -15,7 +15,7 @@
 
 */
 #include <Wire.h>
-#include "SparkFun_VL53L1X.h"
+#include "SparkFun_VL53L1X.h" //Click here to get the library: http://librarymanager/All#SparkFun_VL53L1X
 #include <SoftwareSerial.h>
 
 //Optional interrupt and shutdown pins.
@@ -50,7 +50,7 @@ byte deltaSpot = 0; //Keeps track of where we are within the deltas array
 //Too quickly and it gets twitchy. Too slow and it doesn't seem like it's responding.
 #define LOOPTIME 50
 
-int maxMPH = 0; //Keeps track of what the latest fastest speed is
+int maxMPH = 0;          //Keeps track of what the latest fastest speed is
 long maxMPH_timeout = 0; //Forget the max speed after some length of time
 
 #define maxMPH_remember 3000 //After this number of ms the system will forget the max speed
@@ -73,12 +73,15 @@ void setup(void)
   lcd.print("Distance: 3426  ");
   lcd.print("12 mph          ");
 
-  if (distanceSensor.begin() == 0) //Begin returns 0 on a good init
+  if (distanceSensor.begin() != 0) //Begin returns 0 on a good init
   {
-    Serial.println("Sensor online!");
+    Serial.println("Sensor failed to begin. Please check wiring. Freezing...");
+    while (1)
+      ;
   }
+  Serial.println("Sensor online!");
 
-  for (int x = 0 ; x < HISTORY_SIZE ; x++)
+  for (int x = 0; x < HISTORY_SIZE; x++)
     history[x] = 0;
 }
 
@@ -87,25 +90,26 @@ void loop(void)
 
   //Write configuration block of 135 bytes to setup a measurement
   distanceSensor.startRanging();
-  while (!distanceSensor.checkForDataReady()) {
+  while (!distanceSensor.checkForDataReady())
+  {
     delay(1);
   }
   int distanceMM = distanceSensor.getDistance();
   distanceSensor.clearInterrupt();
   distanceSensor.stopRanging();
-  
+
   lastReading = millis();
 
   history[historySpot] = distanceMM;
-  if (historySpot++ == HISTORY_SIZE) historySpot = 0;
+  if (historySpot++ == HISTORY_SIZE)
+    historySpot = 0;
 
   long avgDistance = 0;
-  for (int x = 0 ; x < HISTORY_SIZE ; x++)
+  for (int x = 0; x < HISTORY_SIZE; x++)
     avgDistance += history[x];
 
   avgDistance /= HISTORY_SIZE;
 
-
   //Every loop let's get a reading
   newDistance = distanceMM / 10; //Go get distance in cm
 
@@ -114,24 +118,26 @@ void loop(void)
 
   //Scan delta array to see if this new delta is sane or not
   boolean safeDelta = true;
-  for (int x = 0 ; x < numberOfDeltas ; x++)
+  for (int x = 0; x < numberOfDeltas; x++)
   {
     //We don't want to register jumps greater than 30cm in 50ms
     //But if we're less than 1000cm then maybe
     //30 works well
-    if ( abs(deltaDistance - deltas[x]) > 40) safeDelta = false;
+    if (abs(deltaDistance - deltas[x]) > 40)
+      safeDelta = false;
   }
 
   //Insert this new delta into the array
   if (safeDelta)
   {
     deltas[deltaSpot++] = deltaDistance;
-    if (deltaSpot > numberOfDeltas) deltaSpot = 0; //Wrap this variable
+    if (deltaSpot > numberOfDeltas)
+      deltaSpot = 0; //Wrap this variable
   }
 
   //Get average of the current deltas array
   float avgDeltas = 0.0;
-  for (byte x = 0 ; x < numberOfDeltas ; x++)
+  for (byte x = 0; x < numberOfDeltas; x++)
     avgDeltas += (float)deltas[x];
   avgDeltas /= numberOfDeltas;
 
@@ -162,10 +168,12 @@ void loop(void)
   else
   {
     validCount++;
-    if (avgDistance > maxDistance) maxDistance = avgDistance;
+    if (avgDistance > maxDistance)
+      maxDistance = avgDistance;
   }
 
-  if (validCount > 10) readingValid = true;
+  if (validCount > 10)
+    readingValid = true;
 
   if (readingValid == false)
   {
@@ -195,4 +203,3 @@ void loop(void)
 
   delay(25);
 }
-