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: 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

20
src/ppd42ns/ppd42ns.h
View File

@ -37,7 +37,7 @@ typedef struct
} dustData;
/**
* @brief PPD42NS dust sensor library
* @brief PPD42NS Dust Sensor library
* @defgroup ppd42ns libupm-ppd42ns
* @ingroup seeed gpio other eak
*/
@ -52,9 +52,9 @@ typedef struct
* @con gpio
* @kit eak
*
* @brief API for the Dust Sensor
* @brief API for the PPD42NS Dust Sensor
*
* UPM module for the Dust Sensor
* UPM module for the PPD42NS dust sensor
*
* @image html ppd42ns.jpg
* @snippet ppd42ns.cxx Interesting
@ -62,28 +62,28 @@ typedef struct
class PPD42NS {
public:
/**
* Dust Sensor Constructor
* PPD42NS constructor
*
* @param pin digital pin to use
* @param pin Digital pin to use
*/
PPD42NS(int pin);
/**
* Dust Sensor Destructor
* PPD42NS destructor
*/
~PPD42NS();
/**
* Print dust concentration
* Prints dust concentration
*
* @return struct dustData contains data from dust sensor
* @return struct dustData Contains data from the dust sensor
*/
dustData getData();
private:
mraa_gpio_context m_gpio;
/**
* Return the amount of time it takes a pin to go from HIGH to LOW or LOW to HIGH
* Returns the amount of time it takes a pin to go from HIGH to LOW or from LOW to HIGH
*
* @param highLowValue int do we measure from HIGH to LOW or LOW to HIGH. highLowValue is "from" value
* @param highLowValue int Do we measure movements from HIGH to LOW or from LOW to HIGH? highLowValue is the "from" value
*/
double pulseIn_polyfill(bool highLowValue, double endTime);
double m_timediff(timespec time1, timespec time2);