Official interfaces for ST components.
Dependents: X_NUCLEO_IKS01A1 mDot_X_NUCLEO_IKS01A1 53L0A1 X_NUCLEO_IKS01A1 ... more
Fork of ST_INTERFACES by
MagneticSensor.h
00001 /** 00002 ****************************************************************************** 00003 * @file MagneticSensor.h 00004 * @author AST / EST 00005 * @version V0.0.1 00006 * @date 13-April-2015 00007 * @brief This file contains the abstract class describing in general 00008 * the interfaces of a magnetometer 00009 ****************************************************************************** 00010 * @attention 00011 * 00012 * <h2><center>© COPYRIGHT(c) 2015 STMicroelectronics</center></h2> 00013 * 00014 * Redistribution and use in source and binary forms, with or without modification, 00015 * are permitted provided that the following conditions are met: 00016 * 1. Redistributions of source code must retain the above copyright notice, 00017 * this list of conditions and the following disclaimer. 00018 * 2. Redistributions in binary form must reproduce the above copyright notice, 00019 * this list of conditions and the following disclaimer in the documentation 00020 * and/or other materials provided with the distribution. 00021 * 3. Neither the name of STMicroelectronics nor the names of its contributors 00022 * may be used to endorse or promote products derived from this software 00023 * without specific prior written permission. 00024 * 00025 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 00026 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 00027 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 00028 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE 00029 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 00030 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 00031 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 00032 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 00033 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 00034 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 00035 * 00036 ****************************************************************************** 00037 */ 00038 00039 00040 /* Define to prevent from recursive inclusion --------------------------------*/ 00041 00042 #ifndef __MAGNETIC_SENSOR_CLASS_H 00043 #define __MAGNETIC_SENSOR_CLASS_H 00044 00045 00046 /* Includes ------------------------------------------------------------------*/ 00047 00048 #include <Component.h> 00049 00050 00051 /* Classes ------------------------------------------------------------------*/ 00052 00053 /** 00054 * An abstract class for a magnetometer 00055 */ 00056 class MagneticSensor : public Component { 00057 public: 00058 00059 /** 00060 * @brief Get current magnetometer magnetic X/Y/Z-axes values 00061 * in standard data units [mgauss] 00062 * @param[out] p_data Pointer to where to store magnetic values to. 00063 * p_data must point to an array of (at least) three elements, where: 00064 * p_data[0] corresponds to X-axis, 00065 * p_data[1] corresponds to Y-axis, and 00066 * p_data[2] corresponds to Z-axis. 00067 * @return 0 in case of success, an error code otherwise 00068 */ 00069 virtual int get_m_axes(int32_t *p_data) = 0; 00070 00071 /** 00072 * @brief Get current magnetometer raw data X/Y/Z-axes values 00073 * in device sepcific LSB units 00074 * @param[out] p_data Pointer to where to store magnetometer raw data to. 00075 * p_data must point to an array of (at least) three elements, where: 00076 * p_data[0] corresponds to X-axis, 00077 * p_data[1] corresponds to Y-axis, and 00078 * p_data[2] corresponds to Z-axis. 00079 * @return 0 in case of success, an error code otherwise 00080 */ 00081 virtual int get_m_axes_raw(int16_t *p_data) = 0; 00082 00083 /** 00084 * @brief Destructor. 00085 */ 00086 virtual ~MagneticSensor() {}; 00087 }; 00088 00089 #endif /* __MAGNETIC_SENSOR_CLASS_H */
Generated on Tue Jul 12 2022 18:43:53 by 1.7.2