mraa/api/mraa/aio.hpp

/*
 * Author: Brendan Le Foll <brendan.le.foll@intel.com>
 * Copyright (c) 2014 Intel Corporation.
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 * SPDX-License-Identifier: MIT
 */

#pragma once

#include <stdexcept>
#include "aio.h"
#include "types.hpp"

namespace mraa
{

/**
 * @brief API to Analog IO
 *
 * This file defines the aio interface for libmraa
 *
 * @snippet aio.cpp Interesting
 */
class Aio
{
  public:
    /**
     * Aio Constructor, takes a pin number which will map directly to the
     * board number
     *
     * @param pin channel number to read ADC inputs
     */
    Aio(int pin)
    {
        m_aio = mraa_aio_init(pin);
        if (m_aio == NULL) {
            throw std::invalid_argument("Invalid AIO pin specified - do you have an ADC?");
        }
    }
    /**
     * Aio Constructor, takes a pointer to the AIO context and initialises
     * the AIO class. Aio pins are always 0 indexed reguardless of their
     * position. Check your board mapping for details. An arduino style layout
     * will have A0 as pin14 but AIO0.
     *
     * @param aio_context void * to an AIO context
     */
    Aio(void* aio_context)
    {
        m_aio = (mraa_aio_context) aio_context;
        if (m_aio == NULL) {
            throw std::invalid_argument("Invalid AIO context");
        }
    }
    /**
     * Aio destructor
     */
    ~Aio()
    {
        if (m_aio != NULL) {
            mraa_aio_close(m_aio);
        }
    }
    /**
     * Closes AIO explicitly, prior to implicit closing on object destruction
     */
    void
    close()
    {
        mraa_aio_close(m_aio);
        m_aio = NULL;
    }
    /**
     * Read a value from the AIO pin. By default mraa will shift
     * the raw value up or down to a 10 bit value.
     *
     * @throws std::invalid_argument in case of error
     * @returns The current input voltage. By default, a 10bit value
     */
    unsigned int
    read()
    {
        int x = mraa_aio_read(m_aio);
	if (x == -1) {
            throw std::invalid_argument("Unknown error in Aio::read()");
        }
        return (unsigned int) x;
    }
    /**
     * Read a value from the AIO pin and return it as a normalized float.
     *
     * @throws std::invalid_argument in case of error
     * @returns The current input voltage as a normalized float (0.0f-1.0f)
     */
    float
    readFloat()
    {
        float x = mraa_aio_read_float(m_aio);
	if (x == -1.0f) {
            throw std::invalid_argument("Unknown error in Aio::readFloat()");
        }
        return x;
    }
    /**
     * Set the bit value which mraa will shift the raw reading
     * from the ADC to. I.e. 10bits
     * @param bits the bits the return from read should be i.e 10
     * @return mraa::Result type
     */
    Result
    setBit(int bits)
    {
        return (Result) mraa_aio_set_bit(m_aio, bits);
    }
    /**
     * Gets the bit value mraa is shifting the analog read to.
     *
     * @return bit value mraa is set return from the read function
     */
    int
    getBit()
    {
        return mraa_aio_get_bit(m_aio);
    }

  private:
    mraa_aio_context m_aio;
};
}