Add test function prototype.

[bertos.git] / bertos / drv / thermo.h

diff --git a/bertos/drv/thermo.h b/bertos/drv/thermo.h
index 9fc20e0dd7b19dfce7898c4949e2133e1426980e..02b1ccbcad4f4ff034d4b3c1e916a28405dab5c5 100644 (file)
--- a/bertos/drv/thermo.h
+++ b/bertos/drv/thermo.h
@@ -26,16 +26,11 @@
  * invalidate any other reasons why the executable file might be covered by
  * the GNU General Public License.
  *
- * Copyright 2004, 2005 Develer S.r.l. (http://www.develer.com/)
+ * Copyright 2004, 2005, 2009 Develer S.r.l. (http://www.develer.com/)
  *
  * -->
  *
- * \brief Thermo-control driver
- *
- * \version $Id$
- *
- * \author Giovanni Bajo <rasky@develer.com>
- * \author Francesco Sacchi <batt@develer.com>
+ * \brief Thermo-control driver.
  *
  * This module implements multiple thermo controls, which is the logic needed to try
  * keeping the temperature of a device constant. For this module, a "device" is a black box
@@ -47,6 +42,15 @@
  * of the black box). This low-level driver also controls the units in which the temperature
  * is expressed: thermo control treats it just as a number.
  *
+ *
+ * \author Giovanni Bajo <rasky@develer.com>
+ * \author Francesco Sacchi <batt@develer.com>
+ * \author Daniele Basile <asterix@develer.com>
+ *
+ * $WIZ$ module_name = "thermo"
+ * $WIZ$ module_depends = "timer", "ntc"
+ * $WIZ$ module_configuration = "bertos/cfg/cfg_thermo.h"
+ * $WIZ$ module_hw = "bertos/hw/hw_thermo.h", "bertos/hw/thermo_map.h"
  */
 
 #ifndef DRV_THERMO_H
@@ -55,8 +59,9 @@
 #include "hw/thermo_map.h"
 
 #include <drv/ntc.h>
+#include <drv/timer.h>
 
-void thermo_init(void);
+typedef uint8_t thermostatus_t;
 
 
 /**
@@ -67,6 +72,12 @@ void thermo_init(void);
  */
 void thermo_setTarget(ThermoDev dev, deg_t temperature);
 
+/**
+ * Start thermo control for a certain device \a dev and stop it after
+ *  \a on_time msec.
+ */
+void thermo_timer(ThermoDev dev, mtime_t on_time);
+
 /** Start thermo control for a certain device \a dev */
 void thermo_start(ThermoDev dev);
 
@@ -88,5 +99,7 @@ thermostatus_t thermo_status(ThermoDev dev);
  */
 deg_t thermo_readTemperature(ThermoDev dev);
 
+void thermo_init(void);
+
 
 #endif /* DRV_THERMO_H */