LinuxMCE - User contributions [en]

LinuxMCE-0810 beta

2011-04-28T22:06:09Z

Icosahedron: Fixed a couple minor typos in the update numbers

{| align="right"
| __TOC__
|}
[[Category: Software]]
This page outlines some information about the Beta, as well as outlining any changes and bugfixes we are applying, just like we did with the alpha2 page.

The installation instructions found on the alpha2 page still apply:

==Installing LinuxMCE-0810==
Please see detailed instruction on how to install LinuxMCE-0810 and keep it up-to-date with the latest updates [[installing 0810|here]].

== Upcoming fixes... ==
'''Note: Please put the name of the package file and the source and bin package number in this list, followed by a small description of what has changed! Hulu Player is not the name of the package, but lmce-hulu-player. It makes the life of the person, who needs to update the repo a lot easier. Thank you!'''
* pluto-system-database (211)
** Fixes #782, #845 use the same variable for sensor type datagrid as the code expects.
* pluto-media-database (233)
** Ref #1022 Adds Season Number attribute to Pluto_Media.AttributeType

== Update 2011-04-14 23901 ==
* pluto-website-admin (220)
** Fix bad character in previous fix for event page
* pluto-updateentarea (341,342)
** Fixes #664 properly select order number

== Update 2011-04-11 23890 ==
* pluto-system-database (211)
** Fixes #15 navigation problems multiple floorplans
* pluto-website-admin (220)
** Fixes #1046 adding/removing extra slashes when saving IR codes
** Fixes #1044 program now available as video sort option
** Fixes #1002 Adds ability to remove attributes directory wide.
** Fixes #1020 Auto-tag button for upcoming media tagging addon
** Fixes #1051 fix deletion of events without criteria
* pluto-avwizard (555,556)
** Fixes #865 adds HDMI-0 output which is required for some ATI cards
* pluto-simplephone (498,499)
** Fixes #1042 always use password when creating auth info object
* pluto-zwave-lighting (506,505)
** Fix bug in logging function
** Possible fix for #989

== Update 2011-03-26 23855 ==
* pluto-motion-wrapper (456,455) - Fixes #715, #904 - fix reload issue
* pluto-boot-scripts (234)
** Fixes #698, change attribute name colum (and all other longtext columns) in db to utf-8
** Fixes #1019 fix firewall rules for "both" rules, handle cases where filter ip is NULL
** Fixes #1035 don't call plymouth if it does not exists
** Fixes #1037 fix call to LoadMDModules.sh
** Fixes #1027 this package had missing dependencies for storage-devices and network-storage
* pluto-website-admin (220)
** Refs #662, remove markers on datalogger graph
** Fixes #901 delete all orbiter data when deleting an Orbiter
* pluto-orbitergen (226,227)
** Fixes #133 properly calculate offset for floorplan texts
** Autogenerate Open/Close/Shade buttons if blinds/drapes etc exist in a room.
* pluto-zwave-lighting (506,505)
** Fixes #997 report battery status

== Update 2011-03-07 23802 ==

* pluto-asterisk (270)
** Added support for Linksys SPA3102 gateway #1012, affinity telecom voip provider #949, voipgo #942
* pluto-dcerouter (154)
** Refs #961 make radvd install by default making dcerouter depend on it
* pluto-website-admin (220)
** Fixes #940
** Refs #662 fix graph.php for devices that report multiple events
** Refs #662 create details page with details graphs
** Refs #961 basic IPv6 implementation
** Refs #959 thermostat internal schedules support (z-wave part needs still to be done)
** Fixes #971 change tcp port for mediatomb to 49153 as djmount has taken 49152
** Fixes #984 patch from golgoj4, tvdb uses program attribute type
* pluto-boot-scripts (234)
** Refs #961 basic IPv6 implementation
** Refs #970 - Reconfigure dhcp server at every boot
** Fixes #990 - Use NIS to look up home directory
* lmce-datalogger-plugin (686,687)
** Refs #913 also install Image_Color
* pluto-pnp-detection (562)
** Refs #1006 - Updates for LG TV template
* pluto-system-database (211)
** Refs #1006 - Updates for LG TV template
** Refs #650 - install picture viewer as default on MDs
* pluto-plutodhcp (491,330)
** Refs #970 - Enable internal network dynamic DNS updates
* lmce-mediatomb (702)
** Fixes #971 change tcp port to 49153 as djmount has taken 49152
* lmce-skins-titanium(718)
** Fixes #305 and #955 - arrows pointing the wrong way in remote screen
* pluto-proxy-orbiter (487,488)
** #893 - Fix deletion of pictures, enable play button for pictures
* pluto-orbiter (119,138)
** #893 - Fix deletion of pictures, enable play button for pictures
* pluto-std-plugins (116,135)
** #893 - Fix deletion of pictures
** #832 - Fix specific date timed event

== Update 2011-01-05 23579 ==
* pluto-plutodhcp (491,330) - Refs #920 fix the dhcp template that is being used
* pluto-boot-script (234) - Fixes Orbiter detection logic

== Update 2011-01-04 23568 ==
* pluto-boot-script (234) - Refs #920 allow adding entries to the dhcpd.conf file using an external file.
* pluto-plutodhcp (491,330) - Refs #920 Honor the dhcpd.conf template file
* pluto-website-admin (220)
** Refs #226 - Enable SSL support in apache
* pluto-mythtv-plugin (136,152)
** Fixes #922 - add storage devices to mythtv even if offline
* lmce-datalogger-plugin (686,687)
**Refs #913 Install Image_Canvas-0.3.3C and Image_Graph-0.8.0 apagg
* pluto-zwave
** refs #874 - change mutex handling
* pluto-plcbus
** refs #918 - adjust dim rate

== Update 2010-12-16 23525 ==
* pluto-website-admin (220)
** Refs #907 - Support for web orbiters to use PLUTO_KEY events - Los93soL
** Refs #708 - wrong media type used when displaying default sort
* pluto-system-database (211)
** Refs #913 Updated dependency for datalogger plugin
** Refs #905 Play All also honors Queue vs Instant play setting
* lmce-datalogger-plugin (686,687)
** Refs #913 Install Image_Graph and dependencies in postinst
* pluto-zwave
** refs #44 - add smoke detector support
* pluto-proxy-orbiter (487,488)
** Refs #905 - New variable substitution to get device data
* pluto-orbiter (119,138)
** Refs #905 - New variable substitution to get device data
* pluto-plcbus

== Update 2010-12-05 23479 ==

* pluto-std-plugins (116,135)
** #879 - OSD Orbiter does not display after stopping non-pluto media device
** #880 - Non-pluto audio-only MediaTypes do not have the proper FK_Pipe=1
** #746 - Follow me volume does not work properly
** #905 - Implement queue media in Media_Plugin
* pluto-system-database (211)
** #860 - Add pnp detection script for ZWave devices
** #868 - Update Acquos LCxxD6U / LCxxD7u GSD codes to confirm input change
** #880 - Non-pluto audio-only MediaTypes do not have the proper FK_Pipe=1
** #883 - Hauppauge HD PVR inputs are not set correctly
* pluto-capture-card-scripts (580)
** #883 - Hauppauge HD PVR inputs are not set correctly
* lmce-dpms-monitor (721,722)
** #885 - DPMS Monitor now works correctly. DPMS is properly enabled, Timeouts are set, and X buffers are properly flushed after each DPMS request. (tschak)
* pluto-storage-devices (533)
** Fixes #884 - No longer ignore bootable partitions - merkur2k
** #889 New shares on existing file servers are not detected - merkur2k
* pluto-website-admin (220)
** Fixes #888 - Display correct description in web orbiter selection dropdown - merkur2k
** Fixes #869 - Event navigation improvement - thanks apagg!
** Refs #677 - More colors for energyGraph and some small fixes - apagg
** #778 Adds TVDB tagging functionality
** #662 datalogger display sensor report correct - apagg
** Fixes #866 update imdbphp to imdbphp2
** Fixes #901 - proper deletion of Orbiter devices
* mce-diskless-tools (627,628)
** Fixes #894 - make MythTV Setup show up properly now on Diskless MDs
* pluto-proxy-orbiter (487,488)
** #905 - Use orbiter setting "Queue instead of instant play"
* pluto-orbiter (119,138)
** #905 - Use orbiter setting "Queue instead of instant play"
* lmce-shoutcast-radio-plugin (703,704)
** Fixes #906 - new method of downloading shoutcast data

