Adafruit_HTS221.h

Go to the documentation of this file.

#ifndef _ADAFRUIT_HTS221_H
#define _ADAFRUIT_HTS221_H

#include "Arduino.h"
#include <Adafruit_BusIO_Register.h>
#include <Adafruit_I2CDevice.h>
#include <Adafruit_SPIDevice.h>
#include <Adafruit_Sensor.h>
#include <Wire.h>

#define HTS221_I2CADDR_DEFAULT 0x5F 
#define HTS221_CHIP_ID 0xBC         
#define HTS221_CTRL_REG_1 0x20      
#define HTS221_CTRL_REG_2                                                      \
  0x21 
#define HTS221_CTRL_REG_3 0x22   
#define HTS221_HUMIDITY_OUT 0x28 
#define HTS221_TEMP_OUT_L 0x2A   
#define HTS221_H0_RH_X2 0x30     
#define HTS221_H1_RH_X2 0x31     
#define HTS221_T0_DEGC_X8 0x32   
#define HTS221_T1_T0_MSB 0x35    
#define HTS221_H0_T0 0x36        
#define HTS221_H0_T1 0x3A        
#define HTS221_T0_OUT 0x3C       
#define HTS221_T1_OUT 0x3E       

#define HTS221_WHOAMI 0x0F 

typedef enum {
  HTS221_RATE_ONE_SHOT,
  HTS221_RATE_1_HZ,
  HTS221_RATE_7_HZ,
  HTS221_RATE_12_5_HZ,
} hts221_rate_t;

class Adafruit_HTS221;

class Adafruit_HTS221_Humidity : public Adafruit_Sensor {
public:
  Adafruit_HTS221_Humidity(Adafruit_HTS221 *parent) { _theHTS221 = parent; }
  bool getEvent(sensors_event_t *);
  void getSensor(sensor_t *);

private:
  int _sensorID = 0x221;
  Adafruit_HTS221 *_theHTS221 = NULL;
};

class Adafruit_HTS221_Temp : public Adafruit_Sensor {
public:
  Adafruit_HTS221_Temp(Adafruit_HTS221 *parent) { _theHTS221 = parent; }

  bool getEvent(sensors_event_t *);
  void getSensor(sensor_t *);

private:
  int _sensorID = 0x222;
  Adafruit_HTS221 *_theHTS221 = NULL;
};

class Adafruit_HTS221 final {
public:
  Adafruit_HTS221();
  ~Adafruit_HTS221();

  bool begin_I2C(uint8_t i2c_addr = HTS221_I2CADDR_DEFAULT,
                 TwoWire *wire = &Wire, int32_t sensor_id = 0);

  bool begin_SPI(uint8_t cs_pin, SPIClass *theSPI = &SPI,
                 int32_t sensor_id = 0);
  bool begin_SPI(int8_t cs_pin, int8_t sck_pin, int8_t miso_pin,
                 int8_t mosi_pin, int32_t sensor_id = 0);

  void boot(void);

  void setActive(bool active);
  hts221_rate_t getDataRate(void);
  void setDataRate(hts221_rate_t data_rate);

  void drdyActiveLow(bool active_low);
  void drdyIntEnabled(bool drdy_int_enabled);

  bool getEvent(sensors_event_t *humidity, sensors_event_t *temp);
  Adafruit_Sensor *getTemperatureSensor(void);
  Adafruit_Sensor *getHumiditySensor(void);

protected:
  bool _read(void);
  virtual bool _init(int32_t sensor_id);

  float corrected_temp,   
      corrected_humidity; 

  uint16_t _sensorid_humidity; 
  uint16_t _sensorid_temp;     

  Adafruit_I2CDevice *i2c_dev = NULL; 
  Adafruit_SPIDevice *spi_dev = NULL; 

  Adafruit_HTS221_Temp *temp_sensor = NULL; 
  Adafruit_HTS221_Humidity *humidity_sensor =
      NULL; 

private:
  void _fetchTempCalibrationValues(void);
  void _fetchHumidityCalibrationValues(void);
  friend class Adafruit_HTS221_Temp;     
  friend class Adafruit_HTS221_Humidity; 

  void fillTempEvent(sensors_event_t *temp, uint32_t timestamp);
  void fillHumidityEvent(sensors_event_t *humidity, uint32_t timestamp);

  void _applyTemperatureCorrection(void);
  void _applyHumidityCorrection(void);
  uint16_t T0, T1, T0_OUT, T1_OUT; 
  uint8_t H0, H1;                  
  uint16_t H0_T0_OUT, H1_T0_OUT;   
  uint16_t raw_temperature; 
  uint16_t raw_humidity;    

  uint8_t multi_byte_address_mask = 0x80; // default to I2C
};

#endif