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: ST_INTERFACES X_NUCLEO_COMMON
Fork of X_NUCLEO_IKS01A1 by
Revision 57:04563dd74269, committed 2015-06-15
- Comitter:
- Wolfgang Betz
- Date:
- Mon Jun 15 10:28:49 2015 +0200
- Parent:
- 54:2a676c734b30
- Child:
- 58:203899d790b4
- Child:
- 60:6d8a78203290
- Commit message:
- Further fine-tuning of doxygen comments
Changed in this revision
--- a/Components/Common/readme.txt Wed Jun 10 18:03:42 2015 +0200 +++ b/Components/Common/readme.txt Mon Jun 15 10:28:49 2015 +0200 @@ -1,15 +1,15 @@ hum_temp.h corresponds to: - X-CUBE-MEMS1/trunk/Drivers/BSP/Components/Common/hum_temp.h: revision #385, -- X-CUBE-MEMS1/trunk: revision #402 +- X-CUBE-MEMS1/trunk: revision #416 imu_6axes.h corresponds to: - X-CUBE-MEMS1/trunk/Drivers/BSP/Components/Common/imu_6axes.h: revision #385, -- X-CUBE-MEMS1/trunk: revision #402 +- X-CUBE-MEMS1/trunk: revision #416 magneto.h corresponds to: - X-CUBE-MEMS1/trunk/Drivers/BSP/Components/Common/magneto.h: revision #385, -- X-CUBE-MEMS1/trunk: revision #402 +- X-CUBE-MEMS1/trunk: revision #416 pressure.h corresponds to: - X-CUBE-MEMS1/trunk/Drivers/BSP/Components/Common/pressure.h: revision #385, -- X-CUBE-MEMS1/trunk: revision #402 +- X-CUBE-MEMS1/trunk: revision #416
--- a/Components/hts221/hts221_class.cpp Wed Jun 10 18:03:42 2015 +0200 +++ b/Components/hts221/hts221_class.cpp Mon Jun 15 10:28:49 2015 +0200 @@ -35,18 +35,16 @@ ****************************************************************************** */ +/* Includes ------------------------------------------------------------------*/ +#include "hts221_class.h" +#include "hts221.h" + +/* Methods -------------------------------------------------------------------*/ /* betzw - based on: - X-CUBE-MEMS1/trunk/Drivers/BSP/Components/hts221/hts221.c: revision #395, - X-CUBE-MEMS1/trunk: revision #402 + X-CUBE-MEMS1/trunk/Drivers/BSP/Components/hts221/hts221.c: revision #410, + X-CUBE-MEMS1/trunk: revision #416 */ -/* Includes ------------------------------------------------------------------*/ -#include "mbed.h" -#include "hts221_class.h" -#include "hts221.h" -#include "../../x_nucleo_iks01a1_targets.h" - -/* Methods -------------------------------------------------------------------*/ /** * @brief HTS221 Calibration procedure * @retval HUM_TEMP_OK in case of success, an error code otherwise
--- 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)
--- a/Components/hts221/readme.txt Wed Jun 10 18:03:42 2015 +0200 +++ b/Components/hts221/readme.txt Mon Jun 15 10:28:49 2015 +0200 @@ -1,3 +1,3 @@ hts221.h corresponds to: - X-CUBE-MEMS1/trunk/Drivers/BSP/Components/hts221/hts221.h: revision #402, -- X-CUBE-MEMS1/trunk: revision #402 +- X-CUBE-MEMS1/trunk: revision #416
--- a/Components/lis3mdl/lis3mdl_class.cpp Wed Jun 10 18:03:42 2015 +0200
+++ b/Components/lis3mdl/lis3mdl_class.cpp Mon Jun 15 10:28:49 2015 +0200
@@ -36,16 +36,15 @@
*/
/* Includes ------------------------------------------------------------------*/
-#include "mbed.h"
#include "lis3mdl_class.h"
#include "lis3mdl.h"
-#include "../../x_nucleo_iks01a1_targets.h"
/* Methods -------------------------------------------------------------------*/
/* betzw - based on:
X-CUBE-MEMS1/trunk/Drivers/BSP/Components/lis3mdl/lis3mdl.c: revision #400,
- X-CUBE-MEMS1/trunk: revision #402
+ X-CUBE-MEMS1/trunk: revision #416
*/
+
/**
* @brief Set LIS3MDL Initialization
* @param LIS3MDL_Init the configuration setting for the LIS3MDL
--- a/Components/lis3mdl/lis3mdl_class.h Wed Jun 10 18:03:42 2015 +0200 +++ b/Components/lis3mdl/lis3mdl_class.h Mon Jun 15 10:28:49 2015 +0200 @@ -41,8 +41,8 @@ /* Includes ------------------------------------------------------------------*/ #include "mbed.h" #include "DevI2C.h" +#include "lis3mdl.h" #include "../Interfaces/MagneticSensor.h" -#include "lis3mdl.h" /* Classes -------------------------------------------------------------------*/ /** Class representing a LIS3MDL sensor component @@ -101,12 +101,12 @@ } /** - * @brief Utility function to read data from LIS3MDL - * @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 MAGNETO_OK if ok, - * @retval MAGNETO_ERROR if an I2C error has occured + * @brief Utility function to read data from LIS3MDL + * @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 MAGNETO_OK if ok, + * @retval MAGNETO_ERROR if an I2C error has occured */ MAGNETO_StatusTypeDef LIS3MDL_IO_Read(uint8_t* pBuffer, uint8_t RegisterAddr, uint16_t NumByteToRead) @@ -122,12 +122,12 @@ } /** - * @brief Utility function to write data to LIS3MDL - * @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 MAGNETO_OK if ok, - * @retval MAGNETO_ERROR if an I2C error has occured + * @brief Utility function to write data to LIS3MDL + * @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 MAGNETO_OK if ok, + * @retval MAGNETO_ERROR if an I2C error has occured */ MAGNETO_StatusTypeDef LIS3MDL_IO_Write(uint8_t* pBuffer, uint8_t RegisterAddr, uint16_t NumByteToWrite)
--- a/Components/lis3mdl/readme.txt Wed Jun 10 18:03:42 2015 +0200 +++ b/Components/lis3mdl/readme.txt Mon Jun 15 10:28:49 2015 +0200 @@ -1,3 +1,3 @@ lis3mdl.h corresponds to: - X-CUBE-MEMS1/trunk/Drivers/BSP/Components/lis3mdl/lis3mdl.h: revision #402, -- X-CUBE-MEMS1/trunk: revision #402 +- X-CUBE-MEMS1/trunk: revision #416
--- a/Components/lps25h/lps25h_class.cpp Wed Jun 10 18:03:42 2015 +0200
+++ b/Components/lps25h/lps25h_class.cpp Mon Jun 15 10:28:49 2015 +0200
@@ -36,16 +36,15 @@
*/
/* Includes ------------------------------------------------------------------*/
-#include "mbed.h"
#include "lps25h_class.h"
#include "lps25h.h"
-#include "../../x_nucleo_iks01a1_targets.h"
/* Methods -------------------------------------------------------------------*/
/* betzw - based on:
X-CUBE-MEMS1/trunk/Drivers/BSP/Components/lps25h/lps25h.c: revision #400,
- X-CUBE-MEMS1/trunk: revision #402
+ X-CUBE-MEMS1/trunk: revision #416
*/
+
/**
* @brief Set LPS25H Initialization
* @param LPS25H_Init the configuration setting for the LPS25H
--- a/Components/lps25h/lps25h_class.h Wed Jun 10 18:03:42 2015 +0200
+++ b/Components/lps25h/lps25h_class.h Mon Jun 15 10:28:49 2015 +0200
@@ -41,9 +41,9 @@
/* Includes ------------------------------------------------------------------*/
#include "mbed.h"
#include "DevI2C.h"
+#include "lps25h.h"
#include "../Interfaces/PressureSensor.h"
#include "../Interfaces/TempSensor.h"
-#include "lps25h.h"
/* Classes -------------------------------------------------------------------*/
/** Class representing a LPS25H sensor component
@@ -122,7 +122,7 @@
/**
* @brief Configures LPS25H I2C interface
- * @retval PRESSURE_OK in case of success, an error code otherwise
+ * @return PRESSURE_OK in case of success, an error code otherwise
*/
PRESSURE_StatusTypeDef LPS25H_IO_Init(void)
{
@@ -130,12 +130,12 @@
}
/**
- * @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
+ * @brief Utility function to read data from LPS25H
+ * @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 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)
@@ -151,12 +151,12 @@
}
/**
- * @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
+ * @brief Utility function to write data to LPS25H
+ * @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 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)
--- a/Components/lps25h/readme.txt Wed Jun 10 18:03:42 2015 +0200 +++ b/Components/lps25h/readme.txt Mon Jun 15 10:28:49 2015 +0200 @@ -1,3 +1,3 @@ lps25h.h corresponds to: - X-CUBE-MEMS1/trunk/Drivers/BSP/Components/lps25h/lps25h.h: revision #402, -- X-CUBE-MEMS1/trunk: revision #402 +- X-CUBE-MEMS1/trunk: revision #416
--- a/Components/lsm6ds0/lsm6ds0_class.cpp Wed Jun 10 18:03:42 2015 +0200
+++ b/Components/lsm6ds0/lsm6ds0_class.cpp Mon Jun 15 10:28:49 2015 +0200
@@ -36,16 +36,15 @@
*/
/* Includes ------------------------------------------------------------------*/
-#include "mbed.h"
#include "lsm6ds0_class.h"
#include "lsm6ds0.h"
-#include "../../x_nucleo_iks01a1_targets.h"
/* Methods -------------------------------------------------------------------*/
/* betzw - based on:
X-CUBE-MEMS1/trunk/Drivers/BSP/Components/lsm6ds0/lsm6ds0.c: revision #400,
- X-CUBE-MEMS1/trunk: revision #402
+ X-CUBE-MEMS1/trunk: revision #416
*/
+
/**
* @brief Set LSM6DS0 Initialization
* @param LSM6DS0_Init the configuration setting for the LSM6DS0
--- a/Components/lsm6ds0/lsm6ds0_class.h Wed Jun 10 18:03:42 2015 +0200
+++ b/Components/lsm6ds0/lsm6ds0_class.h Mon Jun 15 10:28:49 2015 +0200
@@ -41,9 +41,9 @@
/* Includes ------------------------------------------------------------------*/
#include "mbed.h"
#include "DevI2C.h"
+#include "lsm6ds0.h"
#include "../Interfaces/GyroSensor.h"
#include "../Interfaces/MotionSensor.h"
-#include "lsm6ds0.h"
/* Classes -------------------------------------------------------------------*/
/** Class representing a LSM6DS0 sensor component
@@ -157,7 +157,7 @@
/**
* @brief Configures LSM6DS0 I2C interface
- * @retval IMU_6AXES_OK in case of success, an error code otherwise
+ * @return IMU_6AXES_OK in case of success, an error code otherwise
*/
IMU_6AXES_StatusTypeDef LSM6DS0_IO_Init(void)
{
@@ -165,12 +165,12 @@
}
/**
- * @brief Utility function to read data from LSM6DS0
- * @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 IMU_6AXES_OK if ok,
- * @retval IMU_6AXES_ERROR if an I2C error has occured
+ * @brief Utility function to read data from LSM6DS0
+ * @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 IMU_6AXES_OK if ok,
+ * @retval IMU_6AXES_ERROR if an I2C error has occured
*/
IMU_6AXES_StatusTypeDef LSM6DS0_IO_Read(uint8_t* pBuffer,
uint8_t RegisterAddr, uint16_t NumByteToRead)
@@ -186,12 +186,12 @@
}
/**
- * @brief Utility function to write data to LSM6DS0
- * @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 IMU_6AXES_OK if ok,
- * @retval IMU_6AXES_ERROR if an I2C error has occured
+ * @brief Utility function to write data to LSM6DS0
+ * @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 IMU_6AXES_OK if ok,
+ * @retval IMU_6AXES_ERROR if an I2C error has occured
*/
IMU_6AXES_StatusTypeDef LSM6DS0_IO_Write(uint8_t* pBuffer,
uint8_t RegisterAddr, uint16_t NumByteToWrite)
--- a/Components/lsm6ds0/readme.txt Wed Jun 10 18:03:42 2015 +0200 +++ b/Components/lsm6ds0/readme.txt Mon Jun 15 10:28:49 2015 +0200 @@ -1,3 +1,3 @@ lsm6ds0.h corresponds to: - X-CUBE-MEMS1/trunk/Drivers/BSP/Components/lsm6ds0/lsm6ds0.h: revision #402, -- X-CUBE-MEMS1/trunk: revision #402 +- X-CUBE-MEMS1/trunk: revision #416
--- a/Components/lsm6ds3/lsm6ds3_class.cpp Wed Jun 10 18:03:42 2015 +0200
+++ b/Components/lsm6ds3/lsm6ds3_class.cpp Mon Jun 15 10:28:49 2015 +0200
@@ -36,16 +36,15 @@
*/
/* Includes ------------------------------------------------------------------*/
-#include "mbed.h"
#include "lsm6ds3_class.h"
#include "lsm6ds3.h"
-#include "../../x_nucleo_iks01a1_targets.h"
/* Methods -------------------------------------------------------------------*/
/* betzw - based on:
X-CUBE-MEMS1/trunk/Drivers/BSP/Components/lsm6ds3/lsm6ds3.c: revision #400,
- X-CUBE-MEMS1/trunk: revision #410
+ X-CUBE-MEMS1/trunk: revision #416
*/
+
/**
* @brief Set LSM6DS3 Initialization
* @param LSM6DS3_Init the configuration setting for the LSM6DS3
--- a/Components/lsm6ds3/lsm6ds3_class.h Wed Jun 10 18:03:42 2015 +0200
+++ b/Components/lsm6ds3/lsm6ds3_class.h Mon Jun 15 10:28:49 2015 +0200
@@ -41,9 +41,9 @@
/* Includes ------------------------------------------------------------------*/
#include "mbed.h"
#include "DevI2C.h"
+#include "lsm6ds3.h"
#include "../Interfaces/GyroSensor.h"
#include "../Interfaces/MotionSensor.h"
-#include "lsm6ds3.h"
/* Classes -------------------------------------------------------------------*/
/** Class representing a LSM6DS3 sensor component
@@ -159,7 +159,6 @@
* @param[in] fptr A pointer to a void function, or 0 to set as none
*/
void Attach_Free_Fall_Detection_IRQ(void (*fptr)(void)) {
- free_fall.mode(PullNone); /* be precise about pin mode */
free_fall.rise(fptr);
}
@@ -206,12 +205,12 @@
*/
void LSM6DS3_IO_ITConfig(void)
{
- /* done in constructor */
+ free_fall.mode(PullNone); /* be precise about pin mode */
}
/**
* @brief Configures LSM6DS3 I2C interface
- * @retval IMU_6AXES_OK in case of success, an error code otherwise
+ * @return IMU_6AXES_OK in case of success, an error code otherwise
*/
IMU_6AXES_StatusTypeDef LSM6DS3_IO_Init(void)
{
@@ -219,12 +218,12 @@
}
/**
- * @brief Utility function to read data from LSM6DS3
- * @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 IMU_6AXES_OK if ok,
- * @retval IMU_6AXES_ERROR if an I2C error has occured
+ * @brief Utility function to read data from LSM6DS3
+ * @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 IMU_6AXES_OK if ok,
+ * @retval IMU_6AXES_ERROR if an I2C error has occured
*/
IMU_6AXES_StatusTypeDef LSM6DS3_IO_Read(uint8_t* pBuffer,
uint8_t RegisterAddr, uint16_t NumByteToRead)
@@ -240,12 +239,12 @@
}
/**
- * @brief Utility function to write data to LSM6DS3
- * @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 IMU_6AXES_OK if ok,
- * @retval IMU_6AXES_ERROR if an I2C error has occured
+ * @brief Utility function to write data to LSM6DS3
+ * @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 IMU_6AXES_OK if ok,
+ * @retval IMU_6AXES_ERROR if an I2C error has occured
*/
IMU_6AXES_StatusTypeDef LSM6DS3_IO_Write(uint8_t* pBuffer,
uint8_t RegisterAddr, uint16_t NumByteToWrite)
--- a/Components/lsm6ds3/readme.txt Wed Jun 10 18:03:42 2015 +0200 +++ b/Components/lsm6ds3/readme.txt Mon Jun 15 10:28:49 2015 +0200 @@ -1,3 +1,3 @@ lsm6ds0.h corresponds to: - X-CUBE-MEMS1/trunk/Drivers/BSP/Components/lsm6ds3/lsm6ds3.h: revision #402, -- X-CUBE-MEMS1/trunk: revision #410 +- X-CUBE-MEMS1/trunk: revision #416
--- a/x_nucleo_iks01a1.cpp Wed Jun 10 18:03:42 2015 +0200
+++ b/x_nucleo_iks01a1.cpp Mon Jun 15 10:28:49 2015 +0200
@@ -57,14 +57,14 @@
}
/**
- * @brief Get singleton instance
- * @return a pointer to the initialized singleton instance of class X_NUCLEO_IKS01A1
- * @param (optional) ext_i2c pointer to instance of DevI2C to be used
- * for communication on the expansion board.
- * Taken into account only on the very first call of this function.
- * If not provided a new DevI2C will be created with standard
- * configuration parameters.
- * The used DevI2C object gets saved in instance variable dev_i2c.
+ * @brief Get singleton instance
+ * @return a pointer to the initialized singleton instance of class X_NUCLEO_IKS01A1
+ * @param[in] ext_i2c (optional) pointer to an instance of DevI2C to be used
+ * for communication on the expansion board.
+ * Taken into account only on the very first call of this function.
+ * If not provided a new DevI2C will be created with standard
+ * configuration parameters.
+ * The used DevI2C object gets saved in instance variable dev_i2c.
*/
X_NUCLEO_IKS01A1* X_NUCLEO_IKS01A1::Instance(DevI2C *ext_i2c) {
if(_instance == NULL) {
