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

22
src/mlx90614/mlx90614.h
View File

@ -53,7 +53,7 @@
namespace upm {
/**
* @brief MLX90614 temperature sensor library
* @brief MLX90614 Temperature Sensor library
* @defgroup mlx90614 libupm-mlx90614
* @ingroup generic i2c temperature
*/
@ -65,7 +65,7 @@ namespace upm {
* @man generic
* @con i2c
*
* @brief API for MLX90614
* @brief API for the MLX90614 Temperature Sensor
*
* This file defines the MLX90614 interface for libmlx90614
*
@ -76,39 +76,39 @@ class MLX90614 {
public:
/**
* Instanciates a MLX90614 object
* Instantiates an MLX90614 object
*
* @param bus number of used bus
* @param devAddr addres of used i2c device
* @param bus Number of the used bus
* @param devAddr Address of the used I2C device
*/
MLX90614 (int bus=0, int devAddr=0x5A);
/**
* MLX90614 object destructor, basicaly it close i2c connection.
* MLX90614 object destructor; basically, it closes the I2C connection.
*/
~MLX90614 ();
/**
* Read object temperature in Fahrenheit
* Reads the object temperature in Fahrenheit
*/
float readObjectTempF(void);
/**
* Read ambient temperature in Fahrenheit
* Reads the ambient temperature in Fahrenheit
*/
float readAmbientTempF(void);
/**
* Read object temperature in Celsius
* Reads the object temperature in Celsius
*/
float readObjectTempC(void);
/**
* Read ambient temperature in Celsius
* Reads the ambient temperature in Celsius
*/
float readAmbientTempC(void);
/**
* Return name of the component
* Returns the name of the component
*/
std::string name()
{