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 50:f507d4465c31, committed 2015-06-08

Comitter:
Wolfgang Betz
Date:
Mon Jun 08 18:04:19 2015 +0200
Parent:
48:cb18488509a5
Child:
51:74002d89e4d9
Child:
52:54553fd15b50
Commit message:
Cleanup interfaces from not yet comfirmed methods

Potential generic methods to be put into interface classes from which to
derive other interfaces from are (among others):
- virtual int PowerOff(void) { /* not yet implemented */ return 0; }
- virtual int Reset(void) { /* not yet implemented */ return 0; }

- virtual void ConfigIT(uint16_t) { /* not yet implemented */ }
- virtual void EnableIT(uint8_t) { /* not yet implemented */ }
- virtual void DisableIT(uint8_t) { /* not yet implemented */ }
- virtual uint8_t ITStatus(uint16_t, uint16_t) { /* not yet implemented */ return 0; }
- virtual void ClearIT(uint16_t, uint16_t) { /* not yet implemented */ }
- virtual void AttachIT(void (*fptr)(void)) { /* not yet implemented */ }

Changed in this revision

Components/Interfaces/GenericSensor.h Show annotated file Show diff for this revision Revisions of this file
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/Interfaces/GenericSensor.h	Mon Jun 08 17:37:59 2015 +0200
+++ b/Components/Interfaces/GenericSensor.h	Mon Jun 08 18:04:19 2015 +0200
@@ -62,35 +62,6 @@
 	 * @return      0 in case of success, an error code otherwise
 	 */
 	virtual int ReadID(uint8_t *id) = 0;
-
-	/*** betzw - TODO / NOTE: beyond code is still WIP and not confirmed yet!!! ***/
-	/**
-	 * @brief       Enter sensor shutdown mode
-	 * @return      0 in case of success, an error code otherwise
-	 * @note        not confirmed yet (WIP)
-	 */
-	virtual int PowerOff(void) = 0;
-	
-	/**
-	 * @brief       Reset sensor
-	 * @return      0 in case of success, an error code otherwise
-	 * @note        not confirmed yet (WIP)
-	 */
-	virtual int Reset(void) = 0;
-
-	/* Interrupt Interface */
-	virtual void ConfigIT(uint16_t) = 0;
-	virtual void EnableIT(uint8_t) = 0;
-	virtual void DisableIT(uint8_t) = 0;
-	virtual uint8_t ITStatus(uint16_t, uint16_t) = 0;
-	virtual void ClearIT(uint16_t, uint16_t) = 0;
-
-	/**
-	 * @brief       Attach a function to be called when an interrupt occurs
-	 * @param[in]   fptr A pointer to a void function, or 0 to set as none
-	 * @note        not confirmed yet (WIP)
-	 */
-	virtual void AttachIT(void (*fptr)(void)) = 0;
 };
 
 #endif /* __GENERIC_SENSOR_CLASS_H */

--- a/Components/hts221/hts221_class.h	Mon Jun 08 17:37:59 2015 +0200
+++ b/Components/hts221/hts221_class.h	Mon Jun 08 18:04:19 2015 +0200
@@ -67,6 +67,10 @@
 		return HTS221_Init((HUM_TEMP_InitTypeDef*)init_struct);
 	}
 
+	/**
+	 * @brief       Enter sensor shutdown mode
+	 * @return      0 in case of success, an error code otherwise
+	 */
 	virtual int PowerOff(void) {
 		return HTS221_Power_OFF();
 	}
@@ -75,6 +79,10 @@
 		return HTS221_ReadID(ht_id);
 	}
 
+	/**
+	 * @brief       Reset sensor
+	 * @return      0 in case of success, an error code otherwise
+	 */
 	virtual int Reset(void) {
 		return HTS221_RebootCmd();
 	}
@@ -87,13 +95,6 @@
 		return HTS221_GetTemperature(pfData);
 	}
 
-	virtual void ConfigIT(uint16_t) { /* not yet implemented */ }
-	virtual void EnableIT(uint8_t) { /* not yet implemented */ }
-	virtual void DisableIT(uint8_t) { /* not yet implemented */ }
-	virtual uint8_t ITStatus(uint16_t, uint16_t) { /* not yet implemented */ return 0; }
-	virtual void ClearIT(uint16_t, uint16_t) { /* not yet implemented */ }
-	virtual void AttachIT(void (*fptr)(void)) { /* not yet implemented */ }
-
  protected:
 	/*** Methods ***/
 	HUM_TEMP_StatusTypeDef HTS221_Init(HUM_TEMP_InitTypeDef *HTS221_Init);

--- a/Components/lis3mdl/lis3mdl_class.h	Mon Jun 08 17:37:59 2015 +0200
+++ b/Components/lis3mdl/lis3mdl_class.h	Mon Jun 08 18:04:19 2015 +0200
@@ -76,16 +76,6 @@
 		return LIS3MDL_M_GetAxesRaw(pData);
 	}
 
