Merge pull request #8 from AndyEngland521/master

adding distanceMode, updating examples

Author: nseidle

.gitattributes

@@ -0,0 +1,61 @@
+/*
+  Reading distance from the laser based VL53L1X
+  By: Nathan Seidle
+  SparkFun Electronics
+  Date: April 4th, 2018
+  License: This code is public domain but you buy me a beer if you use this and we meet someday (Beerware license).
+
+  SparkFun labored with love to create this code. Feel like supporting open source hardware? 
+  Buy a board from SparkFun! https://www.sparkfun.com/products/14667
+
+  This example prints the distance to an object.
+
+  Are you getting weird readings? Be sure the vacuum tape has been removed from the sensor.
+*/
+
+#include <Wire.h>
+
+#include "SparkFun_VL53L1X_Arduino_Library.h"
+VL53L1X distanceSensor;
+
+uint8_t shortRange = 0;
+uint8_t midRange = 1;
+uint8_t longRange = 2;
+
+void setup(void)
+{
+  Wire.begin();
+
+  Serial.begin(9600);
+  Serial.println("VL53L1X Qwiic Test");
+
+  if (distanceSensor.begin() == false)
+  {
+    Serial.println("Sensor offline!");
+  }
+  //Call setDistanceMode with 0, 1, or 2 to change the sensing range.
+  distanceSensor.setDistanceMode(shortRange);
+}
+
+void loop(void)
+{
+  distanceSensor.startMeasurement(); //Write configuration bytes to initiate measurement
+
+  //Poll for completion of measurement. Takes 40-50ms.
+  while (distanceSensor.newDataReady() == false)
+    delay(5);
+
+  int distance = distanceSensor.getDistance(); //Get the result of the measurement from the sensor
+
+  Serial.print("Distance(mm): ");
+  Serial.print(distance);
+
+  float distanceInches = distance * 0.0393701;
+  float distanceFeet = distanceInches / 12.0;
+
+  Serial.print("\tDistance(ft): ");
+  Serial.print(distanceFeet, 2);
+
+  Serial.println();
+}
+

examples/Example2_SetDistanceMode/Example2_SetDistanceMode.ino

@@ -20,6 +20,8 @@ newDataReady		 KEYWORD2
 getDistance		 KEYWORD2
 getSignalRate		 KEYWORD2
 getRangeStatus		 KEYWORD2
+setDistanceMode		 KEYWORD2
+getDistanceMode		 KEYWORD2
 
 readRegister		 KEYWORD2
 readRegister16		 KEYWORD2

examples/Example2_StatusAndRate/Example2_StatusAndRate.ino renamed to examples/Example3_StatusAndRate/Example3_StatusAndRate.ino

@@ -1,5 +1,5 @@
 name=SparkFun VL53L1X 4m Laser Distance Sensor
-version=1.0.1
+version=1.0.2
 author=SparkFun Electronics <techsupport@sparkfun.com>
 maintainer=SparkFun Electronics <sparkfun.com>
 sentence=Library for the SparkFun Qwiic 4m Distance Sensor - VL53L1X

examples/Example3_LCDDemo/Example3_LCDDemo.ino renamed to examples/Example4_LCDDemo/Example4_LCDDemo.ino

@@ -188,6 +188,62 @@ uint16_t VL53L1X::getSignalRate()
   return (reading);
 }
 
+
+//Adapted from ST API
+//0 is short range, 1 is mid range, 2 is long range.
+void VL53L1X::setDistanceMode(uint8_t mode)
+{
+	uint8_t periodA;
+	uint8_t periodB;
+	uint8_t phaseHigh;
+	uint8_t phaseInit;
+	switch (mode)
+	{
+		case 0:
+		  periodA = 0x07;
+		  periodB = 0x05;
+		  phaseHigh = 0x38;
+		  phaseInit = 6;
+		  break;
+		case 1:
+		  periodA = 0x0B;
+		  periodB = 0x09;
+	  	  phaseHigh = 0x78;
+	  	  phaseInit = 10;
+		  break;
+		case 2:
+		  periodA = 0x0F;
+		  periodB = 0x0D;
+		  phaseHigh = 0xB8;
+		  phaseInit = 14;
+		  break;
+		//If user inputs wrong range, we default to long range
+		default:
+		  periodA = 0x0F;
+		  periodB = 0x0D;
+		  phaseHigh = 0xB8;
+		  phaseInit = 14;
+		  break;
+	}
+	//timing
+	writeRegister(VL53L1_RANGE_CONFIG__VCSEL_PERIOD_A, periodA);
+	writeRegister(VL53L1_RANGE_CONFIG__VCSEL_PERIOD_B , periodB);
+	writeRegister(VL53L1_RANGE_CONFIG__VALID_PHASE_HIGH, phaseHigh);
+	
+	//dynamic
+	writeRegister(VL53L1_SD_CONFIG__WOI_SD0 , periodA);
+	writeRegister(VL53L1_SD_CONFIG__WOI_SD1, periodB);
+	writeRegister(VL53L1_SD_CONFIG__INITIAL_PHASE_SD0, phaseInit);
+	writeRegister(VL53L1_SD_CONFIG__INITIAL_PHASE_SD1, phaseInit);
+	
+	_distanceMode = mode;
+}
+
+uint8_t VL53L1X::getDistanceMode()
+{
+	return _distanceMode;
+}
+
 //The sensor returns a range status that needs to be re-mapped to one of 9 different statuses
 //This does that.
 uint8_t VL53L1X::getRangeStatus()

keywords.txt

@@ -89,6 +89,8 @@ class VL53L1X {
     boolean newDataReady(); //Polls the measurement completion bit
     uint16_t getDistance(); //Returns the results from the last measurement, distance in mm
     uint16_t getSignalRate(); //Returns the results from the last measurement, signal rate
+	void setDistanceMode(uint8_t mode = 2);//Defaults to long range
+	uint8_t getDistanceMode();
     uint8_t getRangeStatus(); //Returns the results from the last measurement, 0 = valid
 
     uint8_t readRegister(uint16_t addr); //Read a byte from a 16-bit address
@@ -101,6 +103,7 @@ class VL53L1X {
     //Variables
     TwoWire *_i2cPort; //The generic connection to user's chosen I2C hardware
     uint8_t _deviceAddress; //Keeps track of I2C address. setI2CAddress changes this.
+	_distanceMode = 0;
 };
 
 #endif