Adafruit_TMP117.h

Go to the documentation of this file.

// "requires_busio": "y",
//   "requires_sensor": "y",
#ifndef _ADAFRUIT_TMP117_H
#define _ADAFRUIT_TMP117_H

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

#define TMP117_I2CADDR_DEFAULT 0x48 
#define TMP117_CHIP_ID 0x0117       

#define TMP117_WHOAMI 0x0F  
#define _CONFIGURATION 0x01 

#define TMP117_TEMP_DATA 0x00     
#define TMP117_CONFIGURATION 0x01 
#define TMP117_T_HIGH_LIMIT 0x02  
#define TMP117_T_LOW_LIMIT 0x03   
#define TMP117_TEMP_OFFSET 0x07   
#define TMP117_DEVICE_ID 0x0F     
#define WHOAMI_ANSWER 0x0117      

#define HIGH_ALRT_FLAG 0b100 
#define LOW_ALRT_FLAG 0b010  
#define DRDY_ALRT_FLAG 0b001 

#define TMP117_RESOLUTION                                                      \
  0.0078125f 

// #define TMP117_EEPROM_UL 0x04
// #define TMP117_EEPROM1 0x05
// #define TMP117_EEPROM2 0x06
// #define TMP117_EEPROM3 0x08


typedef enum {
  TMP117_RATE_ONE_SHOT,
} tmp117_rate_t;

typedef struct {
  bool high;       
  bool low;        
  bool data_ready; 
} tmp117_alerts_t;

typedef enum {
  TMP117_AVERAGE_1X,
  TMP117_AVERAGE_8X,
  TMP117_AVERAGE_32X,
  TMP117_AVERAGE_64X,
} tmp117_average_count_t;

typedef enum {
  TMP117_DELAY_0_MS,
  TMP117_DELAY_125_MS,
  TMP117_DELAY_250_MS,
  TMP117_DELAY_500_MS,
  TMP117_DELAY_1000_MS,
  TMP117_DELAY_4000_MS,
  TMP117_DELAY_8000_MS,
  TMP117_DELAY_16000_MS,
} tmp117_delay_t;

typedef enum {
  TMP117_MODE_CONTINUOUS,
  TMP117_MODE_SHUTDOWN,
  TMP117_MODE_ONE_SHOT = 3, // skipping 0x2 which is a duplicate CONTINUOUS
} tmp117_mode_t;

class Adafruit_TMP117 {
public:
  Adafruit_TMP117();
  ~Adafruit_TMP117();

  bool begin(uint8_t i2c_addr = TMP117_I2CADDR_DEFAULT, TwoWire *wire = &Wire,
             int32_t sensor_id = 117);
  void reset(void);
  void interruptsActiveLow(bool active_low);
  bool interruptsActiveLow(void);

  bool getEvent(sensors_event_t *temp);
  bool getAlerts(tmp117_alerts_t *alerts);

  bool thermAlertModeEnabled(bool therm_enabled);
  bool thermAlertModeEnabled(void);

  tmp117_average_count_t getAveragedSampleCount(void);
  bool setAveragedSampleCount(tmp117_average_count_t count);

  float getOffset(void);
  bool setOffset(float offset);

  float getLowThreshold(void);
  bool setLowThreshold(float low_threshold);

  float getHighThreshold(void);
  bool setHighThreshold(float high_threshold);

  tmp117_delay_t getReadDelay(void);
  bool setReadDelay(tmp117_delay_t delay);

  tmp117_mode_t getMeasurementMode(void);
  bool setMeasurementMode(tmp117_mode_t mode);

private:
  // void _read(void);
  bool _init(int32_t sensor_id);
  uint16_t _sensorid_temp; 

  tmp117_alerts_t
      alert_drdy_flags; 
  float unscaled_temp;  

  Adafruit_I2CDevice *i2c_dev = NULL; 
  Adafruit_BusIO_Register *config_reg =
      NULL; 
  Adafruit_BusIO_Register *temp_reg =
      NULL; 

  void readAlertsDRDY(void);
  bool getDataReady(void);
  void waitForData(void);
};

#endif