Adafruit_MS8607.h

Go to the documentation of this file.

#ifndef __MS8607_H__
#define __MS8607_H__

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

#define MS8607_PT_ADDRESS                                                      \
  0x76 
#define MS8607_HUM_ADDRESS                                                     \
  0x40 

// HSENSOR device commands
#define HSENSOR_RESET_COMMAND 0xFE 
#define HSENSOR_READ_HUMIDITY_W_HOLD_COMMAND                                   \
  0xE5 
#define HSENSOR_READ_HUMIDITY_WO_HOLD_COMMAND                                  \
  0xF5 
#define HSENSOR_READ_SERIAL_FIRST_8BYTES_COMMAND                               \
  0xFA0F 
#define HSENSOR_READ_SERIAL_LAST_6BYTES_COMMAND                                \
  0xFCC9                                    
#define HSENSOR_WRITE_USER_REG_COMMAND 0xE6 
#define HSENSOR_READ_USER_REG_COMMAND 0xE7  

// Processing constants
#define HSENSOR_TEMPERATURE_COEFFICIENT                                        \
  (float)(-0.15)                            
#define HSENSOR_CONSTANT_A (float)(8.1332)  
#define HSENSOR_CONSTANT_B (float)(1762.39) 
#define HSENSOR_CONSTANT_C (float)(235.66)  

// Coefficients for temperature computation
#define TEMPERATURE_COEFF_MUL (175.72) 
#define TEMPERATURE_COEFF_ADD (-46.85) 

// Coefficients for relative humidity computation
#define HUMIDITY_COEFF_MUL (125) 
#define HUMIDITY_COEFF_ADD (-6)  

// Conversion timings
#define HSENSOR_CONVERSION_TIME_12b 16 
#define HSENSOR_CONVERSION_TIME_10b 5  
#define HSENSOR_CONVERSION_TIME_8b 3   
#define HSENSOR_CONVERSION_TIME_11b 9  

// HSENSOR User Register masks and bit position
#define HSENSOR_USER_REG_RESOLUTION_MASK 0x81 
#define HSENSOR_USER_REG_END_OF_BATTERY_MASK                                   \
  0x40 
#define HSENSOR_USER_REG_ENABLE_ONCHIP_HEATER_MASK                             \
  0x4 
#define HSENSOR_USER_REG_DISABLE_OTP_RELOAD_MASK                               \
  0x2 

#define MS8607_RH_ADDRESS (0x40) 
#define MS8607_RH_LSB                                                          \
  0.0019073486328125; 
// PSENSOR commands
#define PROM_ADDRESS_READ_ADDRESS_0 0xA0 

/* Pressure & Temperature commands */
#define P_T_RESET 0x1E           
#define CONVERT_D1_OSR_256 0x40  
#define CONVERT_D1_OSR_512 0x42  
#define CONVERT_D1_OSR_1024 0x44 
#define CONVERT_D1_OSR_2048 0x46 
#define CONVERT_D1_OSR_4096 0x48 
#define CONVERT_D1_OSR_8192 0x4A 
#define CONVERT_D2_OSR_256 0x50  
#define CONVERT_D2_OSR_512 0x52  
#define CONVERT_D2_OSR_1024 0x54 
#define CONVERT_D2_OSR_2048 0x56 
#define CONVERT_D2_OSR_4096 0x58 
#define CONVERT_D2_OSR_8192 0x5A 
#define ADC_READ 0x00            
/* PROM READ P&T is from 0xA0 to 0xAE. Not sure whether or not to add */

/* Commands for relative humidity */
#define HUM_RESET 0xFE          
#define HUM_WRITE_REGISTER 0xE6 
#define HUM_READ_REGISTER 0xE7  
#define HUM_MEASURE_RH_HOLD                                                    \
  0xE5 
#define HUM_MEASURE_RH_NO_HOLD                                                 \
  0xF5 
/* PROM READ RH is from 0xA0 to 0xAE. Not sure whether or not to add */

#define PSENSOR_RESET_COMMAND 0x1E 
#define PSENSOR_START_PRESSURE_ADC_CONVERSION                                  \
  0x40 
#define PSENSOR_START_TEMPERATURE_ADC_CONVERSION                               \
  0x50                        
#define PSENSOR_READ_ADC 0x00 


typedef enum {
  MS8607_PRESSURE_RESOLUTION_OSR_256,  
  MS8607_PRESSURE_RESOLUTION_OSR_512,  
  MS8607_PRESSURE_RESOLUTION_OSR_1024, 
  MS8607_PRESSURE_RESOLUTION_OSR_2048, 
  MS8607_PRESSURE_RESOLUTION_OSR_4096, 
  MS8607_PRESSURE_RESOLUTION_OSR_8192, 
} ms8607_pressure_resolution_t;

