Library for use with VL53L0X, cut 1.1, based on mass-market API v1.1.
Dependencies: ST_INTERFACES X_NUCLEO_COMMON
Dependents: ConcorsoFinal HelloWorld_IHM01A1 m3pi_BT m3pi_LIDAR ... more
Fork of X_NUCLEO_53L0A1 by
X-NUCLEO-53L0A1 Proximity Sensor Expansion Board Firmware Package
Introduction
This firmware package includes Component Device Drivers and the Board Support Package for STMicroelectronics' X-NUCLEO-53L0A1 Proximity sensor expansion board based on VL53L0X.
Firmware Library
Class X_NUCLEO_53L0A1 is intended to represent the Proximity sensor expansion board with the same name.
The expansion board provides support for the following components:
- on-board VL53L0X proximity sensor,
- up to two additional VL53L0X Satellites,
- on-board 4-digit display
It is intentionally implemented as a singleton because only one X-NUCLEO-VL53L0A1 may be deployed at a time in a HW component stack. In order to get the singleton instance you have to call class method `Instance()`, e.g.:
// Sensors expansion board singleton instance static X_NUCLEO_53L0A1 *board = X_NUCLEO_53L0A1::Instance(device_i2c, A2, D8, D2);
Example Applications
- Hello World 53L0
- Display 53L0A1
- Display 53L0A1 Interrupts
- Display 53L0A1 with satellites
- 53L0A1 Satellites with Interrupts
- 53L0A1_HandGestureRecognition
The library and sample application code were tested against mbed revision 143, dated 26th May 2017.
Diff: x_nucleo_53l0a1.h
- Revision:
- 14:8320b5ff96fa
- Parent:
- 9:367d1f390cb2
--- a/x_nucleo_53l0a1.h Thu Jun 15 13:33:35 2017 +0000 +++ b/x_nucleo_53l0a1.h Mon Aug 07 14:30:21 2017 +0000 @@ -1,7 +1,7 @@ /** ****************************************************************************** * @file x_nucleo_53L0A1.h - * @author IMG + * @author IMG * @version V1.0.0 * @date 28-November-2016 * @brief Header file for class X_NUCLEO_53L0A1 representing a X-NUCLEO-53L0A1 @@ -59,132 +59,127 @@ class X_NUCLEO_53L0A1 { public: - /** Constructor 1 - * @param[in] &i2c device I2C to be used for communication - */ + /** Constructor 1 + * @param[in] &i2c device I2C to be used for communication + */ X_NUCLEO_53L0A1(DevI2C *ext_i2c) : dev_i2c(ext_i2c) { - stmpe1600_exp0 = new STMPE1600(*ext_i2c, (0x43 * 2)); // U21 + stmpe1600_exp0 = new Stmpe1600(*ext_i2c, (0x43 * 2)); // U21 - stmpe1600_exp1 = new STMPE1600(*ext_i2c, (0x42 * 2)); // U19 + stmpe1600_exp1 = new Stmpe1600(*ext_i2c, (0x42 * 2)); // U19 display = new Display(*stmpe1600_exp0, *stmpe1600_exp1); - - xshutdown_centre=new STMPE1600DigiOut(*dev_i2c, GPIO_15, (0x42 * 2)); // U19 on schematic - sensor_centre=new VL53L0X(*dev_i2c, *xshutdown_centre, A2); - - xshutdown_left=new STMPE1600DigiOut(*dev_i2c, GPIO_14, (0x43 * 2)); // U21 on schematic - sensor_left=new VL53L0X(*dev_i2c, *xshutdown_left, D8); - - xshutdown_right=new STMPE1600DigiOut(*dev_i2c, GPIO_15, (0x43 * 2)); // U21 on schematic - sensor_right=new VL53L0X(*dev_i2c, *xshutdown_right, D2); + + xshutdown_centre = new Stmpe1600DigiOut(*dev_i2c, GPIO_15, (0x42 * 2)); // U19 on schematic + sensor_centre = new VL53L0X(*dev_i2c, *xshutdown_centre, A2); + + xshutdown_left = new Stmpe1600DigiOut(*dev_i2c, GPIO_14, (0x43 * 2)); // U21 on schematic + sensor_left = new VL53L0X(*dev_i2c, *xshutdown_left, D8); + + xshutdown_right = new Stmpe1600DigiOut(*dev_i2c, GPIO_15, (0x43 * 2)); // U21 on schematic + sensor_right = new VL53L0X(*dev_i2c, *xshutdown_right, D2); } - + /** Constructor 2 * @param[in] &i2c device I2C to be used for communication * @param[in] PinName gpio1_top Mbed DigitalOut pin name to be used as a top sensor GPIO_1 INT * @param[in] PinName gpio1_bottom Mbed DigitalOut pin name to be used as a bottom sensor GPIO_1 INT * @param[in] PinName gpio1_left Mbed DigitalOut pin name to be used as a left sensor GPIO_1 INT - * @param[in] PinName gpio1_right Mbed DigitalOut pin name to be used as a right sensor GPIO_1 INT - */ + * @param[in] PinName gpio1_right Mbed DigitalOut pin name to be used as a right sensor GPIO_1 INT + */ X_NUCLEO_53L0A1(DevI2C *ext_i2c, PinName gpio1_centre, - PinName gpio1_left, PinName gpio1_right) : dev_i2c(ext_i2c) { - stmpe1600_exp0 = new STMPE1600(*ext_i2c, (0x43 * 2)); // U21 + PinName gpio1_left, PinName gpio1_right) : dev_i2c(ext_i2c) + { + stmpe1600_exp0 = new Stmpe1600(*ext_i2c, (0x43 * 2)); // U21 - stmpe1600_exp1 = new STMPE1600(*ext_i2c, (0x42 * 2)); // U19 + stmpe1600_exp1 = new Stmpe1600(*ext_i2c, (0x42 * 2)); // U19 display = new Display(*stmpe1600_exp0, *stmpe1600_exp1); - xshutdown_centre=new STMPE1600DigiOut(*dev_i2c, GPIO_15, (0x42 * 2)); // U19 on schematic - sensor_centre=new VL53L0X(*dev_i2c, *xshutdown_centre, gpio1_centre); - - xshutdown_left=new STMPE1600DigiOut(*dev_i2c, GPIO_14, (0x43 * 2)); // U21 on schematic - sensor_left=new VL53L0X(*dev_i2c, *xshutdown_left, gpio1_left); - - xshutdown_right=new STMPE1600DigiOut(*dev_i2c, GPIO_15, (0x43 * 2)); // U21 on schematic - sensor_right=new VL53L0X(*dev_i2c, *xshutdown_right, gpio1_right); - } + xshutdown_centre = new Stmpe1600DigiOut(*dev_i2c, GPIO_15, (0x42 * 2)); // U19 on schematic + sensor_centre = new VL53L0X(*dev_i2c, *xshutdown_centre, gpio1_centre); + + xshutdown_left = new Stmpe1600DigiOut(*dev_i2c, GPIO_14, (0x43 * 2)); // U21 on schematic + sensor_left = new VL53L0X(*dev_i2c, *xshutdown_left, gpio1_left); - /** Destructor - */ + xshutdown_right = new Stmpe1600DigiOut(*dev_i2c, GPIO_15, (0x43 * 2)); // U21 on schematic + sensor_right = new VL53L0X(*dev_i2c, *xshutdown_right, gpio1_right); + } + + /** Destructor + */ ~X_NUCLEO_53L0A1() { - if(xshutdown_centre!=NULL) - { - delete xshutdown_centre; - xshutdown_centre=NULL; + if (xshutdown_centre != NULL) { + delete xshutdown_centre; + xshutdown_centre = NULL; + } + if (sensor_centre != NULL) { + delete sensor_centre; + sensor_centre = NULL; + } + if (xshutdown_left != NULL) { + delete xshutdown_left; + xshutdown_left = NULL; + } + if (sensor_left != NULL) { + delete sensor_left; + sensor_left = NULL; } - if(sensor_centre!=NULL) - { - delete sensor_centre; - sensor_centre=NULL; - } - if(xshutdown_left!=NULL) - { - delete xshutdown_left; - xshutdown_left=NULL; - } - if(sensor_left!=NULL) - { - delete sensor_left; - sensor_left=NULL; - } - if(xshutdown_right!=NULL) - { - delete xshutdown_right; - xshutdown_right=NULL; - } - if(sensor_right!=NULL) - { - delete sensor_right; - sensor_right=NULL; - } + if (xshutdown_right != NULL) { + delete xshutdown_right; + xshutdown_right = NULL; + } + if (sensor_right != NULL) { + delete sensor_right; + sensor_right = NULL; + } - delete stmpe1600_exp0; - stmpe1600_exp0 = NULL; - delete stmpe1600_exp1; - stmpe1600_exp1 = NULL; - delete display; - display = NULL; - _instance=NULL; + delete stmpe1600_exp0; + stmpe1600_exp0 = NULL; + delete stmpe1600_exp1; + stmpe1600_exp1 = NULL; + delete display; + display = NULL; + _instance = NULL; } - /** - * @brief Creates a singleton object instance + /** + * @brief Creates a singleton object instance * @param[in] &i2c device I2C to be used for communication - * @return Pointer to the object instance - */ - static X_NUCLEO_53L0A1 *Instance(DevI2C *ext_i2c); - - /** - * @brief Creates a singleton object instance + * @return Pointer to the object instance + */ + static X_NUCLEO_53L0A1 *instance(DevI2C *ext_i2c); + + /** + * @brief Creates a singleton object instance * @param[in] &i2c device I2C to be used for communication - * @param[in] PinName gpio1_centre the pin connected to top sensor INT - * @param[in] PinName gpio1_left the pin connected to left sensor INT - * @param[in] PinName gpio1_right the pin connected to right sensor INT - * @return Pointer to the object instance - */ - static X_NUCLEO_53L0A1 *Instance(DevI2C *ext_i2c, PinName gpio1_centre, - PinName gpio1_left, PinName gpio1_right); + * @param[in] PinName gpio1_centre the pin connected to top sensor INT + * @param[in] PinName gpio1_left the pin connected to left sensor INT + * @param[in] PinName gpio1_right the pin connected to right sensor INT + * @return Pointer to the object instance + */ + static X_NUCLEO_53L0A1 *instance(DevI2C *ext_i2c, PinName gpio1_centre, + PinName gpio1_left, PinName gpio1_right); - /** - * @brief Initialize the board and sensors with deft values - * @return 0 on success - */ - int InitBoard(); + /** + * @brief Initialize the board and sensors with deft values + * @return 0 on success + */ + int init_board(); DevI2C *dev_i2c; VL53L0X *sensor_centre; VL53L0X *sensor_left; VL53L0X *sensor_right; - STMPE1600 *stmpe1600_exp0; - STMPE1600 *stmpe1600_exp1; - STMPE1600DigiOut *xshutdown_centre; - STMPE1600DigiOut *xshutdown_left; - STMPE1600DigiOut *xshutdown_right; + Stmpe1600 *stmpe1600_exp0; + Stmpe1600 *stmpe1600_exp1; + Stmpe1600DigiOut *xshutdown_centre; + Stmpe1600DigiOut *xshutdown_left; + Stmpe1600DigiOut *xshutdown_right; Display *display; - - private: + +private: static X_NUCLEO_53L0A1 *_instance; };