==Update 2010-11-01 23388 ==
* asterisk-pluto (269) - all those asterisk changes should finally be deployed
* lmce-launch-manager - segfault due to db going away
* pluto-asterisk - added blueface voip provider
* pluto-boot-script (234) - Refs #315 load ztdummy module at startup
* pluto-capture-card-script - Refs #854 added HD PVR block info.
* pluto-mythtv-player - enable networkcontrol port
* pluto-proxy-orbiter (487,488) - Refs #821 - configuration script for automatic proxy orbiter port selection - merkur2k
* pluto-std-plugins (116,135)
** Refs #857 - Added update device command to general info plugin
** Refs #843 - UpdateEntArea crashes fixed
* pluto-system-database (211)
** #854 Add the above file
** #851 - DCERouter segfaults when exiting
** #873 Software raid devices do not have "use automatically" option
* pluto-updateentarea (341,342)
** Refs #445 don't put proxy orbiters into MDs EA
** Refs #843 UpdateEntArea crashes fixed
* pluto-website-admin (220) - Refs #821 - enable web orbiter in "add orbiter" dropdown in orbiters wizard page - merkur2k
** Refs #856 - View whole log only displays first 5000 lines
** Refs #861 - fixes JS path escaping
** Refs #870 - Web interface for learning IR codes doesn't work when editing existing device
* pluto-pnp-detection (562) - Refs #860 - Add pnp detection script for ZWave devices
* pluto-plutoutils (197,196) - Refs #872 - Fix MySQL timeout issues
* pluto-dcecommon (193,192) - Refs #872 - Fix MySQL timeout issues
* pluto-sql2cpp (203,202) - Refs #872 - Fix MySQL timeout issues
* pluto-tribunetv (599,598) - Refs #872 - Fix MySQL timeout issues
* pluto-vipshared (200,199) - Refs #872 - Fix MySQL timeout issues
* pluto-hdhomerun (621,620) - Refs #872 - Fix MySQL timeout issues
* asterisk-pluto (269) - Refs - #570 Phone book lookup and user validation scripts will now be packaged - Los93soL
* pluto-simplephone (498,499) - Phone audio now works when connected by HDMI - Los93soL
* pluto-zwave-lighting (506,505) - Refs #874 - ZWave controller locks up about twice a day
* pluto-asterisk (270.271) - Added support for WhistlePhone, free ad-supported US calling

== Update 2010-10-13 23333 ==
* pluto-std-plugins (116,135) -
** Media Plugin fix to not turn on OSD (TV) if the TV was already off, and was triggered by an orbiter to play audio. Superfluous block of code removed, Thanks uplink!
** Possible fix for #674, media is not streamed through unnecessary MDs
** Fixes #849 house mode change event now sends previous mode as parameter, event plugin uses that when processing house mode change events
* pluto-system-database (211) - esev made changes to the non-pluto-DVD remote to make it much more usable! Thanks!
* pluto-lirc-wrapper (340,421) - Fixes #822 lirc now depends on required message translation library
* lmce-mediatomb (702) - Fixes #841
* pluto-boot-scripts (234) - #848 - honor "enable UpdateMedia" setting in web admin
* lmce-launch-manager (299,298) - #848 - honor "enable UpdateMedia" setting in web admin

