Diff: Components/ST_INTERFACES/Sensors/MotionSensor.h
- Revision:
- 6:9a5313607546
- Parent:
- 5:6020b7ced569
--- a/Components/ST_INTERFACES/Sensors/MotionSensor.h Tue Nov 03 15:09:55 2020 +0000
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,126 +0,0 @@
-/**
- ******************************************************************************
- * @file MotionSensor.h
- * @author AST / EST
- * @version V0.0.1
- * @date 13-April-2015
- * @brief This file contains the abstract class describing in general
- * the interfaces of an accelerometer
- ******************************************************************************
- * @attention
- *
- * <h2><center>© COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
- *
- * Redistribution and use in source and binary forms, with or without modification,
- * are permitted provided that the following conditions are met:
- * 1. Redistributions of source code must retain the above copyright notice,
- * this list of conditions and the following disclaimer.
- * 2. Redistributions in binary form must reproduce the above copyright notice,
- * this list of conditions and the following disclaimer in the documentation
- * and/or other materials provided with the distribution.
- * 3. Neither the name of STMicroelectronics nor the names of its contributors
- * may be used to endorse or promote products derived from this software
- * without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
- * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
- * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- *
- ******************************************************************************
- */
-
-
-/* Define to prevent from recursive inclusion --------------------------------*/
-
-#ifndef __MOTION_SENSOR_CLASS_H
-#define __MOTION_SENSOR_CLASS_H
-
-
-/* Includes ------------------------------------------------------------------*/
-
-#include <Component.h>
-
-
-/* Classes ------------------------------------------------------------------*/
-
-/**
- * An abstract class for an Accelerometer
- */
-class MotionSensor : public Component {
-public:
-
- /**
- * @brief Get current accelerometer linear acceleration X/Y/Z-axes values
- * in standard data units [mg]
- * @param[out] p_data Pointer to where to store linear accelerations to.
- * p_data must point to an array of (at least) three elements, where:
- * p_data[0] corresponds to X-axis,
- * p_data[1] corresponds to Y-axis, and
- * p_data[2] corresponds to Z-axis.
- * @return 0 in case of success, an error code otherwise
- */
- virtual int get_x_axes(int32_t *p_data) = 0;
-
- /**
- * @brief Get current accelerometer raw data X/Y/Z-axes values
- * in device sepcific LSB units
- * @param[out] p_data Pointer to where to store accelerometer raw data to.
- * p_data must point to an array of (at least) three elements, where:
- * p_data[0] corresponds to X-axis,
- * p_data[1] corresponds to Y-axis, and
- * p_data[2] corresponds to Z-axis.
- * @return 0 in case of success, an error code otherwise
- */
- virtual int get_x_axes_raw(int16_t *p_data) = 0;
-
- /**
- * @brief Get accelerometer's current sensitivity [mg/LSB]
- * @param[out] pf_data Pointer to where the accelerometer's sensitivity is stored to
- * @return 0 in case of success, an error code otherwise
- */
- virtual int get_x_sensitivity(float *pf_data) = 0;
-
- /**
- * @brief Get accelerometer's current output data rate [Hz]
- * @param[out] pf_data Pointer to where the accelerometer output data rate is stored to
- * @return 0 in case of success, an error code otherwise
- */
- virtual int get_x_odr(float *pf_data) = 0;
-
- /**
- * @brief Set accelerometer's output data rate
- * @param[in] odr New value for accelerometer's output data rate in [Hz]
- * @return 0 in case of success, an error code otherwise
- */
- virtual int set_x_odr(float odr) = 0;
-
- /**
- * @brief Get accelerometer's full scale value
- * i.e.\ min/max measurable value [g]
- * @param[out] pf_data Pointer to where the accelerometer full scale value is stored to
- * @return 0 in case of success, an error code otherwise
- */
- virtual int get_x_fs(float *pf_data) = 0;
-
- /**
- * @brief Set accelerometer's full scale value
- * i.e.\ min/max measurable value
- * @param[in] fs New full scale value for accelerometer in [g]
- * @return 0 in case of success, an error code otherwise
- */
- virtual int set_x_fs(float fs) = 0;
-
- /**
- * @brief Destructor.
- */
- virtual ~MotionSensor() {};
-};
-
-#endif /* __MOTION_SENSOR_CLASS_H */