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

rpr220: doxygen comments and adding image from seeed wiki

Browse Source 
Signed-off-by: John Van Drasek <john.r.van.drasek@intel.com>
This commit is contained in:
John Van Drasek 2015-04-14 11:52:38 -07:00
parent d70eef06ac
commit 6a315f817d
2 changed files with 32 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
docs/images/rpr220.JPG Executable file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 35 KiB

51
src/rpr220/rpr220.h
View File

@ -28,25 +28,38 @@
namespace upm {
/**
* @brief C++ API for the RPR220 based Grove IR Reflective Sensor.
*
* UPM module for the Grove IR Reflective Sensor. The sensitivity
* can be adjusted with the potentiometer on the sensor module. It
* has a range of approximately 15mm, and a fast response time.
*
* It detects high contrast dark areas on a light background.
*
* This module allows the user to determine the current status
* (black detected or not). Additionally, if desired, an Interrupt
* Service Routine (ISR) can be installed that will be called when
* black is detected. Either method can be used, depending on your
* use case.
* @ingroup grove gpio
* @snippet rpr220.cxx Interesting
* @snippet rpr220-intr.cxx Interesting
*/
/**
* @brief RPR220 IR Reflective Sensor library
* @defgroup rpr220 libupm-rpr220
* @ingroup seeed gpio light
*/
/**
* @library libupm-rpr220
* @sensor rpr220
* @comname rpr220 IR reflective sensor
* @type light
* @man seeed
* @web http://www.seeedstudio.com/wiki/Grove_-_Infrared_Reflective_Sensor
* @con gpio
*
* @brief C++ API for the RPR220 based Grove IR Reflective Sensor
*
* UPM module for the Grove IR Reflective Sensor. The sensitivity
* can be adjusted with the potentiometer on the sensor module. It
* has a range of approximately 15mm, and a fast response time.
*
* It detects high contrast dark areas on a light background.
*
* This module allows the user to determine the current status
* (black detected or not). Additionally, if desired, an Interrupt
* Service Routine (ISR) can be installed that will be called when
* black is detected. Either method can be used, depending on your
* use case.
*
* @image html rpr220.jpeg
* @snippet rpr220.cxx Interesting
* @snippet rpr220-intr.cxx Interesting
*/
class RPR220 {
public:
/**