From 08fa41749ed577e71f04854e5176ae61fd7c036b Mon Sep 17 00:00:00 2001
From: Stephane D'Alu <sdalu@sdalu.com>
Date: Mon, 8 Feb 2016 12:13:15 +0100
Subject: [PATCH] changed file layout, move startup/bootup time to #define

---
 .../sensors/{hdc1000 => }/hdc1000.c           |  0
 .../sensors/{hdc1000 => }/hdc1000.h           |  0
 .../sensors/{mcp9808 => }/mcp9808.c           |  0
 .../sensors/{mcp9808 => }/mcp9808.h           | 38 +++++------------
 os/various/{ => devices_lib/sensors}/sensor.h | 41 +++++++++++++++++++
 .../sensors/{tsl2561 => }/tsl2561.c           |  3 --
 .../sensors/{tsl2561 => }/tsl2561.h           | 12 +++++-
 7 files changed, 63 insertions(+), 31 deletions(-)
 rename os/various/devices_lib/sensors/{hdc1000 => }/hdc1000.c (100%)
 rename os/various/devices_lib/sensors/{hdc1000 => }/hdc1000.h (100%)
 rename os/various/devices_lib/sensors/{mcp9808 => }/mcp9808.c (100%)
 rename os/various/devices_lib/sensors/{mcp9808 => }/mcp9808.h (90%)
 rename os/various/{ => devices_lib/sensors}/sensor.h (53%)
 rename os/various/devices_lib/sensors/{tsl2561 => }/tsl2561.c (99%)
 rename os/various/devices_lib/sensors/{tsl2561 => }/tsl2561.h (96%)

diff --git a/os/various/devices_lib/sensors/hdc1000/hdc1000.c b/os/various/devices_lib/sensors/hdc1000.c
similarity index 100%
rename from os/various/devices_lib/sensors/hdc1000/hdc1000.c
rename to os/various/devices_lib/sensors/hdc1000.c
diff --git a/os/various/devices_lib/sensors/hdc1000/hdc1000.h b/os/various/devices_lib/sensors/hdc1000.h
similarity index 100%
rename from os/various/devices_lib/sensors/hdc1000/hdc1000.h
rename to os/various/devices_lib/sensors/hdc1000.h
diff --git a/os/various/devices_lib/sensors/mcp9808/mcp9808.c b/os/various/devices_lib/sensors/mcp9808.c
similarity index 100%
rename from os/various/devices_lib/sensors/mcp9808/mcp9808.c
rename to os/various/devices_lib/sensors/mcp9808.c
diff --git a/os/various/devices_lib/sensors/mcp9808/mcp9808.h b/os/various/devices_lib/sensors/mcp9808.h
similarity index 90%
rename from os/various/devices_lib/sensors/mcp9808/mcp9808.h
rename to os/various/devices_lib/sensors/mcp9808.h
index 2d488d76..3bae5d23 100644
--- a/os/various/devices_lib/sensors/mcp9808/mcp9808.h
+++ b/os/various/devices_lib/sensors/mcp9808.h
@@ -16,8 +16,17 @@
 #define MCP9808_CONTINUOUS_ACQUISITION_SUPPORTED   TRUE
 
 
-#define MCP9808_I2CADDR               0x18
+#define MCP9808_I2CADDR_FIXED           0x18
 
+/**
+ * @brief Time necessary for the sensor to boot
+ */
+#define MCP9808_BOOTUP_TIME		0
+
+/**
+ * @brief Time necessary for the sensor to start
+ */
+#define MCP9808_STARTUP_TIME		0
 
 /*===========================================================================*/
 /* Driver pre-compile time settings.                                         */
@@ -27,7 +36,7 @@
 /* Derived constants and error checks.                                       */
 /*===========================================================================*/
 
-#define MCP9808_I2CADDR_DEFAULT       MCP9808_I2CADDR
+#define MCP9808_I2CADDR_DEFAULT       MCP9808_I2CADDR_FIXED
 
 /*===========================================================================*/
 /* Driver data structures and types.                                         */
@@ -110,31 +119,6 @@ msg_t
 MCP9808_setResolution(MCP9808_drv *drv,
 	MCP9808_resolution_t res);
 
