mirror of
https://github.com/eclipse/upm.git
synced 2025-10-31 23:24:20 +03:00
922e0cc26b
To make room for UPM C and C++ sensor code to coexist, all UPM
C++ headers have been renamed from h -> hpp. This commit contains
updates to documentation, includes, cmake collateral, examples, and
swig interface files.
* Renamed all cxx/cpp header files which contain the string
'copyright intel' from .h -> .hpp (if not already hpp).
* Replaced all references to .h with .hpp in documentation,
source files, cmake collateral, example code, and swig interface
files.
* Replaced cmake variable module_h with module_hpp.
* Intentionally left upm.h since this file currently does not
contain code (documentation only).
Signed-off-by: Noel Eck <noel.eck@intel.com>
110 lines
3.3 KiB
C++
110 lines
3.3 KiB
C++
/*
|
|
* 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 A110X Hall Effect library
|
|
* @defgroup a110x libupm-a110x
|
|
* @ingroup seeed gpio electric robok
|
|
*/
|
|
|
|
/**
|
|
* @library a110x
|
|
* @sensor a110x
|
|
* @comname A110X Hall Effect Sensor
|
|
* @altname Grove Hall Sensor
|
|
* @altid A1101, A1102, A1103, A1004, A1106
|
|
* @type electric
|
|
* @man seeed
|
|
* @web http://www.allegromicro.com/en/Products/Magnetic-Digital-Position-Sensor-ICs/Hall-Effect-Unipolar-Switches/A1101-2-3-4-6.aspx
|
|
* @con gpio
|
|
* @kit robok
|
|
*
|
|
* @brief 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.
|
|
*
|
|
* @image html a110x.jpg
|
|
* An example showing a simple test for the presence of a field
|
|
* @snippet a110x.cxx Interesting
|
|
* An example demonstrating the use of an interrupt handler to count pulses
|
|
* @snippet a110x-intr.cxx Interesting
|
|
*/
|
|
class A110X {
|
|
public:
|
|
/**
|
|
* A110x digital sensor constructor
|
|
*
|
|
* @param pin Digital pin to use
|
|
*/
|
|
A110X(int pin);
|
|
/**
|
|
* A110X destructor
|
|
*/
|
|
~A110X();
|
|
/**
|
|
* Determines whether a magnetic field of south polarity has been detected
|
|
*
|
|
* @return True if magnetic field detected
|
|
*/
|
|
bool magnetDetected();
|
|
|
|
/**
|
|
* Installs an interrupt service routine (ISR) to be called when
|
|
* the appropriate magnetic field is detected
|
|
*
|
|
* @param fptr Pointer to a function to be called on interrupt
|
|
* @param arg Pointer to an object to be supplied as an
|
|
* argument to the ISR.
|
|
*/
|
|
#if defined(SWIGJAVA) || defined(JAVACALLBACK)
|
|
void installISR(jobject runnable);
|
|
#else
|
|
void installISR(void (*isr)(void *), void *arg);
|
|
#endif
|
|
/**
|
|
* Uninstalls the previously installed ISR
|
|
*
|
|
*/
|
|
void uninstallISR();
|
|
|
|
private:
|
|
#if defined(SWIGJAVA) || defined(JAVACALLBACK)
|
|
void installISR(void (*isr)(void *), void *arg);
|
|
#endif
|
|
|
|
bool m_isrInstalled;
|
|
mraa_gpio_context m_gpio;
|
|
};
|
|
}
|
|
|
|
|