a110x: Initial implementation

Signed-off-by: Jon Trulson <jtrulson@ics.com>
Signed-off-by: Sarah Knepper <sarah.knepper@intel.com>
This commit is contained in:
Jon Trulson
2014-12-10 16:17:15 -07:00
committed by Sarah Knepper
parent 02156d11c8
commit 0b7547231f
8 changed files with 259 additions and 0 deletions

5
src/a110x/CMakeLists.txt Normal file
View File

@ -0,0 +1,5 @@
set (libname "a110x")
set (libdescription "upm a110x sensor module")
set (module_src ${libname}.cxx)
set (module_h ${libname}.h)
upm_module_init()

54
src/a110x/a110x.cxx Normal file
View File

@ -0,0 +1,54 @@
/*
* Author: Jon Trulson <jtrulson@ics.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.
*/
#include <iostream>
#include "a110x.h"
using namespace upm;
using namespace std;
A110X::A110X(int pin)
{
mraa_init();
if ( !(m_gpio = mraa_gpio_init(pin)) )
{
cerr << __FUNCTION__ << ": mraa_gpio_init() failed" << endl;
return;
}
mraa_gpio_dir(m_gpio, MRAA_GPIO_IN);
}
A110X::~A110X()
{
mraa_gpio_close(m_gpio);
}
bool A110X::magnetDetected()
{
return (!mraa_gpio_read(m_gpio) ? true : false);
}

66
src/a110x/a110x.h Normal file
View File

@ -0,0 +1,66 @@
/*
* Author: Jon Trulson <jtrulson@ics.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 <string>
#include <mraa/gpio.h>
namespace upm {
/**
* @brief C++ API for the A110x Hall Effect sensors
*
* UPM module for the A110x (A1101, A1102, A1103, A1104, and A1106)
* Hall Effect sensors. It outputs a digital signal indicating
* whether it is detecting a magnetic field with south polarity
* perpendicular to the sensor element.
*
* @ingroup gpio
* @snippet a110x.cxx Interesting
*/
class A110X {
public:
/**
* A110x digital sensor constructor
*
* @param pin digital pin to use
*/
A110X(int pin);
/**
* A110X Destructor
*/
~A110X();
/**
* Determine whether a magnetic field of south polarity has been detected
*
* @return True if magnetic field detected
*/
bool magnetDetected();
private:
mraa_gpio_context m_gpio;
};
}

8
src/a110x/jsupm_a110x.i Normal file
View File

@ -0,0 +1,8 @@
%module jsupm_a110x
%include "../upm.i"
%{
#include "a110x.h"
%}
%include "a110x.h"

9
src/a110x/pyupm_a110x.i Normal file
View File

@ -0,0 +1,9 @@
%module pyupm_a110x
%include "../upm.i"
%feature("autodoc", "3");
%include "a110x.h"
%{
#include "a110x.h"
%}