Programmer's Guide - Revision history

Mcefan: /* LinuxMCE software architecture */

2012-10-25T16:17:04Z

LinuxMCE software architecture

←Older revision		Revision as of 16:17, 25 October 2012
Line 31:		Line 31:
	{{p}}		{{p}}

	==== LinuxMCE software architecture ====		====LinuxMCE software architecture====
	LinuxMCE uses a '''modular''' architecture made of "devices" that are integrated to the system by interfacing them to the DCERouter.		LinuxMCE uses a '''modular''' architecture made of "devices" that are integrated to the system by interfacing them to the DCERouter.
	<!-- [Need diagram of software modules here]. -->		<!-- [Need diagram of software modules here]. -->

Mcefan at 16:00, 25 October 2012

2012-10-25T16:00:53Z

@@ Line 4: / Line 4: @@
 A new tutorial for [[Developing a DCE Device]] has just been added to the wiki. While we're creating our own Doxygen documentation, the most recent information regarding architecture and getting started with development can be found on the "[[Developers Guide]]" page, and, the [http://plutohome.com/support/doxygen/ Pluto Doxygen] is still online.
@@ Line 10: / Line 28: @@
 To learn more about Pluto's code, please consult the [http://plutohome.com/support/doxygen/ Doxygen documentation] which details all the scripts and utilities that make up the Pluto distribution.
 {{p}}
 ==== LinuxMCE  software architecture ====
