NEHSROBOT / selfbalansingcar_V1

STILL DEBUGGING

Dependencies:   ST_INTERFACES X_NUCLEO_COMMON

Fork of X_NUCLEO_IKS01A1 by ST

x_nucleo_iks01a1.h@6:8d2abd695c52, 2015-04-15 (annotated)

Committer:
Wolfgang Betz
Date:
Wed Apr 15 13:45:30 2015 +0200
Revision:
6:8d2abd695c52
Parent:
5:8bab0f419849
Child:
7:a2bb3d5e12e9
Added component LPS25H

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Wolfgang Betz 0:0feaa2a2d9ff 1 /**
Wolfgang Betz 0:0feaa2a2d9ff 2 ******************************************************************************
Wolfgang Betz 0:0feaa2a2d9ff 3 * @file x_nucleo_iks01a1.h
Wolfgang Betz 0:0feaa2a2d9ff 4 * @author AST / EST
Wolfgang Betz 0:0feaa2a2d9ff 5 * @version V0.0.1
Wolfgang Betz 0:0feaa2a2d9ff 6 * @date 13-April-2015
Wolfgang Betz 3:088aa5839e0d 7 * @brief Header file for class X_NUCLEO_IKS01A1 representing a X-NUCLEO-IKS01A1
Wolfgang Betz 0:0feaa2a2d9ff 8 * expansion board
Wolfgang Betz 0:0feaa2a2d9ff 9 ******************************************************************************
Wolfgang Betz 0:0feaa2a2d9ff 10 * @attention
Wolfgang Betz 0:0feaa2a2d9ff 11 *
Wolfgang Betz 3:088aa5839e0d 12 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
Wolfgang Betz 0:0feaa2a2d9ff 13 *
Wolfgang Betz 0:0feaa2a2d9ff 14 * Redistribution and use in source and binary forms, with or without modification,
Wolfgang Betz 0:0feaa2a2d9ff 15 * are permitted provided that the following conditions are met:
Wolfgang Betz 0:0feaa2a2d9ff 16 * 1. Redistributions of source code must retain the above copyright notice,
Wolfgang Betz 0:0feaa2a2d9ff 17 * this list of conditions and the following disclaimer.
Wolfgang Betz 0:0feaa2a2d9ff 18 * 2. Redistributions in binary form must reproduce the above copyright notice,
Wolfgang Betz 0:0feaa2a2d9ff 19 * this list of conditions and the following disclaimer in the documentation
Wolfgang Betz 0:0feaa2a2d9ff 20 * and/or other materials provided with the distribution.
Wolfgang Betz 0:0feaa2a2d9ff 21 * 3. Neither the name of STMicroelectronics nor the names of its contributors
Wolfgang Betz 0:0feaa2a2d9ff 22 * may be used to endorse or promote products derived from this software
Wolfgang Betz 0:0feaa2a2d9ff 23 * without specific prior written permission.
Wolfgang Betz 0:0feaa2a2d9ff 24 *
Wolfgang Betz 0:0feaa2a2d9ff 25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
Wolfgang Betz 0:0feaa2a2d9ff 26 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
Wolfgang Betz 0:0feaa2a2d9ff 27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
Wolfgang Betz 0:0feaa2a2d9ff 28 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
Wolfgang Betz 0:0feaa2a2d9ff 29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
Wolfgang Betz 0:0feaa2a2d9ff 30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
Wolfgang Betz 0:0feaa2a2d9ff 31 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
Wolfgang Betz 0:0feaa2a2d9ff 32 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
Wolfgang Betz 0:0feaa2a2d9ff 33 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Wolfgang Betz 0:0feaa2a2d9ff 34 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Wolfgang Betz 0:0feaa2a2d9ff 35 *
Wolfgang Betz 0:0feaa2a2d9ff 36 ******************************************************************************
Wolfgang Betz 0:0feaa2a2d9ff 37 */
Wolfgang Betz 0:0feaa2a2d9ff 38
Wolfgang Betz 0:0feaa2a2d9ff 39 /* Define to prevent from recursive inclusion --------------------------------*/
Wolfgang Betz 0:0feaa2a2d9ff 40 #ifndef __X_NUCLEO_IKS01A1_H
Wolfgang Betz 0:0feaa2a2d9ff 41 #define __X_NUCLEO_IKS01A1_H
Wolfgang Betz 0:0feaa2a2d9ff 42
Wolfgang Betz 0:0feaa2a2d9ff 43 /* Includes ------------------------------------------------------------------*/
Wolfgang Betz 0:0feaa2a2d9ff 44 #include "mbed.h"
Wolfgang Betz 0:0feaa2a2d9ff 45 #include "x_nucleo_iks01a1_targets.h"
Wolfgang Betz 0:0feaa2a2d9ff 46 #include "DevI2C.h"
Wolfgang Betz 3:088aa5839e0d 47 #include "Common/HumTemp.h"
Wolfgang Betz 5:8bab0f419849 48 #include "Common/Magneto.h"
Wolfgang Betz 6:8d2abd695c52 49 #include "Common/Pressure.h"
Wolfgang Betz 4:566f2c41dc1d 50 #if 0 // betzw: TODO
Wolfgang Betz 3:088aa5839e0d 51 #include "Common/Imu6Axis.h"
Wolfgang Betz 4:566f2c41dc1d 52 #endif
Wolfgang Betz 0:0feaa2a2d9ff 53
Wolfgang Betz 0:0feaa2a2d9ff 54 /* Classes -------------------------------------------------------------------*/
Wolfgang Betz 4:566f2c41dc1d 55 /** Class X_NUCLEO_IKS01A1 is intended to represent the MEMS Inertial & Environmental
Wolfgang Betz 4:566f2c41dc1d 56 * Nucleo Expansion Board with the same name.
Wolfgang Betz 0:0feaa2a2d9ff 57 *
Wolfgang Betz 3:088aa5839e0d 58 * The expansion board is featuring basically four IPs:\n
Wolfgang Betz 3:088aa5839e0d 59 * -# a HTS221 Relative Humidity and Temperature Sensor\n
Wolfgang Betz 3:088aa5839e0d 60 * -# a LIS3MDL 3-Axis Magnetometer\n
Wolfgang Betz 3:088aa5839e0d 61 * -# a LPS25H MEMS Pressure Sensor\n
Wolfgang Betz 3:088aa5839e0d 62 * -# and a LSM6DS0 3D Acceleromenter and 3D Gyroscope\n
Wolfgang Betz 0:0feaa2a2d9ff 63 *
Wolfgang Betz 0:0feaa2a2d9ff 64 * It is intentionally implemented as a singleton because only one
Wolfgang Betz 0:0feaa2a2d9ff 65 * X_NUCLEO_IKS01A1 at a time might be deployed in a HW component stack.\n
Wolfgang Betz 0:0feaa2a2d9ff 66 * In order to get the singleton instance you have to call class method `Instance()`,
Wolfgang Betz 0:0feaa2a2d9ff 67 * e.g.:
Wolfgang Betz 0:0feaa2a2d9ff 68 * @code
Wolfgang Betz 3:088aa5839e0d 69 * // Inertial & Environmental expansion board singleton instance
Wolfgang Betz 0:0feaa2a2d9ff 70 * static X_NUCLEO_IKS01A1 *<TODO>_expansion_board = X_NUCLEO_IKS01A1::Instance();
Wolfgang Betz 0:0feaa2a2d9ff 71 * @endcode
Wolfgang Betz 0:0feaa2a2d9ff 72 */
Wolfgang Betz 0:0feaa2a2d9ff 73 class X_NUCLEO_IKS01A1
Wolfgang Betz 0:0feaa2a2d9ff 74 {
Wolfgang Betz 0:0feaa2a2d9ff 75 protected:
Wolfgang Betz 0:0feaa2a2d9ff 76 X_NUCLEO_IKS01A1(DevI2C *ext_i2c);
Wolfgang Betz 0:0feaa2a2d9ff 77
Wolfgang Betz 0:0feaa2a2d9ff 78 public:
Wolfgang Betz 0:0feaa2a2d9ff 79 static X_NUCLEO_IKS01A1* Instance(DevI2C *ext_i2c = NULL);
Wolfgang Betz 0:0feaa2a2d9ff 80
Wolfgang Betz 0:0feaa2a2d9ff 81 DevI2C *dev_i2c;
Wolfgang Betz 0:0feaa2a2d9ff 82
Wolfgang Betz 3:088aa5839e0d 83 HumTemp &ht_sensor;
Wolfgang Betz 5:8bab0f419849 84 Magneto &magnetometer;
Wolfgang Betz 6:8d2abd695c52 85 Pressure &pressure_sensor;
Wolfgang Betz 4:566f2c41dc1d 86 #if 0 // betzw: TODO
Wolfgang Betz 3:088aa5839e0d 87 Imu6Axis &gyroscope;
Wolfgang Betz 4:566f2c41dc1d 88 #endif // 0
Wolfgang Betz 3:088aa5839e0d 89
Wolfgang Betz 0:0feaa2a2d9ff 90 private:
Wolfgang Betz 0:0feaa2a2d9ff 91 static X_NUCLEO_IKS01A1 *_instance;
Wolfgang Betz 0:0feaa2a2d9ff 92 };
Wolfgang Betz 0:0feaa2a2d9ff 93
Wolfgang Betz 0:0feaa2a2d9ff 94 #endif /* __X_NUCLEO_IKS01A1_H */