Jim Carver / Mbed OS pelion-workshop

Workshop example

Dependencies:   X_NUCLEO_COMMON ST_INTERFACES

sensors/HTS221/HTS221Sensor.h@35:42b3fba640b1, 2019-05-21 (annotated)

Committer:
JimCarver
Date:
Tue May 21 21:16:24 2019 +0000
Revision:
35:42b3fba640b1
Parent:
18:a15bfe7aaebd 
Simple version for workshop

Who changed what in which revision?

UserRevisionLine numberNew contents of line
screamer 18:a15bfe7aaebd 1 /**
screamer 18:a15bfe7aaebd 2 ******************************************************************************
screamer 18:a15bfe7aaebd 3 * @file HTS221Sensor.h
screamer 18:a15bfe7aaebd 4 * @author CLab
screamer 18:a15bfe7aaebd 5 * @version V1.0.0
screamer 18:a15bfe7aaebd 6 * @date 5 August 2016
screamer 18:a15bfe7aaebd 7 * @brief Abstract class of an HTS221 Humidity and Temperature sensor.
screamer 18:a15bfe7aaebd 8 ******************************************************************************
screamer 18:a15bfe7aaebd 9 * @attention
screamer 18:a15bfe7aaebd 10 *
screamer 18:a15bfe7aaebd 11 * <h2><center>&copy; COPYRIGHT(c) 2016 STMicroelectronics</center></h2>
screamer 18:a15bfe7aaebd 12 *
screamer 18:a15bfe7aaebd 13 * Redistribution and use in source and binary forms, with or without modification,
screamer 18:a15bfe7aaebd 14 * are permitted provided that the following conditions are met:
screamer 18:a15bfe7aaebd 15 * 1. Redistributions of source code must retain the above copyright notice,
screamer 18:a15bfe7aaebd 16 * this list of conditions and the following disclaimer.
screamer 18:a15bfe7aaebd 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
screamer 18:a15bfe7aaebd 18 * this list of conditions and the following disclaimer in the documentation
screamer 18:a15bfe7aaebd 19 * and/or other materials provided with the distribution.
screamer 18:a15bfe7aaebd 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
screamer 18:a15bfe7aaebd 21 * may be used to endorse or promote products derived from this software
screamer 18:a15bfe7aaebd 22 * without specific prior written permission.
screamer 18:a15bfe7aaebd 23 *
screamer 18:a15bfe7aaebd 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
screamer 18:a15bfe7aaebd 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
screamer 18:a15bfe7aaebd 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
screamer 18:a15bfe7aaebd 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
screamer 18:a15bfe7aaebd 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
screamer 18:a15bfe7aaebd 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
screamer 18:a15bfe7aaebd 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
screamer 18:a15bfe7aaebd 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
screamer 18:a15bfe7aaebd 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
screamer 18:a15bfe7aaebd 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
screamer 18:a15bfe7aaebd 34 *
screamer 18:a15bfe7aaebd 35 ******************************************************************************
screamer 18:a15bfe7aaebd 36 */
screamer 18:a15bfe7aaebd 37
screamer 18:a15bfe7aaebd 38
screamer 18:a15bfe7aaebd 39 /* Prevent recursive inclusion -----------------------------------------------*/
screamer 18:a15bfe7aaebd 40
screamer 18:a15bfe7aaebd 41 #ifndef __HTS221Sensor_H__
screamer 18:a15bfe7aaebd 42 #define __HTS221Sensor_H__
screamer 18:a15bfe7aaebd 43
screamer 18:a15bfe7aaebd 44
screamer 18:a15bfe7aaebd 45 /* Includes ------------------------------------------------------------------*/
screamer 18:a15bfe7aaebd 46
screamer 18:a15bfe7aaebd 47 #include "DevI2C.h"
screamer 18:a15bfe7aaebd 48 #include "HTS221_driver.h"
screamer 18:a15bfe7aaebd 49 #include "HumiditySensor.h"
screamer 18:a15bfe7aaebd 50 #include "TempSensor.h"
screamer 18:a15bfe7aaebd 51 #include <assert.h>
screamer 18:a15bfe7aaebd 52
screamer 18:a15bfe7aaebd 53 /* Class Declaration ---------------------------------------------------------*/
screamer 18:a15bfe7aaebd 54
screamer 18:a15bfe7aaebd 55 /**
screamer 18:a15bfe7aaebd 56 * Abstract class of an HTS221 Humidity and Temperature sensor.
screamer 18:a15bfe7aaebd 57 */
screamer 18:a15bfe7aaebd 58 class HTS221Sensor : public HumiditySensor, public TempSensor
screamer 18:a15bfe7aaebd 59 {
screamer 18:a15bfe7aaebd 60 public:
screamer 18:a15bfe7aaebd 61 HTS221Sensor(SPI *spi, PinName cs_pin=NC, PinName drdy_pin=NC); // SPI3W ONLY
screamer 18:a15bfe7aaebd 62 HTS221Sensor(DevI2C *i2c, uint8_t address=HTS221_I2C_ADDRESS, PinName drdy_pin=NC);
screamer 18:a15bfe7aaebd 63 virtual int init(void *init);
screamer 18:a15bfe7aaebd 64 virtual int read_id(uint8_t *id);
screamer 18:a15bfe7aaebd 65 virtual int get_humidity(float *pfData);
screamer 18:a15bfe7aaebd 66 virtual int get_temperature(float *pfData);
screamer 18:a15bfe7aaebd 67 int enable(void);
screamer 18:a15bfe7aaebd 68 int disable(void);
screamer 18:a15bfe7aaebd 69 int reset(void);
screamer 18:a15bfe7aaebd 70 int get_odr(float *odr);
screamer 18:a15bfe7aaebd 71 int set_odr(float odr);
screamer 18:a15bfe7aaebd 72 int read_reg(uint8_t reg, uint8_t *data);
screamer 18:a15bfe7aaebd 73 int write_reg(uint8_t reg, uint8_t data);
screamer 18:a15bfe7aaebd 74 /**
screamer 18:a15bfe7aaebd 75 * @brief Utility function to read data.
screamer 18:a15bfe7aaebd 76 * @param pBuffer: pointer to data to be read.
screamer 18:a15bfe7aaebd 77 * @param RegisterAddr: specifies internal address register to be read.
screamer 18:a15bfe7aaebd 78 * @param NumByteToRead: number of bytes to be read.
screamer 18:a15bfe7aaebd 79 * @retval 0 if ok, an error code otherwise.
screamer 18:a15bfe7aaebd 80 */
screamer 18:a15bfe7aaebd 81 uint8_t io_read(uint8_t* pBuffer, uint8_t RegisterAddr, uint16_t NumByteToRead)
screamer 18:a15bfe7aaebd 82 {
screamer 18:a15bfe7aaebd 83 if (_dev_spi) {
screamer 18:a15bfe7aaebd 84 /* Write Reg Address */
screamer 18:a15bfe7aaebd 85 _dev_spi->lock();
screamer 18:a15bfe7aaebd 86 _cs_pin = 0;
screamer 18:a15bfe7aaebd 87 /* Write RD Reg Address with RD bit*/
screamer 18:a15bfe7aaebd 88 uint8_t TxByte = RegisterAddr | 0x80;
screamer 18:a15bfe7aaebd 89 _dev_spi->write((char *)&TxByte, 1, (char *)pBuffer, (int) NumByteToRead);
screamer 18:a15bfe7aaebd 90 _cs_pin = 1;
screamer 18:a15bfe7aaebd 91 _dev_spi->unlock();
screamer 18:a15bfe7aaebd 92 return 0;
screamer 18:a15bfe7aaebd 93 }
screamer 18:a15bfe7aaebd 94 if (_dev_i2c) return (uint8_t) _dev_i2c->i2c_read(pBuffer, _address, RegisterAddr, NumByteToRead);
screamer 18:a15bfe7aaebd 95 return 1;
screamer 18:a15bfe7aaebd 96 }
screamer 18:a15bfe7aaebd 97
screamer 18:a15bfe7aaebd 98 /**
screamer 18:a15bfe7aaebd 99 * @brief Utility function to write data.
screamer 18:a15bfe7aaebd 100 * @param pBuffer: pointer to data to be written.
screamer 18:a15bfe7aaebd 101 * @param RegisterAddr: specifies internal address register to be written.
screamer 18:a15bfe7aaebd 102 * @param NumByteToWrite: number of bytes to write.
screamer 18:a15bfe7aaebd 103 * @retval 0 if ok, an error code otherwise.
screamer 18:a15bfe7aaebd 104 */
screamer 18:a15bfe7aaebd 105 uint8_t io_write(uint8_t* pBuffer, uint8_t RegisterAddr, uint16_t NumByteToWrite)
screamer 18:a15bfe7aaebd 106 {
screamer 18:a15bfe7aaebd 107 if (_dev_spi) {
screamer 18:a15bfe7aaebd 108 _dev_spi->lock();
screamer 18:a15bfe7aaebd 109 _cs_pin = 0;
screamer 18:a15bfe7aaebd 110 int data = _dev_spi->write(RegisterAddr);
screamer 18:a15bfe7aaebd 111 _dev_spi->write((char *)pBuffer, (int) NumByteToWrite, NULL, 0);
screamer 18:a15bfe7aaebd 112 _cs_pin = 1;
screamer 18:a15bfe7aaebd 113 _dev_spi->unlock();
screamer 18:a15bfe7aaebd 114 return data;
screamer 18:a15bfe7aaebd 115 }
screamer 18:a15bfe7aaebd 116 if (_dev_i2c) return (uint8_t) _dev_i2c->i2c_write(pBuffer, _address, RegisterAddr, NumByteToWrite);
screamer 18:a15bfe7aaebd 117 return 1;
screamer 18:a15bfe7aaebd 118 }
screamer 18:a15bfe7aaebd 119
screamer 18:a15bfe7aaebd 120 private:
screamer 18:a15bfe7aaebd 121
screamer 18:a15bfe7aaebd 122 /* Helper classes. */
screamer 18:a15bfe7aaebd 123 DevI2C *_dev_i2c;
screamer 18:a15bfe7aaebd 124 SPI * _dev_spi;
screamer 18:a15bfe7aaebd 125
screamer 18:a15bfe7aaebd 126 /* Configuration */
screamer 18:a15bfe7aaebd 127 uint8_t _address;
screamer 18:a15bfe7aaebd 128 DigitalOut _cs_pin;
screamer 18:a15bfe7aaebd 129 InterruptIn _drdy_pin;
screamer 18:a15bfe7aaebd 130 };
screamer 18:a15bfe7aaebd 131
screamer 18:a15bfe7aaebd 132 #ifdef __cplusplus
screamer 18:a15bfe7aaebd 133 extern "C" {
screamer 18:a15bfe7aaebd 134 #endif
screamer 18:a15bfe7aaebd 135 uint8_t HTS221_io_write( void *handle, uint8_t WriteAddr, uint8_t *pBuffer, uint16_t nBytesToWrite );
screamer 18:a15bfe7aaebd 136 uint8_t HTS221_io_read( void *handle, uint8_t ReadAddr, uint8_t *pBuffer, uint16_t nBytesToRead );
screamer 18:a15bfe7aaebd 137 #ifdef __cplusplus
screamer 18:a15bfe7aaebd 138 }
screamer 18:a15bfe7aaebd 139 #endif
screamer 18:a15bfe7aaebd 140
screamer 18:a15bfe7aaebd 141 #endif