Remove uneeded debug string.

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

diff --git a/bertos/drv/thermo.h b/bertos/drv/thermo.h
index 693c086dbf4884a40515863dab3a5d0448672dc8..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,46 +42,26 @@
  * 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"
  */
 
-/*#*
- *#* $Log$
- *#* Revision 1.3  2006/09/20 20:12:41  marco
- *#* Names convention, MOD_* macros.
- *#*
- *#* Revision 1.2  2006/07/19 12:56:26  bernie
- *#* Convert to new Doxygen style.
- *#*
- *#* Revision 1.1  2005/11/04 17:59:47  bernie
- *#* Import into DevLib.
- *#*
- *#* Revision 1.2  2005/06/14 10:13:36  batt
- *#* Better thermo errors handling.
- *#*
- *#* Revision 1.1  2005/05/24 09:17:58  batt
- *#* Move drivers to top-level.
- *#*
- *#* Revision 1.4  2005/05/10 16:55:10  batt
- *#* Add timeout to thermo-regulator; better thermo control handling; change thermo_getStatus() to thermo_status().
- *#*
- *#* Revision 1.3  2005/05/10 09:26:54  batt
- *#* Add thermo_getStatus for getting status/errors of thermo control.
- *#*
- *#* Revision 1.2  2005/05/09 19:18:40  batt
- *#* Remove old logs.
- *#*
- *#* Revision 1.1  2005/05/09 16:40:44  batt
- *#* Add thermo-control driver
- *#*/
-
-
 #ifndef DRV_THERMO_H
 #define DRV_THERMO_H
 
+#include "hw/thermo_map.h"
+
 #include <drv/ntc.h>
-#include <thermo_map.h>
+#include <drv/timer.h>
 
-void thermo_init(void);
+typedef uint8_t thermostatus_t;
 
 
 /**
@@ -97,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);
 
@@ -118,5 +99,7 @@ thermostatus_t thermo_status(ThermoDev dev);
  */
 deg_t thermo_readTemperature(ThermoDev dev);
 
+void thermo_init(void);
+
 
 #endif /* DRV_THERMO_H */