ST / X_NUCLEO_53L0A1

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 ST Expansion SW Team

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:

  1. on-board VL53L0X proximity sensor,
  2. up to two additional VL53L0X Satellites,
  3. 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

The library and sample application code were tested against mbed revision 143, dated 26th May 2017.

XNucleo53L0A1.h@18:2413acea538f, 2017-10-13 (annotated)

Committer:
Davidroid
Date:
Fri Oct 13 15:32:03 2017 +0000
Revision:
18:2413acea538f
Parent:
17:f8187a3fa36e 
Astyle reformatting.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
johnAlexander 0:c523920bcc09 1 /**
johnAlexander 0:c523920bcc09 2 ******************************************************************************
Davidroid 16:27d3d95c8593 3 * @file XNucleo53L0A1.h
johnAlexander 14:8320b5ff96fa 4 * @author IMG
johnAlexander 1:01b8004bc0a7 5 * @version V1.0.0
johnAlexander 1:01b8004bc0a7 6 * @date 28-November-2016
Davidroid 16:27d3d95c8593 7 * @brief Header file for class XNucleo53L0A1 representing a X-NUCLEO-53L0A1
johnAlexander 0:c523920bcc09 8 * expansion board
johnAlexander 0:c523920bcc09 9 ******************************************************************************
johnAlexander 0:c523920bcc09 10 * @attention
johnAlexander 0:c523920bcc09 11 *
johnAlexander 0:c523920bcc09 12 * <h2><center>&copy; COPYRIGHT(c) 2016 STMicroelectronics</center></h2>
johnAlexander 0:c523920bcc09 13 *
johnAlexander 0:c523920bcc09 14 * Redistribution and use in source and binary forms, with or without modification,
johnAlexander 0:c523920bcc09 15 * are permitted provided that the following conditions are met:
johnAlexander 0:c523920bcc09 16 * 1. Redistributions of source code must retain the above copyright notice,
johnAlexander 0:c523920bcc09 17 * this list of conditions and the following disclaimer.
johnAlexander 0:c523920bcc09 18 * 2. Redistributions in binary form must reproduce the above copyright notice,
johnAlexander 0:c523920bcc09 19 * this list of conditions and the following disclaimer in the documentation
johnAlexander 0:c523920bcc09 20 * and/or other materials provided with the distribution.
johnAlexander 0:c523920bcc09 21 * 3. Neither the name of STMicroelectronics nor the names of its contributors
johnAlexander 0:c523920bcc09 22 * may be used to endorse or promote products derived from this software
johnAlexander 0:c523920bcc09 23 * without specific prior written permission.
johnAlexander 0:c523920bcc09 24 *
johnAlexander 0:c523920bcc09 25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
johnAlexander 0:c523920bcc09 26 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
johnAlexander 0:c523920bcc09 27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
johnAlexander 0:c523920bcc09 28 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
johnAlexander 0:c523920bcc09 29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
johnAlexander 0:c523920bcc09 30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
johnAlexander 0:c523920bcc09 31 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
johnAlexander 0:c523920bcc09 32 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
johnAlexander 0:c523920bcc09 33 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
johnAlexander 0:c523920bcc09 34 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
johnAlexander 0:c523920bcc09 35 *
johnAlexander 0:c523920bcc09 36 ******************************************************************************
johnAlexander 0:c523920bcc09 37 */
johnAlexander 0:c523920bcc09 38
johnAlexander 0:c523920bcc09 39 /* Define to prevent from recursive inclusion --------------------------------*/
Davidroid 16:27d3d95c8593 40 #ifndef __XNucleo53L0A1_H
Davidroid 16:27d3d95c8593 41 #define __XNucleo53L0A1_H
johnAlexander 0:c523920bcc09 42
johnAlexander 0:c523920bcc09 43 /* Includes ------------------------------------------------------------------*/
Davidroid 16:27d3d95c8593 44 #include "VL53L0X.h"
Davidroid 16:27d3d95c8593 45 #include "Display.h"
Davidroid 16:27d3d95c8593 46 #include "Stmpe1600.h"
johnAlexander 0:c523920bcc09 47 #include "DevI2C.h"
johnAlexander 0:c523920bcc09 48
johnAlexander 0:c523920bcc09 49 /** New device addresses */
johnAlexander 9:367d1f390cb2 50 #define NEW_SENSOR_CENTRE_ADDRESS 0x54
johnAlexander 0:c523920bcc09 51 #define NEW_SENSOR_LEFT_ADDRESS 0x56
johnAlexander 0:c523920bcc09 52 #define NEW_SENSOR_RIGHT_ADDRESS 0x58
johnAlexander 0:c523920bcc09 53
johnAlexander 0:c523920bcc09 54 /* Classes--------------------------------------------------------------------*/
johnAlexander 0:c523920bcc09 55
johnAlexander 0:c523920bcc09 56 /* Classes -------------------------------------------------------------------*/
johnAlexander 0:c523920bcc09 57 /** Class representing the X-NUCLEO-VL53L0A1 expansion board
johnAlexander 0:c523920bcc09 58 */
Davidroid 16:27d3d95c8593 59 class XNucleo53L0A1
johnAlexander 0:c523920bcc09 60 {
johnAlexander 5:c82a48da3c9e 61 public:
johnAlexander 14:8320b5ff96fa 62 /** Constructor 1
johnAlexander 14:8320b5ff96fa 63 * @param[in] &i2c device I2C to be used for communication
johnAlexander 14:8320b5ff96fa 64 */
Davidroid 16:27d3d95c8593 65 XNucleo53L0A1(DevI2C *ext_i2c) : dev_i2c(ext_i2c)
johnAlexander 0:c523920bcc09 66 {
nikapov 17:f8187a3fa36e 67 stmpe1600_exp0 = new Stmpe1600(ext_i2c, (0x43 * 2)); // U21
johnAlexander 0:c523920bcc09 68
nikapov 17:f8187a3fa36e 69 stmpe1600_exp1 = new Stmpe1600(ext_i2c, (0x42 * 2)); // U19
johnAlexander 0:c523920bcc09 70
nikapov 17:f8187a3fa36e 71 display = new Display(stmpe1600_exp0, stmpe1600_exp1);
johnAlexander 14:8320b5ff96fa 72
nikapov 17:f8187a3fa36e 73 xshutdown_centre = new Stmpe1600DigiOut(dev_i2c, GPIO_15, (0x42 * 2)); // U19 on schematic
nikapov 17:f8187a3fa36e 74 sensor_centre = new VL53L0X(dev_i2c, xshutdown_centre, A2);
johnAlexander 14:8320b5ff96fa 75
nikapov 17:f8187a3fa36e 76 xshutdown_left = new Stmpe1600DigiOut(dev_i2c, GPIO_14, (0x43 * 2)); // U21 on schematic
nikapov 17:f8187a3fa36e 77 sensor_left = new VL53L0X(dev_i2c, xshutdown_left, D8);
johnAlexander 14:8320b5ff96fa 78
nikapov 17:f8187a3fa36e 79 xshutdown_right = new Stmpe1600DigiOut(dev_i2c, GPIO_15, (0x43 * 2)); // U21 on schematic
nikapov 17:f8187a3fa36e 80 sensor_right = new VL53L0X(dev_i2c, xshutdown_right, D2);
johnAlexander 0:c523920bcc09 81 }
johnAlexander 14:8320b5ff96fa 82
johnAlexander 0:c523920bcc09 83 /** Constructor 2
johnAlexander 0:c523920bcc09 84 * @param[in] &i2c device I2C to be used for communication
johnAlexander 0:c523920bcc09 85 * @param[in] PinName gpio1_top Mbed DigitalOut pin name to be used as a top sensor GPIO_1 INT
johnAlexander 0:c523920bcc09 86 * @param[in] PinName gpio1_bottom Mbed DigitalOut pin name to be used as a bottom sensor GPIO_1 INT
johnAlexander 0:c523920bcc09 87 * @param[in] PinName gpio1_left Mbed DigitalOut pin name to be used as a left sensor GPIO_1 INT
johnAlexander 14:8320b5ff96fa 88 * @param[in] PinName gpio1_right Mbed DigitalOut pin name to be used as a right sensor GPIO_1 INT
johnAlexander 14:8320b5ff96fa 89 */
Davidroid 16:27d3d95c8593 90 XNucleo53L0A1(DevI2C *ext_i2c, PinName gpio1_centre,
Davidroid 18:2413acea538f 91 PinName gpio1_left, PinName gpio1_right) : dev_i2c(ext_i2c)
johnAlexander 14:8320b5ff96fa 92 {
nikapov 17:f8187a3fa36e 93 stmpe1600_exp0 = new Stmpe1600(ext_i2c, (0x43 * 2)); // U21
johnAlexander 0:c523920bcc09 94
nikapov 17:f8187a3fa36e 95 stmpe1600_exp1 = new Stmpe1600(ext_i2c, (0x42 * 2)); // U19
johnAlexander 0:c523920bcc09 96
nikapov 17:f8187a3fa36e 97 display = new Display(stmpe1600_exp0, stmpe1600_exp1);
johnAlexander 0:c523920bcc09 98
nikapov 17:f8187a3fa36e 99 xshutdown_centre = new Stmpe1600DigiOut(dev_i2c, GPIO_15, (0x42 * 2)); // U19 on schematic
nikapov 17:f8187a3fa36e 100 sensor_centre = new VL53L0X(dev_i2c, xshutdown_centre, gpio1_centre);
johnAlexander 14:8320b5ff96fa 101
nikapov 17:f8187a3fa36e 102 xshutdown_left = new Stmpe1600DigiOut(dev_i2c, GPIO_14, (0x43 * 2)); // U21 on schematic
nikapov 17:f8187a3fa36e 103 sensor_left = new VL53L0X(dev_i2c, xshutdown_left, gpio1_left);
johnAlexander 0:c523920bcc09 104
nikapov 17:f8187a3fa36e 105 xshutdown_right = new Stmpe1600DigiOut(dev_i2c, GPIO_15, (0x43 * 2)); // U21 on schematic
nikapov 17:f8187a3fa36e 106 sensor_right = new VL53L0X(dev_i2c, xshutdown_right, gpio1_right);
johnAlexander 14:8320b5ff96fa 107 }
johnAlexander 14:8320b5ff96fa 108
johnAlexander 14:8320b5ff96fa 109 /** Destructor
johnAlexander 14:8320b5ff96fa 110 */
Davidroid 16:27d3d95c8593 111 ~XNucleo53L0A1()
johnAlexander 0:c523920bcc09 112 {
johnAlexander 14:8320b5ff96fa 113 if (xshutdown_centre != NULL) {
johnAlexander 14:8320b5ff96fa 114 delete xshutdown_centre;
johnAlexander 14:8320b5ff96fa 115 xshutdown_centre = NULL;
johnAlexander 14:8320b5ff96fa 116 }
johnAlexander 14:8320b5ff96fa 117 if (sensor_centre != NULL) {
johnAlexander 14:8320b5ff96fa 118 delete sensor_centre;
johnAlexander 14:8320b5ff96fa 119 sensor_centre = NULL;
johnAlexander 14:8320b5ff96fa 120 }
johnAlexander 14:8320b5ff96fa 121 if (xshutdown_left != NULL) {
johnAlexander 14:8320b5ff96fa 122 delete xshutdown_left;
johnAlexander 14:8320b5ff96fa 123 xshutdown_left = NULL;
johnAlexander 14:8320b5ff96fa 124 }
johnAlexander 14:8320b5ff96fa 125 if (sensor_left != NULL) {
johnAlexander 14:8320b5ff96fa 126 delete sensor_left;
johnAlexander 14:8320b5ff96fa 127 sensor_left = NULL;
johnAlexander 0:c523920bcc09 128 }
johnAlexander 14:8320b5ff96fa 129 if (xshutdown_right != NULL) {
johnAlexander 14:8320b5ff96fa 130 delete xshutdown_right;
johnAlexander 14:8320b5ff96fa 131 xshutdown_right = NULL;
johnAlexander 14:8320b5ff96fa 132 }
johnAlexander 14:8320b5ff96fa 133 if (sensor_right != NULL) {
johnAlexander 14:8320b5ff96fa 134 delete sensor_right;
johnAlexander 14:8320b5ff96fa 135 sensor_right = NULL;
johnAlexander 14:8320b5ff96fa 136 }
johnAlexander 1:01b8004bc0a7 137
johnAlexander 14:8320b5ff96fa 138 delete stmpe1600_exp0;
johnAlexander 14:8320b5ff96fa 139 stmpe1600_exp0 = NULL;
johnAlexander 14:8320b5ff96fa 140 delete stmpe1600_exp1;
johnAlexander 14:8320b5ff96fa 141 stmpe1600_exp1 = NULL;
johnAlexander 14:8320b5ff96fa 142 delete display;
johnAlexander 14:8320b5ff96fa 143 display = NULL;
johnAlexander 14:8320b5ff96fa 144 _instance = NULL;
johnAlexander 0:c523920bcc09 145 }
johnAlexander 0:c523920bcc09 146
johnAlexander 14:8320b5ff96fa 147 /**
johnAlexander 14:8320b5ff96fa 148 * @brief Creates a singleton object instance
johnAlexander 0:c523920bcc09 149 * @param[in] &i2c device I2C to be used for communication
johnAlexander 14:8320b5ff96fa 150 * @return Pointer to the object instance
johnAlexander 14:8320b5ff96fa 151 */
Davidroid 16:27d3d95c8593 152 static XNucleo53L0A1 *instance(DevI2C *ext_i2c);
johnAlexander 14:8320b5ff96fa 153
johnAlexander 14:8320b5ff96fa 154 /**
johnAlexander 14:8320b5ff96fa 155 * @brief Creates a singleton object instance
johnAlexander 0:c523920bcc09 156 * @param[in] &i2c device I2C to be used for communication
johnAlexander 14:8320b5ff96fa 157 * @param[in] PinName gpio1_centre the pin connected to top sensor INT
johnAlexander 14:8320b5ff96fa 158 * @param[in] PinName gpio1_left the pin connected to left sensor INT
johnAlexander 14:8320b5ff96fa 159 * @param[in] PinName gpio1_right the pin connected to right sensor INT
johnAlexander 14:8320b5ff96fa 160 * @return Pointer to the object instance
johnAlexander 14:8320b5ff96fa 161 */
Davidroid 16:27d3d95c8593 162 static XNucleo53L0A1 *instance(DevI2C *ext_i2c, PinName gpio1_centre,
Davidroid 18:2413acea538f 163 PinName gpio1_left, PinName gpio1_right);
johnAlexander 0:c523920bcc09 164
johnAlexander 14:8320b5ff96fa 165 /**
johnAlexander 14:8320b5ff96fa 166 * @brief Initialize the board and sensors with deft values
johnAlexander 14:8320b5ff96fa 167 * @return 0 on success
johnAlexander 14:8320b5ff96fa 168 */
johnAlexander 14:8320b5ff96fa 169 int init_board();
johnAlexander 0:c523920bcc09 170
johnAlexander 0:c523920bcc09 171 DevI2C *dev_i2c;
johnAlexander 0:c523920bcc09 172 VL53L0X *sensor_centre;
johnAlexander 1:01b8004bc0a7 173 VL53L0X *sensor_left;
johnAlexander 1:01b8004bc0a7 174 VL53L0X *sensor_right;
johnAlexander 14:8320b5ff96fa 175 Stmpe1600 *stmpe1600_exp0;
johnAlexander 14:8320b5ff96fa 176 Stmpe1600 *stmpe1600_exp1;
johnAlexander 14:8320b5ff96fa 177 Stmpe1600DigiOut *xshutdown_centre;
johnAlexander 14:8320b5ff96fa 178 Stmpe1600DigiOut *xshutdown_left;
johnAlexander 14:8320b5ff96fa 179 Stmpe1600DigiOut *xshutdown_right;
johnAlexander 0:c523920bcc09 180 Display *display;
johnAlexander 14:8320b5ff96fa 181
johnAlexander 14:8320b5ff96fa 182 private:
Davidroid 16:27d3d95c8593 183 static XNucleo53L0A1 *_instance;
johnAlexander 0:c523920bcc09 184 };
johnAlexander 0:c523920bcc09 185
Davidroid 16:27d3d95c8593 186 #endif /* __XNucleo53L0A1_H */
johnAlexander 0:c523920bcc09 187
johnAlexander 0:c523920bcc09 188