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

20
src/temperature/temperature.h
View File

@ -48,12 +48,28 @@ typedef struct _temperature_context {
int16_t m_aRes;
} *temperature_context;
/**
* Analog temperature sensor initialization function
*
* @param pin analog pin to use
* @return sensor context
*/
temperature_context temperature_init(int pin);
/**
* Analog temperature sensor destructor
*
* @param dev sensor context pointer
*/
void temperature_close(temperature_context dev);
// Celsius
/**
* Gets the temperature in Celsius from the sensor
*
* @param dev sensor context pointer
* @param tempval temperature value in Celsius
* @return result of the operation
*/
upm_result_t temperature_get_value(temperature_context dev,
float* tempval);

20
src/temperature/temperature.hpp
View File

@ -46,14 +46,14 @@ namespace upm {
* @con analog
* @kit gsk
*
* @brief API for the Grove Temperature Sensor
* @brief API for NTC Temperature Sensors
*
* Basic UPM module for the Grove temperature sensor on analog. This sensor
* uses a NTC thermistor to measure ambient temperature. The conversion formula
* has been updated to work with versions 1.1 and 1.2 of the sensor. For the
* older v1.0 sensor you will have to specify R0 and B values when initializing
* the device. The range of this sensor is -40 to 125 C and accuracy is +/- 1.5
* C.
* Basic UPM module for analog temperature sensors. These sensors use a NTC
* thermistor to measure ambient temperature. This driver was developed using
* the Grove Temperature Sensor. The conversion formula has been updated
* to work with versions 1.1 and 1.2 of the sensor. For the older v1.0
* sensor you will have to specify R0 and B values when initializing the
* device. The range of this sensor is -40 to 125 C and accuracy is +/- 1.5 C.
*
* @image html temp.jpg
* @snippet temperature.cxx Interesting
@ -61,7 +61,7 @@ namespace upm {
class Temperature {
public:
/**
* Grove analog temperature sensor constructor
* Analog temperature sensor constructor
*
* @param pin Analog pin to use
* @param scale Scaling factor for raw analog value from the ADC,
@ -73,7 +73,7 @@ class Temperature {
*/
Temperature(unsigned int pin, float scale = 1.0, int r0 = 100000, int b = 4275);
/**
* Temperature destructor
* Analog temperature sensor destructor
*/
~Temperature();
/**
@ -82,7 +82,7 @@ class Temperature {
* @return Raw value from the ADC
*/
float raw_value();
/* Provided for compatibility with old grove base class
/** Provided for compatibility with old grove base class
*
* @return Sensor name
*/