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  * This file defines the MAX31723 C++ interface for libmax31723
  40  *
  41  */
  42 class MAX31723 {
  43     public:
  44         static const uint8_t R_STS_READ_CMD     = 0x00;
  45         static const uint8_t R_STS_WRITE_CMD    = 0x80;
  46         static const uint8_t R_TEMPERATURE_LSB  = 0x01;
  47         static const uint8_t R_TEMPERATURE_MSB  = 0x02;
  48
  49         static const uint8_t B_CONT_READING     = 0x00;
  50
  51         /**
  52          * Instanciates a MAX31723 object
  53          *
  54          * @param bus number of used bus
  55          * @param devAddr addres of used i2c device
  56          */
  57         MAX31723 (int csn);
  58
  59         /**
  60          * MAXDS3231M object destructor, basicaly it close i2c connection.
  61          */
  62         ~MAX31723 ();
  63
  64         /**
  65          * Get on board temperature.
  66          */
  67         short getTemperature ();
  68
  69         /**
  70          * Return name of the component
  71          */
  72         std::string name()
  73         {
  74             return m_name;
  75         }
  76     private:
  77         std::string m_name;
  78         mraa_spi_context        m_spi;
  79         mraa_gpio_context       m_csnPinCtx;
  80
  81         uint8_t readRegister (uint8_t reg);
  82         void writeRegister (uint8_t reg, uint8_t data);
  83
  84         /**
  85          * Set chip select pin LOW
  86          */
  87         mraa_result_t CSOn ();
  88
  89         /**
  90          * Set chip select pin HIGH
  91          */
  92         mraa_result_t CSOff ();
  93 };
  94
  95 }