Example of tilt detection for LSM6DSL in X-NUCLEO-IKS01A2
Dependencies: X_NUCLEO_IKS01A2 mbed
Fork of Tilt_IKS01A2 by
Tilt Detection Demo Application based on sensor expansion board X-NUCLEO-IKS01A2
Main function is to show how to detect the tilt 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 tilt the board and then view the notification using an hyper terminal. When the tilt event is detected, the LED is switched on for a while.
- the user button can be used to enable/disable the tilt detection feature.
X_NUCLEO_IKS01A2/Components/HTS221Sensor/HTS221Sensor.h
- Committer:
- cparata
- Date:
- 2016-08-12
- Revision:
- 0:489965565a0d
File content as of revision 0:489965565a0d:
/**
******************************************************************************
* @file HTS221Sensor.h
* @author AST
* @version V1.0.0
* @date 5 August 2016
* @brief Abstract class of an HTS221 Humidity and Temperature sensor.
******************************************************************************
* @attention
*
* <h2><center>© COPYRIGHT(c) 2016 STMicroelectronics</center></h2>
*
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
* 3. Neither the name of STMicroelectronics nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
******************************************************************************
*/
/* Prevent recursive inclusion -----------------------------------------------*/
#ifndef __HTS221Sensor_H__
#define __HTS221Sensor_H__
/* Includes ------------------------------------------------------------------*/
#include "DevI2C.h"
#include "HTS221_Driver.h"
/* Typedefs ------------------------------------------------------------------*/
typedef enum
{
HTS221_STATUS_OK = 0,
HTS221_STATUS_ERROR,
HTS221_STATUS_TIMEOUT,
HTS221_STATUS_NOT_IMPLEMENTED
} HTS221StatusTypeDef;
/* Class Declaration ---------------------------------------------------------*/
/**
* Abstract class of an HTS221 Humidity and Temperature sensor.
*/
class HTS221Sensor
{
public:
HTS221Sensor (DevI2C &i2c);
HTS221Sensor (DevI2C &i2c, uint8_t address);
HTS221StatusTypeDef Enable (void);
HTS221StatusTypeDef Disable (void);
HTS221StatusTypeDef ReadID (uint8_t *ht_id);
HTS221StatusTypeDef Reset (void);
HTS221StatusTypeDef GetHumidity (float *pfData);
HTS221StatusTypeDef GetTemperature (float *pfData);
HTS221StatusTypeDef GetODR (float *odr);
HTS221StatusTypeDef SetODR (float odr);
HTS221StatusTypeDef ReadReg (uint8_t reg, uint8_t *data);
HTS221StatusTypeDef WriteReg (uint8_t reg, uint8_t data);
/**
* @brief Utility function to read data.
* @param pBuffer: pointer to data to be read.
* @param RegisterAddr: specifies internal address register to be read.
* @param NumByteToRead: number of bytes to be read.
* @retval 0 if ok, an error code otherwise.
*/
uint8_t IO_Read(uint8_t* pBuffer, uint8_t RegisterAddr, uint16_t NumByteToRead)
{
return (uint8_t) dev_i2c.i2c_read(pBuffer, address, RegisterAddr, NumByteToRead);
}
/**
* @brief Utility function to write data.
* @param pBuffer: pointer to data to be written.
* @param RegisterAddr: specifies internal address register to be written.
* @param NumByteToWrite: number of bytes to write.
* @retval 0 if ok, an error code otherwise.
*/
uint8_t IO_Write(uint8_t* pBuffer, uint8_t RegisterAddr, uint16_t NumByteToWrite)
{
return (uint8_t) dev_i2c.i2c_write(pBuffer, address, RegisterAddr, NumByteToWrite);
}
private:
/* Helper classes. */
DevI2C &dev_i2c;
/* Configuration */
uint8_t address;
};
#ifdef __cplusplus
extern "C" {
#endif
uint8_t HTS221_IO_Write( void *handle, uint8_t WriteAddr, uint8_t *pBuffer, uint16_t nBytesToWrite );
uint8_t HTS221_IO_Read( void *handle, uint8_t ReadAddr, uint8_t *pBuffer, uint16_t nBytesToRead );
#ifdef __cplusplus
}
#endif
#endif
