ST / X_NUCLEO_IKS01A1

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 ST Expansion SW Team

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:

  1. a HTS221 Relative Humidity and Temperature Sensor,
  2. a LIS3MDL 3-Axis Magnetometer,
  3. a LPS25H MEMS Pressure Sensor, and
  4. 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

Diff: Components/Common/magneto.h

Revision:
24:92cc9c6e4b2b
Parent:
3:088aa5839e0d
--- a/Components/Common/magneto.h	Fri May 29 16:50:56 2015 +0200
+++ b/Components/Common/magneto.h	Wed Jun 03 14:57:57 2015 +0200
@@ -4,7 +4,7 @@
  * @author  MEMS Application Team
  * @version V1.2.0
  * @date    28-January-2015
- * @brief   This header file contains the functions prototypes for the 
+ * @brief   This header file contains the functions prototypes for the
  *          magneto driver.
  ******************************************************************************
  * @attention
@@ -46,7 +46,7 @@
 #endif
 
 /* Includes ------------------------------------------------------------------*/
-#include <stdint.h> 
+#include <stdint.h>
 
 /** @addtogroup BSP
   * @{
@@ -55,7 +55,7 @@
 /** @addtogroup Components
   * @{
   */
-    
+
 /** @addtogroup MAGNETO
   * @{
   */
@@ -69,53 +69,58 @@
 */
 typedef struct
 {
-    uint8_t M_OutputDataRate;
-    uint8_t M_OperatingMode;
-    uint8_t M_FullScale;
-    uint8_t M_XYOperativeMode;
-}MAGNETO_InitTypeDef;
+  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
+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
+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;
+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_DrvExtTypeDef                   *extData;
-}MAGNETO_DrvTypeDef;
+  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;
 
 /**
  * @}
  */
- 
+
 /**
  * @}
  */
@@ -134,4 +139,4 @@
 
 #endif /* __MAGNETO_H */
 
-/************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/ 
+/************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/