updating to fix a few typos, fixing issues filed by matthias

AndyEngland521 · AndyEngland521 · commit e35acdf6e2b2 · 2019-01-02T12:27:40.000-07:00
diff --git a/examples/Example1_ReadDistance/Example1_ReadDistance.ino b/examples/Example1_ReadDistance/Example1_ReadDistance.ino
@@ -29,7 +29,7 @@ void setup(void)
   Serial.begin(9600);
   Serial.println("VL53L1X Qwiic Test");
 
-  if (distanceSensor.init() == false)
+  if (distanceSensor.begin() == false)
     Serial.println("Sensor online!");
 
 }
diff --git a/examples/Example1_ReadDistance/Example1_ReadDistance/Example1_ReadDistance.ino b/examples/Example1_ReadDistance/Example1_ReadDistance/Example1_ReadDistance.ino
diff --git a/examples/Example2_SetDistanceMode/Example2_SetDistanceMode.ino b/examples/Example2_SetDistanceMode/Example2_SetDistanceMode.ino
@@ -29,7 +29,7 @@ void setup(void)
   Serial.begin(9600);
   Serial.println("VL53L1X Qwiic Test");
 
-  if (distanceSensor.init() == false)
+  if (distanceSensor.begin() == false)
   {
     Serial.println("Sensor online!");
   }
diff --git a/examples/Example3_StatusAndRate/Example3_StatusAndRate.ino b/examples/Example3_StatusAndRate/Example3_StatusAndRate.ino
@@ -34,7 +34,7 @@ void setup(void)
   Serial.begin(9600);
   Serial.println("VL53L1X Qwiic Test");
 
-  if (distanceSensor.init() == false)
+  if (distanceSensor.begin() == false)
     Serial.println("Sensor online!");
 
   for (int x = 0 ; x < HISTORY_SIZE ; x++)
diff --git a/examples/Example4_SetIntermeasurementPeriod/Example4_SetIntermeasurementPeriod.ino b/examples/Example4_SetIntermeasurementPeriod/Example4_SetIntermeasurementPeriod.ino
@@ -29,7 +29,7 @@ void setup(void)
   Serial.begin(9600);
   Serial.println("VL53L1X Qwiic Test");
 
-  if (distanceSensor.init() == false)
+  if (distanceSensor.begin() == false)
     Serial.println("Sensor online!");
     
   distanceSensor.setIntermeasurementPeriod(40);
diff --git a/examples/Example5_LCDDemo/Example5_LCDDemo.ino b/examples/Example5_LCDDemo/Example5_LCDDemo.ino
@@ -68,7 +68,7 @@ void setup(void)
   lcd.print("Distance: 3426  ");
   lcd.print("12 mph          ");
 
-  if (distanceSensor.init() == false)
+  if (distanceSensor.begin() == false)
   {
     Serial.println("Sensor offline!");
   }
diff --git a/keywords.txt b/keywords.txt
@@ -12,49 +12,49 @@ VL53L1X	KEYWORD1
 # Methods and Functions (KEYWORD2)
 #######################################
 
-init					KEYWORD2
-
-startRanging		 KEYWORD2
-checkForDataReady		 KEYWORD2
-setTimingBudgetInMs		 KEYWORD2
-getTimingBudgetInMs		 KEYWORD2
-setDistanceModeLong		 KEYWORD2
+init						 KEYWORD2
+begin						 KEYWORD2
+startRanging				 KEYWORD2
+checkForDataReady			 KEYWORD2
+setTimingBudgetInMs			 KEYWORD2
+getTimingBudgetInMs			 KEYWORD2
+setDistanceModeLong			 KEYWORD2
 setDistanceModeShort		 KEYWORD2
-getDistanceMode		 KEYWORD2
-setIntermeasurementPeriod		 KEYWORD2
-getIntermeasurementPeriod		 KEYWORD2
-checkBootState		 KEYWORD2
-getSensorID		 KEYWORD2
-getDistance		 KEYWORD2
-getSignalPerSpad		 KEYWORD2
-getAmbientPerSpad		 KEYWORD2
-getSignalRate		 KEYWORD2
-getSpadNb		 KEYWORD2
-getAmbientRate		 KEYWORD2
-getRangeStatus		 KEYWORD2
-setOffset		 KEYWORD2
-getOffset		 KEYWORD2
-setXTalk		 KEYWORD2
-getXTalk		 KEYWORD2
+getDistanceMode				 KEYWORD2
+setIntermeasurementPeriod	 KEYWORD2
+getIntermeasurementPeriod	 KEYWORD2
+checkBootState				 KEYWORD2
+getSensorID					 KEYWORD2
+getDistance					 KEYWORD2
+getSignalPerSpad			 KEYWORD2
+getAmbientPerSpad			 KEYWORD2
+getSignalRate		 	   	 KEYWORD2
+getSpadNb					 KEYWORD2
+getAmbientRate				 KEYWORD2
+getRangeStatus				 KEYWORD2
+setOffset					 KEYWORD2
+getOffset					 KEYWORD2
+setXTalk					 KEYWORD2
+getXTalk					 KEYWORD2
 setDistanceThreshold		 KEYWORD2
-getDistanceThresholdWindow		 KEYWORD2
+getDistanceThresholdWindow	 KEYWORD2
 getDistanceThresholdLow		 KEYWORD2