== Update 2010-10-06 23324 ==
* lmce-linux-igd (765 - New package for #826 - merkur2k
* lirc_0.8.3
** built in build-replacements.sh, only it is commented atm
** Refs #822 fixes repeat problems with pronto codes
* lmce-mediatomb (702) - Generate a more sane config file for mediatomb - merkur2k
* pluto-boot-script (234) - Mount /home via nfs instead of cifs on media directors, updates for #826 - merkur2k
* pluto-lirc-wrapper (340,421) - Fixes #822 lirc can now send pronto codes properly
* pluto-orbiter (119,138) - Fix for #458 - power menu now works correctly to control other media directors from OSD
* pluto-std-plugins (116,135)
** Voicemail changes and fixes.
** Absolute Timed Events are working (thanks TSCHAK)
** Fixes #833 - possible to compare integer criteria against a list of comma-separated values
* pluto-system-database (211) - lots of sqlCVS changes.
* pluto-website-admin (220) - Misc fixes from various tickets - merkur2k
* pluto-zwave-lighting (505,506) - #44 Improve detection of multi instance devices, possible to resync device data
* pluto-storage-devices (533) - Add NFS Radar - merkur2k
* pluto-mythtv-plugin (136,152) - misc storage group fixes - merkur2k
** "use autumatically" flag for storage devices is now honored
** better support for remote storage devices (Nas, windows share, etc)

== Update 2010-09-16 23289 ==
* pluto-boot-scripts (234)
** enable WOL on boot up again
** fix HDMI and SPDIF unmuting for AVWizard and successive boots.
** #813, SetupUsers_Homes.sh no longer executes on media directors, faster boot.
** #733, BootMessage.sh no longer emits an error.
* pluto-generic-serial-device (307,335) - fix ethernet device support for GSDs
* pluto-orbiter (119,138) - #811 - WiiMote support. Change mouse accelleration so that the wiimote can actually traverse the entire width of the screen.
* pluto-std-plugins - #814 - Display the dimming column on the floor plan for drapes and blinds
* pluto-updateentarea (341,342) - #815 - Autogenerated scenarios sleep/wakeup do the right thing for blinds/drapes
* pluto-website-admin (220) #708 - add default media sort options to orbiters page, #636 - fixes special characters for IMDB tagging

== Update 2010-08-29 23259 ==
* lmce-squeezeslave (763) - Refs #776 wrapper script to start squeezeslave
* mce-diskless-tools (627,628) - #798 /etc/diskless.conf not being created - merkur2k
* pluto-app-server (145,126) - #344 Allow power off mode override
* pluto-asterisk (270,271)
** Refs #570 Display caller name and picture from LinuxMCE phone book when available - Los93soL
** Change line ending for create_amp_sipgate_de.pl
* pluto-slimserver-plugin (424,425) - Refs #776 add squeezeslave template as possible playback device
* pluto-std-plugins - fix audio album snafu
* pluto-storage-devices (533) - #799 (re)enable NFS instead of CIFS for internal disk drive sharing - merkur2k

== Update 2010-08-02 23227 ==
* lmce-datalogger-plugin (686,687) - Refs #104 Add initial support for logging Sensor Tripped Events - Los93soL
* lmce-datalog-database (753) - Refs #104 Add initial support for logging Sensor Tripped Events - Los93soL
* pluto-boot-scripts (234)
** Start the StorageDevices setup in the background during system start, and restart samba as part of the storage devices setup.
** Fixes #748 Some MAC addresses would get truncated, Thanks Coley - Los93soL
* pluto-app-server (145,126) - Do proper check to determine if suspend is supported
* pluto-website-admin (220) - Fixes #569 Don't assume calls originate from the US - Los93soL
* asterisk-pluto (269) - Fixes #570 Attempt to lookup caller name in phone book and correct as possible - Los93sol
* pluto-asterisk (270,271) - Fixes #570 Attempt to lookup caller name in phone book and correct as possible - Los93soL

== Update 2010-07-27 23202 ==
* asterisk-pluto (269) - Generate all speech for pluto-sos-menus, and generate /etc/asterisk/extensions_custom.conf completely dynamically - Los93soL
* libxine - Refs [http://svn.linuxmce.org/trac.cgi/ticket/535 #535], Backport of newer Matroska container support form lib-xine 1.1.17.
* lmce-picture-viewer (754,755) Refs [http://svn.linuxmce.org/trac.cgi/ticket/650 #650], fixes alpha blending of picture viewer
* pluto-boot-scripts (234) - Refs [http://svn.linuxmce.org/trac.cgi/ticket/758 #758], Fix cameras on MDs by using NFS mount for the camera dir
* pluto-updatemedia (405,406) - Refs [http://svn.linuxmce.org/trac.cgi/ticket/651 #434], Different handling for VDR files - WARNING!! Playback of VDR recording from video is still not possible!
* pluto-website-admin (220) - Make sure the phone system is updated with changes made to cell phone notifications via web admin - Los93soL
* pluto-std-plugins (116,135) - Refs #315 Should fix most of the call transfer issues, please test thoroughly - Los93soL

== Update 2010-07-17 23165 ==
* pluto-boot-scripts (234) - New startup script for the Launch Manager (fixes #753)
* pluto-website-admin (220)
** Weborbiter: add missing getNews function (fixes #755)
** Weborbiter: keep trying to get images/data when an communication error occurs
** Weborbiter: fix keyboard processing (fixes #754)

== Update 2010-07-16 23161 ==
* pluto-proxy-orbiter (487,488) - now with committed fixes for the 404 in 7970

== Update 2010-07-14 23155 ==
* pluto-asterisk (270,271) - Only send extra channel options for transfers when an extra channel is there, also fixes to viatalk create script so things work nicely again
* pluto-simplephone (498,499) - Whoops! Missed this package a few days ago, fixes Orbiter phones so they connect with the SIP secret
* pluto-system-database (211) - Updates to the Size table to include older iPhone/iPod Touch sizes, as well as iPhone4 size.
* pluto-mythtv-plugin (136,152) - Fixed some incorrect behavior with generating mythtv storage groups
* lmce-launch-manager (299,298) - Fixed the StartCoreServices.sh from passing wrong Device_ID to Sync2amp.pl causing NAS passwords to become scrabled.

== Update 2010-07-06 23148 ==
* freepbx - Changelog updated to get a new version number
* pluto-asterisk (270,271) - Add support for making announcements to phones
* pluto-dhcpd-plugin (302) - Define helper script as a perl script
* pluto-std-plugins (116,135) - Small speed up fix for video file list
* pluto-text-to-speech (283,284) - Add support for making announcements to phones
* pluto-website-admin (220) - Updates to the new weborbiter

== Update 2010-07-03 ==
*asterisk-pluto (269)
** Fix pluto sos menu generates the voice dialogs now
** Update caller id when sos menu calls out
*freepbx
** General dialplan cleanup
** FreePBX system status works now
** Fix warnings when updating modules list in FreePBX
*lmce-hai-omni-rs232 (748,749) - Make sure HAI created devices set HAI as the controlled via device
*pluto-asterisk (270,271)
** Update create scripts and abstract redundant code
** Keep Line_HouseMode in sync when trunks are deleted
** Transfers are working again
*pluto-website-admin (220) - Don't display phone trunk passwords in web admin
*pluto-dhcpd-plugin (302) - Cisco 7960 (with SIP firmware) will use sip secret now
*pluto-std-plugins (116,135) - CRITICAL MEDIA PLUGIN FIX IN CMD_Set_Media_Private which was causing the router to rapidly crash due to odd data coming in from MythTV PlugIn. Will investigate further, but this does stop the crashes.
*pluto-mythtv-plugin (136,152) - Add changes to MythTvSyncDB.sh to always set AlwaysStreamFiles to 1 for media directors.
*lmce-hulu-player (744,745) - somehow, an older package snuck in. This needs to be rebuilt to fix the hanging bug that somehow reappeared. Yes, I went back and checked the checked in code from a fresh checkin, this will fix it
*pluto-storage-devices (533) - Added dependencies for nbd-client and nbd-server so that remote playing of DVDs will work, correctly. (Fixes #743)
* pluto-proxy-orbiter - updates from Dianemo

== Update 2010-06-28 23119 ==
* asterisk-pluto (269) - Fix fire SOS event and dialplan cleanup - Los93soL
* freepbx - Fix fire SOS event and dialplan cleanup - Los93soL
* mjproxy (760,761)
* pluto-dhcpd-plugin (302) - update configure scripts for grandstream and snom 3xx phones for support of database secret.
* pluto-mythtv-player (133,152) - Bug #737 - MH Play Media can now set initial channel
* pluto-std-plugins (116,135) - Bug #736 - CMD_Delete_File in Media PlugIn now will not allow deletion of arbitrary files from the disk, lots of sanity checks. Support for deleting voicemails.
* pluto-system-database (211)
* pluto-xine-player (117,136) - enable subtitle support
* pluto-vdr (468,469) - Bug #737 - MH Play Media can now set initial channel
* pluto-website-admin (220) - Adds energy monitor that uses state change #677

== Update 2010-06-18 23082 ==
* lmce-datalogger-plugin (686,687)
* lmce-datalog-database (753)
* pluto-boot-scripts (234)
* pluto-std-plugins (116,135)
* asterisk-pluto (269)
* pluto-asterisk (270,271)
* pluto-website-admin (220)
* pluto-mythtv-player (133,152) - Fix the missing MythTV Setup in Computing. as the Quick Start Template has moved rows.
* pluto-mythtv-plugin (134,153) - Fixes #732 - Storage devices not locally attached to core are not added to mythtv storage groups and cleans up some error messages

== Update 2010-06-14 23070 ==
* pluto-std-plugins (116,135) - Fix to General Info Plugin to allow Firefox Bookmarks to work again. Please test!
* pluto-boot-scripts (234) - Modify Mozilla.sh to properly output a profile where bookmarks work again.
* mce-diskless-tools (627,628) - Modify DisklessInteractor to always return i386 until we get a working amd64 build again.
* vdr - Update to version 1.7.15
** Get rid of a few patches
** Fixes for sound decoding in Denmark

== Update 2010-06-10 23047 ==
* v4l2-Modules (732) - Fix Debian package naming to allow proper install of dkms package

== Update 2010-06-09 23046 ==
* lmce-picture-viewer (754,755) Refs #650, start picture viewer minimized
* pluto-website-admin (220) - Change wording of VDR error message to better reflect what's going on.
* v4l2-Modules (732) - Fix debian package naming to allow proper install of dkms package

== Update 2010-06-07 23036 ==
* pluto-asterisk (270.271) - Fix initial for no voicemail greetings after setup wizard (thanks los93sol)
* pluto-vdr (469,468)
** Syntax error fix in StartVDRClient - should start correct on MDs now.
** Add a default remote.conf so people can use the keyboard to control VDR.
* pluto-system-database (211) - Add support for TED5000 and Energy Monitoring Events to be used by future devices

== Update 2010-06-01 23002 ==
* lmce-hulu-player (739,740) - changed the accept() loop to be non-blocking, fixing the hung hulu player issue when the router needs to reload. -TSCHAK
* mce-diskless-tools (627,628) - cBuckle sent in a bugfix that prevented media directors with more than one NIC from properly being detected. We now assume the booting NIC is eth0. Thanks cBuckle! -TSCHKA
* pluto-website-admin (220) - Fixes #705, and #706 -TSCHAK
* pluto-system-database (211) - Fixes to QuickStartTemplate so icons will show. -TSCHAK
* pluto-std-plugins (116,135) - Fix to General Info Plugin so that it will properly show PNG images
* pluto-boot-scripts (234) - Fix to UpdateQuickStartIcons.sh to download quick start icons and convert to PNG if needed.
* lmce-update-system (650,651) - Fix preferences file

== Update 2010-05-20 22959 ==
* lmce-update-system (650,651) - Setup pinning to the LinuxMCE repository
* pluto-mythtv-plugin (134,153) - MythTV 0.23 support has been baked in. Thanks mandingo
* pluto-mythtv-player (133,152)

== Update 2010-05-20 22958 ==

* pluto-orbitergen (226,227) - Orbitergen changed to specify that MIDs are on-screen orbiters. This may change in the future, but I need to test something... --[[User:Tschak909|Tschak909]] 06:22, 9 May 2010 (CEST)
* pluto-system-database (211) - [http://svn.linuxmce.org/trac.cgi/ticket/684 Toshiba RAS series IR control template]
* pluto-generic-serial-device (307,335) - [http://svn.linuxmce.org/trac.cgi/ticket/685 access return parameters in GSD device]
* mythtv-0.23

== Update 2010-04-28 22898 ==
* pluto-website-admin (220) - [http://svn.linuxmce.org/trac.cgi/ticket/662 Fixes #662 (again ;) )]
* pluto-system-database (211) - sqlCVS additions for the SmartQ V7 MID
* pluto-updateentarea (341,342) - code in Setup to allow for devices in the MID category to get media scenarios.
* pluto-storage-devices (533) - Refs [http://svn.linuxmce.org/trac.cgi/ticket/672 #672]
* mce-diskless-tools (627,628) - Refs [http://svn.linuxmce.org/trac.cgi/ticket/655 #655]

== Update 2010-04-14 22889 *CLOUD Release* ==
* pluto-system-database (211) changes to the repository information for a package

== Update 2010-04-08 22883 ==
* pluto-boot-script (234) - Change smb.conf template to disable unix extension.
* pluto-website-admin (220) - [http://svn.linuxmce.org/trac.cgi/ticket/662 Fixes #662]
* lmce-picture-plugin (756,757) Refs [http://svn.linuxmce.org/trac.cgi/ticket/650 #650] fix pause of slideshow
* pluto-system-database (211) [http://svn.linuxmce.org/trac.cgi/ticket/650 #650] designer changes for picture viewer

== Update 2010-03-23 22876 ==
* pluto-std-plugins (116,135) Refs [http://svn.linuxmce.org/trac.cgi/ticket/650 #650], media plugin supports play all for pictures
* lmce-picture-viewer (754,755) Refs [http://svn.linuxmce.org/trac.cgi/ticket/650 #650], picture viewer
* lmce-picture-plugin (756,757) Refs [http://svn.linuxmce.org/trac.cgi/ticket/650 #650], picture plugin
* Pluto PNP Detection Scripts (562), added detection script for Pioneer Elite series of Receivers
* Pluto Capture Card Setup Scripts (580), added input change scripts for various capture cards

== Update 2010-03-14 22853 ==
* pluto-website-admin (220) - Refs [http://svn.linuxmce.org/trac.cgi/ticket/637 #637] Reload event plugin configuration when events change (no need to reload router anymore, except after adding/deleting event commands), [http://svn.linuxmce.org/trac.cgi/ticket/648 #648] Fix device template adding to avoid sqlCVS commit problems
* pluto-orbiter (119,138) [http://svn.linuxmce.org/trac.cgi/ticket/647 #647] Enable event mapping for mouse buttons
* pluto-system-database (211) [http://svn.linuxmce.org/trac.cgi/ticket/646 #646] Device template for Logitech MX Air mouse
* pluto-std-plugins (116,135) - Refs [http://svn.linuxmce.org/trac.cgi/ticket/651 #651] fix router crash with boolean event parameters

== Update 2010-03-07 22832 ==

* pluto-zwave-lighting (505,506) - Refs [http://svn.linuxmce.org/trac.cgi/ticket/620 #620] make command for child work again
* pluto-system-database (211) - new package and package changes for datalogger plugin
* lmce-datalog-database (753) - datalogger database, refs [http://svn.linuxmce.org/trac.cgi/ticket/630 #630]
* lmce-datalogger-plugin (686,687) - Refs [http://svn.linuxmce.org/trac.cgi/ticket/630 #630] install automatically, configurable graph display
* lmce-datalog-db (688,689) - Refs [http://svn.linuxmce.org/trac.cgi/ticket/630 #630]
* pluto-website-admin (220) - Refs [http://svn.linuxmce.org/trac.cgi/ticket/630 #630], [http://svn.linuxmce.org/trac.cgi/ticket/633 #633], fix for some attribute names not showing up in media browser page, improvements to datalogger section
* pluto-std-plugins (116,135) - Refs [http://svn.linuxmce.org/trac.cgi/ticket/637 #637] allow event plugin to reload configuration without a router reload

== Update 2010-02-28 22812 ==

Hulu Now works, and the HAI Omni Security panel driver has been checked in and integrated.

* pluto-system-database (211) - Addition of buttons to Hulu Remote (tschak)
* lmce-hulu-player (739,740) - Hulu Player now uses Hulu Desktop's LIRCD port via a fake LIRCD Server. (tschak)
* 751 HAI Control Program
* 750 HAI Control Program Source
* 749 LinuxMCE HAI Omni RS232 Panel Support
* 748 LinuxMCE HAI Omni RS232 Panel Support Source
* pluto-zwave-lighting (505,506) - Refs [http://svn.linuxmce.org/trac.cgi/ticket/620 #620] multi instance support for sensors
* pluto-mplayer-player (657,656) - Refs [http://svn.linuxmce.org/trac.cgi/ticket/471 #471] Finally committed vdpau support for mplayer

== Update 2010-02-23 22803 ==
* pluto-boot-script (234)
** Install zaptel-modules and load ztdummy for meetme
** Disable KDE screensaver upon KDE Desktop start (fixes #600)
* pluto-dhcpd-plugin (302) - Make sure to transfer database secret into sip_additional.conf
* pluto-orbiter (119,138) - Color fixes
* pluto-proxy-orbiter (488,487) - Color fixes - thanks radu
* pluto-vdr (468,469)
** Only create setup.conf if it does not contain a remotetimers entry
** Disable shutdown of system from VDR
* v4l2-firmware (733) - Added new firmware drivers to support a broader range of DVB cards

== Update 2010-02-18 22795 ==
* pluto-proxy-orbiter (487,488) Fixes [http://svn.linuxmce.org/trac.cgi/ticket/610 #610]

== Update 2010-02-16 22777 ==
* pluto-std-plugins (116,135)
** Fixes event criteria for PK_EventParameter [http://svn.linuxmce.org/trac.cgi/ticket/602 #602]
** Fixes time of day - can now check againt hh:mm:ss [http://svn.linuxmce.org/trac.cgi/ticket/605 #605]
** Fixed bug introduced in the two fixes above [http://svn.linuxmce.org/trac.cgi/ticket/608 #608]
* pluto-vdr (468,469) - Remove SourceCaps entries from default setup.conf
* pluto-system-database (211) - Hulu Player/PlugIn changes
* Hulu PlugIn (737,738) - device template constant fixes
* Hulu Player (739,740) - device template constant fixes

== Update 2010-02-14 22768 ==
* pluto-xine-player (117,136) - removed dependency for libxine1-ffmpeg

== Update 2010-02-13 22765 ==
* pluto-std-plugins - fixes #587

== Update 2010-02-12 22763 ==
* new-installer
** changes in kdm link management
** verify kubuntu-desktop is installed
* pluto-boot-script (234) - Fix copying of desktop link to activate Orbiter into root's Desktop dir
* pluto-vdr (469,468) - Only backup setup.conf if it exists.

== Update 2010-02-10 22758 ==
* pluto-boot-script (234)- Add Activate Orbiter to KDE desktop (#596)
* mce-diskless-tools (627,628) - Add a link to the desktop to call Activate Orbiter (#596)
* linux-diskless-image (2.6.27-17) - Update to the latest kernel released by Ubuntu
* alsa-modules (2.6.27-17) - Update to the latest kernel released by Ubuntu
* zaptel-modules (2.6.27-17) - Update to the latest kernel released by Ubuntu

== Update 2010-02-08 22754 ==
* Hulu PlugIn (737,738) - Initial Beta of Hulu Support
* Hulu Player (739,740) - from TSCHAK
* Game Player (673,674) - Added support for custom controller files to Game Player - see TankStick DT #2100 for an example.
* pluto-std-plugins - fixes #587

== Update 2010-02-03 22733 ==
* MythTV - We provide our own packages (0.22 sources packages from mythbuntu )
* ZWave Lighting (505,506) - Wizard bugfix

== Update 2010-01-27 22704 ==
* pluto-photo-screen-saver (582,581) - maintain correct image aspect ratio [http://svn.linuxmce.org/trac.cgi/ticket/568 #568]
* pluto-vdr (469,468)
** Use remotetimer for central scheduling
** Don't autostart VDR on MD
** Support VDPAU
* VDR - We provide our own packages (1.7.11 sources packages from eTobi and free-vdr.de)

== Update 2010-01-16 22689 ==
* pluto-boot-scripts (234) - new safe_delete.sh script for safely deleting database entries
* pluto-cm15a (730,731) - new DCE device, CM15A USB interface for X10
* pluto-mythtv-plugin (134,153) - Capture card install now goes directly to the setup wizard
* pluto-orbiter (119,138) - Capture card install now goes directly to the setup wizard
* pluto-storage-devices (533) - mount no longer echos out errors during ro filesystem
* pluto-photo-screen-saver (582,581) - Rotate image according to exif tag [http://svn.linuxmce.org/trac.cgi/ticket/566 #566]

== Update 2010-01-08 22669 ==
*pluto-boot-scripts (234)
** Purge_Camera_Archives.pl fixed
** backup/restore fixed
** enable_wol called from Startup script - WOL for MDs should work again
*pluto-motion-wrapper (456,455) - Now calls the purge script every 6 hours and on reload
*pluto-storage-devices (533)
** Hostname now added to string to be displayed on orbiters when new drives are detected.
** Boot partitions will be filtered out also.
*pluto-system-database (211) - changes to MotionWrapper's motion.conf default options to use new option names

== Update 2009-12-25 22639 - Christmas fix ==
* freepbx - removal of chan_vpb.so to circumvent coredumps on system without a Voicetronix board (#519)
* pluto-avwizard (555,556) - modification of startup scripts to not screw the system upon status calls to the startup scripts
* pluto-boot-scripts (234)
** modification of startup scripts to not screw the system upon status calls to the startup scripts
** updated Backup/Restore functionallity
** fixes web admin log links for hybrid MD
** Make sure only a single logrotate configuration file for LinuxMCE exist
* pluto-hdhomerun(621,620)- Fixes bug where only 1 tuner was added to mythtv
* pluto-mythtv-plugin (134,153) - Fixes deletion of of hostname from mythconverg.capturecard by creating and using a dummy videosource
* pluto-simplephone (498,499) - Adds support for password in DeviceData
* pluto-std-plugins (116,135) - Adds support for specialized interfaces
* pluto-system-database (211) - Some devicedata changes for SIP phone templates to include devicedata for password
* pluto-website-admin (220) - Fixes Climate Command Wizard Set Temperature command, Climate Command Wizard also now works with On//Off Climate Devices
* pluto-orbiter (119,138) - Fixes issue with input devices crashing orbiter [http://svn.linuxmce.org/trac.cgi/ticket/522 #522]

== Update 2009-12-14 22600 ==
* pluto-dcerouter (154,155) - Fixes broken Delay command
* pluto-libresolution (545,544) - UseEDID HDMI Audio xorg.conf entry
* pluto-asterisk (270.271) - Fix for Messagenet configuration script (changing Window's EOL characters)
* pluto-system-database (211) - Some devicedata changes for dcerouter delay command and DCS-5300G camera
* pluto-website-admin (220) - fix HDMI selection in web admin
* pluto-xine-player (117,136) - removed 1 second sleep after play media. refactored code to stop screen saver

== Update 2009-12-12 22598 ==
* pluto-website-admin (220) - sql fix from http://svn.linuxmce.org/trac.cgi/changeset/22567
* pluto-xine-plugin (118,137) - fix for remote audio cd streaming [http://svn.linuxmce.org/trac.cgi/ticket/470 #470] - still not working
* pluto-xine-player - refactor screen saver handling
* pluto-disk-drive (122,141) - fix for remote audio cd streaming [http://svn.linuxmce.org/trac.cgi/ticket/470 #470] - still not working
* pluto-x-scripts (520,523) - fix for audio over HDMI
* alsa-lib, alsa-utils, lib64asound2, libasound2 - fix for audio over HDMI

== Update 2009-12-06 22569 ==
* pluto-dce-router (154,155) - now depends on lmce-skins-uita
* pluto-system-database (211) - new lmce-skins-uita package definition
* lmce-skins-uita (727) - new skin
* MPlayer_Player (656,657) - Videos that is played by mplayer can now take advantage of vdpau. (Set hw accel to "auto" or "vdpau")
* pluto-xine-player (117,136) - don't stop screen saver when playing audio [http://svn.linuxmce.org/trac.cgi/ticket/486 #486]
* pluto-orbiter (119,138) - hide xine when playing audio, keeps screen saver visible [http://svn.linuxmce.org/trac.cgi/ticket/486 #486]
* Update of Zaptel and other kernel related packages to -16

== Update 2009-12-03 22558 ==
* Build_Replacement_Package - freepbx (ubuntu/asterisk/freepbx) - Ticket #345 - Fixes the issue of installing new modules in FreePBX.
* pluto-asterisk (270.271) - Phone Lines fixing - asterisk (src/asterisk) - Ticket #374 - Fixes the issue during the creation procedure of a new phone lines via web LinuxMCE Admin. New MessageNet Provider support.
* pluto-avwizard (555,556) - Fixes #480 - Fails to identify untouched xorg.conf
* pluto-boot-scripts (234)
** Cleanup in nvidia-config
** MD WOL Problem fixed
* pluto-website-admin (220)
** #469 IVR menue will now be regenerated every time a phone line is added.
** #221 IR commands selection screen now has sort modes to make it easier to sift through all those commands.
** #219 Various layout improvements to the wizard pages.
* pluto-xine-player (117,136) - changes for HDMI out
* pluto-std-plugins (116,135) - Changes to Telecom PlugIn to give proper audio switching behaviour when USB Conference microphones are used for the media director phone. This is of relevance to particular configurations that do not allow concurrent access to the soundcard (such as coax/optical settings). -tschak

== Bugfixes ==
=== Mythtv-plugin fails to install ===
Install with apt-get install -f <name-of-package>

Developers Guide

2011-04-20T02:11:26Z

Icosahedron: Fixed a couple incorrect paragraph numbers

[[Category: Programmer's Guide]]
[[Category:Development]]
[[Category:Documentation]]

{| align="right"
| __TOC__
|}
LinuxMCE developer’s guide
Document version 1.0

==1. Architecture==

LinuxMCE uses a modular architecture. The heart of LinuxMCE, the 'main application' DCERouter is nothing but a general-purpose message router. It has absolutely no code relating to any of LinuxMCE’s functionality--it just relays messages between "Devices". The functionality of LinuxMCE is entirely in separate programs (aka "Devices") which all run independently and communicate with each other by passing messages through DCERouter over sockets.

[[Image:LMCE_Architecture_mini.jpg|frame|none|LinuxMCE architecture – the devices]]

The plug-in’s are also devices, but instead of running as separate binaries, they run as dynamic libraries in DCERouter’s memory space.
A LinuxMCE system can have one or more Media Directors (MD’s). Also, a Core machine can have also the functionality of a Media Director. We call it a Hybrid:

[[Image:LMCE_Architecture_-_the_machines.jpg|frame|none|Linux MCE architecture – the machines]]

==2. DCE==

DCE (Data, Commands and Events) is a lightweight network protocol allowing any device to access its configuration (ie data) from a central database, send + receive commands, and fire + respond to events.

The DCE protocol can be implemented with any device that supports standard networking. LinuxMCE provides a DCE library written in Ansi C++ that implements the protocol on any socket-compatible operating system, and has been tested on Linux and Windows. Porting to other languages should not be a big task. Because the messaging is socket-based, any device, regardless of operating system or language, can be used with any other device.

In each installation there is also one DCE Router, through which all messages are routed. An "installation" is a group of devices treated as a unit, and normally corresponds to a physical residence.

The DCE Router is itself quite simple. It just opens a port for incoming connections. When a device connects, the device sends its unique ID, or Mac Address. The DCE Router does a lookup in a database, and returns that device's data (configuration). DCERouter also sends back a list of all the other devices in the installation with basic information including the commands they know how to implement. The DCE Device then opens a minimum of 2 socket connections to the router. One is for incoming messages (usually commands) from the router, another for outgoing messages (usually events) to it. The DCE Library, which implements the protocol for DCE Devices and the DCE Router, will also open a 3rd socket connection so that it has 2 outgoing sockets: 1 dedicated for sending events and the other for sending other types of messages, like requests and commands to other devices.

All messages go through the router. The devices do not communicate directly to each other. The message will contain information such as the destination device, the type of message, the message id and any number of optional parameters. The router does nothing with the message but forward it to the destination device or devices if the message is being sent to more than one. The DCE library, from which DCE Devices and the DCE Router are derived, knows how to receive incoming messages of the type command and route them to a message handler in the DCE Device.

Another important library is PlutoUtils. It has cross-platform wrapper classes to handle file, strings, processes, threads synchronization, database utils, etc.

==3. DCERouter==

When a DCE Device connects, DCERouter gives it its configuration data and is responsible for receiving and forwarding any messages to and from the devices that connect to it. The most common types of messages are commands and events. All communication goes through DCE Router. If a doorbell device fires an event that the button was pushed, that event goes to DCERouter, which will forward it whatever plug-in has indicated it wants to handle that type of event. If the plug-in then wants to send a command to the media player, this command goes first to the DCE Router, which will then forward it to the media player. The DCE Devices never communicate with each other directly--everything goes through DCE Router. Devices can create their own types of messages specific to them--not just commands and events. For example, a DVD player may send a message that contains a screen capture, or a TV program may send a stream of messages with streaming video. To DCE Router it makes no difference. Messages just have sources and destinations, and DCE Router does not care what type of message it is.

DCERouter also allows you to Message Interceptors. This means a device or plug-in can say that it wants to pre-process all messages that meet a certain criteria. For example, a security plug-in may want to see all events relating to security.
Plug-in’s are DCE Devices that run within the DCERouter's memory space. They are DCE Devices just like any other and they are created like any other DCE Device. The code is the same, it's just a compilation option whether the device is built as a normal DCE Device, which runs in its own memory space and communicates with DCERouter over a socket, or if it's a plug-in which gets loaded into DCERouter's memory space. Plug-in’s have the ability to get pointers to the in-memory instance of the other plug-ins so they can share memory and call each others methods.

See below a simplified class diagram for DCERouter:
[[Image:DCERouter.jpg|frame|none|Simplified class diagram for the DCE router]]

==4. The binary communication protocol==

===4.1 Introduction===
A device can create a command connection and one or more event connections to the router.
*The command connection is used as an incoming connection and device will use it to receive message from the router (commands).
*An event connection is used by the device as an outgoing connection to notify the router about events or the deliver commands to other devices.
The DCERouter process is listening on 3450 port.

===4.2. How to create an event connection===
Here is how the handshake is made for an event connection:

>> Device sends:
EVENT <my_device_id> '\n'

<< The router will respond with :
OK <my_device_id> IP=<device_ip_address> '\n'

>> To send a message, the device will send :
MESSAGE <size_of_binary_message> '\n'

and then:
<serialized_binary_message>

===4.3 How to serialize data===
DCE uses SerializeClass to serialize/deserialize data.
The sources can be found here : src/SerializeClass/Serialize.h/cpp.
The deserialize the data, the deserializing module must know the way the data was serialized like this:
* 4 bytes, unsigned long
* 1 byte, unsigned char

Primitives:
* 8 bytes, unsigned int64
* 8 bytes, int64
* 4 bytes, unsigned long
* 4 bytes, unsigned short
* 1 byte, unsigned char
* 1 byte, char
* 4 byte, long
* 4 bytes, float
* 8 bytes, double
* 2 bytes, short

Complex types:

#string
#*STR_LENGTH bytes, the array with chars
#*1 byte, '/0' (value 0x00)
#:
#block of data
#*BLOCK_LENGTH bytes, the array with bytes
#:
#vector of strings
#*VECT_LENGTH bytes, the number of strings from vector
#*string 0
#*string 1
#*...
#*string VECT_LENGTH - 1

Other complex types serialized (see SerializeClass.cpp for details) :
* map<int,string>
* map<u_int64_t,string>
* map<int,int>
* map<string,string>
* vector<int>
* vector< pair<int,int> >
* map<string, pair<int,int> >

SerializeClass also allowed you to serialize/deserialize custom objects. Examples:
* PlutoColor
* PlutoPoint
* PlutoSize
* PlutoRectangle
* PlutoDataBlock

===4.4 How to serialize a message===

The class used by DCE is Message class from src/DCE/Message.h/cpp unit.

This is how the raw data looks like into a binary message:

* long, value must be 1234 (magic number)
* long, <device_from_id>
* long, <device_to_id>
* long, <device_group_to_id>
* long, <message_id>
* long, <message_priority>
* long, <message_type>
* long, <device_category_to>
* long, <device_template_to>
* unsigned char, <include_children>
* long, <message_broadcast_level>
* long, <message_retry>
* unsigned char, <relative_to_sender>
* long, <expected_response>
* string, <device_list_to>
* unsigned long, <number_of_string_parameters>
** foreach <string_parameter>
*** long, <string_parameter_id>
*** string, <string_parameter_value>
** end_foreach
* unsigned long, <number_of_data_parameters>
** foreach <data_parameter>
*** long, <data_parameter_id>
*** unsigned long, <data_parameter_length>
*** array of bytes, <data_parameter_value>
** end_foreach
* unsigned long, <number_of_extra_messages>
** foreach <extra_message>
*** unsigned long, <serialized_extra_message_length>
*** array of bytes, <serialized_extra_message_value>
** end_foreach
* unsigned long, must be 6789

'''Enums:'''
* enum eBroadcastLevel { BL_None=0, BL_DirectSiblings=1, BL_SameComputer=2, BL_SameRoom=3, BL_SameHouse=4, BL_AllHouses=5 };
* enum eRetry { MR_None=0, MR_Retry=1, MR_Persist=2 };
* enum eExpectedResponse { ER_None=0, ER_ReplyMessage, ER_ReplyString, ER_DeliveryConfirmation };
* message types: enum { MESSAGETYPE_COMMAND=1, MESSAGETYPE_EVENT=2, MESSAGETYPE_DATAPARM_CHANGE=3, MESSAGETYPE_REPLY=4, MESSAGETYPE_DATAPARM_REQUEST=5, MESSAGETYPE_LOG=6, MESSAGETYPE_SYSCOMMAND=7, MESSAGETYPE_REGISTER_INTERCEPTOR=8, MESSAGETYPE_MESSAGE_INTERCEPTED=9, MESSAGETYPE_EXEC_COMMAND_GROUP=10, MESSAGETYPE_START_PING=11, MESSAGETYPE_STOP_PING=12, MESSAGETYPE_PURGE_INTERCEPTORS=13, MESSAGETYPE_PENDING_TASKS=14 };
* message priority : enum { PRIORITY_LOW=0, PRIORITY_NORMAL=1, PRIORITY_HIGH=2, PRIORITY_URGENT=3 };

'''Important notes:'''
* when sending to device template, set <device_template_to> to desired device template and also <device_to_id> to -2000 (DEVICEID_MASTERDEVICE)
* when sending to device category, set <device_category_to> to desired device category and also <device_to_id> to -2001 (DEVICEID_CATEGORY)
* when sending to a list with devices, set <device_list_to> to comma delimited list with devices and also <device_to_id> to -2002 (DEVICEID_LIST).

'''Example:'''
Here is the pseudocode to send the "on" command to a light switch.
We'll assume that the your device has #id 250 and the light switch has device #id 100

*MyDevice.Connect(router_ip, 3450 /*port*/)
*MyDevice.SendData("EVENT 250\n")
*MyDevice.ReceiveData() //until you'll get a '\n' ; you should receive: "OK 250 IP=<device_ip_address> '\n';

'''next: creating a message'''
let's say MyData is an array of bytes
*SerializeLong(MyData, 1234) //magic number
*SerializeLong(MyData, 250) //my id
*SerializeLong(MyData, 100) //the light switch
*SerializeLong(MyData, 0) //not used now
*SerializeLong(MyData, 192) //message id of command 'on'
*SerializeLong(MyData, 1) //normal priority
*SerializeLong(MyData, 1) //message type : command
*SerializeLong(MyData, 0) //not used now
*SerializeLong(MyData, 0) //not used now
*SerializeUnsignedChar(MyData, 0) //not including children
*SerializeLong(MyData, 0) //broadcast level : none
*SerializeLong(MyData, 0) //don't retry
*SerializeUnsignedChar(MyData, 0) //relative to sender false
*SerializeLong(MyData, 3) //delivery confirmation
*SerializeString(MyData, "") //device list to empty
*SerializeUnsignedLong(MyData, 2) //2 parameters
*SerializeLong(MyData, 98) //parameter type #98
*SerializeString(MyData, "") //empty value
*SerializeLong(MyData, 97) //parameter type #97
*SerializeString(MyData, "") //empty value
*SerializeUnsignedLong(MyData, 0) //no binary parameters
*SerializeUnsignedLong(MyData, 0) //no extra messages
*SerializeUnsignedLong(6789) //magic number

*MyDevice.SendData("MESSAGE " + MyData.length() + '\n')
*MyDevice.SendData(MyData)
*MyDevice.ReceiveData() //until you'll get a '\n' ; you should receive: "OK" or an error message

*MyDevice.CloseConnection();

===4.5 How to serialize data-grids ===
'''Complex objects:'''
# DataGridCellSerializableData
#* unsigned long, <sizeof(DataGridCellSerializableData)>
#* unsigned long, <graphic_length>
#* unsigned long, <message_length>
#* unsigned long, <text_length>
#* unsigned long, <value_length>
#* unsigned long, <image_path_length>
#* unsigned long, <number_of_attributes_length>
#* unsigned long, <attributes_length>
#* int, <alternate_color>
#* unsigned long, <graphic_format>
#* unsigned char, <selectable>
#* int, <style_detail>
#* int, <col_span>
#* int, <row_span>
#* unsigned char, <dont_fire_grid_event>
#:
#:Enums:
#* enum eGraphicFormat { GR_UNKNOWN=0, GR_JPG=1, GR_GIF=2, GR_TIF=3, GR_PNG=4, GR_MNG=5, GR_BMP=6, GR_OCG=7, GR_PFG=8 };
#:
# DataGridCell
#* DataGridCellSerializableData, <datagrid_cell_serializable_data>
#* array of chars, <text>
#* array of chars, <value>
#* array of bytes, <graphic_data>
#* array of bytes, <message_data>
#* array of chars, <image_path>
#*:
#** foreach <cell_attribute>
#*** array of chars ended with '\0' , <cell_attribute_name>
#*** array of chars ended with '\0', <cell_attribute_value>
#** end_foreach
#:
#DataGridTableSerializableData
#* int, <total_number_of_columns>
#* int, <total_number_of_rows>
#* unsigned char, <keep_row_header>
#* unsigned char, <keep_column_header>
#* int, <column_count>
#* int, <row_count>
#* int, <starting_column>
#* int, <starting_row>
#* int, <cell_count>
#:
#DataGridTableCellIndex
#* unsigned int, <column_row_type>
#* unsigned int, <size>
#:
#DataGridTable
#* unsigned long, <sizeof(DataGridTableSerializableData)>
#* array of DataGridTableCellIndex, <col * row * sizeof(DataGridTableCellIndex)>
#* array of DataGridCell, <col * row * serialized DataGridCell>

----
Additional step: lzo compression/decompression

'''Note:''' can be disabled if compiled with DISABLE_LZO_DATAGRID
----

==5. The devices==

Each device has associated an interface, which we call device template. A device template is a set of commands to be implemented, events which can be fired by the device and device data (persistent information for device).
To create device templates and modify them, go to LinuxMCE Web Admin -> Advanced -> Configuration -> Device Templates.
To generate the C++ code for the device implementing a device template interface, you must use DCEGen tool, specifying the database ip address and the device template number.
Here is the simplified class diagram for one of the devices (App_Server):

[[Image:App_Server.jpg|frame|none|Simplified class diagram for a DCE device]]

The classes App_Server_Event, App_Server_Command and App_Server_Data are generated using DCEGen tool. The base classes for them are implemented in DCE Library.

==6. App_Server device==

App_Server device is present by default on all LinuxMCE machines. It spawns/kills applications, handles volume of sound on that machine, restarts/halts the device.

# Implemented commands:
#*CMD_Spawn_Application - Spawns an application
#*CMD_Kill_Application - Kills an application
#*CMD_Application_Is_Running - Checks if the given application is running.
#*CMD_Halt_Device - Halts or reboots this device
#*CMD_Vol_Up - Increases the volume 1%
#*CMD_Vol_Down - Decreases the volume 1%
#*CMD_Set_Volume - Sets the volume to a specific level between 0-100
#*CMD_Mute - Toggles mute/unmute
#:
#:
#It doesn’t fire any events.
#:
#:
#It has the following device data:
#*Discrete Volume
#*Volume Level

==7. Photo_Screen_Saver device==

The photo screen saver (PSS) displays pictures when there is no video playing, even if you just happen to be listening to music. By default, the photos come from Flickr and are downloaded regularly to local drive.

PSS is a OpenGL application and it slides pictures and fades them between transitions.

1. Implemented commands

The list with pictures is taken by sending a command to Orbiter Plugin : CMD_Get_Screen_Saver_Files which has an output parameter Filename. The filenames are delimited by a ‘\n’ character.

The PSS animations are started/stopped using CMD_On/CMD_Off commands. To force PSS reload the list with pictures from Orbiter Plugin, CMD_Reload is used.

When PSS starts, it should check every 10 minutes if there are any pictures downloaded and ready to be displayed. If there are pictures to display it should display them on CMD_On command and refresh the list with pictures every 24 hours.

2. It doesn’t fire any events

3. Device data:
* ZoomTime - Value in miliseconds that a zoom effect will take
* FadeTime - value in miliseconds that a fade effect will take
* Name - The window name to activate

==8. Media Player device==

Currently there are two Media Players in LinuxMCE, the primary Xine_Player and
secondary MPlayer_Player.
First one is based one the Xine engine (http://xinehq.de) and supports the
following formats:

*'''File formats (System layer / media types)supported:'''
**direct DVD playback (of unlocked/unencrypted DVDs, see below)
** Video CD
** Audio CD
** mpeg program streams (.mpg, .mpeg)
** mpeg transport streams (.ts)
** ogg (.ogg, .ogm)
** avi (.avi)
** asf (.asf, .wmv, .wma)
** quicktime (.mov, .mp4)
** mpeg-video (.mpv, .m2v)
** mpeg-audio (.mp2, .mp3)
** Sega Saturn FILM (.cpk)
** Id Software RoQ (.roq)
** wav (.wav)
** Autodesk FLIC (.fli)
** real (.rm, .ra, .ram)
** raw dv (.dv)
** network graphics format (.png, .mng)
** Creative Voice (.voc)
** Sun/NeXT SND/AU (.snd, .au)
** Wing Commander III (.mve)
** Westwood Studios files (.vqa, .aud)
** Electronic Arts WVE (.wve)
** AIFF (.aif, .aiff)
** YUV4MPEG2 (.y4m)
** SMJPEG (.mjpg)
** raw AC3 (.ac3)
** Dialogic VOX (.vox)
** TechnoTrend PVA (.pva)
** Playstation STR (.str)
** Nullsoft Video (.nsv)
** 4X Technologies (.4xm)

*'''Video codecs supported:'''
** mpeg 1/2
** mpeg 4 (aka OpenDivX)
** ms mpeg 4
** divx 3/4/5
** windows media video 7 & 8
** motion jpeg
** Cinepak
** DV
** ms video 1 (msvc)
** ms rle
** Sorenson SVQ1/SVQ3 (often used in Quicktime trailers)
** creative yuv (cyuv)
** roq video
** QT RLE, SMC, RPZA
** theora
** via external binary/win32 codecs (not included in xine):
** Indeo 3.1-5.0
** Window Media Video 8,9
** On2 VP3.1
** I263
** Real Media 2.0, 3.0, 4.0
* currently unsupported/untested Formats:
** 3ivx
** h263 (aka Real Video 1.0)

*'''Audio codecs'''
** mpeg audio (layer 1,2,3)
** a/52 (aka ac3, dolby digital)
** aac (used in .mp4 files)
** dts (via external decoder)
** vorbis
** pcm
** adpcm (MS/IMA/DVI/Dialogic)
** mu-law and A-law
** roq dpcm
** Real Media dnet audio
** Real Media 28.8 audio
** DivX audio (WMA)
** GSM 6.10
** FLAC
** NSF (NES sound format)
** Speex

The MPlayer_Player is used as the fallback player for the formats Xine doesn't
support/supports not well and currently is used for playing HD-DVD/Bluray
video files and disks.

A media player device plays all kind of media: audio and video, stored media or from cd/dvd/hd/bluray drivers, etc.

1. Implemented commands

*'''Keyboard input:'''
** CMD_EnterGo - Select the currently highlighted menu item
** CMD_Move_Up, CMD_Move_Down, CMD_Move_Left, CMD_Move_Right - Move the highlighter

*'''Media Player Commands'''
** CMD_Pause - Pause the media
** CMD_Play - Play the media
** CMD_Skip_Back_ChannelTrack_Lower - Lower the channel, track, station, etc. by 1. Same as Jump to Pos in Playlist with value -1 for a smart media player
** CMD_Skip_Fwd_ChannelTrack_Greater - Raise the channel, track, station, etc. by 1. Same as Jump to Pos in Playlist with value +1 for a smart media player
** CMD_Stop - Stop the media

*'''Menu Navigation'''
** CMD_EnterGo - Select the currently highlighted menu item
** CMD_Move_Up, CMD_Move_Down, CMD_Move_Left, CMD_Move_Right - Move the highlighter
** CMD_Get_Video_Frame - Gets the current video frame from the media player.
** CMD_Goto_Media_Menu - Goto to the current media Root Menu.
** CMD_Navigate_Next - Nagivate to the next possible navigable area. (The actual outcome depends on the specifc device)
** CMD_Navigate_Prev - Nagivate the previous possible navigable area. (The actual outcome depends on the specific device).
** CMD_Simulate_Mouse_Click - Simlate a mouse click at a certain position on the screen

*'''Smart DVD commands'''
** CMD_Angle – Go to an angle
** CMD_Audio_Track – Go to an audio track
** Subtitle – Go to a subtitle

* '''Smart Media Player'''
** CMD_Change_Playback_Speed – Will make the playback to FF with a configurable amount of speed.
** CMD_Guide - Show guide information. For a dvd this may be the menu, just like the menu command
** CMD_Jump_Position_In_Playlist - Jump to a specific position in the playlist, or a track, or a chapter. Smart media players should also understand the skip fwd/skip back (which non-DCE media players use) to be the same thing as a jump +1 or -1
** CMD_Jump_To_Position_In_Stream - Jump to a position in the stream, specified in seconds.
** CMD_Menu - Show a menu associated with this media
** CMD_Pause_Media - This will stop a media that is currently played. This method should be paired with the "Restart Media" and used when the playback will be stopped and restarted on the same display device.
** CMD_Play_Media - This command will instruct a Media Player to play a media stream identified by a media descriptor created by the "Create Media" command.
** CMD_Report_Playback_Position - This will report the playback position of the current stream.
** CMD_Restart_Media - This will restart a media was paused with the above command
** CMD_Set_Aspect_Ratio - Force aspect ratio
** CMD_Set_Media_ID - Set Media ID - information about media stream
** CMD_Set_Media_Position - Jump to a certain media position
** CMD_SetZoom - Sets zoom level, relative, absolute or 'auto'
** CMD_Simulate_Keypress - Send a key to the device's OSD, or simulate keypresses on the device's panel
** CMD_Start_Streaming - Like play media, but it means the destination device is not the same as the source
** CMD_Stop_Media - This will instruct the media player to stop the playback of a media started with the "Play Media" Command
** CMD_Update_Object_Image - Display an image on the media player

2. '''It fires the following events'''
* EVENT_Menu_Onscreen - A DVD Menu appeared on screen
* EVENT_Playblack_Completed - Fired when the playback of a stream has completed.
* EVENT_Playback_Info_Changed – Playback info changed
* EVENT_Playback_Started – Media has start playing

3. '''Device data:'''
* Name - The name of the window for this app
* Hardware acceleration - driver used
* Deinterlacing Mode - Movie deinterlacing filter status
* Port – Time code notification every second
* Zoom Level – default zoom level

'''NOTE:''' A deviation from design, the media player must bind on a port specified in the device data and report the time code every one second. Any device like an Orbiter could connect to that port and read the time code. Here is the format used for time code:
Speed,CurrentTime,TotalTime,StreamID,Title,Chapter,MediaType,MediaID,Filename (comma delimited).

==9. Orbiter==

===9.1 Introduction===

The Orbiter is really a device just like any other. The main class, Orbiter, is a normal DCE command implementation. However, the Orbiter class was written so that it has no platform-specific functions, such as graphics and sound. It handles the basic logic, and calls pure virtual functions that derived classes must implement to handle the platform-specific commands. Most of the code and virtually all of the logic is contained in the base classes. Therefore, it is a fairly easy task to make a new version of Orbiter for a platform other than SDL, perhaps one that uses Windows SDK calls, or another image library.

Right now there are implementations of Orbiter using SDL. PocketFrog and OpenGL engines. Orbiter runs on different operation systems like Linux, Windows, Windows CE, Window Mobile, Symbian60. There also implementation for web orbiter (running into a browser) or for a Cisco hard phones (using XML services).

===9.2 Architecture===

[[Image:architecture.jpg|frame|none|Orbiter application architecture]]

The present diagram shows how the Orbiter application architecture looks like. Depending on the Graphic Engine and the platform, the only modules dependent on them are “Renderers – engine specific” and “Orbiter - platform specific”.

====9.2.1. The renderers====

There are two kinds of renders:
* orbiter renderers
* object renderers

The orbiter renderers (derived from OrbiterRenderer class) handle the graphic primitives, having pure virtual methods for operations like this:
* RenderText
* SolidRectangle
* HollowRectangle
* DrawLine
* FloodFill
* RenderGraphic
* ReplaceColorInRectangle
* etc.

and applications flow :
* event loop
* configure
* destroy
* on quit
* on reload

However, OrbiterRenderer is not an interface. It also has implemented the logic needed for:
* render screen action
* show a progress bar
* highlighting / un-highlighting objects
* render shortcuts
* show / hide popup’s
* redraw objects
* refresh screen
* render object asynchronously
* object on screen / off screen actions
* background image loading
* drawing an arrow

Here is the class diagram for derived OrbiterRenderer‘s:

[[Image:orbiterrenderer.jpg|frame|none|OrbiterRenderer class diagram]]

Also, there are renderer classes of complex objects like button, data grid, edit box, etc. The base classes for them are : ObjectRenderer, DataGridRenderer. Each renderer is attached to an object like DesignObj_Orbiter, DesignObj_DataGrid.

Here is the class diagram for OpenGL implementation:

[[Image:openGLimplementation.jpg|frame|none|OpenGL implementation]]

The screens are actually trees of objects. The characteristics of the objects are set using the Designer application and stored in the database, then serialized by OrbiterGen and then deserialized by Orbiter.
OrbiterGen scales and pre-renders the screens. Also, OrbiterGen embeds in the serialized data info about the actions to be executed when an object is loaded, activated, unloaded, etc.

====9.2.2. Orbiter – platform specific====

Orbiter also has to take care of the input events like mouse click, keyboard events, etc. For example, Orbiter_Win32 is derived from Orbiter class and takes care of enabling the auto-update mechanism.
Platform specific are the external dialogs with progress bar and prompt user, or the way the composite or masks are used (see OrbiterRenderer_Linux, OrbiterLinux, OrbiterRenderer_SDL_Win32

The Linux version uses XRecord extension to intercept events. The Windows versions use PocketFrog engine’s event loop or SDL event loop.

====9.2.3. Cache image manager====

This module is mainly used by remote orbiters, non-OSD orbiters. Because these orbiters don’t have access to core’s file system, all the graphic files are obtained by network connection and it might be slow. So instead of requesting same image over and over, the image is cached on the local drivers. The collection of images cached are associated with a timestamp (the generation date for the screens). If the user decides to regenerate the screens, the timestamp is changed and the cache is purged and the images are requested, on demand, again from the server.

====9.2.4. Self update module====

The “Self update” module is also used for non-OSD orbiters. Once a new version of the Orbiter XP/CE is available, a new binary data is stored on core’s filesystem. When an non-OSD orbiter starts, compares the md5sum of the current binary with the one from the server. If it’s different, the UpdateBinary is spawned, Orbiter exits and UpdateBinary requests the new binary from server, it downloads it, replaces the old binary and restart Orbiter.

====9.2.5. Simulator====

The simulator is responsible for generating mouse and keyboard events used for stress testing. It also stores some configuration settings.

====9.2.6. Graphic objects====

They are all derived from PlutoGraphic class and store info about the filename, width, height, the block of data and its length, graphic format and graphic management. The operations required are related to loading graphics from a file or a block of data, clearing the data stored, initializations, etc.
In the derived classes like PocketFrogGraphic, SDLGraphic, OpenGLGraphic, specific info are stored like the Surface for PocketFrong, SDL_Surface for SDL and the texture for OpenGL.

====9.2.7. Orbiter logic module====

Just like any other device, Orbiter is derived from a {Device_name}_Command class, the wrapper class generated by DCEGen to allow the device communicate with the router. However, Orbiter is also derived from OrbiterData and IRReceiverBase.

[[Image:orbiterlogicclassdiagram.jpg|frame|none|Orbiter logic – class diagram]]

OrbiterData helps Orbiter deserialize the data needed for its graphic objects, data serialized by OrbiterGen. IRReceiverBase is the base class for all IR receiver devices and it translates IR codes into actions, base on the current screen type and remote layout.

====9.2.8. Mouse handlers====

The goal of handlers is the interpret mouse movements and perform specific actions depending on current screen type. This is one of the main features add in UI2 version.

See below the class diagram:

[[Image:mousehandlers.jpg|frame|none|Mouse handlers – class diagram]]

Note that the mouse handlers are not available for UI1 version of Orbiter.

MouseIterator and MouseGovernor limit the mouse movements the only one move per x ms to prevent extreme numbers of messages burdening the system.
MouseBehaviour handles special mouse behavior, such as locking axis’s, ramping and acceleration.

====9.2.9. HID interface====

This module gets events from the Fiire remote. See below the class diagram:

[[Image:HIDinterface.jpg|frame|none|HID interface – class diagram]]

This code has been augmented by the Generic HID Interface, below.

====9.2.10. Generic HID Interface====

The Generic HID Handler is implemented in http://svn.linuxmce.org/trac.cgi/browser/branches/LinuxMCE-0810/src/Orbiter/Linux/GenericHIDInterface.cpp and http://svn.linuxmce.org/trac.cgi/browser/branches/LinuxMCE-0810/src/Orbiter/Linux/GenericHIDInterface.h

And basically consists of:

* UpdateEventFDs - a function which scans /dev/input looking for event* devices, opening them read-only, and setting descriptors in a vector, which...
* ProcessGenericHIDEvents - is passed back into here, and the vector is iterated, filling the parameters of a select() call to determine which event devices need to be read. Those devices are checked, and passed into...
* DecodeEventFDs - This takes a file descriptor, and reads it, looking for EV_KEY events, those are found, the resulting key code is grabbed, and 20000 is added to it to indicate a synthetic key event. The resulting keycode is then passed to Orbiter's event queue, which can then be used by configuration device data for a given remote to map keys. This loop between ProcessGenericHIDEvents and DecodeEventFDs repeats until m_bQuit is set true from orbiter, at which point....
* CloseEventFDs - closes the file descriptors in the vector, the remainder of CloseEventFDs is procedded, and the thread simply exits.

=====Things left to do=====

The thread handler is still very early in design. It merely passes any EV_KEY value that's greater than 0 as a KEY_DOWN. For Gyration 3101's, this also means the value of 2 gets passed as KEY_DOWN. Some interesting things happen as a result,

Held down keys need to be properly handled. --[[User:Tschak909|Tschak909]] 23:11, 27 June 2009 (CEST)

=====How to Implement a Remote Template that uses Generic HID Interface=====

See this page: [[Creating a Device Template for a Remote that uses the kernel input subsystem]]

===9.3 Skinning and User Interface===

====9.3.1 HADesigner====
The graphics, layout and display for the screens rendered in different Orbiter interfaces for the different UI versions are generated and manipulated using a Windows UI management tool called [[HADesigner_User's_manual|HADesigner]].

The following series of screencasts describes the use of the HADesigner tool and the process of generating a brand new UI for a specific plugin for all different variations of the Orbiter UI versions.

Before proceeding, follow the [[Installing_HADesigner | installation instructions for HADesigner]].

# [http://www.localeconcept.com/HADesigner-Screencasts/01-basic_hadesigner_fundamentals.html Basic Designer Fundamentals]
# [http://www.localeconcept.com/HADesigner-Screencasts/ogg/02_designobj_basics_1.ogg Design Object Basics]
# [http://www.localeconcept.com/HADesigner-Screencasts/ogg/03_ui2_popup_part_1.ogg UI2 Popup Part I]
# [http://www.localeconcept.com/HADesigner-Screencasts/ogg/04_ui2_popup_part_2.ogg UI2 Popup Part II]
# [http://www.localeconcept.com/HADesigner-Screencasts/ogg/05_UI1_Orbiter.ogg UI1 Orbiter]
# [http://www.localeconcept.com/HADesigner-Screencasts/ogg/06_UI1_Full_Screen_OSD.ogg UI1 Full Screen OSD]
# [http://www.localeconcept.com/HADesigner-Screencasts/ogg/07_UI1_Full_Screen_OSD_2.ogg UI1 Full Screen OSD Part II]
# [http://www.localeconcept.com/HADesigner-Screencasts/ogg/08_UI1_PDA.ogg UI1 PDA]
# [http://www.localeconcept.com/HADesigner-Screencasts/ogg/09_Mobile_Remote.ogg Mobile Remote]
# [http://www.localeconcept.com/HADesigner-Screencasts/ogg/10_cisco_7970_orbiter.ogg Cisco 7970 Orbiter]
# [http://www.localeconcept.com/HADesigner-Screencasts/ogg/11_Monitor_mode.ogg Monitor Mode]

The Basic skin, included with LinuxMCE, should really not be modified, since it is used extensively by LinuxMCE and Pluto and is known to work.

====9.3.2 UI Design and process====
The following series of screencasts walks through the design considerations involved in creating a brand new skin for LinuxMCE.

# [http://www.localeconcept.com/Skin-Screencasts/01_introduction_and_aesthetic.ogg Introduction and Aesthetic considerations]
# [http://www.localeconcept.com/Skin-Screencasts/02_main_menu_first_pass.ogg First Pass at the Main Menu]
# [http://www.localeconcept.com/Skin-Screencasts/03_main_menu_notes_and_corrections.ogg Main Menu Notes and Corrections]
# [http://www.localeconcept.com/Skin-Screencasts/04_the_floorplan_buttons.ogg The Floorplan Buttons]