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

docs: more header files edited

Browse Source 
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
VadimPopov
2015-08-09 22:51:25 +03:00
committed by Mihai Tudor Panu
parent 55e8076988
commit 04edb9be04
68 changed files with 1172 additions and 1172 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
src/groveehr/groveehr.h
View File

@ -30,7 +30,7 @@
namespace upm {
/**
* @brief Grove Ear-clip Heart Rate sensor library
* @brief Grove Ear-clip Heart Rate Sensor library
* @defgroup groveehr libupm-groveehr
* @ingroup seeed gpio medical
*/
@ -43,10 +43,10 @@ namespace upm {
* @man seeed
* @con gpio
*
* @brief API for the Grove Ear-clip Heart Rate sensor
* @brief API for the Grove Ear-clip Heart Rate Sensor
*
* UPM module for the GroveEHR sensor. It is used to measure your
* heartbeat.
* UPM module for the Grove ear-clip heart rate sensor. It is used to measure your
* heart rate.
*
* @image html groveehr.jpg
* @snippet groveehr.cxx Interesting
@ -56,63 +56,63 @@ namespace upm {
/**
* GroveEHR constructor
*
* @param pin digital pin to use
* @param pin Digital pin to use
*/
GroveEHR(int pin);
/**
* GroveEHR Destructor
* GroveEHR destructor
*/
~GroveEHR();
/**
* Return the number of milliseconds elapsed since initClock()
* Returns the time of milliseconds elapsed since initClock()
* was last called.
*
* @return elapsed milliseconds
* @return Elapsed milliseconds
*/
uint32_t getMillis();
/**
* Reset the Clock
* Resets the clock
*
*/
void initClock();
/**
* Reset the beat counter to 0. The beat Counter should be
* Resets the beat counter to 0. The beat counter should be
* stopped via stopBeatCounter() prior to calling this function.
*
*/
void clearBeatCounter();
/**
* Start the beat counter
* Starts the beat counter
*
*/
void startBeatCounter();
/**
* Stop the beat counter
* Stops the beat counter
*
*/
void stopBeatCounter();
/**
* Get the beat Counter
* Gets the beat Counter
*
* @return the beat counter
* @return Beat counter
*/
uint32_t beatCounter();
/**
* Beat Interrupt Service Routine
* Beat interrupt service routine (ISR)
*
*/
static void beatISR(void *ctx);
/**
* Compute the heart rate
* Computes the heart rate
*
* @return the computed heart rate
* @return Computed heart rate
*/
int heartRate();