ST / Mbed 2 deprecated WakeUp_IKS01A2

Example of wake up detection for LSM6DSL in X-NUCLEO-IKS01A2

Dependencies:   X_NUCLEO_IKS01A2 mbed

Fork of WakeUp_IKS01A2 by ST Expansion SW Team

Wake up Demo Application based on sensor expansion board X-NUCLEO-IKS01A2

Main function is to show how to detect the wake up event using the sensor expansion board and send a notification using UART to a connected PC or Desktop and display it on terminal applications like TeraTerm.
After connection has been established:
- the user can try to shake the board and then view the notification using an hyper terminal. When the wake up event is detected, the LED is switched on for a while.
- the user button can be used to enable/disable the wake up detection feature.

X_NUCLEO_IKS01A2/Components/LSM303AGRSensor/LSM303AGR_MAG_Sensor.h@2:7ad7571557a5, 2016-08-19 (annotated)

Committer:
cparata
Date:
Fri Aug 19 12:35:45 2016 +0000
Revision:
2:7ad7571557a5
Child:
3:22f2cb8e0c36
Add interfaces to all components

Who changed what in which revision?

UserRevisionLine numberNew contents of line
cparata 2:7ad7571557a5 1 /**
cparata 2:7ad7571557a5 2 ******************************************************************************
cparata 2:7ad7571557a5 3 * @file LSM303AGR_MAG_Sensor.h
cparata 2:7ad7571557a5 4 * @author AST
cparata 2:7ad7571557a5 5 * @version V1.0.0
cparata 2:7ad7571557a5 6 * @date 5 August 2016
cparata 2:7ad7571557a5 7 * @brief Abstract Class of an LSM303AGR magnetometer sensor.
cparata 2:7ad7571557a5 8 ******************************************************************************
cparata 2:7ad7571557a5 9 * @attention
cparata 2:7ad7571557a5 10 *
cparata 2:7ad7571557a5 11 * <h2><center>&copy; COPYRIGHT(c) 2016 STMicroelectronics</center></h2>
cparata 2:7ad7571557a5 12 *
cparata 2:7ad7571557a5 13 * Redistribution and use in source and binary forms, with or without modification,
cparata 2:7ad7571557a5 14 * are permitted provided that the following conditions are met:
cparata 2:7ad7571557a5 15 * 1. Redistributions of source code must retain the above copyright notice,
cparata 2:7ad7571557a5 16 * this list of conditions and the following disclaimer.
cparata 2:7ad7571557a5 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
cparata 2:7ad7571557a5 18 * this list of conditions and the following disclaimer in the documentation
cparata 2:7ad7571557a5 19 * and/or other materials provided with the distribution.
cparata 2:7ad7571557a5 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
cparata 2:7ad7571557a5 21 * may be used to endorse or promote products derived from this software
cparata 2:7ad7571557a5 22 * without specific prior written permission.
cparata 2:7ad7571557a5 23 *
cparata 2:7ad7571557a5 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
cparata 2:7ad7571557a5 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
cparata 2:7ad7571557a5 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
cparata 2:7ad7571557a5 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
cparata 2:7ad7571557a5 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
cparata 2:7ad7571557a5 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
cparata 2:7ad7571557a5 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
cparata 2:7ad7571557a5 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
cparata 2:7ad7571557a5 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
cparata 2:7ad7571557a5 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
cparata 2:7ad7571557a5 34 *
cparata 2:7ad7571557a5 35 ******************************************************************************
cparata 2:7ad7571557a5 36 */
cparata 2:7ad7571557a5 37
cparata 2:7ad7571557a5 38
cparata 2:7ad7571557a5 39 /* Prevent recursive inclusion -----------------------------------------------*/
cparata 2:7ad7571557a5 40
cparata 2:7ad7571557a5 41 #ifndef __LSM303AGR_MAG_Sensor_H__
cparata 2:7ad7571557a5 42 #define __LSM303AGR_MAG_Sensor_H__
cparata 2:7ad7571557a5 43
cparata 2:7ad7571557a5 44
cparata 2:7ad7571557a5 45 /* Includes ------------------------------------------------------------------*/
cparata 2:7ad7571557a5 46
cparata 2:7ad7571557a5 47 #include "DevI2C.h"
cparata 2:7ad7571557a5 48 #include "LSM303AGR_MAG_driver.h"
cparata 2:7ad7571557a5 49 #include "MagneticSensor.h"
cparata 2:7ad7571557a5 50
cparata 2:7ad7571557a5 51
cparata 2:7ad7571557a5 52 /* Class Declaration ---------------------------------------------------------*/
cparata 2:7ad7571557a5 53
cparata 2:7ad7571557a5 54 /**
cparata 2:7ad7571557a5 55 * Abstract class of an LSM303AGR Inertial Measurement Unit (IMU) 6 axes
cparata 2:7ad7571557a5 56 * sensor.
cparata 2:7ad7571557a5 57 */
cparata 2:7ad7571557a5 58 class LSM303AGR_MAG_Sensor
cparata 2:7ad7571557a5 59 {
cparata 2:7ad7571557a5 60 public:
cparata 2:7ad7571557a5 61 LSM303AGR_MAG_Sensor(DevI2C &i2c);
cparata 2:7ad7571557a5 62 LSM303AGR_MAG_Sensor(DevI2C &i2c, uint8_t address);
cparata 2:7ad7571557a5 63 virtual int Init(void *init);
cparata 2:7ad7571557a5 64 virtual int ReadID(uint8_t *id);
cparata 2:7ad7571557a5 65 virtual int Get_M_Axes(int32_t *pData);
cparata 2:7ad7571557a5 66 virtual int Get_M_AxesRaw(int16_t *pData);
cparata 2:7ad7571557a5 67 int Enable(void);
cparata 2:7ad7571557a5 68 int Disable(void);
cparata 2:7ad7571557a5 69 int Get_M_Sensitivity(float *pfData);
cparata 2:7ad7571557a5 70 int Get_M_ODR(float *odr);
cparata 2:7ad7571557a5 71 int Set_M_ODR(float odr);
cparata 2:7ad7571557a5 72 int Get_M_FS(float *fullScale);
cparata 2:7ad7571557a5 73 int Set_M_FS(float fullScale);
cparata 2:7ad7571557a5 74 int ReadReg(uint8_t reg, uint8_t *data);
cparata 2:7ad7571557a5 75 int WriteReg(uint8_t reg, uint8_t data);
cparata 2:7ad7571557a5 76
cparata 2:7ad7571557a5 77 /**
cparata 2:7ad7571557a5 78 * @brief Utility function to read data.
cparata 2:7ad7571557a5 79 * @param pBuffer: pointer to data to be read.
cparata 2:7ad7571557a5 80 * @param RegisterAddr: specifies internal address register to be read.
cparata 2:7ad7571557a5 81 * @param NumByteToRead: number of bytes to be read.
cparata 2:7ad7571557a5 82 * @retval 0 if ok, an error code otherwise.
cparata 2:7ad7571557a5 83 */
cparata 2:7ad7571557a5 84 uint8_t IO_Read(uint8_t* pBuffer, uint8_t RegisterAddr, uint16_t NumByteToRead)
cparata 2:7ad7571557a5 85 {
cparata 2:7ad7571557a5 86 return (uint8_t) dev_i2c.i2c_read(pBuffer, address, RegisterAddr, NumByteToRead);
cparata 2:7ad7571557a5 87 }
cparata 2:7ad7571557a5 88
cparata 2:7ad7571557a5 89 /**
cparata 2:7ad7571557a5 90 * @brief Utility function to write data.
cparata 2:7ad7571557a5 91 * @param pBuffer: pointer to data to be written.
cparata 2:7ad7571557a5 92 * @param RegisterAddr: specifies internal address register to be written.
cparata 2:7ad7571557a5 93 * @param NumByteToWrite: number of bytes to write.
cparata 2:7ad7571557a5 94 * @retval 0 if ok, an error code otherwise.
cparata 2:7ad7571557a5 95 */
cparata 2:7ad7571557a5 96 uint8_t IO_Write(uint8_t* pBuffer, uint8_t RegisterAddr, uint16_t NumByteToWrite)
cparata 2:7ad7571557a5 97 {
cparata 2:7ad7571557a5 98 return (uint8_t) dev_i2c.i2c_write(pBuffer, address, RegisterAddr, NumByteToWrite);
cparata 2:7ad7571557a5 99 }
cparata 2:7ad7571557a5 100
cparata 2:7ad7571557a5 101 private:
cparata 2:7ad7571557a5 102
cparata 2:7ad7571557a5 103 /* Helper classes. */
cparata 2:7ad7571557a5 104 DevI2C &dev_i2c;
cparata 2:7ad7571557a5 105
cparata 2:7ad7571557a5 106 /* Configuration */
cparata 2:7ad7571557a5 107 uint8_t address;
cparata 2:7ad7571557a5 108 };
cparata 2:7ad7571557a5 109
cparata 2:7ad7571557a5 110 #ifdef __cplusplus
cparata 2:7ad7571557a5 111 extern "C" {
cparata 2:7ad7571557a5 112 #endif
cparata 2:7ad7571557a5 113 uint8_t LSM303AGR_MAG_IO_Write( void *handle, uint8_t WriteAddr, uint8_t *pBuffer, uint16_t nBytesToWrite );
cparata 2:7ad7571557a5 114 uint8_t LSM303AGR_MAG_IO_Read( void *handle, uint8_t ReadAddr, uint8_t *pBuffer, uint16_t nBytesToRead );
cparata 2:7ad7571557a5 115 #ifdef __cplusplus
cparata 2:7ad7571557a5 116 }
cparata 2:7ad7571557a5 117 #endif
cparata 2:7ad7571557a5 118
cparata 2:7ad7571557a5 119 #endif