LPS22HBSensor.h

00001 /**
00002  ******************************************************************************
00003  * @file    LPS22HBSensor.h
00004  * @author  CLab
00005  * @version V1.0.0
00006  * @date    5 August 2016
00007  * @brief   Abstract Class of an LPS22HB Pressure sensor.
00008  ******************************************************************************
00009  * @attention
00010  *
00011  * <h2><center>&copy; COPYRIGHT(c) 2016 STMicroelectronics</center></h2>
00012  *
00013  * Redistribution and use in source and binary forms, with or without modification,
00014  * are permitted provided that the following conditions are met:
00015  *   1. Redistributions of source code must retain the above copyright notice,
00016  *      this list of conditions and the following disclaimer.
00017  *   2. Redistributions in binary form must reproduce the above copyright notice,
00018  *      this list of conditions and the following disclaimer in the documentation
00019  *      and/or other materials provided with the distribution.
00020  *   3. Neither the name of STMicroelectronics nor the names of its contributors
00021  *      may be used to endorse or promote products derived from this software
00022  *      without specific prior written permission.
00023  *
00024  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00025  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00026  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00027  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
00028  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00029  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
00030  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00031  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00032  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00033  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00034  *
00035  ******************************************************************************
00036  */
00037 
00038 
00039 /* Prevent recursive inclusion -----------------------------------------------*/
00040 
00041 #ifndef __LPS22HBSensor_H__
00042 #define __LPS22HBSensor_H__
00043 
00044 
00045 /* Includes ------------------------------------------------------------------*/
00046 
00047 #include "DevI2C.h"
00048 #include "LPS22HB_driver.h"
00049 #include "PressureSensor.h"
00050 #include "TempSensor.h"
00051 
00052 /* Class Declaration ---------------------------------------------------------*/
00053 
00054 /**
00055  * Abstract class of an LPS22HB Pressure sensor.
00056  */
00057 class LPS22HBSensor : public PressureSensor, public TempSensor
00058 {
00059   public:
00060     LPS22HBSensor(DevI2C &i2c);
00061     LPS22HBSensor(DevI2C &i2c, uint8_t address);
00062     virtual int init(void *init);
00063     virtual int read_id(uint8_t *id);
00064     virtual int get_pressure(float *pfData);
00065     virtual int get_temperature(float *pfData);
00066     int enable(void);
00067     int disable(void);
00068     int reset(void);
00069     int get_odr(float *odr);
00070     int set_odr(float odr);
00071     int read_reg(uint8_t reg, uint8_t *data);
00072     int write_reg(uint8_t reg, uint8_t data);
00073     
00074     /**
00075      * @brief Utility function to read data.
00076      * @param  pBuffer: pointer to data to be read.
00077      * @param  RegisterAddr: specifies internal address register to be read.
00078      * @param  NumByteToRead: number of bytes to be read.
00079      * @retval 0 if ok, an error code otherwise.
00080      */
00081     uint8_t io_read(uint8_t* pBuffer, uint8_t RegisterAddr, uint16_t NumByteToRead)
00082     {
00083         return (uint8_t) _dev_i2c.i2c_read(pBuffer, _address, RegisterAddr, NumByteToRead);
00084     }
00085     
00086     /**
00087      * @brief Utility function to write data.
00088      * @param  pBuffer: pointer to data to be written.
00089      * @param  RegisterAddr: specifies internal address register to be written.
00090      * @param  NumByteToWrite: number of bytes to write.
00091      * @retval 0 if ok, an error code otherwise.
00092      */
00093     uint8_t io_write(uint8_t* pBuffer, uint8_t RegisterAddr, uint16_t NumByteToWrite)
00094     {
00095         return (uint8_t) _dev_i2c.i2c_write(pBuffer, _address, RegisterAddr, NumByteToWrite);
00096     }
00097 
00098   private:
00099     int Set_ODR_When_Enabled(float odr);
00100     int Set_ODR_When_Disabled(float odr);
00101 
00102     /* Helper classes. */
00103     DevI2C &_dev_i2c;
00104     
00105     /* Configuration */
00106     uint8_t _address;
00107     
00108     uint8_t _is_enabled;
00109     float _last_odr;
00110 };
00111 
00112 #ifdef __cplusplus
00113  extern "C" {
00114 #endif
00115 uint8_t LPS22HB_io_write( void *handle, uint8_t WriteAddr, uint8_t *pBuffer, uint16_t nBytesToWrite );
00116 uint8_t LPS22HB_io_read( void *handle, uint8_t ReadAddr, uint8_t *pBuffer, uint16_t nBytesToRead );
00117 #ifdef __cplusplus
00118   }
00119 #endif
00120 
00121 #endif