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 "aio.h"
  28
  29 namespace mraa {
  30
  31 /**
  32  * @brief C++ API to Analog IO
  33  *
  34  * This file defines the aio C++ interface for libmraa
  35  *
  36  * @snippet examples/c++/AioA0.cpp Interesting
  37  */
  38 class Aio {
  39     public:
  40         /**
  41          * Aio Constructor, takes a pin number which will map directly to the
  42          * board number
  43          *
  44          * @param pin channel number to read ADC inputs
  45          */
  46         Aio(unsigned int pin) {
  47             m_aio = mraa_aio_init(pin);
  48         }
  49         /**
  50          * Aio destructor
  51          */
  52         ~Aio() {
  53             mraa_aio_close(m_aio);
  54         }
  55         /**
  56          * Read a value from the AIO pin. Note this value can never be outside
  57          * of the bounds of an unsigned short
  58          *
  59          * @returns The current input voltage, normalised to a 16-bit value
  60          */
  61         int read() {
  62             // Use basic types to make swig code generation simpler
  63             return (int) mraa_aio_read(m_aio);
  64         }
  65     private:
  66         mraa_aio_context m_aio;
  67 };
  68
  69 }