src/max31855/max31855.h

   1 /*
   2  * Author: Brendan Le Foll <brendan.le.foll@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/spi.h>
  28 #include <mraa/gpio.h>
  29
  30 namespace upm {
  31
  32 /**
  33  * @brief C++ API for MAX31855
  34  *
  35  * This file defines the max31855 SPI sensor
  36  *
  37  * @snippet examples/max31855.cxx Interesting
  38  *
  39  */
  40  //! [Interesting]
  41 class MAX31855 {
  42     public:
  43         /**
  44          * Instanciates a MAX31855 object
  45          *
  46          * @param bus The spi bus to use
  47          * @param cs The chip select pin
  48          */
  49         MAX31855(int bus, int cs);
  50
  51         /**
  52          * MAX31855 object destructor
  53          */
  54         ~MAX31855();
  55
  56         /**
  57          * Get the distance from the sensor
  58          *
  59          * @return value in degrees celcius
  60          */
  61         double getTemp();
  62
  63     private:
  64         mraa_spi_context m_sensor;
  65         mraa_gpio_context m_gpio;
  66 };
  67 //! [Interesting]
  68
  69 }