alexey.zholtikov/upm
1
0
Fork 0
mirror of https://github.com/eclipse/upm.git synced 2025-07-01 17:31:13 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

doc: Scrubbed ALL sensor library descriptions

Browse Source 
In an effort to clean-up and standardize UPM library
documentation, this commit updates (and in most cases,
unifies) the CMake description string AND CXX header
@comname string.

Strings were taken from datasheets when possible, spelling
mistakes were addressed, copy/paste errors where fixed,
Title Case was used, etc.

    * Tested/updated/added @web tags
    * Added/updated invalid sensor images
    * Added/updated @man tags, added missing manufacturers

Signed-off-by: Noel Eck <noel.eck@intel.com>
This commit is contained in:
Noel Eck
2016-12-15 15:15:21 -08:00
parent 7a5c8a6cb3
commit 283fce619e
416 changed files with 793 additions and 675 deletions
Download Patch File Download Diff File Expand all files Collapse all files

104
src/hmc5883l/hmc5883l.hpp
View File

@ -32,83 +32,83 @@
namespace upm {
/**
* @brief HMC5883L Magnometer library
* @defgroup hmc5883l libupm-hmc5883l
* @ingroup seeed i2c compass robok
*/
/**
* @brief HMC5883L Magnometer library
* @defgroup hmc5883l libupm-hmc5883l
* @ingroup seeed i2c compass robok
*/
/**
* @library hmc5883l
* @sensor hmc5883l
* @comname HMC5883L 3-Axis Digital Compass
* @altname Grove 3-Axis Digital Compass
* @type compass
* @man seeed
* @con i2c
* @kit robok
*
* @brief API for the HMC5883L 3-Axis Digital Compass
*
* Honeywell [HMC5883L]
* (http://www.adafruit.com/datasheets/HMC5883L_3-Axis_Digital_Compass_IC.pdf)
* is a 3-axis digital compass. Communication with HMC5883L is
* simple and all done through an I2C interface. Different
* breakout boards are available. Typically, a 3V supply is all
* that is needed to power the sensor.
*
* @image html hmc5883l.jpeg
* @snippet hmc5883l.cxx Interesting
*/
class Hmc5883l {
/**
* @library hmc5883l
* @sensor hmc5883l
* @comname 3-axis Digital Compass
* @altname Grove 3-Axis Digital Compass
* @type compass
* @man seeed
* @con i2c
* @web http://wiki.seeed.cc/Grove-3-Axis_Compass_V1.0/
* @kit robok
*
* @brief API for the HMC5883L 3-Axis Digital Compass
*
* Honeywell [HMC5883L]
* (http://www.adafruit.com/datasheets/HMC5883L_3-Axis_Digital_Compass_IC.pdf)
* is a 3-axis digital compass. Communication with HMC5883L is simple and
* all done through an I2C interface. Different breakout boards are available.
* Typically, a 3V supply is all that is needed to power the sensor.
*
* @image html hmc5883l.jpeg
* @snippet hmc5883l.cxx Interesting
*/
class Hmc5883l {
public:
/**
* Creates an Hmc5883l object. The I2C address cannot be
* changed, and is always 0x1e (7-bit).
*
* @param bus I2C bus number
*/
* Creates an Hmc5883l object. The I2C address cannot be
* changed, and is always 0x1e (7-bit).
*
* @param bus I2C bus number
*/
Hmc5883l(int bus);
/*
* Returns the direction
*/
* Returns the direction
*/
float direction();
/*
* Returns the heading
*/
* Returns the heading
*/
float heading();
/**
* Returns a pointer to an int[3] that contains the coordinates as ints
*
* @return *int to an int[3]
*/
* Returns a pointer to an int[3] that contains the coordinates as ints
*
* @return *int to an int[3]
*/
const int16_t* coordinates();
/**
* Updates the values by reading from I2C
*
* @return 0 if successful
*/
* Updates the values by reading from I2C
*
* @return 0 if successful
*/
upm_result_t update();
/**
* Sets the magnetic declination for better calibration
*/
* Sets the magnetic declination for better calibration
*/
void set_declination(float dec);
/**
* Gets the current magnetic declination value
*
* @return Magnetic declination as a floating-point value
*/
* Gets the current magnetic declination value
*
* @return Magnetic declination as a floating-point value
*/
float get_declination();
protected:
hmc5883l_context m_hmc5883l;
private:
};
};
}