Merge branch 'master' into master_internal
[enigma2-plugins.git] / fancontrol2 / src / readme.txt
1 ===========================================================\r
2 FanControl2 by joergm6                           Help V.2.7\r
3 Support forum: IHAD\r
4 Acknowledgments: diddsen, _marv_, DreamKK, Lukasz S.\r
5                  Spaeleus(it), mimi74(fr), Bschaar(nl)\r
6 ===========================================================\r
7 Apologies if the english translation is not always correct.\r
8 \r
9    Function\r
10    --------\r
11 Control a 3pin or 4pin fan (PWM) depends from the average\r
12 of the 2 highest temperature values.\r
13 Slowly regulation, because temperatures are not too\r
14 change quickly and there should no unnecessary CPU load.\r
15 \r
16    Security Features\r
17    -----------------\r
18 If 20min no reports of the fan speed, it is assumed that the\r
19 fan is defective. Regularly appears on the TV then an\r
20 appropriate message.\r
21 If standby mode the fan is off, the fan switched on, when the maximum\r
22 temperature is exceed. The temperature drops by more than 3C the fan\r
23 turns off again. The fan runs in the first 10 minutes with\r
24 minimum speed.\r
25 The overheat protection can be increased by up to 9C.\r
26 It can be set when shutting down the box, at which temperature and\r
27 fan failure.\r
28 \r
29    Preferences\r
30    -----------\r
31    Fan off in Standby\r
32 yes = Fan will be turned off if the box is in standby\r
33 yes, Except for recording or HDD= Fan is turned off in standby\r
34 if there is no recording and HDD is in Sleep-Mode\r
35 \r
36    Min speed\r
37 At Temperature "static-temperature" and below it is set this\r
38 speed.\r
39 \r
40    Max speed\r
41 At Temperature "end-temperature" it is set this speed.\r
42 \r
43    Static temperature\r
44 Until this temperature is not regulated, min speed is set.\r
45 \r
46    End Temperature\r
47 This is the maximum temperature may occur, is\r
48 this achieved, we will set the max speed.\r
49 \r
50    Initially, voltage and PWM\r
51 When changing the values the fan is immediately set with these\r
52 values. It can now be directly read off the speed. The controlling\r
53 is nevertheless once again active. So quick look or change the\r
54 values.\r
55 These values are set when the box boots up or if the fan was\r
56 switched off in standby.\r
57   \r
58    for 3pin Fan type\r
59 For regulation of voltage 3-pin fan with tachometer signal.\r
60 Is controlled only the voltage. Settings for PWM have no control.\r
61 Sets the initial voltage to a value of Rotation rate, \r
62 with the fan at the start of the Box initially intended to run.\r
63 From this starting speed is regulated.\r
64 \r
65    for 4pin Fan type\r
66 For regulation PWM, 4-pin Fan. First is controlled the PWM value.\r
67 If the control range is no longer sufficient, if possible, also\r
68 regulate the voltage.\r
69 The voltage adjustment is required. Set the voltage on the\r
70 Maximum value (for DM500HD set 5-10). But also a lower voltage level\r
71 is useful. A lower voltage means a lower maximum speed and a lower\r
72 minimum speed. Set the voltage as possible so that the control\r
73 range with PWM enough.\r
74 There are also fans spin at PWM = 0 to be too high.\r
75 Reduce the voltage here, until the desired min Speed (including 0 is\r
76 possible) is achieved. Have also the max speed in mind.\r
77 PWM provides a value that corresponds to the speed, initially run\r
78 the fan at the start of the Box. From this speed is regulated.\r
79 \r
80    for 4pin (PID) Fan type -- by Lukasz S.\r
81 Voltage and PWM is controlled automatically by a PI controller, that\r
82 tries to follow the Target RPM calculated by the built-in algorithm,\r
83 and minimize the difference between target RPM and current.\r
84 \r
85 Control theory explanation en.wikipedia.org/wiki/PID_controller;\r
86 In this implementation, only Proportional and Integral section is used \r
87 (no Derivative).\r
88 \r
89    Features: \r
90 Built-in input deadband will ensure controller won't act unless the\r
91 Target RPM differs from Current RPM by more than 1% either way, to\r
92 filter out spikes and fluctuations in actual fan speed measurements.\r
93 \r
94 In this mode PID Ctl Err (its percentage) is showing why the controller\r
95 thinks it should speed fan up (or slow down).\r
96 \r
97 Fan is controlled by means of PWM first (keeping voltage at minimum setting),\r
98 only progressing to change voltage if PWM would be larger than 255;\r
99 If calculated PWM would go below 255 again, voltage is set back to min.\r
100 (in effect, voltage is treated as overspill for PWM, with different coefficient\r
101 to prevent too large changes in voltage)\r
102 \r
103    Setup:\r
104 \r
105 Initial Voltage and Initial PWM shall be set so that fan has exactly min \r
106 speed that you require, and that shall be set as 'min speed RPM' setting.\r
107 (to avoid 'battling' with the PI controller over the pwm and voltage settings, \r
108 change to the traditional 4pin to determine this - or use the Check feature)\r
109 \r
110 (On Authors' box, setting Initial Voltage and PWM to zero didn't stop the fan\r
111 my minimum fan speed on 0 volt and 0 PWM was about 850 RPM)\r
112 \r
113 'max speed RPM' should be set to maximum fan speed you ever want the fan to \r
114 achieve AND is achievable by available setting of voltage and PWM. \r
115 Setting this to an unreachable value may lead to improper behavior.\r
116 \r
117    Known Problems: \r
118    * crossing the PWM - VLT control boundary, can look like it's unstable,\r
119 because of different reaction of the fan to controlling it with voltage, \r
120 vs what it does on PWM solely. Workaround: set your Static Temp so that \r
121 PWM won't reach 255 in normal conditions, or so that Voltage won't need \r
122 to fall below minimum setting in normal conditions. \r
123 (Example procedure : launch the FanControl2 interface when your box is \r
124 in what you think is its normal working temperature, and if the PWM displayed \r
125 is close to 255, but on the PWM side, set the static temperature to a degree \r
126 or two higher than current setting; if the voltage is being controlled already \r
127 and is near the min vlt setting, set the static temp to a degree or two MORE \r
128 than current static temp setting - to ensure controller output is considerably \r
129 under 255 for PWM, and considerably more than min Volt for Voltage). \r
130 Unfortunately there is not much that can be done here unless some automation \r
131 is employed to tune this as it can differ from fan to fan, and even from box \r
132 to box, and also fan response to controlling will get worse as it ages, due to\r
133 bearings getting old. Plan is to work on recognizing failing fan bearings situation.\r
134    \r
135    * If static temp setting is changed, controllers' integrator is reset, starts from 0,\r
136 to prevent long-time of unwinding, but it has the effect of setting minimum PWM and Voltage,\r
137 slowing the fan down to minimum first. This is actually a feature, not a problem, \r
138 but it probably should be made configurable.\r
139    \r
140    * PID Ctl Err displaying the error, can be misleading when displaying negative value;\r
141 This is being explored to find a widget which can handle showing 0 in the middle and then the \r
142 signed value either way.\r
143 \r
144 -- by Lukasz S.\r
145 \r
146    for Fan type Control disabled\r
147 The regulation is disabled. The fan runs with the last parameters\r
148 further. The fan is not turned off!\r
149 \r
150    Check\r
151    -----\r
152 This attempts to determine the minimum speed of the fan\r
153 for the startup and the minimum before the fan speed goes\r
154 shutdown.\r
155 Similarly, the maximum speed for these settings is\r
156 determined. (OK) mean value matches the settings\r
157 (!!) values do not match. These details are for information\r
158 and do not affect the regulation, within the possible.\r
159 4Pin to be displayed in addition information on the wider\r
160 control range. That means it is on the PWM area also changed\r
161 the voltage.\r
162 \r
163    Temperature Monitor\r
164    -------------------\r
165 With the "info key", can the individual values of the temperatures\r
166 are shown.\r
167 Press the Info button for single reading of HDD temperature.\r
168 \r
169    Special Setup\r
170    -------------\r
171 With the "Menu key" special values can be defined.\r
172 Action in case of fan failure      [show info]\r
173   Notification of defective fan, box shut down or do nothing.\r
174 Box shutdown at temperature (C)    [65]\r
175   Upon reaching the specified temperature, the box switch off\r
176   (DeepStandby).\r
177 Thermal protection increase at (C) [0]\r
178   If the fan is off in standby the fan switched on at maximum\r
179   temperature. This maximum temperature can be increased by \r
180   up to 9C\r
181 read HDD-Temperature in HDD-Standby-Mode [auto]\r
182   yes = read HDD temperature in HDD-Standby\r
183   no = read HDD temperature only when HDD is active\r
184   Auto = at the start of FC2 once tested whether the HDD\r
185          starts, and if so reading is disabled\r
186   never = Temperature is never read\r
187 DMM fancontrol disabled            [No]\r
188   Appears in the skins with temperature, the DMM-FanControl is active\r
189   and also switch the fan. It caused unwanted on/off operations.\r
190   Recommendation: Disable DMM-FanControl\r
191 See Monitor in extension menu      [Yes]\r
192   Monitor shown in the extension menu (Long-Blue-Button).\r
193 WebIF number of log entries        [40]\r
194   How many events should be show in WebIF.\r
195   40-999\r
196 Logging directory\r
197   Choose the "OK" the place to which directory the log files are written.\r
198   Data is written only if least 10MByte are free.\r
199 Enable Data Logging\r
200   There will be written every minute a record in the file FC2data.csv. \r
201   This can called directly in Excel. If this file does not exist and will\r
202   Option enabled, a header is generated.\r
203   about 4kBytes each hour\r
204 Auto-Delete Data older than (days) [No]\r
205   Data-logging-Data older than this definition are\r
206   deleted.\r
207   Starting: daily at 00:00 and at Enigma2 start\r
208 Enable Event Logging\r
209   There will be written all Events in the file FC2events.txt.\r
210   about 30kByte each hour\r
211 \r
212    Web Interface\r
213    -------------\r
214 Call: http://dreamboxip/fancontrol\r
215 Displays information about current fan-values and the last\r
216 Event logs. Per hour a value for temperature and Speed is appears.\r
217 With "FC2 Log", the log files are downloaded and the logging can be set.\r
218 "FC2 Chart" shows online diagrams of the last 48 hours. The Data\r
219 Logging must be enabled to do so. It must be present at least 2.5h data!\r
220 When using Firefox, it may happen that the diagram does not\r
221 display properly. Then, an additional Page refresh (F5) is necessary.\r
222 \r
223    Miscellaneous\r
224    -------------\r
225 All important for the fan current readings\r
226 appears as a value and bar graph. The bar display\r
227 range is based on the individually set parameters.\r
228 FanControl2 is prepared for different languages.\r
229 POT file is in ipkg if anyone other languages\r
230 would make available.\r
231 The settings are stored in the normal Enigma2 settings and\r
232 are therefore included in the backup / restore.\r
233 \r
234 \r
235 ===========================================================\r
236 \r