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

hmc5883l: improve documentation and sample

Browse Source 
Signed-off-by: Brendan Le Foll <brendan.le.foll@intel.com>
This commit is contained in:
Brendan Le Foll
2014-09-07 15:20:04 +01:00
parent 88bf6956fe
commit 0ef50b8be2
4 changed files with 10 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
src/hmc5883l/hmc5883l.h
View File

@ -32,10 +32,14 @@ namespace upm {
/**
* @brief C++ API for HMC5883l (3-axis digital compass)
*
* This file defines the HMC5883l C++ interface for libhmc5883l
* The Honeywell [HMC5883L]
* (http://www.adafruit.com/datasheets/HMC5883L_3-Axis_Digital_Compass_IC.pdf)
* is a 3-axis digital compass. Communication with the 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.
*
* @snippet hmc5883l.cxx Interesting
*
* @image html hmc5883l.jpeg
*/
class Hmc5883l {