api/mraa/aio.hpp

   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
  25 #pragma once
  26
  27 #include <stdexcept>
  28 #include "aio.h"
  29
  30 namespace mraa {
  31
  32 /**
  33  * @brief API to Analog IO
  34  *
  35  * This file defines the aio interface for libmraa
  36  *
  37  * @snippet examples/c++/AioA0.cpp Interesting
  38  */
  39 class Aio {
  40     public:
  41         /**
  42          * Aio Constructor, takes a pin number which will map directly to the
  43          * board number
  44          *
  45          * @param pin channel number to read ADC inputs
  46          */
  47         Aio(unsigned int pin) {
  48             m_aio = mraa_aio_init(pin);
  49             if (m_aio == NULL) {
  50                 throw std::invalid_argument("Invalid AIO pin specified - do you have an ADC?");
  51             }
  52         }
  53         /**
  54          * Aio destructor
  55          */
  56         ~Aio() {
  57             mraa_aio_close(m_aio);
  58         }
  59         /**
  60          * Read a value from the AIO pin. By default mraa will shift
  61          * the raw value up or down to a 10 bit value.
  62          *
  63          * @returns The current input voltage. By default, a 10bit value
  64          */
  65         int read() {
  66             return mraa_aio_read(m_aio);
  67         }
  68         /**
  69          * Read a value from the AIO pin and return it as a normalized float.
  70          *
  71          * @returns The current input voltage as a normalized float (0.0f-1.0f)
  72          */
  73         float readFloat() {
  74             return mraa_aio_read_float(m_aio);
  75         }
  76         /**
  77          * Set the bit value which mraa will shift the raw reading
  78          * from the ADC to. I.e. 10bits
  79          * @param bits the bits the return from read should be i.e 10
  80          * @return mraa result type
  81          */
  82         mraa_result_t setBit(int bits) {
  83             return mraa_aio_set_bit(m_aio, bits);
  84         }
  85         /**
  86          * Gets the bit value mraa is shifting the analog read to.
  87          *
  88          * @return bit value mraa is set return from the read function
  89          */
  90         int getBit() {
  91             return mraa_aio_get_bit(m_aio);
  92         }
  93
  94     private:
  95         mraa_aio_context m_aio;
  96 };
  97
  98 }