4 * This file is part of BeRTOS.
6 * Bertos is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
20 * As a special exception, you may use this file as part of a free software
21 * library without restriction. Specifically, if other files instantiate
22 * templates or use macros or inline functions from this file, or you compile
23 * this file and link it with other files to produce an executable, this
24 * file does not by itself cause the resulting executable to be covered by
25 * the GNU General Public License. This exception does not however
26 * invalidate any other reasons why the executable file might be covered by
27 * the GNU General Public License.
29 * Copyright 2004, 2005 Develer S.r.l. (http://www.develer.com/)
33 * \brief Thermo-control driver
37 * \author Giovanni Bajo <rasky@develer.com>
38 * \author Francesco Sacchi <batt@develer.com>
40 * This module implements multiple thermo controls, which is the logic needed to try
41 * keeping the temperature of a device constant. For this module, a "device" is a black box
42 * whose temperature can be measured, and which has a mean to make it hotter or colder.
43 * For instance, a device could be the combination of a NTC (analog temperature reader) and
44 * a Peltier connected to the same physic block.
46 * This module relies on a low-level driver to communicate with the device (implementation
47 * of the black box). This low-level driver also controls the units in which the temperature
48 * is expressed: thermo control treats it just as a number.
55 #include "hw/thermo_map.h"
59 void thermo_init(void);
63 * Set the target temperature at which a given device should be kept.
66 * \param temperature Target temperature
68 void thermo_setTarget(ThermoDev dev, deg_t temperature);
70 /** Start thermo control for a certain device \a dev */
71 void thermo_start(ThermoDev dev);
73 /** Stop thermo control for a certain device \a dev */
74 void thermo_stop(ThermoDev dev);
76 /** Clear errors for channel \a dev */
77 void thermo_clearErrors(ThermoDev dev);
79 /** Return the status of the specific \a dev thermo-device. */
80 thermostatus_t thermo_status(ThermoDev dev);
83 * Return the current temperature of a device currently under thermo
87 * \return Current temperature (Celsius degrees * 10)
89 deg_t thermo_readTemperature(ThermoDev dev);
92 #endif /* DRV_THERMO_H */