mirror of
https://github.com/eclipse/upm.git
synced 2025-03-15 04:57:30 +03:00
rpr220: doxygen comments and adding image from seeed wiki
Signed-off-by: John Van Drasek <john.r.van.drasek@intel.com>
This commit is contained in:
parent
d70eef06ac
commit
6a315f817d
BIN
docs/images/rpr220.JPG
Executable file
BIN
docs/images/rpr220.JPG
Executable file
Binary file not shown.
After Width: | Height: | Size: 35 KiB |
@ -28,25 +28,38 @@
|
|||||||
|
|
||||||
namespace upm {
|
namespace upm {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief C++ API for the RPR220 based Grove IR Reflective Sensor.
|
* @brief RPR220 IR Reflective Sensor library
|
||||||
*
|
* @defgroup rpr220 libupm-rpr220
|
||||||
* UPM module for the Grove IR Reflective Sensor. The sensitivity
|
* @ingroup seeed gpio light
|
||||||
* can be adjusted with the potentiometer on the sensor module. It
|
*/
|
||||||
* has a range of approximately 15mm, and a fast response time.
|
/**
|
||||||
*
|
* @library libupm-rpr220
|
||||||
* It detects high contrast dark areas on a light background.
|
* @sensor rpr220
|
||||||
*
|
* @comname rpr220 IR reflective sensor
|
||||||
* This module allows the user to determine the current status
|
* @type light
|
||||||
* (black detected or not). Additionally, if desired, an Interrupt
|
* @man seeed
|
||||||
* Service Routine (ISR) can be installed that will be called when
|
* @web http://www.seeedstudio.com/wiki/Grove_-_Infrared_Reflective_Sensor
|
||||||
* black is detected. Either method can be used, depending on your
|
* @con gpio
|
||||||
* use case.
|
*
|
||||||
|
* @brief C++ API for the RPR220 based Grove IR Reflective Sensor
|
||||||
* @ingroup grove gpio
|
*
|
||||||
* @snippet rpr220.cxx Interesting
|
* UPM module for the Grove IR Reflective Sensor. The sensitivity
|
||||||
* @snippet rpr220-intr.cxx Interesting
|
* 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 {
|
class RPR220 {
|
||||||
public:
|
public:
|
||||||
/**
|
/**
|
||||||
|
Loading…
x
Reference in New Issue
Block a user