Beta
Dependencies: ST_INTERFACES X_NUCLEO_COMMON
Fork of X_NUCLEO_IKS01A2 by
Components/LPS22HBSensor/LPS22HBSensor.h
- Committer:
- nikapov
- Date:
- 2016-11-28
- Revision:
- 0:cad5dab2b21d
- Child:
- 1:bd2a01e81e6f
File content as of revision 0:cad5dab2b21d:
/** ****************************************************************************** * @file LPS22HBSensor.h * @author AST * @version V1.0.0 * @date 5 August 2016 * @brief Abstract Class of an LPS22HB Pressure 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 __LPS22HBSensor_H__ #define __LPS22HBSensor_H__ /* Includes ------------------------------------------------------------------*/ #include "DevI2C.h" #include "LPS22HB_Driver.h" #include "PressureSensor.h" #include "TempSensor.h" /* Class Declaration ---------------------------------------------------------*/ /** * Abstract class of an LPS22HB Pressure sensor. */ class LPS22HBSensor : public PressureSensor, public TempSensor { public: LPS22HBSensor(DevI2C &i2c); LPS22HBSensor(DevI2C &i2c, uint8_t address); virtual int Init(void *init); virtual int ReadID(uint8_t *id); virtual int GetPressure(float *pfData); virtual int GetTemperature(float *pfData); int Enable(void); int Disable(void); int Reset(void); int Get_ODR(float *odr); int Set_ODR(float odr); int ReadReg(uint8_t reg, uint8_t *data); int 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: int Set_ODR_When_Enabled(float odr); int Set_ODR_When_Disabled(float odr); /* Helper classes. */ DevI2C &dev_i2c; /* Configuration */ uint8_t address; uint8_t isEnabled; float Last_ODR; }; #ifdef __cplusplus extern "C" { #endif uint8_t LPS22HB_IO_Write( void *handle, uint8_t WriteAddr, uint8_t *pBuffer, uint16_t nBytesToWrite ); uint8_t LPS22HB_IO_Read( void *handle, uint8_t ReadAddr, uint8_t *pBuffer, uint16_t nBytesToRead ); #ifdef __cplusplus } #endif #endif