Initial commit
[breezed.git] / README.txt
1
2    Breezed is a small daemon to control the speed of the fan,
3    depending on the current temperature of the computer. I have tested
4    it only on a Thinkpad X61s.
5
6  * INSTALLATION
7
8    You can install it simply by running as root
9
10      ./install.sh
11
12    and de-install it with
13
14      ./remove.sh
15
16    You must have a configuration file in /etc/breezed.conf. Only one
17    is currently provided in the archive, and it corresponds to the
18    settings _I_ picked for _my_ Lenovo X61s.
19
20    I have no idea if these settings are safe on this laptop (I guess
21    so, since I have been using them for a few months now and it works
22    perfectly), and I suspect they are not safe for another laptop.
23
24  * ALGORITHM
25
26    Breezed scans the temperatures every 5s and sets the fan speed
27    according to a series of thresholds.
28
29    Unfortunately, if the fan speed is set directly according to these
30    temperature thresholds, it creates oscillations: The fan goes up,
31    temperature goes down, hence fan goes down, temperature goes up,
32    etc.
33
34    To mitigate such phenomenons, the daemon waits at least 30s after
35    the last change before reducing the fan speed, and the actual
36    thresholds to decrease the fan speed are two degrees below the
37    provided thresholds, which are used when increasing the fan
38    speed. This creates a stability area of two degrees, which seems to
39    be enough. Please let me know if you have problem with the
40    resulting overall behavior.
41
42  * NOTES
43
44    I wrote this daemon for my personal usage on a X61s, and using it
45    may damage your hardware.
46
47    On Thinkpads you have to allow the module thinkpad_acpi to set the
48    fan speed, which is not allowed by default in Debian. To do so, you
49    have to have a file /etc/modprobe.d/thinkpad_acpi.modprobe
50    containing
51
52    ---------------------------- snip snip -------------------------------
53    options thinkpad_acpi fan_control=1
54    ---------------------------- snip snip -------------------------------
55
56 --
57 Francois Fleuret (francois@fleuret.org)
58 December 2008