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: more header files edited

Browse Source 
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
VadimPopov
2015-08-09 22:51:25 +03:00
committed by Mihai Tudor Panu
parent 55e8076988
commit 04edb9be04
68 changed files with 1172 additions and 1172 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
src/enc03r/enc03r.h
View File

@ -46,8 +46,8 @@ namespace upm {
*
* @brief API for the ENC03R Single Axis Analog Gyro
*
* UPM module for the ENC03R Single Axis Analog Gyro.
* This gyroscope measures the x-axis angular velocity; that is,
* UPM module for the ENC03R single axis analog gyro.
* This gyroscope measures x-axis angular velocity, that is
* how fast the sensor is rotating around the x-axis.
* Calibration of the sensor is necessary for accurate readings.
*
@ -60,45 +60,45 @@ namespace upm {
/**
* ENC03R sensor constructor
*
* @param pin analog pin to use
* @param vref the voltage reference to use, default 5.0
* @param pin Analog pin to use
* @param vref Reference voltage to use; default is 5.0 V
*/
ENC03R(int pin, float vref=5.0);
/**
* ENC03R Destructor
* ENC03R destructor
*/
~ENC03R();
/**
* Calibrate the sensor by determining an analog reading over many
* samples with no movement of the sensor. This must be done
* Calibrates the sensor by determining an analog reading over many
* samples with no movement of the sensor. This must be done
* before attempting to use the sensor.
*
* @param samples the number of samples to use for calibration
* @param samples Number of samples to use for calibration
*/
void calibrate(unsigned int samples);
/**
* Return the raw value of the sensor
* Returns the raw value of the sensor
*
* @return raw value of sensor
* @return Raw value of the sensor
*/
unsigned int value();
/**
* Return the currently stored calibration value
* Returns the currently stored calibration value
*
* @return current calibration value
* @return Current calibration value
*/
float calibrationValue() { return m_calibrationValue; };
/**
* Compute angular velocity based on value and stored calibration
* Computes angular velocity based on the value and stored calibration
* reference.
*
* @param val the value to use to compute the angular velocity
* @return computed angular velocity
* @param val Value to use to compute angular velocity
* @return Computed angular velocity
*/
double angularVelocity(unsigned int val);