-LinuxMCE uses a '''modular''' architecture. <br>
+LinuxMCE uses a '''modular''' architecture made of "devices" that are integrated to the system by interfacing them to the DCERouter.
 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".  <br>
 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. There can be hundreds of these "Devices" in a smart home, that do all sorts of things. As shown in the diagram below, many of LinuxMCE's devices are actually "'''wrappers'''" we have written for existing open source programs to allow them to work together seamlessly in a LinuxMCE system. An example of this is the wrapper written for Asterisk: it sends event messages to the DCERouter whenever a phone call comes in, and, receives command messages when it is time to place a call. <br>
 How the wrapper communicates with the open source program depends on that project. In the case of Asterisk, the wrapper communicates with Asterisk over a socket. It acts as a translator, converting messages from its socket connection with the DCERouter into messages from its socket connection with Asterisk. The wrapper for the Xine media player links in Xine's own library, and calls Xine functions directly, while for MythTV, the wrapper communicates via a special telnet interface. Each project's wrapper is written to meet its needs.
-LinuxMCE uses the GPL home automation engine and UI front-end developed by Pluto, the GPL PVR developed by the MythTV folks, the GPL phone system Asterisk originally developed by Mark Spencer at Digium, the GPL Xine program, etc, and combines them into a whole using the DCERouter. Since these OSS projects all have disparate histories and development roadmaps, the wrappers need to be kept up to date as these applications develop, and we're hoping to get some of these applications to talk directly to the DCERouter in the future.
+LinuxMCE uses the GPL home automation engine and UI front-end developed by Pluto, the GPL PVR developed by the MythTV folks, the GPL phone system Asterisk originally developed by Mark Spencer at Digium, the GPL Xine program, etc, and combines them into a whole using the DCERouter. Since these OSS projects all have disparate histories and development roadmaps, the wrappers need to be kept up to date as these applications develop, and we're hoping to get some of these applications to talk directly to the DCERouter in the future
 The DCE message router and the controllers for the various applications are modular by nature, which means you can just modify a small module at a time, then quickly compile, and test it in the system.
 Initially, the build system was a little cumbersome because we inherited it from a commercial company that paid their developers and could expect them to learn a custom build system. One of the immediate development goals was to switch to a more traditional OSS build system so any developer could just jump in and start making changes using a simple "make; sudo make install" for the whole distribution, or just one program, or library within the whole. In time, this was abandoned mostly because nobody was interested in working on it, and it wasn't critical for the developers who were working on it. However, changes have been made that removed the need for a dedicated build server. The source tree can be copied and the individual pieces can be compiled using make. Currently, LinuxMCE is being developed on such a server as it is the most efficient way to produce all the packages in one go. Although this is not necessary for someone developing a C++ DCE device, you can use it if you wish to build packages for a Linux distribution. There is a set of tables in our database that are package definitions which are used in two places:
@@ Line 35: / Line 61: @@
 ::* ''ConfirmDependencies'', which installs packages for a given operating system.
 They both pull their software and dependencies from the same database. You can go to <code>advanced > software > packages</code> to find the list of packages, including those for the Pluto manufacturer which is the data we use to figure out what to install when and where.
 {{p}}

Mcefan at 05:54, 25 October 2012

2012-10-25T05:54:07Z

←Older revision		Revision as of 05:54, 25 October 2012
Line 20:		Line 20:
	{{p}}		{{p}}

	==== ~~Architecture~~ ====		==== LinuxMCE software architecture ====
	LinuxMCE uses a '''modular''' architecture. <br>		LinuxMCE uses a '''modular''' architecture. <br>

Line 43:		Line 43:
	{{p}}		{{p}}

	== So the DCE Router lets applications communicate, so what? ==		==== So the DCE Router lets applications communicate, so what? ====

	Imagine you set up a LinuxMCE system in your living room and want the lights to dim when you start watching a movie. If you were using a regular Linux distribution without the DCERouter, you would need to write a launch script for Xine that tells MisterHouse to dim the lights on entry and restore them on exit. If you wanted this to be delayed so that when you exit one movie and enter another shortly thereafter the lights don't dim, the script would become rather complicated. You would need to adapt the script for watching TV in MythTV and any other media application you wanted to use. <br>		Imagine you set up a LinuxMCE system in your living room and want the lights to dim when you start watching a movie. If you were using a regular Linux distribution without the DCERouter, you would need to write a launch script for Xine that tells MisterHouse to dim the lights on entry and restore them on exit. If you wanted this to be delayed so that when you exit one movie and enter another shortly thereafter the lights don't dim, the script would become rather complicated. You would need to adapt the script for watching TV in MythTV and any other media application you wanted to use. <br>

Mcefan: /* Introduction to the LinuxMCE Architecture */

2012-10-25T05:49:51Z

Introduction to the LinuxMCE Architecture

←Older revision		Revision as of 05:49, 25 October 2012
Line 5:		Line 5:
	A new tutorial for [[Developing a DCE Device]] has just been added to the wiki. While we're creating our own Doxygen documentation, the most recent information regarding architecture and getting started with development can be found on the "[[Developers Guide]]" page, and, the [http://plutohome.com/support/doxygen/ Pluto Doxygen] is still online.		A new tutorial for [[Developing a DCE Device]] has just been added to the wiki. While we're creating our own Doxygen documentation, the most recent information regarding architecture and getting started with development can be found on the "[[Developers Guide]]" page, and, the [http://plutohome.com/support/doxygen/ Pluto Doxygen] is still online.


	~~==Introduction to the LinuxMCE Architecture==~~

	==== Origins of LinuxMCE ====		==== Origins of LinuxMCE ====

Mcefan at 05:48, 25 October 2012

2012-10-25T05:48:56Z

Show changes

PlatypusPedersen: /* Introduction to the LinuxMCE Architecure */

2012-02-11T04:08:56Z

Introduction to the LinuxMCE Architecure

←Older revision		Revision as of 04:08, 11 February 2012
Line 1:		Line 1:
	==Introduction to the LinuxMCE ~~Architecure~~==		==Introduction to the LinuxMCE Architecture==

	'''[[Developers Guide]] is the most recent information regarding architecture and getting started with development. We have also created a new tutorial for [[Developing a DCE Device]]'''		'''[[Developers Guide]] is the most recent information regarding architecture and getting started with development. We have also created a new tutorial for [[Developing a DCE Device]]'''

Tschak909: /* Programmer's Guide Sections */ typo

2011-05-09T11:03:43Z

Programmer's Guide Sections: typo

←Older revision		Revision as of 11:03, 9 May 2011
Line 18:		Line 18:
	**[[A new concept in collaborative development]]		**[[A new concept in collaborative development]]
	**[[Adding support for home automation devices]]		**[[Adding support for home automation devices]]
	*[[Developing A DCE Device]]		*[[Developing a DCE Device]]
	*[[Building_From_Source]]		*[[Building_From_Source]]
	*[[STEngine]]		*[[STEngine]]

Tschak909: Adding bits to the developers guide.

2011-05-09T11:03:13Z

Adding bits to the developers guide.

←Older revision		Revision as of 11:03, 9 May 2011
Line 1:		Line 1:
	==Introduction to the LinuxMCE Architecure==		==Introduction to the LinuxMCE Architecure==

	'''[[Developers Guide]] is the most recent information regarding architecture and getting started with development.'''		'''[[Developers Guide]] is the most recent information regarding architecture and getting started with development. We have also created a new tutorial for [[Developing a DCE Device]]'''

	LinuxMCE includes hundreds of scripts and utilities that were forked from Pluto's linux distribution in 2006. Pluto wrote these to create a 'turn it on and press play' appliance, rather than a traditional software application.		LinuxMCE includes hundreds of scripts and utilities that were forked from Pluto's linux distribution in 2006. Pluto wrote these to create a 'turn it on and press play' appliance, rather than a traditional software application.
Line 18:		Line 18:
	**[[A new concept in collaborative development]]		**[[A new concept in collaborative development]]
	**[[Adding support for home automation devices]]		**[[Adding support for home automation devices]]
			*[[Developing A DCE Device]]
	*[[Building_From_Source]]		*[[Building_From_Source]]
	*[[STEngine]]		*[[STEngine]]

Ray N at 20:33, 13 August 2009

2009-08-13T20:33:33Z

←Older revision		Revision as of 20:33, 13 August 2009
Line 22:		Line 22:
	**[[OpenGL implementation]]		**[[OpenGL implementation]]
	**[[Photo Screen Saver]]		**[[Photo Screen Saver]]
	*[[~~ZWave~~ \| ZWave implementation]]		*[[Z-Wave \| ZWave implementation]]
	*[[AVWizard specifications]]		*[[AVWizard specifications]]
	*[[Orbiter]]		*[[Orbiter]]

Davka: /* Programmer's Guide Sections */ Correcting Zwave link to not need to click thru a redirect.

2009-07-22T18:16:28Z

Programmer's Guide Sections: Correcting Zwave link to not need to click thru a redirect.

←Older revision		Revision as of 18:16, 22 July 2009
Line 22:		Line 22:
	**[[OpenGL implementation]]		**[[OpenGL implementation]]
	**[[Photo Screen Saver]]		**[[Photo Screen Saver]]
	*[[ZWave implementation]]		*[[ZWave \| ZWave implementation]]
	*[[AVWizard specifications]]		*[[AVWizard specifications]]
	*[[Orbiter]]		*[[Orbiter]]