ST » Code » 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:

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

Diff: Components/hts221/hts221_class.h

Revision:: 57:04563dd74269
Parent:: 54:2a676c734b30
Child:: 88:7b8d3316d753

--- a/Components/hts221/hts221_class.h	Wed Jun 10 18:03:42 2015 +0200
+++ b/Components/hts221/hts221_class.h	Mon Jun 15 10:28:49 2015 +0200
@@ -41,9 +41,9 @@
 /* Includes ------------------------------------------------------------------*/
 #include "mbed.h"
 #include "DevI2C.h"
+#include "hts221.h"
 #include "../Interfaces/HumiditySensor.h"
 #include "../Interfaces/TempSensor.h"
-#include "hts221.h"
 
 /* Classes -------------------------------------------------------------------*/
 /** Class representing a HTS221 sensor component
@@ -117,7 +117,7 @@
 
 	/**
 	 * @brief  Configures HTS221 I2C interface
-	 * @retval HUM_TEMP_OK in case of success, an error code otherwise
+	 * @return HUM_TEMP_OK in case of success, an error code otherwise
 	 */
 	HUM_TEMP_StatusTypeDef HTS221_IO_Init(void)
 	{
@@ -125,12 +125,12 @@
 	}
 
 	/**
-	 * @brief  Utility function to read data from HTS221
-	 * @param  pBuffer pointer to the byte-array to read data in to
-	 * @param  RegisterAddr specifies internal address register to read from.
-	 * @param  NumByteToRead number of bytes to be read.
-	 * @retval HUM_TEMP_OK if ok, 
-	 * @retval HUM_TEMP_ERROR if an I2C error has occured
+	 * @brief      Utility function to read data from HTS221
+	 * @param[out] pBuffer pointer to the byte-array to read data in to
+	 * @param[in]  RegisterAddr specifies internal address register to read from.
+	 * @param[in]  NumByteToRead number of bytes to be read.
+	 * @retval     HUM_TEMP_OK if ok, 
+	 * @retval     HUM_TEMP_ERROR if an I2C error has occured
 	 */
 	HUM_TEMP_StatusTypeDef HTS221_IO_Read(uint8_t* pBuffer, 
 					      uint8_t RegisterAddr, uint16_t NumByteToRead)
@@ -146,12 +146,12 @@
 	}
 	
 	/**
-	 * @brief  Utility function to write data to HTS221
-	 * @param  pBuffer pointer to the byte-array data to send
-	 * @param  RegisterAddr specifies internal address register to read from.
-	 * @param  NumByteToWrite number of bytes to write.
-	 * @retval HUM_TEMP_OK if ok, 
-	 * @retval HUM_TEMP_ERROR if an I2C error has occured
+	 * @brief      Utility function to write data to HTS221
+	 * @param[in]  pBuffer pointer to the byte-array data to send
+	 * @param[in]  RegisterAddr specifies internal address register to read from.
+	 * @param[in]  NumByteToWrite number of bytes to write.
+	 * @retval     HUM_TEMP_OK if ok, 
+	 * @retval     HUM_TEMP_ERROR if an I2C error has occured
 	 */
 	HUM_TEMP_StatusTypeDef HTS221_IO_Write(uint8_t* pBuffer, 
 					       uint8_t RegisterAddr, uint16_t NumByteToWrite)