fix versioned depends lines
[enigma2-plugins.git] / fancontrol2 / src / readme.txt
1 ===========================================================
2 FanControl2 by joergm6                           Help V.2.4
3 Support forum: IHAD
4 Acknowledgments: diddsen, _marv_, DreamKK
5                  Spaeleus(it), mimi74(fr), Bschaar(nl)
6 ===========================================================
7 Apologies if the english translation is not always correct.
8
9    Function
10    --------
11 Control a 3pin or 4pin fan (PWM) depends from the average
12 of the 2 highest temperature values.
13 Slowly regulation, because temperatures are not too
14 change quickly and there should no unnecessary CPU load.
15
16    Security Features
17    -----------------
18 If 20min no reports of the fan speed, it is assumed that the
19 fan is defective. Regularly appears on the TV then an
20 appropriate message.
21 If standby mode the fan is off, the fan switched on, when the maximum
22 temperature is exceed. The temperature drops by more than 3C the fan
23 turns off again. The fan runs in the first 10 minutes with
24 minimum speed.
25 The overheat protection can be increased by up to 9C.
26 It can be set when shutting down the box, at which temperature and
27 fan failure.
28
29    Preferences
30    -----------
31    Fan off in Standby
32 yes = Fan will be turned off if the box is in standby
33 yes, Except for recording or HDD= Fan is turned off in standby
34 if there is no recording and HDD is in Sleep-Mode
35
36    Min speed
37 At Temperature "static-temperature" and below it is set this
38 speed.
39
40    Max speed
41 At Temperature "end-temperature" it is set this speed.
42
43    Static temperature
44 Until this temperature is not regulated, min speed is set.
45
46    End Temperature
47 This is the maximum temperature may occur, is
48 this achieved, we will set the max speed.
49
50    Initially, voltage and PWM
51 When changing the values the fan is immediately set with these
52 values. It can now be directly read off the speed. The controlling
53 is nevertheless once again active. So quick look or change the
54 values.
55 These values are set when the box boots up or if the fan was
56 switched off in standby.
57   
58    for 3pin Fan type
59 For regulation of voltage 3-pin fan with tachometer signal.
60 Is controlled only the voltage. Settings for PWM have no control.
61 Sets the initial voltage to a value of Rotation rate, 
62 with the fan at the start of the Box initially intended to run.
63 From this starting speed is regulated.
64
65    for 4pin Fan type
66 For regulation PWM, 4-pin Fan. First is controlled the PWM value.
67 If the control range is no longer sufficient, if possible, also
68 regulate the voltage.
69 The voltage adjustment is required. Set the voltage on the
70 Maximum value (for DM500HD set 5-10). But also a lower voltage level
71 is useful. A lower voltage means a lower maximum speed and a lower
72 minimum speed. Set the voltage as possible so that the control
73 range with PWM enough.
74 There are also fans spin at PWM = 0 to be too high.
75 Reduce the voltage here, until the desired min Speed (including 0 is
76 possible) is achieved. Have also the max speed in mind.
77 PWM provides a value that corresponds to the speed, initially run
78 the fan at the start of the Box. From this speed is regulated.
79
80    for Fan type Control disabled
81 The regulation is disabled. The fan runs with the last parameters
82 further. The fan is not turned off!
83
84    Check
85    -----
86 This attempts to determine the minimum speed of the fan
87 for the startup and the minimum before the fan speed goes
88 shutdown.
89 Similarly, the maximum speed for these settings is
90 determined. (OK) mean value matches the settings
91 (!!) values do not match. These details are for information
92 and do not affect the regulation, within the possible.
93 4Pin to be displayed in addition information on the wider
94 control range. That means it is on the PWM area also changed
95 the voltage.
96
97    Temperature Monitor
98    -------------------
99 With the "info key", can the individual values of the temperatures
100 are shown.
101 Press the Info button for single reading of HDD temperature.
102
103    Special Setup
104    -------------
105 With the "Menu key" special values can be defined.
106 Action in case of fan failure      [show info]
107   Notification of defective fan, box shut down or do nothing.
108 Box shutdown at temperature (C)    [65]
109   Upon reaching the specified temperature, the box switch off
110   (DeepStandby).
111 Thermal protection increase at (C) [0]
112   If the fan is off in standby the fan switched on at maximum
113   temperature. This maximum temperature can be increased by 
114   up to 9C
115 read HDD-Temperature in HDD-Standby-Mode [auto]
116   yes = read HDD temperature in HDD-Standby
117   no = read HDD temperature only when HDD is active
118   Auto = at the start of FC2 once tested whether the HDD
119          starts, and if so reading is disabled
120   never = Temperature is never read
121 DMM fancontrol disabled            [No]
122   Appears in the skins with temperature, the DMM-FanControl is active
123   and also switch the fan. It caused unwanted on/off operations.
124   Recommendation: Disable DMM-FanControl
125 See Monitor in extension menu      [Yes]
126   Monitor shown in the extension menu (Long-Blue-Button).
127 WebIF number of log entries        [40]
128   How many events should be show in WebIF.
129   40-999
130 Logging directory
131   Choose the "OK" the place to which directory the log files are written.
132   Data is written only if least 10MByte are free.
133 Enable Data Logging
134   There will be written every minute a record in the file FC2data.csv. 
135   This can called directly in Excel. If this file does not exist and will
136   Option enabled, a header is generated.
137   about 4kBytes each hour
138 Auto-Delete Data older than (days) [No]
139   Data-logging-Data older than this definition are
140   deleted.
141   Starting: daily at 00:00 and at Enigma2 start
142 Enable Event Logging
143   There will be written all Events in the file FC2events.txt.
144   about 30kByte each hour
145
146    Web Interface
147    -------------
148 Call: http://dreamboxip/fancontrol
149 Displays information about current fan-values and the last
150 Event logs. Per hour a value for temperature and Speed is appears.
151 With "FC2 Log", the log files are downloaded and the logging can be set.
152 "FC2 Chart" shows online diagrams of the last 48 hours. The Data
153 Logging must be enabled to do so. It must be present at least 2.5h data!
154 When using Firefox, it may happen that the diagram does not
155 display properly. Then, an additional Page refresh (F5) is necessary.
156
157    Miscellaneous
158    -------------
159 All important for the fan current readings
160 appears as a value and bar graph. The bar display
161 range is based on the individually set parameters.
162 FanControl2 is prepared for different languages.
163 POT file is in ipkg if anyone other languages
164 would make available.
165 The settings are stored in the normal Enigma2 settings and
166 are therefore included in the backup / restore.
167
168
169 ===========================================================
170