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

6
src/ads1x15/ads1015.hpp
View File

@ -120,8 +120,8 @@ namespace upm {
* to set gain so it matches full scale value of input
*
* @param bus i2c bus the sensor is attached to.
* @param address. Optional device address. Default is 0x48.
* @param vref. Optional reference (i.e. half full swing) voltage. Default is 2.048V
* @param address Optional device address. Default is 0x48.
* @param vref Optional reference (i.e. half full swing) voltage. Default is 2.048V
*/
ADS1015 (int bus, uint8_t address = 0x48, float vref = ADS1015_VREF);
@ -135,7 +135,7 @@ namespace upm {
* needs to be overridden in subclasses as the ADS1115 and
* ADS1015 have different sample rates.
*
* @param ADSSAMPLERATE enum
* @param rate ADSSAMPLERATE enum
*/
void setSPS(ADSSAMPLERATE rate = SPS_1600);

4
src/ads1x15/ads1115.hpp
View File

@ -119,7 +119,7 @@ namespace upm {
* ADS1X15 constructor
*
* @param bus i2c bus the sensor is attached to.
* @param address. Device address. Default is 0x48.
* @param address Device address. Default is 0x48.
*/
ADS1115 (int bus, uint8_t address = 0x48);
@ -133,7 +133,7 @@ namespace upm {
* needs to be overridden in subclasses as the ADS1115 and
* ADS1015 have different sample rates.
*
* @param ADSSAMPLERATE enum
* @param rate ADSSAMPLERATE enum
*/
void setSPS(ADSDATARATE rate = ADS1115::SPS_128);

2
src/ads1x15/ads1x15.hpp
View File

@ -212,7 +212,7 @@ namespace upm {
* ADS1X15 constructor
*
* @param bus i2c bus the sensor is attached to.
* @param address. Device address. Default is 0x48.
* @param address Device address. Default is 0x48.
*/
ADS1X15(int bus, uint8_t address);