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

38
src/max44000/max44000.h
View File

@ -38,7 +38,7 @@
#define PRXDATA 0x15 // proximity sensor data
#define ALS_UP_THRESH_HIGH 0x06 // ALS Interrupt Threshold Registers High
#define ALS_UP_THRESH_LOW 0x07 // ALS Interrupt Threshold Registers LOW
#define ALS_UP_THRESH_LOW 0x07 // ALS Interrupt Threshold Registers Low
#define ALS_LO_THRESH_HIGH 0x08 // ALS Interrupt Threshold Registers High
#define ALS_LO_THRESH_LOW 0x09 // ALS Interrupt Threshold Registers Low
#define TPTR 0x0A // ALS/PROX Threshold Persist Timer Register
@ -53,7 +53,7 @@
namespace upm {
/**
* @brief MAX44000 proximity sensor library
* @brief MAX44000 Proximity Sensor library
* @defgroup max44000 libupm-max44000
* @ingroup maxim i2c light
*/
@ -65,11 +65,11 @@ namespace upm {
* @man maxim
* @con i2c
*
* @brief API for MAX44000 chip (Ambient and Infrared Proximity Sensor)
* @brief API for the MAX44000 Ambient and Infrared Proximity Sensor
*
* The Maxim Integrated
* Maxim Integrated*
* [MAX44000](http://datasheets.maximintegrated.com/en/ds/MAX44000.pdf)
* is Ambient and Infrared Proximity Sensor. This module was tested on the
* is an ambient and infrared proximity sensor. This module was tested on the
* Maxim Integrated
* [MAX44000PMB1 PMOD module]
* (http://datasheets.maximintegrated.com/en/ds/MAX44000PMB1.pdf) from the
@ -80,29 +80,29 @@ namespace upm {
class MAX44000 {
public:
/**
* Instanciates a MAX44000 object
* Instantiates an MAX44000 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
*/
MAX44000 (int bus, int devAddr);
/**
* MAX44000 object destructor, basicaly it close i2c connection.
* MAX44000 object destructor; basically, it closes the I2C connection.
*/
~MAX44000 ();
/**
* Read the proximity value from the chip (based on ambient data).
* Reads the proximity value from the sensor (based on ambient data).
*/
uint16_t getProximity ();
/**
* Read the ambient value from the chip (based on ambient data).
* Reads the ambient value from the sensor (based on ambient data).
*/
uint16_t getAmbient ();
/**
* Return name of the component
* Returns the name of the component
*/
std::string name()
{
@ -110,24 +110,24 @@ class MAX44000 {
}
/**
* Read one byte register
* Reads a one-byte register
*
* @param reg address of a register
* @param reg Address of the register
*/
uint8_t i2cReadReg_8 (int reg);
/**
* Read two bytes register
* Reads a two-byte register
*
* @param reg address of a register
* @param reg Address of the register
*/
uint16_t i2cReadReg_16 (int reg);
/**
* Write to one byte register
* Writes to a one-byte register
*
* @param reg address of a register
* @param value byte to be written
* @param reg Address of the register
* @param value Byte to be written
*/
mraa_result_t i2cWriteReg (uint8_t reg, uint8_t value);