alexey.zholtikov/upm
1
0
Fork 0
mirror of https://github.com/eclipse/upm.git synced 2025-07-02 09:51:14 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: final batch of header files reviewed

Browse Source 
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
VadimPopov
2015-08-10 18:53:31 +03:00
committed by Mihai Tudor Panu
parent 04edb9be04
commit 1fe9b9eb1d
53 changed files with 1182 additions and 1191 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
src/rotaryencoder/rotaryencoder.h
View File

@ -47,11 +47,11 @@ namespace upm {
*
* @brief API for the Grove Rotary Encoder
*
* UPM module for the Grove Rotary Encoder. A Rotary Encoder
* UPM module for the Grove rotary encoder. This 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
* 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+
* 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.
*
@ -66,32 +66,32 @@ namespace upm {
/**
* RotaryEncoder constructor
*
* @param pinA digital pin to use for signal A
* @param pinB digital pin to use for signal B
* @param pinA Digital pin to use for signal A
* @param pinB Digital pin to use for signal B
*/
RotaryEncoder(int pinA, int pinB);
/**
* RotaryEncoder Destructor
* RotaryEncoder destructor
*/
~RotaryEncoder();
/**
* Reset the position to a given number, default is 0.
* Resets the position to a given number; default is 0.
*
* @param count integer to initialize the position to
* @param count Integer to initialize the position to
*/
void initPosition(int count=0);
/**
* Get the position value
* Gets the position value
*
*/
int position();
/**
* ISR for signal A
* Interrupt service routine (ISR) for signal A
*
* @param ctx user context for the ISR (*this pointer)
* @param ctx User context for the ISR (*this pointer)
*/
static void signalAISR(void *ctx);