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 48:cb18488509a5, committed 2015-06-08

Comitter:
Wolfgang Betz
Date:
Mon Jun 08 17:37:59 2015 +0200
Parent:
46:badcff0675e8
Child:
49:d77c54dd9dee
Child:
50:f507d4465c31
Commit message:
Added important comment

Changed in this revision

Components/Interfaces/GenericSensor.h Show annotated file Show diff for this revision Revisions of this file 
--- a/Components/Interfaces/GenericSensor.h	Mon Jun 08 17:22:35 2015 +0200
+++ b/Components/Interfaces/GenericSensor.h	Mon Jun 08 17:37:59 2015 +0200
@@ -57,26 +57,28 @@
 	virtual int Init(void *ptr) = 0;
 
 	/**
-	 * @brief       Enter sensor shutdown mode
-	 * @return      0 in case of success, an error code otherwise
-	 */
-	virtual int PowerOff(void) = 0;
-	
-	/**
 	 * @brief       Get ID of sensor
 	 * @param[out]  id Pointer to where to store the ID to
 	 * @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 */
-	/* betzw - TODO: WIP */
 	virtual void ConfigIT(uint16_t) = 0;
 	virtual void EnableIT(uint8_t) = 0;
 	virtual void DisableIT(uint8_t) = 0;
@@ -86,6 +88,7 @@
 	/**
 	 * @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;
 };