pluginsort: initial checkin
[enigma2-plugins.git] / eibox / src / README
1 == E.I.B.ox setup how-to ==
2
3 * install and setup linknx server
4   (cf. http://sourceforge.net/apps/mediawiki/linknx/)
5
6 either
7  * install knxweb
8  * create visualization using knxweb ajax frontend
9  * save as design.xml
10 or
11  * modify design.sample.xml from the plugin directory
12 or
13  * create visualization layout xml by hand
14
15 * add or adapt this line in the <config> section of design.xml:
16         <settings host="yourlinknxhost" port="1028" refresh="0" debug="true"/>
17   refresh time is in ms. intervals below 500 will disable auto refresh.
18   it is recommended to disable refresh and enable debug during setup phase and then 
19   enable autorefresh and disable debug for performance reasons during normal operation
20
21 * copy design.xml into plugin directory on your dreambox
22    
23 * quantize your custom images (must be in PNG format)
24         pngquant 256 inputfilename.png 
25   (cf. http://www.libpng.org/pub/png/apps/pngquant.html)
26
27 * rename quantized images back to original names and copy them to the images subdirectory
28
29 * restart enigma2 and have fun testing
30
31 * usage is pretty much self-explanatory:
32   navigate with up and down keys,
33   switch or change values with OK or left and right keys
34   thermostat values can directly be entered with number keys
35   navigation order is defined by the order of control nodes in the design.xml
36
37 * please report bugs at http://www.dream-multimedia-tv.de/board/
38
39
40
41 == known issues ==
42
43 so far the following "widgets" of knxweb have been implemented in E.I.B.ox:
44 * switches for light, blinds, outlet, fan, pump
45 * multiswitch
46 * light dimmer
47 * thermostat (actual temperature and set point)
48 * text
49 * zone goto
50
51 still to be implemented are
52 * thermostat KONNEX mode switching
53 * value input
54 * camera link
55
56
57
58 == constraints ==
59
60 * for right now, screens are not optimized for FULL HD yet, so they will work on a regular SD screen
61 * have background images, use only PNG files with dimensions of exactly 550x400
62 * for icons, use 32x32 PNGs
63 * don't have dots ('.') in your object IDs or dimmer progress bars won't work
64