code.vuplus.com Git - vuplus_dvbapp-plugin/blob - babelzapper/src/readme.txt

   1 ===========================================
   2 Babelzapper Version 0.8
   3 by gutemine from 15.03.2010
   4 ===========================================
   5 Release infos
   6 ===========================================
   7 0.9.6   IF and TOGGLE
   8 0.9.5   colors
   9 0.9.4   new menu and ON/OFF
  10 0.9.3   EXIT to ESC
  11 0.9.2   bugfixing
  12 0.9.1   LOAD command
  13 0.9     Release Candidate
  14 0.8     learn the basics
  15 0.7     Jumpin Jack
  16 0.6     bugfixing
  17 0.5     to release or not release ?
  18 0.4     going python now
  19 0.3     menu is now sticky
  20 0.2     speed is now msec
  21 0.1     First public Beta
  22 ===========================================
  23
  24 Installation:
  25 -------------
  26
  27 First copy the file enigma2-plugin-extensions-babelzapper*.ipk
  28 to /tmp with ftp (TCP/IP must be working already).
  29
  30 Then install Babelzapping by entering the
  31 following commands in a Telnet session:
  32
  33 cd /
  34 ipkg install /tmp/enigma2-plugin-extensions-babelzapper*.ipk
  35
  36 You can remove Babelzapper with the red button in the Plugin List,
  37 or the Softwaremanager Plugin of enigma2,
  38 or with the following command in telnet:
  39
  40 ipkg remove enigma2-plugin-extensions-babelzapper
  41
  42 Usage:
  43 ------
  44
  45 The Babelzapper plugin allows you to control
  46 your Dreambox completely with a single RC button,
  47 the mute button.
  48
  49 If the Plugin is enabled and you press the mute
  50 button the Babelzapping Command Button
  51 will appear in the upper middle of the TV screen.
  52
  53 It then simply srolls trough the appropiate
  54 remote control buttons as defined in the babelzapper.zbb
  55 file, and if you press the mute button
  56 again the choosen remote control button
  57 or other babelzapper commands as defined in the
  58 babelzapper.zbb file will be executed.
  59 When you choose NONE (which executes STOP)
  60 you can exit without executing a command.
  61
  62 The speed of button scrolling is adjustable
  63 in the Babelzapper Plugin.
  64
  65 The real mute button is disabled
  66 when you enable the Babelzapper,
  67 use volume down to mute instead of this.
  68
  69 For adapting the commands available for execution
  70 edit the babelzapper.zbb file at /etc/enigma2
  71
  72 zBABEL Language:
  73 ---------------
  74
  75 The first text at the beginning of the line in the
  76 babelzapper.zbb file is always the label as shown
  77 on the TV screen when scrolling through the command
  78 lines of the babelzapper.zbb file.
  79
  80 For the correct key names of your remote control
  81 have a look at the provided
  82 examples in the babelzapper.cfg
  83 file or at /usr/lib/enigma2/python/keyids.py
  84 for the full list of available keys.
  85 Keycodes are always writen with $KEY_LABEL
  86 and will be replaced by the apropiate keycodes
  87 as found in the keyids.py file.
  88
  89 If you add _LONG to the keyname (for example
  90 $KEY_BLUE_LONG) the keycode will be executed
  91 as long press, and you can spefify
  92 multiple keycodes to be
  93 sequentially executed from left
  94 to right and other babelzapper commands
  95 as explained below when they are
  96 seperated with the ";"
  97
  98 The first text at the beginning of the line in the
  99 babelzapper.zbb file is always the label as shown
 100 on the TV screen when scrolling through the command
 101 lines of the babelzapper.zbb file.
 102
 103 Other commands supported are:
 104
 105 GOTO    linenumber
 106 STOP    miliseconds (from 1000 to 60000)
 107 REM     remarking text
 108 RETURN  linenumber
 109 PRINT   text for the TV screen
 110 END     exit scrollmode
 111 LOAD    menufile
 112 RUN     menufile
 113 ON      on flag enable and continue if enabled
 114 OFF     on flag disable
 115
 116 A line with a GOTO has to be executed
 117 by pressing Mute, but GOTO can also be
 118 used at the end of a line with other
 119 commands. This can be used for
 120 jumping into all areas of the
 121 babelzapper.zbb file.
 122
 123 If you edit the babelzapper.zbb file on a PC
 124 it is wise to use an editor which shows
 125 you the linenumbers to simplify identifying
 126 the correct linenumbers. Be aware
 127 that line 0 is a NONE with the END command
 128 which is hardcoded and not in the babelzapper.zbb
 129 file.
 130
 131 RETURN is a jump to the specified
 132 linenumber which gets executed
 133 when reached during the scrolling
 134 of the commands and doesn't need to be selected
 135 (it is not even shown on the TV).
 136 Hence RETURN cann be used to jump
 137 back from submenus entered with GOTO.
 138
 139 If you don't specifiy a linenumber
 140 for RETURN or GOTO always 0 will be used.
 141
 142 You can now also add colors to the button label
 143 by using LABEL:x:y
 144
 145 with x the background color and y the foreground color
 146 with the following values:
 147
 148 black   0
 149 white   1
 150 grey    2
 151 red     3
 152 green   4
 153 yellow  5
 154 blue    6
 155
 156 The zBABEL script language used in
 157 the babelzapper.zbb file
 158 is a little bit like good old BASIC,
 159 so keep in mind the typical
 160 recommandations for it like commenting your code
 161 with REM lines, using tabs and/or blanks
 162 to increase readability
 163 and especially use GOTO and RETURN with care and
 164 wisdom.
 165
 166 =======================================================
 167 Have fun testing and using Babelzapper on your Dreambox
 168 =======================================================