/* * Author: Jon Trulson * Abhishek Malik * Copyright (c) 2016 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. */ #ifndef A110X_A110X_H_ #define A110X_A110X_H_ #include #include #include #include "upm.h" #include "mraa/gpio.h" /** * @brief A110X Hall Effect library * @defgroup a110x libupm-a110x * @ingroup gpio electric robok */ /** * @library a110x * @sensor a110x * @comname A110X Hall Effect Sensor * @altname Grove Hall Sensor * @altid A1101, A1102, A1103, A1004, A1106 * @type electric * @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 */ /** * device context */ typedef struct _a110x_context { mraa_gpio_context gpio; uint8_t gpio_pin; bool isr_installed; } *a110x_context; /** * A110X Initialization function * * @param pin GPIO pin to use * @return device context pointer */ a110x_context a110x_init(uint8_t pin); /** * A110X Initialization function * * @param dev a110x_context pointer */ void a110x_close(a110x_context dev); /** * Determines whether a magnetic field of south polarity has been detected * * @param dev a110x_context pointer * @param bool* to note the response * @return upm_result_t UPM success/error code */ upm_result_t a110x_magnet_detected(a110x_context dev, bool* res); /** * Installs an interrupt service routine (ISR) to be called when * the appropriate magnetic field is detected * * @param dev a110x_context pointer * @param mraa_gpio_edge_t edge trigger level * @param isr ISR callback function * @return upm_result_t UPM success/error code */ upm_result_t a110x_install_isr(a110x_context dev, mraa_gpio_edge_t edge_level, void (*isr)(void *), void *arg); /** * Uninstalls the previously installed ISR * * @param dev a110x_context pointer * @return upm_result_t UPM success/error code */ upm_result_t a110x_uninstall_isr(a110x_context dev); #endif /* A110X_A110X_H_ */