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 MAX31855 Thermocouple library
34  * @defgroup max31855 libupm-max31855
35  * @ingroup maxim adafruit spi other
36  */
37 /**
38  * @library max31855
39  * @sensor max31855
40  * @comname MAX31855 Thermocouple Amplifier
41  * @type other
42  * @man maxim adafruit
43  * @con spi
44  *
45  * @brief API for the MAX31855 Thermocouple Amplifier
46  *
47  * Maxim Integrated*
48  * [MAX31855](http://datasheets.maximintegrated.com/en/ds/MAX31855.pdf)
49  * is a cold-junction compensated thermocouple-to-digital converter. This
50  * module was tested on the Maxim Integrated
51  * [MAX31855PMB1 PMOD module]
52  * (http://datasheets.maximintegrated.com/en/ds/MAX31855PMB1.pdf) from the
53  * analog PMOD kit.
54  *
55  * @image html max31855.jpg
56  * @snippet max31855.cxx Interesting
57  */
58 class MAX31855 {
59     public:
60         /**
61          * Instantiates an MAX31855 object
62          *
63          * @param bus SPI bus to use
64          * @param cs Chip select pin
65          */
66         MAX31855(int bus, int cs);
67 
68         /**
69          * MAX31855 object destructor
70          */
71         ~MAX31855();
72 
73         /**
74          * Gets the distance from the sensor
75          *
76          * @return Value in Celsius
77          */
78 //! [Interesting]
79         double getTemp();
80 //! [Interesting]
81 
82     private:
83         mraa_spi_context m_sensor;
84         mraa_gpio_context m_gpio;
85 };
86 
87 }
88