HDC2080.h

Go to the documentation of this file.

/*
        HDC2080.h
        HDC2010.h originally created by: Brandon Fisher, August 1st 2017
 
        This code is release AS-IS into the public domain, no guarantee or warranty is given.
 
        Description: This header file accompanies HDC2080.cpp, and declares all methods, fields,
        and constants used in the source code.
*/
 
#ifndef HDC2080_h
#define HDC2080_h
#include <stdint.h>
#include <stdio.h>
//  Constants for setting measurement resolution
#define FOURTEEN_BIT 0
#define ELEVEN_BIT 1
#define NINE_BIT 2
 
//  Constants for setting sensor mode
#define TEMP_AND_HUMID 0
#define TEMP_ONLY 1
#define HUMID_ONLY 2
#define ACTIVE_LOW 0
#define ACTIVE_HIGH 1
#define LEVEL_MODE 0
#define COMPARATOR_MODE 1
 
//  Constants for setting sample rate
#define MANUAL 0
#define TWO_MINS 1
#define ONE_MINS 2
#define TEN_SECONDS 3
#define FIVE_SECONDS 4
#define ONE_HZ 5
#define TWO_HZ 6
#define FIVE_HZ 7
#define HDC_ADDRESS 0x40
 
#define MAN_ID 0x5449
#define DEV_ID 0x07D0
#define DRDY_STATUS 0x80
#define TH_STATUS 0x40
#define TL_STATUS 0x20
#define HH_STATUS 0x10
#define HL_STATUS 0x08
#define TH_ENABLE 0x40
#define TL_ENABLE 0x20
#define HH_ENABLE 0x10
#define HL_ENABLE 0x08
 
// Define Register Map
#define TEMP_LOW 0x00
#define TEMP_HIGH 0x01
#define HUMID_LOW 0x02
#define HUMID_HIGH 0x03
#define INTERRUPT_DRDY 0x04
#define TEMP_MAX 0x05
#define HUMID_MAX 0x06
#define INTERRUPT_CONFIG 0x07
#define TEMP_OFFSET_ADJUST 0x08
#define HUM_OFFSET_ADJUST 0x09
#define TEMP_THR_L 0x0A
#define TEMP_THR_H 0x0B
#define HUMID_THR_L 0x0C
#define HUMID_THR_H 0x0D
#define HDC_CONFIG 0x0E
#define MEASUREMENT_CONFIG 0x0F
#define MID_L 0xFC
#define MID_H 0xFD
#define DEVICE_ID_L 0xFE
#define DEVICE_ID_H 0xFF
 
int initHDC2080(void);
 
float readTemp(void);                     // Returns the temperature in degrees C
uint8_t readTempOffsetAdjust(void);       // Returns the offset adjust in binary
uint8_t setTempOffsetAdjust(uint8_t);     // Set and return the offset adjust in binary
float readHumidity(void);                 // Returns the relative humidity
uint8_t readHumidityOffsetAdjust(void);   // Returns the offset adjust in binary
uint8_t setHumidityOffsetAdjust(uint8_t); // Set and return the offset adjust in binary
void enableHeater(void);                  // Enables the heating element
void disableHeater(void);                 // Disables the heating element
void setLowTemp(float temp);              // Sets low threshold temperature (in c)
void setHighTemp(float temp);             // Sets high threshold temperature (in c)
void setHighHumidity(float humid);        // Sets high Humiditiy threshold
void setLowHumidity(float humid);         // Sets low Humidity threshold
float readLowHumidityThreshold(void);     // Returns contents of low humidity threshold register
float readHighHumidityThreshold(void);    // Returns contents of high humidity threshold register
float readLowTempThreshold(void);         // Returns contents of low temperature threshold register (in C)
float readHighTempThreshold(void);        // Returns contents of high temperature threshold register (in C)
void triggerMeasurement(void);            // Triggers a manual temperature/humidity reading
void reset(void);                         // Triggers a software reset
void enableInterrupt(void);               // Enables the interrupt/DRDY pin
void disableInterrupt(void);              // Disables the interrupt/DRDY pin (High Z)
uint8_t readInterruptStatus(void);        // Reads the status of the interrupt register
void clearMaxTemp(void);                  // Clears the Maximum temperature register
void clearMaxHumidity(void);              // Clears the Maximum humidity register
float readMaxTemp(void);                  // Reads the maximum temperature register
float readMaxHumidity(void);              // Reads the maximum humidity register
void enableThresholdInterrupt(void);      // Enables high and low temperature/humidity interrupts
void disableThresholdInterrupt(void);     // Disables high and low temperature/humidity interrupts
void enableDRDYInterrupt(void);           // Enables data ready interrupt
void disableDRDYInterrupt(void);          // Disables data ready interrupt
 
/* Sets Temperature & Humidity Resolution, 3 options
           0 - 14 bit
           1 - 11 bit
           2 - 9 bit
           default - 14 bit                         */
void setTempRes(int resolution);
void setHumidRes(int resolution);
 
/* Sets measurement mode, 3 options
                   0 - Temperature and Humidity
                   1 - Temperature only
                   2 - Humidity only
                   default - Temperature & Humidity         */
void setMeasurementMode(int mode);
 
/* Sets reading rate, 8 options
                   0 - Manual
                   1 - reading every 2 minutes
                   2 - reading every minute
                   3 - reading every ten seconds
                   4 - reading every 5 seconds
                   5 - reading every second
                   6 - reading at 2Hz
                   7 - reading at 5Hz
                   default - Manual     */
void setRate(int rate);
 
/* Sets Interrupt polarity, 2 options
                   0 - Active Low
                   1 - Active High
                   default - Active Low         */
void setInterruptPolarity(int polarity);
 
/* Sets Interrupt mode, 2 options
                   0 - Level sensitive
                   1 - Comparator mode
                   default - Level sensitive    */
void setInterruptMode(int polarity);
 
// private:
uint8_t readReg(uint8_t reg, uint8_t *data, uint8_t count);  // Reads bytes starting at reg, returns TRUE if passed
uint8_t writeReg(uint8_t reg, uint8_t *data, uint8_t count); // Writes bytes starting at reg, returns TRUE if passed
float readTemp(void);
//};
//
#endif