mirror of
https://github.com/eclipse/upm.git
synced 2025-03-15 04:57:30 +03:00
rotaryencoder: Adding doxygen comments and image from seeed wiki
Signed-off-by: John Van Drasek <john.r.van.drasek@intel.com>
This commit is contained in:
parent
6a315f817d
commit
3b4e9da7c6
BIN
docs/images/rotaryencoder.jpg
Executable file
BIN
docs/images/rotaryencoder.jpg
Executable file
Binary file not shown.
After Width: | Height: | Size: 136 KiB |
@ -30,23 +30,37 @@
|
|||||||
|
|
||||||
namespace upm {
|
namespace upm {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief C++ API for the Grove Rotary Encoder
|
* @brief Grove Rotary Encoder library
|
||||||
*
|
* @defgroup rotaryencoder libupm-rotaryencoder
|
||||||
* UPM module for the Grove Rotary Encoder. A Rotary Encoder
|
* @ingroup seeed gpio other
|
||||||
* encodes a rotation signal into electronic pulses that can be used
|
*/
|
||||||
* to measure rotation and direction. It is useful in cases where a
|
/**
|
||||||
* rotary knob is required, but using a potentiometer is not
|
* @library libupm-rotaryencoder
|
||||||
* desireable. A rotary encoder can turn a full 360 degrees+
|
* @sensor rotaryencoder
|
||||||
* without a stop and does not place a resistive load on the
|
* @comname Grove Rotary Encoder
|
||||||
* circuit, as is the case with a potentiometer.
|
* @type other
|
||||||
*
|
* @man seeed
|
||||||
* This module maintains a position that is incremented or
|
* @web http://www.seeedstudio.com/wiki/Grove_-_Encoder
|
||||||
* decremented according to the rotation on the encoder.
|
* @con gpio
|
||||||
*
|
* @kit gsk
|
||||||
* @ingroup gpio
|
*
|
||||||
* @snippet rotaryencoder.cxx Interesting
|
* @brief C++ API for the Grove Rotary Encoder
|
||||||
*/
|
*
|
||||||
|
* UPM module for the Grove Rotary Encoder. A Rotary Encoder
|
||||||
|
* encodes a rotation signal into electronic pulses that can be used
|
||||||
|
* to measure rotation and direction. It is useful in cases where a
|
||||||
|
* rotary knob is required, but using a potentiometer is not
|
||||||
|
* desirable. A rotary encoder can turn a full 360 degrees+
|
||||||
|
* without a stop and does not place a resistive load on the
|
||||||
|
* circuit, as is the case with a potentiometer.
|
||||||
|
*
|
||||||
|
* This module maintains a position that is incremented or
|
||||||
|
* decremented according to the rotation on the encoder.
|
||||||
|
*
|
||||||
|
* @image html rotaryencoder.jpg
|
||||||
|
* @snippet rotaryencoder.cxx Interesting
|
||||||
|
*/
|
||||||
class RotaryEncoder {
|
class RotaryEncoder {
|
||||||
public:
|
public:
|
||||||
/**
|
/**
|
||||||
|
Loading…
x
Reference in New Issue
Block a user