src/max5487/max5487.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 MAX5487 chip (Temperature sensor)
  38  *
  39  * This file defines the MAX5487 C++ interface for libmax5487
  40  *
  41  */
  42 class MAX5487 {
  43     public:
  44         static const uint8_t R_WR_WIPER_A   = 0x01;
  45         static const uint8_t R_WR_WIPER_B   = 0x02;
  46
  47         /**
  48          * Instanciates a MAX5487 object
  49          *
  50          * @param bus number of used bus
  51          * @param devAddr addres of used i2c device
  52          */
  53         MAX5487 (int csn);
  54
  55         /**
  56          * MAX5487 object destructor, basicaly it close SPI connection and GPIO.
  57          */
  58         ~MAX5487 ();
  59
  60         /**
  61          * Set wiper for port A.
  62          */
  63         void setWiperA (uint8_t wiper);
  64
  65         /**
  66          * Set wiper for port B.
  67          */
  68         void setWiperB (uint8_t wiper);
  69
  70         /**
  71          * Return name of the component
  72          */
  73         std::string name()
  74         {
  75             return m_name;
  76         }
  77     private:
  78         std::string m_name;
  79         mraa_spi_context        m_spi;
  80         mraa_gpio_context       m_csnPinCtx;
  81
  82         /**
  83          * Set chip select pin LOW
  84          */
  85         mraa_result_t CSOn ();
  86
  87         /**
  88          * Set chip select pin HIGH
  89          */
  90         mraa_result_t CSOff ();
  91 };
  92
  93 }