typedef enum {
  MS8607_HUMIDITY_RESOLUTION_OSR_12b = 0x00,
  MS8607_HUMIDITY_RESOLUTION_OSR_11b = 0x81,
  MS8607_HUMIDITY_RESOLUTION_OSR_10b = 0x80,
  MS8607_HUMIDITY_RESOLUTION_OSR_8b = 0x01,
} ms8607_humidity_resolution_t;

typedef enum {
  MS8607_I2C_HOLD = 0xE5,
  MS8607_I2C_NO_HOLD = 0xF5,
} ms8607_hum_clock_stretch_t;

class Adafruit_MS8607;

#define HSENSOR_READ_HUMIDITY_W_HOLD_COMMAND                                   \
  0xE5 
#define HSENSOR_READ_HUMIDITY_WO_HOLD_COMMAND                                  \
  0xF5 

class Adafruit_MS8607_Temp : public Adafruit_Sensor {
public:
  Adafruit_MS8607_Temp(Adafruit_MS8607 *parent) { _theMS8607 = parent; }

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

private:
  int _sensorID = 0x8600;
  Adafruit_MS8607 *_theMS8607 = NULL;
};
class Adafruit_MS8607_Pressure : public Adafruit_Sensor {
public:
  Adafruit_MS8607_Pressure(Adafruit_MS8607 *parent) { _theMS8607 = parent; }

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

private:
  int _sensorID = 0x8601;
  Adafruit_MS8607 *_theMS8607 = NULL;
};

class Adafruit_MS8607_Humidity : public Adafruit_Sensor {
public:
  Adafruit_MS8607_Humidity(Adafruit_MS8607 *parent) { _theMS8607 = parent; }

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

private:
  int _sensorID = 0x8602;
  Adafruit_MS8607 *_theMS8607 = NULL;
};

class Adafruit_MS8607 {
public:
  Adafruit_MS8607(void);
  ~Adafruit_MS8607(void);

  bool begin(TwoWire *wire = &Wire, int32_t sensor_id = 0);
  bool init(int32_t sensor_id);

  bool reset(void);

  ms8607_humidity_resolution_t getHumidityResolution(void);
  bool setHumidityResolution(ms8607_humidity_resolution_t res);

  ms8607_pressure_resolution_t getPressureResolution(void);
  bool setPressureResolution(ms8607_pressure_resolution_t res);

  bool enableHumidityClockStretching(bool enable_stretching);

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

protected:
  // uint16_t _sensorid_presure;     ///< ID number for pressure
  uint16_t _sensorid_temp;     
  uint16_t _sensorid_pressure; 
  uint16_t _sensorid_humidity; 

  Adafruit_I2CDevice *pt_i2c_dev = NULL; 
  Adafruit_I2CDevice *hum_i2c_dev =
      NULL; 

  Adafruit_MS8607_Temp *temp_sensor = NULL; 
  Adafruit_MS8607_Pressure *pressure_sensor =
      NULL; 
  Adafruit_MS8607_Humidity *humidity_sensor =
      NULL; 

private:
  bool _read(void);
  bool _read_humidity(void);
  bool _psensor_crc_check(uint16_t *n_prom, uint8_t crc);
  bool _hsensor_crc_check(uint16_t value, uint8_t crc);

  bool _fetch_temp_calibration_values(void);
  uint8_t _read_humidity_user_register(void);
  bool _write_humidity_user_register(uint8_t new_reg_value);

  friend class Adafruit_MS8607_Temp;     
  friend class Adafruit_MS8607_Pressure; 
  friend class Adafruit_MS8607_Humidity; 

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

  void _applyTemperatureCorrection(void);
  bool _applyPTCorrections(int32_t raw_temp, int32_t raw_pressure);

  float _pressure,  
      _temperature, 
      _humidity;    
  ms8607_pressure_resolution_t psensor_resolution_osr;
  uint16_t press_sens, press_offset, press_sens_temp_coeff,
      press_offset_temp_coeff, ref_temp,
      temp_temp_coeff; 
  ms8607_hum_clock_stretch_t
      _hum_sensor_i2c_read_mode; 
};
#endif
/*
       boolean humidityHasBeenRead = true;
       boolean pressureHasBeenRead = true;
       boolean temperatureHasBeenRead = true;
       bool hsensor_read_user_register(uint8_t *value);
       bool hsensor_write_user_register(uint8_t value);
       bool hsensor_reset(void);
       bool psensor_reset(void);

*/