-getDistanceThresholdHigh		 KEYWORD2
-setROI		 KEYWORD2
-getROIX		 KEYWORD2
-getROIY		 KEYWORD2
-setSignalThreshold		 KEYWORD2
-getSignalThreshold		 KEYWORD2
-setSigmaThreshold		 KEYWORD2
-getSigmaThreshold		 KEYWORD2
+getDistanceThresholdHigh	 KEYWORD2
+setROI						 KEYWORD2
+getROIX						 KEYWORD2
+getROIY						 KEYWORD2
+setSignalThreshold			 KEYWORD2
+getSignalThreshold			 KEYWORD2
+setSigmaThreshold			 KEYWORD2
+getSigmaThreshold			 KEYWORD2
 startTemperatureUpdate		 KEYWORD2
-calibrateOffset		 KEYWORD2
-calibrateXTalk		 KEYWORD2
+calibrateOffset				 KEYWORD2
+calibrateXTalk				 KEYWORD2
 
-readRegister		 KEYWORD2
-readRegister16		 KEYWORD2
-writeRegister		 KEYWORD2
-writeRegister16		 KEYWORD2
+readRegister				 KEYWORD2
+readRegister16				 KEYWORD2
+writeRegister				 KEYWORD2
+writeRegister16				 KEYWORD2
 
 #######################################
 # Constants (LITERAL1)
diff --git a/library.properties b/library.properties
@@ -1,5 +1,5 @@
 name=SparkFun VL53L1X 4m Laser Distance Sensor
-version=1.1.0
+version=1.1.1
 author=SparkFun Electronics <techsupport@sparkfun.com>
 maintainer=SparkFun Electronics <sparkfun.com>
 sentence=Library for the SparkFun Qwiic 4m Distance Sensor - VL53L1X
diff --git a/src/SparkFun_VL53L1X.cpp b/src/SparkFun_VL53L1X.cpp
@@ -3,7 +3,7 @@
 #include "SparkFun_VL53L1X.h"
 #include "vl53l1x_class.h"
 
-SFEVL53L1X::SFEVL53L1X(TwoWire &i2cPort = Wire, int shutdownPin, int interruptPin)
+SFEVL53L1X::SFEVL53L1X(TwoWire &i2cPort, int shutdownPin, int interruptPin)
 {
 	*_i2cPort = i2cPort;
 	_shutdownPin = shutdownPin;
@@ -16,6 +16,11 @@ bool SFEVL53L1X::init()
 	return _device->VL53L1X_SensorInit();
 }
 
+bool SFEVL53L1X::begin()
+{
+	return _device->VL53L1X_SensorInit();
+}
+
 /*Checks the ID of the device, returns true if ID is correct*/
 
 bool SFEVL53L1X::checkID()
@@ -225,7 +230,7 @@ void SFEVL53L1X::setOffset(int16_t offset)
 
 int16_t SFEVL53L1X::getOffset()
 {
-	uint16_t temp;
+	int16_t temp;
 	_device->VL53L1X_GetOffset(&temp);
 	return temp;
 }

Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ void setup(void)`
`29`	`29`	`Serial.begin(9600);`
`30`	`30`	`Serial.println("VL53L1X Qwiic Test");`
`31`	`31`
`32`		`- if (distanceSensor.init() == false)`
	`32`	`+ if (distanceSensor.begin() == false)`
`33`	`33`	`Serial.println("Sensor online!");`
`34`	`34`
`35`	`35`	`}`
Original file line number	Diff line number	Diff line change
`@@ -68,7 +68,7 @@ void setup(void)`
`68`	`68`	`lcd.print("Distance: 3426 ");`
`69`	`69`	`lcd.print("12 mph ");`
`70`	`70`
`71`		`- if (distanceSensor.init() == false)`
	`71`	`+ if (distanceSensor.begin() == false)`
`72`	`72`	`{`
`73`	`73`	`Serial.println("Sensor offline!");`
`74`	`74`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`	`#include "SparkFun_VL53L1X.h"`
`4`	`4`	`#include "vl53l1x_class.h"`
`5`	`5`
`6`		`-SFEVL53L1X::SFEVL53L1X(TwoWire &i2cPort = Wire, int shutdownPin, int interruptPin)`
	`6`	`+SFEVL53L1X::SFEVL53L1X(TwoWire &i2cPort, int shutdownPin, int interruptPin)`
`7`	`7`	`{`
`8`	`8`	`*_i2cPort = i2cPort;`
`9`	`9`	`_shutdownPin = shutdownPin;`
`@@ -16,6 +16,11 @@ bool SFEVL53L1X::init()`
`16`	`16`	`return _device->VL53L1X_SensorInit();`
`17`	`17`	`}`
`18`	`18`
	`19`	`+bool SFEVL53L1X::begin()`
	`20`	`+{`
	`21`	`+ return _device->VL53L1X_SensorInit();`
	`22`	`+}`
	`23`	`+`
`19`	`24`	`/Checks the ID of the device, returns true if ID is correct/`
`20`	`25`
`21`	`26`	`bool SFEVL53L1X::checkID()`
`@@ -225,7 +230,7 @@ void SFEVL53L1X::setOffset(int16_t offset)`
`225`	`230`
`226`	`231`	`int16_t SFEVL53L1X::getOffset()`
`227`	`232`	`{`
`228`		`- uint16_t temp;`
	`233`	`+ int16_t temp;`
`229`	`234`	`_device->VL53L1X_GetOffset(&temp);`
`230`	`235`	`return temp;`
`231`	`236`	`}`