alexey.zholtikov/upm
1
0
Fork 0
mirror of https://github.com/eclipse/upm.git synced 2025-03-15 04:57:30 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

a110x: updated header with new tags

Browse Source 
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
Mihai Tudor Panu 2015-03-20 15:53:25 -07:00
parent ec067857c5
commit 2203d0b906
1 changed files with 16 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
src/a110x/a110x.h
View File

@ -27,16 +27,29 @@
#include <mraa/gpio.h>
namespace upm {
/**
* @brief A110X Hall Effect library
* @defgroup a110x libupm-a110x
* @ingroup seeed gpio electric
*/
/**
* @brief C++ API for the A110x Hall Effect sensors
* @library a110x
* @sensor a110x
* @comname A110X Hall Effect Sensor
* @altname 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
*
* UPM module for the A110x (A1101, A1102, A1103, A1104, and A1106)
* @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 {