-/**
- * @brief Time necessary for the sensor to boot
- *
- * @returns
- *   unsigned int   time in millis-seconds
- */
-
-static inline unsigned int
-MCP9808_getBootupTime(MCP9808_drv *drv) {
-    (void)drv;
-    return 0; /* no info found */
-};
-
-/**
- * @brief Time necessary the sensor to for starting
- *
- * @returns
- *   unsigned int   time in millis-seconds
- */
-static inline unsigned int
-MCP9808_getStartupTime(MCP9808_drv *drv) {
-    (void)drv;
-    return 0; /* no info found */
-};
-
 /**
  * @brief Time in milli-seconds necessary for acquiring a naw measure
  *
diff --git a/os/various/sensor.h b/os/various/devices_lib/sensors/sensor.h
similarity index 53%
rename from os/various/sensor.h
rename to os/various/devices_lib/sensors/sensor.h
index 7e776441..6ffa5a48 100644
--- a/os/various/sensor.h
+++ b/os/various/devices_lib/sensors/sensor.h
@@ -1,3 +1,44 @@
+/**
+ * 
+ * Example of function calls.
+ *
+ * @code
+ * static SENSOR_config sensor_config = {
+ * };
+ * static SENSOR_drv    sensor_drv;
+ * @endcode
+ *
+ * 
+ * @code
+ * osalThreadSleepMilliseconds(SENSOR_BOOTUP_TIME);
+ * SENSOR_init(&sensor_drv);
+ * @endcode
+ *
+ * @code
+ * SENSOR_start(&sensor_drv, &sensor_config);
+ * osalThreadSleepMilliseconds(SENSOR_STARTUP_TIME);
+ * @endcode
+ *
+ * If using SENSOR_startMeasure()/SENSOR_readMeasure()
+ * @code
+ * while(true) {
+ *   SENSOR_startMeasure(&sensor_drv);
+ *   osalThreadSleepMilliseconds(SENSOR_getAcquisitionTime());
+ *   SENSOR_readMeasure(&sensor_drv, ...);
+ * }
+ * @endcode
+ *
+ * If using SENSOR_readValue() or SENSOR_getValue()
+ * @code
+ * #if SENSOR_CONTINUOUS_ACQUISITION_SUPPORTED == TRUE
+ * osalThreadSleepMilliseconds(SENSOR_getAcquisitionTime())
+ * #endif
+ * 
+ * while(true) {
+ *   SENSOR_readValue(&sensor_drv, ...);
+ * }
+ * @encode
+ */
 #ifndef _SENSOR_H_
 #define _SENSOR_H_
 
diff --git a/os/various/devices_lib/sensors/tsl2561/tsl2561.c b/os/various/devices_lib/sensors/tsl2561.c
similarity index 99%
rename from os/various/devices_lib/sensors/tsl2561/tsl2561.c
rename to os/various/devices_lib/sensors/tsl2561.c
index e8372c08..f67823ab 100644
--- a/os/various/devices_lib/sensors/tsl2561/tsl2561.c
+++ b/os/various/devices_lib/sensors/tsl2561.c
@@ -249,9 +249,6 @@ _readChannel(TSL2561_drv *drv, uint16_t *broadband, uint16_t *ir) {
 				  TSL2561_REG_CHAN1_LOW,
 				  ir       )) < MSG_OK))
 	return msg;
-
-
-    chprintf(&SD1, "CHANNELS : %x, %x\r\n", *broadband, *ir);
     return MSG_OK;
 }
 
diff --git a/os/various/devices_lib/sensors/tsl2561/tsl2561.h b/os/various/devices_lib/sensors/tsl2561.h
similarity index 96%
rename from os/various/devices_lib/sensors/tsl2561/tsl2561.h
rename to os/various/devices_lib/sensors/tsl2561.h
index 16e63d33..d91fb4a2 100644
--- a/os/various/devices_lib/sensors/tsl2561/tsl2561.h
+++ b/os/various/devices_lib/sensors/tsl2561.h
@@ -26,11 +26,21 @@
 #define TSL2561_OVERLOADED        (-1)
 
 
-// I2C address
+/* I2C address */
 #define TSL2561_I2CADDR_LOW          (0x29)
 #define TSL2561_I2CADDR_FLOAT        (0x39)
 #define TSL2561_I2CADDR_HIGH         (0x49)
 
+/**
+ * @brief Time necessary for the sensor to boot
+ */
+#define TSL2561_BOOTUP_TIME		0
+
+/**
+ * @brief Time necessary for the sensor to start
+ */
+#define TSL2561_STARTUP_TIME		0
+
 
 
 /*===========================================================================*/