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

docs: updated @param tags, added missing function descriptions, other minor changes

Browse Source 
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
Mihai Tudor Panu
2017-04-10 16:59:39 -07:00
parent 39df7fd10f
commit 3aef2ea70e
94 changed files with 327 additions and 222 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
src/ad8232/ad8232.h
View File

@ -58,12 +58,28 @@ typedef struct _ad8232_context {
} *ad8232_context;
/**
* Sensor Init function
* Sensor init function
*
* @param lo_plus Digital pin to use for LO+
* @param lo_minus Digital pin to use for LO-
* @param output Analog pin to read the data
* @param a_ref Analog voltage reference
*/
ad8232_context ad8232_init(int lo_plus, int lo_minus, int output, float a_ref);
/**
* Sensor destructor
*/
void ad8232_close(ad8232_context dev);
/**
* Returns the current ADC value for the device output pin. If an
* LO (leads off) event is detected, 0 is returned.
*
* @param dev sensor context pointer
* @param value ADC value
* @return result status code
*/
upm_result_t ad8232_get_value(ad8232_context dev, int* value);
#endif /* AD8232_H_ */

1
src/ad8232/ad8232.hpp
View File

@ -80,6 +80,7 @@ namespace upm {
* @param loPlus Digital pin to use for LO+
* @param loMinus Digital pin to use for LO-
* @param output Analog pin to read the data
* @param aref Analog voltage reference
*/
AD8232(int loPlus, int loMinus, int output, float aref=AD8232_DEFAULT_AREF);