Mike Fiore / X_NUCLEO_IKS01A1

removed X-NUCLEO-COMMON and ST-INTERFACES

Dependents:   unh-hackathon-example unh-hackathon-example-raw

Fork of X_NUCLEO_IKS01A1 by ST

Files at this revision

API Documentation at this revision

Revision 54:2a676c734b30, committed 2015-06-10

Comitter:
Wolfgang Betz
Date:
Wed Jun 10 18:03:42 2015 +0200
Parent:
52:54553fd15b50
Child:
55:aa12ca2004ac
Child:
57:04563dd74269
Commit message:
Comment additional public methods of class LSM6DS3 & other doxygen improvements

Changed in this revision

Components/hts221/hts221_class.h Show annotated file Show diff for this revision Revisions of this file
Components/lis3mdl/lis3mdl_class.h Show annotated file Show diff for this revision Revisions of this file
Components/lps25h/lps25h_class.h Show annotated file Show diff for this revision Revisions of this file
Components/lsm6ds0/lsm6ds0_class.h Show annotated file Show diff for this revision Revisions of this file
Components/lsm6ds3/lsm6ds3_class.h Show annotated file Show diff for this revision Revisions of this file 
--- a/Components/hts221/hts221_class.h	Wed Jun 10 16:44:54 2015 +0200
+++ b/Components/hts221/hts221_class.h	Wed Jun 10 18:03:42 2015 +0200
@@ -51,7 +51,7 @@
 class HTS221 : public HumiditySensor, public TempSensor {
  public:
 	/** Constructor
-	 * @param i2c device I2C to be used for communication
+	 * @param[in] i2c device I2C to be used for communication
 	 */
         HTS221(DevI2C &i2c) : HumiditySensor(), TempSensor(), dev_i2c(i2c) {
 		T0_degC = T1_degC = H0_rh = H1_rh = 0.0;
@@ -109,8 +109,6 @@
 
 	/**
 	 * @brief  Configures HTS221 interrupt lines for NUCLEO boards
-	 * @param  None
-	 * @retval None
 	 */
 	void HTS221_IO_ITConfig(void)
 	{
@@ -119,7 +117,6 @@
 
 	/**
 	 * @brief  Configures HTS221 I2C interface
-	 * @param  None
 	 * @retval HUM_TEMP_OK in case of success, an error code otherwise
 	 */
 	HUM_TEMP_StatusTypeDef HTS221_IO_Init(void)
@@ -128,11 +125,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 HUM_TEMP_OK if ok, HUM_TEMP_ERROR if an I2C error has occured
+	 * @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
 	 */
 	HUM_TEMP_StatusTypeDef HTS221_IO_Read(uint8_t* pBuffer, 
 					      uint8_t RegisterAddr, uint16_t NumByteToRead)
@@ -148,11 +146,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 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
 	 */
 	HUM_TEMP_StatusTypeDef HTS221_IO_Write(uint8_t* pBuffer, 
 					       uint8_t RegisterAddr, uint16_t NumByteToWrite)

--- a/Components/lis3mdl/lis3mdl_class.h	Wed Jun 10 16:44:54 2015 +0200
+++ b/Components/lis3mdl/lis3mdl_class.h	Wed Jun 10 18:03:42 2015 +0200
@@ -50,7 +50,7 @@
 class LIS3MDL : public MagneticSensor {
  public:
 	/** Constructor
-	 * @param i2c device I2C to be used for communication
+	 * @param[in] i2c device I2C to be used for communication
 	 */
         LIS3MDL(DevI2C &i2c) : MagneticSensor(), dev_i2c(i2c) {
 	}
@@ -101,11 +101,11 @@
 	}
 
 	/**
-	 * @brief utility function to read data from STC3115
-	 * @param  pBuffer pointer to data to be read.
+	 * @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_OK if ok, 
 	 * @retval MAGNETO_ERROR if an I2C error has occured
 	 */
 	MAGNETO_StatusTypeDef LIS3MDL_IO_Read(uint8_t* pBuffer, 
@@ -122,11 +122,11 @@
 	}
 	
 	/**
-	 * @brief utility function to write data to STC3115
-	 * @param  pBuffer pointer to buffer to be filled.
+	 * @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_OK if ok, 
 	 * @retval MAGNETO_ERROR if an I2C error has occured
 	 */
 	MAGNETO_StatusTypeDef LIS3MDL_IO_Write(uint8_t* pBuffer, 

--- 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)

--- a/Components/lsm6ds0/lsm6ds0_class.h	Wed Jun 10 16:44:54 2015 +0200
+++ b/Components/lsm6ds0/lsm6ds0_class.h	Wed Jun 10 18:03:42 2015 +0200
@@ -51,7 +51,7 @@
 class LSM6DS0 : public GyroSensor, public MotionSensor {
  public:
 	/** Constructor
-	 * @param i2c device I2C to be used for communication
+	 * @param[in] i2c device I2C to be used for communication
 	 */
         LSM6DS0(DevI2C &i2c) : GyroSensor(), MotionSensor(), dev_i2c(i2c) {
 	}
@@ -149,8 +149,6 @@
 
 	/**
 	 * @brief  Configures LSM6DS0 interrupt lines for NUCLEO boards
-	 * @param  None
-	 * @retval None
 	 */
 	void LSM6DS0_IO_ITConfig(void)
 	{
@@ -159,7 +157,6 @@
 
 	/**
 	 * @brief  Configures LSM6DS0 I2C interface
-	 * @param  None
 	 * @retval IMU_6AXES_OK in case of success, an error code otherwise
 	 */
 	IMU_6AXES_StatusTypeDef LSM6DS0_IO_Init(void)
@@ -168,11 +165,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 IMU_6AXES_OK if ok, IMU_6AXES_ERROR if an I2C error has occured
+	 * @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
 	 */
 	IMU_6AXES_StatusTypeDef LSM6DS0_IO_Read(uint8_t* pBuffer, 
 					      uint8_t RegisterAddr, uint16_t NumByteToRead)
@@ -188,11 +186,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 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
 	 */
 	IMU_6AXES_StatusTypeDef LSM6DS0_IO_Write(uint8_t* pBuffer, 
 					       uint8_t RegisterAddr, uint16_t NumByteToWrite)

--- a/Components/lsm6ds3/lsm6ds3_class.h	Wed Jun 10 16:44:54 2015 +0200
+++ b/Components/lsm6ds3/lsm6ds3_class.h	Wed Jun 10 18:03:42 2015 +0200
@@ -51,7 +51,8 @@
 class LSM6DS3 : public GyroSensor, public MotionSensor {
  public:
 	/** Constructor
-	 * @param i2c device I2C to be used for communication
+	 * @param[in] i2c device I2C to be used for communication
+	 * @param[in] irq_pin pin name for free fall detection interrupt
 	 */
         LSM6DS3(DevI2C &i2c, PinName irq_pin) : GyroSensor(), MotionSensor(), 
 		dev_i2c(i2c), free_fall(irq_pin) {
@@ -127,21 +128,35 @@
 	}
 
 	/* Additional Public Methods */
+	/**
+	 * @brief  Enable free fall detection
+	 * @return IMU_6AXES_OK in case of success, an error code otherwise
+	 */
 	IMU_6AXES_StatusTypeDef Enable_Free_Fall_Detection(void) {
 		return LSM6DS3_Enable_Free_Fall_Detection();
 	}
 
+	/**
+	 * @brief  Disable free fall detection
+	 * @return IMU_6AXES_OK in case of success, an error code otherwise
+	 */
 	IMU_6AXES_StatusTypeDef Disable_Free_Fall_Detection(void) {
 		return LSM6DS3_Disable_Free_Fall_Detection();
 	}
 
+	/**
+	 * @brief       Get status of free fall detection
+	 * @param[out]  status the pointer where the status of free fall detection is stored; 
+	 *              0 means no detection, 1 means detection happened
+	 * @return      IMU_6AXES_OK in case of success, an error code otherwise
+	 */
 	IMU_6AXES_StatusTypeDef Get_Status_Free_Fall_Detection(uint8_t *status) {
 		return LSM6DS3_Get_Status_Free_Fall_Detection(status);
 	}
 	
 	/** Attach a function to call when a free fall is detected
 	 *
-	 *  @param fptr A pointer to a void function, or 0 to set as none
+	 *  @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 */
@@ -188,8 +203,6 @@
 
 	/**
 	 * @brief  Configures LSM6DS3 interrupt lines for NUCLEO boards
-	 * @param  None
-	 * @retval None
 	 */
 	void LSM6DS3_IO_ITConfig(void)
 	{
@@ -198,7 +211,6 @@
 
 	/**
 	 * @brief  Configures LSM6DS3 I2C interface
-	 * @param  None
 	 * @retval IMU_6AXES_OK in case of success, an error code otherwise
 	 */
 	IMU_6AXES_StatusTypeDef LSM6DS3_IO_Init(void)
@@ -207,11 +219,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 IMU_6AXES_OK if ok, IMU_6AXES_ERROR if an I2C error has occured
+	 * @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
 	 */
 	IMU_6AXES_StatusTypeDef LSM6DS3_IO_Read(uint8_t* pBuffer, 
 					      uint8_t RegisterAddr, uint16_t NumByteToRead)
@@ -227,11 +240,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 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
 	 */
 	IMU_6AXES_StatusTypeDef LSM6DS3_IO_Write(uint8_t* pBuffer, 
 					       uint8_t RegisterAddr, uint16_t NumByteToWrite)