ST Expansion SW Team / X_NUCLEO_53L0A1_mbed_sdk

Updates to follow mbed SDK coding style guidelines.

Dependencies:   ST_INTERFACES X_NUCLEO_COMMON

Dependents:   53L0A1_Satellites_with_Interrupts_OS5 Display_53L0A1_OS5

Fork of X_NUCLEO_53L0A1 by ST

x_nucleo_53l0a1.h.orig@7:35ecf3e060c3, 2016-12-05 (annotated)

Committer:
johnAlexander
Date:
Mon Dec 05 11:50:38 2016 +0000
Revision:
7:35ecf3e060c3
Replace STM32 HAL_delay call with equivalent mbed wait_ms, for cross processor compatibility.; Import mbed.h in VL53L0X class to ease finding InterruptIn.; Minor code tidy up.

Who changed what in which revision?

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