Adafruit Library
Adafruit_VL53L1X.h
Go to the documentation of this file.
1 
19 #ifndef ADAFRUIT_VL53L1X_H
20 #define ADAFRUIT_VL53L1X_H
21 
22 #include "Wire.h"
23 #include "vl53l1x_class.h"
24 
25 #define VL53L1X_I2C_ADDR 0x29
26 
27 /**************************************************************************/
32 /**************************************************************************/
33 class Adafruit_VL53L1X : public VL53L1X {
34 public:
35  Adafruit_VL53L1X(uint8_t shutdown_pin = -1, uint8_t irq_pin = -1);
36 
37  bool begin(uint8_t i2c_addr = VL53L1X_I2C_ADDR, TwoWire *theWire = &Wire,
38  bool debug = false);
39  uint16_t sensorID(void);
40 
41  bool startRanging(void);
42  bool stopRanging(void);
43  bool setTimingBudget(uint16_t ms);
44  uint16_t getTimingBudget(void);
45 
46  bool dataReady(void);
47  int16_t distance(void);
48 
49  bool clearInterrupt(void);
50  bool setIntPolarity(bool polarity);
51  bool getIntPolarity(void);
52 
53  /*
54  boolean SetDistanceMode(VL53L1_DistanceModes mode);
55  boolean SetMeasurementTimingBudgetMicroSeconds(uint32_t budget);
56  boolean SetInterMeasurementPeriodMilliSeconds(uint32_t period);
57  boolean StartMeasurement(void);
58  boolean WaitMeasurementDataReady(void);
59  boolean GetRangingMeasurementData(VL53L1_RangingMeasurementData_t *ranging);
60  */
61 
62  VL53L1X_ERROR vl_status;
64 private:
65  int8_t _irq_pin, _shutdown_pin;
66  /*
67  VL53L1_Dev_t MyDevice;
68  VL53L1_Dev_t *pMyDevice = &MyDevice;
69  //VL53L1X_Version_t Version;
70  //VL53L1X_Version_t *pVersion = &Version;
71  VL53L1_DeviceInfo_t DeviceInfo;
72  */
73 };
74 
75 #endif
bool startRanging(void)
Start ranging operations.
Definition: Adafruit_VL53L1X.cpp:196
uint16_t getTimingBudget(void)
Get the timing budget.
Definition: Adafruit_VL53L1X.cpp:242
uint16_t sensorID(void)
Get the sensor ID.
Definition: Adafruit_VL53L1X.cpp:127
bool clearInterrupt(void)
Clear the interrupt.
Definition: Adafruit_VL53L1X.cpp:161
bool getIntPolarity(void)
Get the interrupt polarity.
Definition: Adafruit_VL53L1X.cpp:184
int16_t distance(void)
Get the distance.
Definition: Adafruit_VL53L1X.cpp:139
VL53L1X_ERROR vl_status
Definition: Adafruit_VL53L1X.h:62
Class that stores state and functions for interacting with VL53L1X time-of-flight sensor chips...
Definition: Adafruit_VL53L1X.h:33
#define VL53L1X_I2C_ADDR
Default sensor I2C address.
Definition: Adafruit_VL53L1X.h:25
bool stopRanging(void)
Stop ranging operations.
Definition: Adafruit_VL53L1X.cpp:207
bool setTimingBudget(uint16_t ms)
Set the timing budget.
Definition: Adafruit_VL53L1X.cpp:231
Adafruit_VL53L1X(uint8_t shutdown_pin=-1, uint8_t irq_pin=-1)
Create a new VL53L1X instance.
Definition: Adafruit_VL53L1X.cpp:41
bool dataReady(void)
Check status of new data.
Definition: Adafruit_VL53L1X.cpp:218
bool setIntPolarity(bool polarity)
Set the interrupt polarity.
Definition: Adafruit_VL53L1X.cpp:173
bool begin(uint8_t i2c_addr=VL53L1X_I2C_ADDR, TwoWire *theWire=&Wire, bool debug=false)
Setups the I2C interface and hardware.
Definition: Adafruit_VL53L1X.cpp:58