mirror of
https://github.com/eclipse/upm.git
synced 2025-12-16 05:44:32 +03:00
cpp_headers: Renamed C++ headers from .h -> .hpp
To make room for UPM C and C++ sensor code to coexist, all UPM
C++ headers have been renamed from h -> hpp. This commit contains
updates to documentation, includes, cmake collateral, examples, and
swig interface files.
* Renamed all cxx/cpp header files which contain the string
'copyright intel' from .h -> .hpp (if not already hpp).
* Replaced all references to .h with .hpp in documentation,
source files, cmake collateral, example code, and swig interface
files.
* Replaced cmake variable module_h with module_hpp.
* Intentionally left upm.h since this file currently does not
contain code (documentation only).
Signed-off-by: Noel Eck <noel.eck@intel.com>
This commit is contained in:
111
src/hmc5883l/hmc5883l.hpp
Normal file
111
src/hmc5883l/hmc5883l.hpp
Normal file
@@ -0,0 +1,111 @@
|
||||
/*
|
||||
* Author: Brendan Le Foll <brendan.le.foll@intel.com>
|
||||
* Contributions: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
|
||||
* Copyright (c) 2014 Intel Corporation.
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining
|
||||
* a copy of this software and associated documentation files (the
|
||||
* "Software"), to deal in the Software without restriction, including
|
||||
* without limitation the rights to use, copy, modify, merge, publish,
|
||||
* distribute, sublicense, and/or sell copies of the Software, and to
|
||||
* permit persons to whom the Software is furnished to do so, subject to
|
||||
* the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be
|
||||
* included in all copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
||||
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
||||
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
||||
* LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
||||
* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
||||
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
*/
|
||||
#pragma once
|
||||
|
||||
#include <mraa/i2c.hpp>
|
||||
|
||||
#define MAX_BUFFER_LENGTH 6
|
||||
|
||||
namespace upm {
|
||||
|
||||
/**
|
||||
* @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 {
|
||||
public:
|
||||
/**
|
||||
* Creates an Hmc5883l object
|
||||
*
|
||||
* @param bus Number of the used I2C bus
|
||||
*/
|
||||
Hmc5883l(int bus);
|
||||
|
||||
/*
|
||||
* Returns the direction
|
||||
*/
|
||||
float direction();
|
||||
|
||||
/*
|
||||
* Returns the heading
|
||||
*/
|
||||
float heading();
|
||||
|
||||
/**
|
||||
* Returns a pointer to an int[3] that contains the coordinates as ints
|
||||
*
|
||||
* @return *int to an int[3]
|
||||
*/
|
||||
int16_t* coordinates();
|
||||
|
||||
/**
|
||||
* Updates the values by reading from I2C
|
||||
*
|
||||
* @return 0 if successful
|
||||
*/
|
||||
mraa::Result update();
|
||||
|
||||
/**
|
||||
* 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
|
||||
*/
|
||||
float get_declination();
|
||||
private:
|
||||
int16_t m_coor[3];
|
||||
float m_declination;
|
||||
uint8_t m_rx_tx_buf[MAX_BUFFER_LENGTH];
|
||||
mraa::I2c m_i2c;
|
||||
};
|
||||
|
||||
}
|
||||
Reference in New Issue
Block a user