Revert "update plugin icons (and some minor cleanups)" --> let the author of the...
[enigma2-plugins.git] / elektro / src / readme.txt
1 ====================================================
2 Elektro Power Save for Dreambox 
3 Version 1 & 2 by gutemine
4 Version 3 by Morty <morty@gmx.net>
5 Profiles, HDD, IP, NAS Mod by joergm6
6 ====================================================
7 Release infos 
8 ====================================================
9 1.0   first version, as usually completely 
10       untested - have Fun !
11 1.1   now after boot the Dreambox will go 
12       immediately to normal Standby
13 1.2   some bugfixes on Plugin Text and 
14       make standby on boot configurable
15 2.0   make ipk kit, add info messages before standby 
16       and prevent deepstandby if timer is running
17 2.1   bug fixes and support for new images with TryQuit
18       mainloop (which is since mid January 2007 in CVS)
19 2.2   still alive 
20 2.3   make compatible with latest CVS changes
21       probably last version by gutemine
22
23 3.0   Rewritten by Morty, lots of new features
24 3.0.2 It's now possible to adjust the how long to
25       show the shutdown screen
26 3.0.4 Bugfix
27 3.0.5 Fixed problem where the box shuts down again
28       when it boots up too fast
29 3.1.0 Removed unneeded dependencies
30       Don't shut down if woken up manually
31 3.2.0 Recording detection should work now
32       Holiday mode has been implemented
33 3.2.1 Fixed Bug not recognizing a wakeup by Elektro 
34 3.2.2 Added the Italian translation by Spaeleus     
35 3.2.3 Fixed problem with auto-Timers
36 3.3.0 Added an option to choose whether to go to 
37       standby on manual boot
38 3.3.1 Fixed problem when the global session was not
39       available
40 3.3.2 Fixed some problems shutting down on latest
41           versions of enigma2.
42 3.3.3 Added patch to installer to fix enigma2. It 
43           should now be possible to run Elektro and 
44           EPG refresh in parallel.
45 3.3.4 Added Turkish locale by MytHoLoG    
46 3.4.0 no shutdown if HDD not Idle (joergm6)  
47 3.4.1 Fix: Multi-Language (locale) does not work 
48 3.4.2 Enhance user interface (configuration menu)
49 3.4.3 2 Profiles; waiting for responding IP addresses
50 3.4.5 A NAS/server can be shutdown via Telnet
51
52 1) Prerequisites
53 ----------------
54
55 Should work on most systems using Enigma2, but this 
56 isn't granted.
57 DM7025, DM800SE  + DM8000: Supported.
58 DM800: Can not wake up by itself. It therefore isn't
59 really supported.
60
61 2) Installation
62 ---------------
63
64 If your Dreambox has Internet access, Elektro can be
65 installed using Plugin-Browser. Or using Addons, if 
66 it's a Blue Panel Image.
67
68 Else, simply copy the elektro*.ipk file to /tmp with
69 FTP (TCP/IP must be working already) or from an
70 USB stick using a Filebrowser.
71
72 Then install by "Install local extension" (Menu 
73 Setup Software management). 
74
75 Or by entering the following commands in a Telnet
76 session:
77
78 cd /
79 ipkg install /tmp/elektro*.ipk
80
81 To ensure proper operation of Elektro please "Restart"
82 (reboot) the Dreambox. 
83
84
85 3) Mode of operation    
86 --------------------
87 The Elektro Power Save Plugin puts the Dreambox from
88 Standby to sleep mode (Deep Standby) at specified times.
89 This only happens if the box is in Standby mode
90 and no recording is running or scheduled during the
91 next 20 minutes.
92
93 The Dreambox automatically wakes up for recordings or
94 at the end of the specified sleep time. Hence you needn't
95 wait for it to boot-up.
96
97 4) Options
98 ----------
99 Main menu -> Extensions -> Elektro Power Save
100
101  - Show in:
102    Specify whether Elektro shall show up in plugin menu 
103    or extensions menu (needs GUI restart).
104
105  - Name:
106    Specify plugin name to be used in menu (needs 
107    GUI restart).
108
109  - Description:
110    Specify plugin description to be used in menu 
111    (needs GUI restart).
112
113  - Active Time profile
114    The times of this profile will be used.
115
116  - Use both profiles alternately
117    Both profiles are used alternately. When
118    shutting down the other profile is enabled.
119    This allows two time cycles per day. Do not overlap the times.
120
121  - Check IPs (press OK to edit)
122    This list of IP addresses is checked. Elektro waits
123    until addresses no longer responds to ping.
124
125  - Enable Elektro Power Save
126    Unless this is enabled, this plugin won't run 
127    automatically.
128    
129  - Standby on boot:
130    Puts the box in standby after boot.  
131    
132  - Standby on manual boot:
133    Whether to put the box in standby when booted
134    manually. On manual boot the box will not go to
135    standby before the next deep standby interval
136    starts, even if this option is set.
137    This option is only active if 'Standby on boot'
138    option is set, too.  
139    
140  - Standby on boot screen timeout:
141    Specify how long to show the standby query on
142    boot screen. This value can be set to ensure
143    the box does not shut down to deep standby again
144    too fast when in standby mode.
145    
146  - Force sleep (even when not in standby):
147    Forces deep standby, even when not in standby mode.
148    Scheduled recordings remain unaffected.
149  
150  - Avoid deep standby when HDD is active, e.g. for FTP:
151    Wait for the HDD to enter sleep mode. Depending on
152    the configuration this can prevent the box entirely
153    from entering deep standby mode.
154    
155  - Dont wake up:
156    Do not wake up at the end of next deep standby
157    interval.
158    
159  - Holiday mode:
160    The box always enters deep standby mode, except
161    for recording.
162    
163  - Next day starts at and other times:
164    If the box is supposed to enter deep standby
165    e.g. monday night at 1 AM, it actually is already
166    tuesday. To enable this anyway, differing next day
167    start time can to be specified here.   
168    Hopefully the rest is self-explanatory. 
169
170
171 ======================================================
172 Have fun to let Elektro save power and preserve the 
173 environment on using your Dreambox!!!!
174 ======================================================