mraa: add common hpp
* Wraps some of the C functions that libmraa has into the mraa namespace * Not included in swig bindings as of yet Signed-off-by: Thomas Ingleby <thomas.c.ingleby@intel.com>
This commit is contained in:
@@ -24,7 +24,7 @@
|
|||||||
|
|
||||||
#pragma once
|
#pragma once
|
||||||
|
|
||||||
#include "mraa/common.h"
|
#include "mraa/common.hpp"
|
||||||
#include "mraa/pwm.hpp"
|
#include "mraa/pwm.hpp"
|
||||||
#include "mraa/aio.hpp"
|
#include "mraa/aio.hpp"
|
||||||
#include "mraa/gpio.hpp"
|
#include "mraa/gpio.hpp"
|
||||||
|
|||||||
95
api/mraa/common.hpp
Normal file
95
api/mraa/common.hpp
Normal file
@@ -0,0 +1,95 @@
|
|||||||
|
/*
|
||||||
|
* Author: Thomas Ingleby <thomas.c.ingleby@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.
|
||||||
|
*/
|
||||||
|
|
||||||
|
#pragma once
|
||||||
|
|
||||||
|
#include "common.h"
|
||||||
|
#include <string>
|
||||||
|
|
||||||
|
namespace mraa {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief C++ API to common functions of MRAA
|
||||||
|
*
|
||||||
|
* This file defines the C++ interface for libmraa common functions
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get libmraa version.
|
||||||
|
*
|
||||||
|
* @return libmraa version (e.g. v0.4.0-20-gb408207)
|
||||||
|
*/
|
||||||
|
std::string getVersion()
|
||||||
|
{
|
||||||
|
std::string ret = mraa_get_version();
|
||||||
|
return ret;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This function attempts to set the mraa process to a given priority and the
|
||||||
|
* scheduler to SCHED_RR. Highest * priority is typically 99 and minimum is 0.
|
||||||
|
* This function * will set to MAX if * priority is > MAX. Function will return
|
||||||
|
* -1 on failure.
|
||||||
|
*
|
||||||
|
* @param priority Value from typically 0 to 99
|
||||||
|
* @return The priority value set
|
||||||
|
*/
|
||||||
|
int setPriority(const unsigned int priority)
|
||||||
|
{
|
||||||
|
return mraa_set_priority(priority);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get platform type, board must be initialised.
|
||||||
|
*
|
||||||
|
* @return mraa_platform_t Platform type enum
|
||||||
|
*/
|
||||||
|
mraa_platform_t getPlatformType()
|
||||||
|
{
|
||||||
|
return mraa_get_platform_type();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Print a textual representation of the mraa_result_t
|
||||||
|
*
|
||||||
|
* @param result the result to print
|
||||||
|
*/
|
||||||
|
void printError(mraa_result_t result)
|
||||||
|
{
|
||||||
|
mraa_result_print(result);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Checks if a pin is able to use the passed in mode.
|
||||||
|
*
|
||||||
|
* @param pin Physical Pin to be checked.
|
||||||
|
* @param mode the mode to be tested.
|
||||||
|
* @return boolean if the mode is supported, 0=false.
|
||||||
|
*/
|
||||||
|
bool pinModeTest(int pin, mraa_pinmodes_t mode)
|
||||||
|
{
|
||||||
|
return (bool) mraa_pin_mode_test(pin,mode);
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
Reference in New Issue
Block a user