-	virtual int PowerOff(void) { /* not yet implemented */ return 0; }
-	virtual int Reset(void) { /* not yet implemented */ return 0; }
-
-	virtual void ConfigIT(uint16_t) { /* not yet implemented */ }
-	virtual void EnableIT(uint8_t) { /* not yet implemented */ }
-	virtual void DisableIT(uint8_t) { /* not yet implemented */ }
-	virtual uint8_t ITStatus(uint16_t, uint16_t) { /* not yet implemented */ return 0; }
-	virtual void ClearIT(uint16_t, uint16_t) { /* not yet implemented */ }
-	virtual void AttachIT(void (*fptr)(void)) { /* not yet implemented */ }
-
  protected:
 	/*** Methods ***/
 	MAGNETO_StatusTypeDef LIS3MDL_Init(MAGNETO_InitTypeDef *LIS3MDL_Init);

--- a/Components/lps25h/lps25h_class.h	Mon Jun 08 17:37:59 2015 +0200
+++ b/Components/lps25h/lps25h_class.h	Mon Jun 08 18:04:19 2015 +0200
@@ -66,6 +66,10 @@
 		return LPS25H_Init((PRESSURE_InitTypeDef*)init_struct);
 	}
 
+	/**
+	 * @brief       Enter sensor shutdown mode
+	 * @return      0 in case of success, an error code otherwise
+	 */
 	virtual int PowerOff(void) {
 		return LPS25H_PowerOff();
 	}
@@ -74,16 +78,14 @@
 		return LPS25H_ReadID(p_id);
 	}
 
+	/**
+	 * @brief       Reset sensor
+	 * @return      0 in case of success, an error code otherwise
+	 */
 	virtual int Reset(void) {
 		return LPS25H_RebootCmd();
 	}
 
-	virtual void ConfigIT(uint16_t) { /* not yet implemented */ }
-	virtual void EnableIT(uint8_t) { /* not yet implemented */ }
-	virtual void DisableIT(uint8_t) { /* not yet implemented */ }
-	virtual uint8_t ITStatus(uint16_t, uint16_t) { /* not yet implemented */ return 0; }
-	virtual void ClearIT(uint16_t, uint16_t) { /* not yet implemented */ }
-    
 	virtual int GetPressure(float *pfData) {
 		return LPS25H_GetPressure(pfData);
 	}
@@ -92,8 +94,6 @@
 		return LPS25H_GetTemperature(pfData);
 	}
 
-	virtual void AttachIT(void (*fptr)(void)) { /* not yet implemented */ }
-
 	void SlaveAddrRemap(uint8_t SA0_Bit_Status) {
 		LPS25H_SlaveAddrRemap(SA0_Bit_Status);
 	}

--- a/Components/lsm6ds0/lsm6ds0_class.h	Mon Jun 08 17:37:59 2015 +0200
+++ b/Components/lsm6ds0/lsm6ds0_class.h	Mon Jun 08 18:04:19 2015 +0200
@@ -125,16 +125,6 @@
 		return LSM6DS0_G_Set_FS(fullScale);
 	}
 
-	virtual int PowerOff(void) { /* not yet implemented */ return 0; }
-	virtual int Reset(void) { /* not yet implemented */ return 0; }
-
-	virtual void ConfigIT(uint16_t) { /* not yet implemented */ }
-	virtual void EnableIT(uint8_t) { /* not yet implemented */ }
-	virtual void DisableIT(uint8_t) { /* not yet implemented */ }
-	virtual uint8_t ITStatus(uint16_t, uint16_t) { /* not yet implemented */ return 0; }
-	virtual void ClearIT(uint16_t, uint16_t) { /* not yet implemented */ }
-	virtual void AttachIT(void (*fptr)(void)) { /* not yet implemented */ }
-
  protected:
 	/*** Methods ***/
 	IMU_6AXES_StatusTypeDef LSM6DS0_Init(IMU_6AXES_InitTypeDef *LSM6DS0_Init);

--- a/Components/lsm6ds3/lsm6ds3_class.h	Mon Jun 08 17:37:59 2015 +0200
+++ b/Components/lsm6ds3/lsm6ds3_class.h	Mon Jun 08 18:04:19 2015 +0200
@@ -138,16 +138,6 @@
 		return LSM6DS3_Get_Status_Free_Fall_Detection(status);
 	}
 
-	virtual int PowerOff(void) { /* not yet implemented */ return 0; }
-	virtual int Reset(void) { /* not yet implemented */ return 0; }
-
-	virtual void ConfigIT(uint16_t) { /* not yet implemented */ }
-	virtual void EnableIT(uint8_t) { /* not yet implemented */ }
-	virtual void DisableIT(uint8_t) { /* not yet implemented */ }
-	virtual uint8_t ITStatus(uint16_t, uint16_t) { /* not yet implemented */ return 0; }
-	virtual void ClearIT(uint16_t, uint16_t) { /* not yet implemented */ }
-	virtual void AttachIT(void (*fptr)(void)) { /* not yet implemented */ }
-
  protected:
 	/*** Methods ***/
 	IMU_6AXES_StatusTypeDef LSM6DS3_Init(IMU_6AXES_InitTypeDef *LSM6DS3_Init);