Official interfaces for ST components.
Dependents: X_NUCLEO_IKS01A1 mDot_X_NUCLEO_IKS01A1 53L0A1 X_NUCLEO_IKS01A1 ... more
Fork of ST_INTERFACES by
This library contains all abstract classes which together constitute the common API to which all existing and future ST components will adhere to.
Sensors/MagneticSensor.h@3:b1bb477e115e, 2017-03-10 (annotated)
- Committer:
- davide.aliprandi@st.com
- Date:
- Fri Mar 10 10:50:53 2017 +0100
- Revision:
- 3:b1bb477e115e
- Parent:
- 1:a7810e7acf8d
Aligning to ARM mbed coding style.
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
Davidroid | 0:f6dd8f22f875 | 1 | /** |
Davidroid | 0:f6dd8f22f875 | 2 | ****************************************************************************** |
Davidroid | 0:f6dd8f22f875 | 3 | * @file MagneticSensor.h |
Davidroid | 0:f6dd8f22f875 | 4 | * @author AST / EST |
Davidroid | 0:f6dd8f22f875 | 5 | * @version V0.0.1 |
Davidroid | 0:f6dd8f22f875 | 6 | * @date 13-April-2015 |
Davidroid | 0:f6dd8f22f875 | 7 | * @brief This file contains the abstract class describing in general |
Davidroid | 0:f6dd8f22f875 | 8 | * the interfaces of a magnetometer |
Davidroid | 0:f6dd8f22f875 | 9 | ****************************************************************************** |
Davidroid | 0:f6dd8f22f875 | 10 | * @attention |
Davidroid | 0:f6dd8f22f875 | 11 | * |
Davidroid | 0:f6dd8f22f875 | 12 | * <h2><center>© COPYRIGHT(c) 2015 STMicroelectronics</center></h2> |
Davidroid | 0:f6dd8f22f875 | 13 | * |
Davidroid | 0:f6dd8f22f875 | 14 | * Redistribution and use in source and binary forms, with or without modification, |
Davidroid | 0:f6dd8f22f875 | 15 | * are permitted provided that the following conditions are met: |
Davidroid | 0:f6dd8f22f875 | 16 | * 1. Redistributions of source code must retain the above copyright notice, |
Davidroid | 0:f6dd8f22f875 | 17 | * this list of conditions and the following disclaimer. |
Davidroid | 0:f6dd8f22f875 | 18 | * 2. Redistributions in binary form must reproduce the above copyright notice, |
Davidroid | 0:f6dd8f22f875 | 19 | * this list of conditions and the following disclaimer in the documentation |
Davidroid | 0:f6dd8f22f875 | 20 | * and/or other materials provided with the distribution. |
Davidroid | 0:f6dd8f22f875 | 21 | * 3. Neither the name of STMicroelectronics nor the names of its contributors |
Davidroid | 0:f6dd8f22f875 | 22 | * may be used to endorse or promote products derived from this software |
Davidroid | 0:f6dd8f22f875 | 23 | * without specific prior written permission. |
Davidroid | 0:f6dd8f22f875 | 24 | * |
Davidroid | 0:f6dd8f22f875 | 25 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
Davidroid | 0:f6dd8f22f875 | 26 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
Davidroid | 0:f6dd8f22f875 | 27 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
Davidroid | 0:f6dd8f22f875 | 28 | * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE |
Davidroid | 0:f6dd8f22f875 | 29 | * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
Davidroid | 0:f6dd8f22f875 | 30 | * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR |
Davidroid | 0:f6dd8f22f875 | 31 | * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER |
Davidroid | 0:f6dd8f22f875 | 32 | * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, |
Davidroid | 0:f6dd8f22f875 | 33 | * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
Davidroid | 0:f6dd8f22f875 | 34 | * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
Davidroid | 0:f6dd8f22f875 | 35 | * |
Davidroid | 0:f6dd8f22f875 | 36 | ****************************************************************************** |
Davidroid | 0:f6dd8f22f875 | 37 | */ |
Davidroid | 0:f6dd8f22f875 | 38 | |
davide.aliprandi@st.com | 3:b1bb477e115e | 39 | |
Davidroid | 0:f6dd8f22f875 | 40 | /* Define to prevent from recursive inclusion --------------------------------*/ |
davide.aliprandi@st.com | 3:b1bb477e115e | 41 | |
Davidroid | 0:f6dd8f22f875 | 42 | #ifndef __MAGNETIC_SENSOR_CLASS_H |
Davidroid | 0:f6dd8f22f875 | 43 | #define __MAGNETIC_SENSOR_CLASS_H |
Davidroid | 0:f6dd8f22f875 | 44 | |
davide.aliprandi@st.com | 3:b1bb477e115e | 45 | |
Davidroid | 0:f6dd8f22f875 | 46 | /* Includes ------------------------------------------------------------------*/ |
davide.aliprandi@st.com | 3:b1bb477e115e | 47 | |
davide.aliprandi@st.com | 3:b1bb477e115e | 48 | #include <Component.h> |
davide.aliprandi@st.com | 3:b1bb477e115e | 49 | |
Davidroid | 0:f6dd8f22f875 | 50 | |
Davidroid | 0:f6dd8f22f875 | 51 | /* Classes ------------------------------------------------------------------*/ |
davide.aliprandi@st.com | 3:b1bb477e115e | 52 | |
davide.aliprandi@st.com | 3:b1bb477e115e | 53 | /** |
davide.aliprandi@st.com | 3:b1bb477e115e | 54 | * An abstract class for a magnetometer |
Davidroid | 0:f6dd8f22f875 | 55 | */ |
davide.aliprandi@st.com | 3:b1bb477e115e | 56 | class MagneticSensor : public Component { |
davide.aliprandi@st.com | 3:b1bb477e115e | 57 | public: |
davide.aliprandi@st.com | 3:b1bb477e115e | 58 | |
Davidroid | 0:f6dd8f22f875 | 59 | /** |
Davidroid | 0:f6dd8f22f875 | 60 | * @brief Get current magnetometer magnetic X/Y/Z-axes values |
Davidroid | 0:f6dd8f22f875 | 61 | * in standard data units [mgauss] |
davide.aliprandi@st.com | 3:b1bb477e115e | 62 | * @param[out] p_data Pointer to where to store magnetic values to. |
davide.aliprandi@st.com | 3:b1bb477e115e | 63 | * p_data must point to an array of (at least) three elements, where: |
davide.aliprandi@st.com | 3:b1bb477e115e | 64 | * p_data[0] corresponds to X-axis, |
davide.aliprandi@st.com | 3:b1bb477e115e | 65 | * p_data[1] corresponds to Y-axis, and |
davide.aliprandi@st.com | 3:b1bb477e115e | 66 | * p_data[2] corresponds to Z-axis. |
Davidroid | 0:f6dd8f22f875 | 67 | * @return 0 in case of success, an error code otherwise |
Davidroid | 0:f6dd8f22f875 | 68 | */ |
davide.aliprandi@st.com | 3:b1bb477e115e | 69 | virtual int get_m_axes(int32_t *p_data) = 0; |
Davidroid | 0:f6dd8f22f875 | 70 | |
Davidroid | 0:f6dd8f22f875 | 71 | /** |
Davidroid | 0:f6dd8f22f875 | 72 | * @brief Get current magnetometer raw data X/Y/Z-axes values |
Davidroid | 0:f6dd8f22f875 | 73 | * in device sepcific LSB units |
davide.aliprandi@st.com | 3:b1bb477e115e | 74 | * @param[out] p_data Pointer to where to store magnetometer raw data to. |
davide.aliprandi@st.com | 3:b1bb477e115e | 75 | * p_data must point to an array of (at least) three elements, where: |
davide.aliprandi@st.com | 3:b1bb477e115e | 76 | * p_data[0] corresponds to X-axis, |
davide.aliprandi@st.com | 3:b1bb477e115e | 77 | * p_data[1] corresponds to Y-axis, and |
davide.aliprandi@st.com | 3:b1bb477e115e | 78 | * p_data[2] corresponds to Z-axis. |
Davidroid | 0:f6dd8f22f875 | 79 | * @return 0 in case of success, an error code otherwise |
Davidroid | 0:f6dd8f22f875 | 80 | */ |
davide.aliprandi@st.com | 3:b1bb477e115e | 81 | virtual int get_m_axes_raw(int16_t *p_data) = 0; |
davide.aliprandi@st.com | 3:b1bb477e115e | 82 | |
davide.aliprandi@st.com | 3:b1bb477e115e | 83 | /** |
davide.aliprandi@st.com | 3:b1bb477e115e | 84 | * @brief Destructor. |
davide.aliprandi@st.com | 3:b1bb477e115e | 85 | */ |
davide.aliprandi@st.com | 3:b1bb477e115e | 86 | virtual ~MagneticSensor() {}; |
Davidroid | 0:f6dd8f22f875 | 87 | }; |
Davidroid | 0:f6dd8f22f875 | 88 | |
Davidroid | 0:f6dd8f22f875 | 89 | #endif /* __MAGNETIC_SENSOR_CLASS_H */ |