tmp006.hpp

/*
 * Author: Norbert Wesp <nwesp@phytec.de>
 * Copyright (c) 2017 Phytec Messtechnik GmbH.
 *
 * based on: RIOT-driver tmp006 by Johann Fischer <j.fischer@phytec.de>
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

#pragma once

#include <string>
#include <mraa/i2c.hpp>
#include <math.h>

#define TMP006_NAME "TMP006"
#define TMP006_I2C_ADDRESS     0x41
#define TMP006_MANUFACTURER_ID 0x5449
#define TMP006_DEVICE_ID       0x0067

#define TMP007_I2C_ADDRESS     0x40
// this should actually be split
#define TMP007_DEVICE_ID       0x0078

#ifndef TMP006_CONVERSION_TIME
#define TMP006_CONVERSION_TIME 1E6 
#endif

/* TMP006 Register Map */
#define TMP006_SENSOR_VOLTAGE      0x00   /* Sensor voltage register */
#define TMP006_LOCAL_TEMPERATURE   0x01   /* Ambient temperature register */
#define TMP006_CONFIGURATION       0x02
#define TMP006_MANUFACTURER_ID_REG 0xFE
#define TMP006_DEVICE_ID_REG       0xFF

/* TMP007 Register Map */
#define TMP007_DEVICE_ID_REG       0x1F

/* TMP006 configuration register bitmap */
#define TMP006_RST_SOFT         (1 << 15)

#define TMP006_CONFIG_MOD_SHIFT 12
#define TMP006_CONFIG_MOD_MASK  0x7000
#define TMP006_CONFIG_MOD(x)    (((uint16_t)(((uint16_t)(x))<<\
                                TMP006_CONFIG_MOD_SHIFT))\
                                &TMP006_CONFIG_MOD_MASK)
#define TMP006_CONFIG_MOD_CC    0x07
#define TMP006_CONFIG_MOD_OFF   0x00

#define TMP006_CONFIG_CR_SHIFT  9
#define TMP006_CONFIG_CR_MASK   0x0E00
#define TMP006_CONFIG_CR(x)     (((uint16_t)(((uint16_t)(x))<<\
                                TMP006_CONFIG_CR_SHIFT))\
                                &TMP006_CONFIG_CR_MASK)
#define TMP006_CONFIG_CR_AS1  0x00 /* Conversion Time 0.25 s, AVG Samples: 1 */
#define TMP006_CONFIG_CR_AS2  0x01 /* Conversion Time 0.5 s, AVG Samples: 2 */
#define TMP006_CONFIG_CR_AS4  0x02 /* Conversion Time 1 s, AVG Samples: 4 */
#define TMP006_CONFIG_CR_AS8  0x03 /* Conversion Time 2 s, AVG Samples: 8 */
#define TMP006_CONFIG_CR_AS16 0x04 /* Conversion Time 4 s, AVG Samples: 16 */
#define TMP006_CONFIG_CR_DEF  TMP006_CONFIG_CR_AS4 
#define TMP006_DRDY_EN          (1 << 8)
#define TMP006_DRDY_DATA_RDY    (1 << 7)

/* constant values for data conversion */
#ifndef TMP006_CCONST_S0
#define TMP006_CCONST_S0       6.4E-14    /* Calibration Factor */
#endif

#define TMP006_CCONST_A1       1.75E-3   /* Constant \f$a_{\mathrm{1}}\f$ */
#define TMP006_CCONST_A2       -1.678E-5 /* Constant \f$a_{\mathrm{2}}\f$ */
#define TMP006_CCONST_TREF     298.15    /* Constant \f$T_{\mathrm{REF}}\f$ */
#define TMP006_CCONST_B0       -2.94E-5  /* Constant \f$b_{\mathrm{0}}\f$ */
#define TMP006_CCONST_B1       -5.7E-7   /* Constant \f$b_{\mathrm{1}}\f$ */
#define TMP006_CCONST_B2       4.63E-9   /* Constant \f$b_{\mathrm{2}}\f$ */
#define TMP006_CCONST_C2       13.4      /* Constant \f$c_{\mathrm{2}}\f$ */
#define TMP006_CCONST_LSB_SIZE 156.25E-9 /* Sensor Voltage Register LSB Size */

typedef enum {
    TMP006_SEN,
    TMP007_SEN } tmp_t;

namespace upm {

class TMP006 {
    public:
        TMP006 (int bus, uint8_t conv_rate=TMP006_CONFIG_CR_DEF,
                                  int devAddr=TMP006_I2C_ADDRESS);

        int checkID(void);

        void resetSensor(void);

        void setActive(void);

        void setStandby(void);

        int sampleData(void);

        void convert_data(int16_t rawv,int16_t rawt, float *tamb, float *tobj);

        float getTemperature(int bSampleData = 0);

        uint16_t getConfig(void);

    private:

        std::string m_name;

        int m_controlAddr;
        int m_bus;
        mraa::I2c m_i2ControlCtx;
        tmp_t sensorType;

        int32_t m_temperature;
};

}