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

70
src/otp538u/otp538u.h
View File

@ -45,24 +45,24 @@ namespace upm {
*
* @brief API for the OTP538U IR Temperature Sensor
*
* UPM module for the OTP538U IR Temperature Sensor
* UPM module for the OTP538U IR temperature sensor
*
* This module was tested with the Grove IR non-contact temperature
* sensor.
*
* The sensor provides 2 analog outputs - one for the thermistor
* that measures ambient temperature, and another for the thermopile
* that measures object temperature.
* The sensor provides 2 analog outputs: one for the thermistor
* that measures the ambient temperature, and the other for the thermopile
* that measures the object temperature.
*
* Much of the code depends on analyzing the SeeedStudio examples
* and circuit design. As a result, there are several 'magic'
* numbers that were derived from their circuit design. By default,
* these values will be used.
* Much of the code depends on analyzing Seeed Studio* examples
* and the circuit design. As a result, there are several 'magic'
* numbers derived from their circuit design. These values are used
* by default.
*
* The tables used came from the datasheets "538U VT
* Table__20_200(v1.3).pdf" and "538RT_table.pdf".
* The tables used came from the "538U VT
* Table__20_200(v1.3).pdf" and "538RT_table.pdf" datasheets.
*
* These tables assume the object to be measured is 9cm (3.54
* These tables assume the object to be measured is 9 cm (3.54
* inches) from the sensor.
*
* @image html otp538u.jpg
@ -71,71 +71,71 @@ namespace upm {
class OTP538U {
public:
/**
* OTP538U sensor constructor
* OTP538U constructor
*
* @param pinA analog pin to use for Ambient temperature
* @param pinO analog pin to use for Object temperature
* @param aref analog reference voltage, default 5.0
* @param pinA Analog pin to use for the ambient temperature
* @param pinO Analog pin to use for the object temperature
* @param aref Analog reference voltage; default is 5.0 V
*/
OTP538U(int pinA, int pinO, float aref = 5.0);
/**
* OTP538U Destructor
* OTP538U destructor
*/
~OTP538U();
/**
* Get the ambient temperature in C
* Gets the ambient temperature in Celsius
*
* @return the ambient temperature
* @return Ambient temperature
*/
float ambientTemperature();
/**
* Get the object temperature in C
* Gets the object temperature in Celsius
*
* @return the object's temperature
* @return Object temperature
*/
float objectTemperature();
/**
* Set the offset voltage
* Sets the offset voltage
*
* The Seeedstudio wiki gives an example on calibrating the sensor
* and calculating the offset voltage to apply. Currently, the
* The Seeed Studio wiki gives an example of calibrating the sensor
* and calculating the offset voltage to apply. Currently, the
* default value is set, but you can use the function to set one
* of your own.
*
* @param vOffset the desired offset voltage
* @param vOffset Desired offset voltage
*/
void setVoltageOffset(float vOffset) { m_offsetVoltage = vOffset; };
/**
* Set the output resistance value
* Sets the output resistance value
*
* The Seeedstudio wiki example uses a value, 2000000 in one of
* the equations used to calculate a voltage. The value is the
* The Seeed Studio wiki example uses a value of 2,000,000 in one of
* the equations used to calculate voltage. The value is the
* resistance of a resistor they use in the output stage of their
* SIG2 output. This was 'decoded' by looking at the eagle files
* SIG2 output. This was 'decoded' by looking at the EAGLE* files
* containing their schematics for this device.
*
* @param outResistance value of output resistor, default 2M Ohm.
* @param outResistance Value of the output resistor; default is 2M Ohm
*/
void setOutputResistence(int outResistance) {
m_vResistance = outResistance; };
/**
* Set the voltage reference of the internal seedstudio voltage
* Sets the reference voltage of the internal Seeed Studio voltage
* regulator on the sensor board.
*
* The Seeedstudio wiki example uses a value, 2.5 in one of the
* The Seeed Studio wiki example uses a value of 2.5 in one of the
* equations used to calculate the resistance of the ambient
* thermistor. The value is the voltage of an internal voltage
* regulator used in the sensor board. This was 'decoded' by
* looking at the eagle files containing their schematics for this
* thermistor. The value is the voltage of an internal voltage
* regulator used on the sensor board. This was 'decoded' by
* looking at the EAGLE files containing their schematics for this
* device.
*
* @param vref internal sensor voltage reference, default 2.5
* @param vref Reference voltage of the internal sensor; default is 2.5 V
*/
void setVRef(float vref) { m_vref = vref; };

4
src/otp538u/thermister_rt_table.h
View File

@ -22,9 +22,9 @@
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
// This table was taken from the 538RT_table.pdf datasheet. It maps
// This table was taken from the '538RT_table.pdf' datasheet. It maps
// resistance values to ambient temperatures starting at -20C and
// going to 200C in increments of 1C
// going up to 200C in increments of 1C
static const int otp538u_rt_table_max = 121;

4
src/otp538u/thermopile_vt_table.h
View File

@ -22,12 +22,12 @@
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
// This table was taken from the 538U VT Table__20_200(v1.3).pdf
// This table was taken from the '538U VT Table__20_200(v1.3).pdf'
// datasheet, but the 25C column has been removed for consistency.
static const int otp538u_vt_table_max = 23;
// Thermister temperature (C)
// Thermistor temperature (C)
// { -20 -10 0 10 20 30 40 50 60 70 80 90 100 }
static float otp538u_vt_table[otp538u_vt_table_max][13] = {