Firmware Library for X-NUCLEO-IKS01A1 (MEMS Inertial & Environmental Sensors) Expansion Board
Dependencies: X_NUCLEO_COMMON ST_INTERFACES
Dependents: MultiTech_Dragonfly_2015_ATT_Gov_Solutions_Hackathon_Example HelloWorld_IKS01A1 LoRaWAN-test-10secs ServoMotorDemo ... more
Fork of X_NUCLEO_IKS01A1 by
X-NUCLEO-IKS01A1 MEMS Inertial & Environmental Sensor Nucleo Expansion Board Firmware Package
Introduction
This firmware package includes Components Device Drivers and Board Support Package for STMicroelectronics' X-NUCLEO-IKS01A1 MEMS Inertial & Environmental Sensors Nucleo Expansion Board.
Firmware Library
Class X_NUCLEO_IKS01A1 is intended to represent the MEMS inertial & environmental sensors expansion board with the same name.
The expansion board is basically featuring four IPs:
- a HTS221 Relative Humidity and Temperature Sensor,
- a LIS3MDL 3-Axis Magnetometer,
- a LPS25H MEMS Pressure Sensor, and
- a LSM6DS0 3D Accelerometer and 3D Gyroscope
The expansion board features also a DIL 24-pin socket which makes it possible to add further MEMS adapters and other sensors (e.g. UV index).
It is intentionally implemented as a singleton because only one X_NUCLEO_IKS01A1 at a time might be deployed in a HW component stack. In order to get the singleton instance you have to call class method `Instance()`, e.g.:
// Sensors expansion board singleton instance static X_NUCLEO_IKS01A1 *sensors_expansion_board = X_NUCLEO_IKS01A1::Instance();
Furthermore, library ST_INTERFACES
contains all abstract classes which together constitute the common API to which all existing and future ST components will adhere to.
Example Applications
Components/Common/magneto.h
- Committer:
- Wolfgang Betz
- Date:
- 2015-06-03
- Revision:
- 24:92cc9c6e4b2b
- Parent:
- 3:088aa5839e0d
File content as of revision 24:92cc9c6e4b2b:
/** ****************************************************************************** * @file magneto.h * @author MEMS Application Team * @version V1.2.0 * @date 28-January-2015 * @brief This header file contains the functions prototypes for the * magneto driver. ****************************************************************************** * @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 recursive inclusion -------------------------------------*/ #ifndef __MAGNETO_H #define __MAGNETO_H #ifdef __cplusplus extern "C" { #endif /* Includes ------------------------------------------------------------------*/ #include <stdint.h> /** @addtogroup BSP * @{ */ /** @addtogroup Components * @{ */ /** @addtogroup MAGNETO * @{ */ /** @defgroup MAGNETO_Exported_Types * @{ */ /** * @brief MAGNETO init structure definition */ typedef struct { uint8_t M_OutputDataRate; uint8_t M_OperatingMode; uint8_t M_FullScale; uint8_t M_XYOperativeMode; } MAGNETO_InitTypeDef; /** * @brief MAGNETO status enumerator definition */ typedef enum { MAGNETO_OK = 0, MAGNETO_ERROR = 1, MAGNETO_TIMEOUT = 2, MAGNETO_NOT_IMPLEMENTED = 3 } MAGNETO_StatusTypeDef; /** * @brief MAGNETO component id enumerator definition */ typedef enum { MAGNETO_NONE_COMPONENT = 0, MAGNETO_LIS3MDL_COMPONENT = 1 } MAGNETO_ComponentTypeDef; /** * @brief MAGNETO driver extended structure definition */ typedef struct { MAGNETO_ComponentTypeDef id; /* This id must be unique for each component belonging to this class that wants to extend common class */ void *pData; /* This pointer is specific for each component */ } MAGNETO_DrvExtTypeDef; /** * @brief MAGNETO driver structure definition */ typedef struct { MAGNETO_StatusTypeDef (*Init)(MAGNETO_InitTypeDef *); MAGNETO_StatusTypeDef (*Read_M_ID)(uint8_t *); MAGNETO_StatusTypeDef (*Get_M_Axes)(int32_t *); MAGNETO_StatusTypeDef (*Get_M_AxesRaw)(int16_t *); MAGNETO_DrvExtTypeDef *extData; } MAGNETO_DrvTypeDef; /** * @} */ /** * @} */ /** * @} */ /** * @} */ #ifdef __cplusplus } #endif #endif /* __MAGNETO_H */ /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/