ST / X_NUCLEO_IKS01A1

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

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/lps25h/lps25h_class.h

Revision:
54:2a676c734b30
Parent:
50:f507d4465c31
Child:
57:04563dd74269
diff -r 54553fd15b50 -r 2a676c734b30 Components/lps25h/lps25h_class.h
--- a/Components/lps25h/lps25h_class.h	Wed Jun 10 16:44:54 2015 +0200
+++ b/Components/lps25h/lps25h_class.h	Wed Jun 10 18:03:42 2015 +0200
@@ -51,7 +51,7 @@
 class LPS25H : public PressureSensor, public TempSensor {
  public:
 	/** Constructor
-	 * @param i2c device I2C to be used for communication
+	 * @param[in] i2c device I2C to be used for communication
 	 */
         LPS25H(DevI2C &i2c) : PressureSensor(), TempSensor(), dev_i2c(i2c) {
 		LPS25H_SlaveAddress = LPS25H_ADDRESS_HIGH;
@@ -114,8 +114,6 @@
 
 	/**
 	 * @brief  Configures LPS25H interrupt lines for NUCLEO boards
-	 * @param  None
-	 * @retval None
 	 */
 	void LPS25H_IO_ITConfig(void)
 	{
@@ -124,7 +122,6 @@
 
 	/**
 	 * @brief  Configures LPS25H I2C interface
-	 * @param  None
 	 * @retval PRESSURE_OK in case of success, an error code otherwise
 	 */
 	PRESSURE_StatusTypeDef LPS25H_IO_Init(void)
@@ -133,11 +130,12 @@
 	}
 
 	/**
-	 * @brief utility function to read data from STC3115
-	 * @param  pBuffer: pointer to data to be read.
-	 * @param  RegisterAddr: specifies internal address register to read from.
-	 * @param  NumByteToRead: number of bytes to be read.
-	 * @retval PRESSURE_OK if ok, PRESSURE_ERROR if an I2C error has occured
+	 * @brief  Utility function to read data from LPS25H
+	 * @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 PRESSURE_OK if ok, 
+	 * @retval PRESSURE_ERROR if an I2C error has occured
 	 */
 	PRESSURE_StatusTypeDef LPS25H_IO_Read(uint8_t* pBuffer, 
 					      uint8_t RegisterAddr, uint16_t NumByteToRead)
@@ -153,11 +151,12 @@
 	}
 	
 	/**
-	 * @brief utility function to write data to STC3115
-	 * @param  pBuffer: pointer to buffer to be filled.
-	 * @param  RegisterAddr: specifies internal address register to read from.
-	 * @param  NumByteToWrite: number of bytes to write.
-	 * @retval 0 if ok, -1 if an I2C error has occured
+	 * @brief  Utility function to write data to LPS25H
+	 * @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 PRESSURE_OK if ok, 
+	 * @retval PRESSURE_ERROR if an I2C error has occured
 	 */
 	PRESSURE_StatusTypeDef LPS25H_IO_Write(uint8_t* pBuffer, 
 					       uint8_t RegisterAddr, uint16_t NumByteToWrite)