src/max31723/max31723.h

   1 /*
   2  * Author: Yevgeniy Kiveisha <yevgeniy.kiveisha@intel.com>
   3  * Copyright (c) 2014 Intel Corporation.
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining
   6  * a copy of this software and associated documentation files (the
   7  * "Software"), to deal in the Software without restriction, including
   8  * without limitation the rights to use, copy, modify, merge, publish,
   9  * distribute, sublicense, and/or sell copies of the Software, and to
  10  * permit persons to whom the Software is furnished to do so, subject to
  11  * the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be
  14  * included in all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  19  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  20  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  21  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  22  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  23  */
  24 #pragma once
  25
  26 #include <string>
  27 #include <mraa/aio.h>
  28 #include <mraa/gpio.h>
  29 #include <mraa/spi.h>
  30
  31 #define HIGH                    1
  32 #define LOW                     0
  33
  34 namespace upm {
  35
  36 /**
  37  * @brief C++ API for MAX31723 chip (Temperature sensor)
  38  *
  39  * The Maxim Integrated
  40  * [MAX31723](http://datasheets.maximintegrated.com/en/ds/MAX31722-MAX31723.pdf)
  41  * is a Low-Voltage 3-Wire/SPI Temperature Sensor controller. This module was
  42  * tested on the Maxim Integrated [MAX31732PMB1 PMOD
  43  * module](http://datasheets.maximintegrated.com/en/ds/MAX31723PMB1.pdf) from
  44  * the analog PMOD kit.
  45  *
  46  * @image html max31723.jpeg
  47  *
  48  */
  49 class MAX31723 {
  50     public:
  51         static const uint8_t R_STS_READ_CMD     = 0x00;
  52         static const uint8_t R_STS_WRITE_CMD    = 0x80;
  53         static const uint8_t R_TEMPERATURE_LSB  = 0x01;
  54         static const uint8_t R_TEMPERATURE_MSB  = 0x02;
  55
  56         static const uint8_t B_CONT_READING     = 0x00;
  57
  58         /**
  59          * Instanciates a MAX31723 object
  60          *
  61          * @param bus number of used bus
  62          * @param devAddr addres of used i2c device
  63          */
  64         MAX31723 (int csn);
  65
  66         /**
  67          * MAXDS3231M object destructor, basicaly it close i2c connection.
  68          */
  69         ~MAX31723 ();
  70
  71         /**
  72          * Get on board temperature.
  73          */
  74         short getTemperature ();
  75
  76         /**
  77          * Return name of the component
  78          */
  79         std::string name()
  80         {
  81             return m_name;
  82         }
  83     private:
  84         std::string m_name;
  85         mraa_spi_context        m_spi;
  86         mraa_gpio_context       m_csnPinCtx;
  87
  88         uint8_t readRegister (uint8_t reg);
  89         void writeRegister (uint8_t reg, uint8_t data);
  90
  91         /**
  92          * Set chip select pin LOW
  93          */
  94         mraa_result_t CSOn ();
  95
  96         /**
  97          * Set chip select pin HIGH
  98          */
  99         mraa_result_t CSOff ();
 100 };
 101
 102 }