LinuxMCE - User contributions [en]

Mirrors

2011-08-24T10:54:30Z

Chris Caven: /* LinuxMCE 0810 */

__NOTOC__

[[Category: Software]]
[[Category: Install]]

= LinuxMCE 0810 =
Although LinuxMCE 0710 is the latest official release, its development and features haven't been touched for a number of years. Currently all development is done in LinuxMCE 0810. 
Even if there are some issues (LinuxMCE 0810 is still a Beta), it is recommended for most users to download and install the latest LinuxMCE 0810 DVD snapshot image. 
Latest snapshot DVDs can be found at http://linuxmce.iptp.org/snapshots/ 

= Installation Help =
'''Before installing, check out the [[Known Issues|Known issues]], and please read the [[Installation Guide]] and/or the [[DVD Installation]] guide.''' Installing from DVD is the fastest. Installing from CD .iso images on your hard disk is second fastest (you will need to install [http://old-releases.ubuntu.com/releases/kubuntu/8.10/ Kubuntu 8.10] first), and installing from burned CDs is slowest.

'''NOTE:''' It is a good idea to use md5sum and the checksums to verify your download is not corrupted.

'''NOTE:''' It is ''essential'' that you burn your CDs and DVDs using the slowest possible speed your burner supports - faster speeds regularly cause corruptions on the burn which will be fatal to your install.

== What you have to download ==
To install LinuxMCE you need to download the DVD (which includes everything needed for the installation) or you can download [http://old-releases.ubuntu.com/releases/kubuntu/8.10/ Kubuntu 8.10] and use LinuxMCE install script.

'''''Warning: The DVD installation will wipe the entire disk of the machine -- all previous data will be permanently lost!'''''
(Note: There is a new "keep settings" option which will preserve data in the home directory for most, '''''but not all''''', installations. Also, there are instructions on how to use the [[DVD Install And Custom Partitions|DVD Install with custom partitions]])

====NOTES:====
If you have some issues with LinuxMCE 0810 you can use the [http://forum.linuxmce.org/ forum] for support, and if you want you can also install [[Mirrors_710|older LinuxMCE 0710]]

==Download locations==

'''NOTE''': Please use the Bit Torrent downloads wherever possible, to ensure a clean, uncorrupted download, and then leave it seeding as long as possible. Important: Always burn these DVDs at the slowest possible speed your drive supports ... this is critical!

This wiki page is editable so users can add additional mirrors. If you would like to mirror LinuxMCE, please contact danielk@cuymedia.net. He will give you rsync access to the linuxmce.org servers so you can automatically download the releases ahead of time.

Please see the [http://www.linuxmce.org/index.php/news release announcement] on the front page for the md5sums of the files. Since this wiki page is editable we can not keep the md5sums here without the risk of tampering.

=Additional Links=
* [[Mirrors_710|LinuxMCE 0710 Install mirrors]]
* [[Mirrors_old|Old LinuxMCE Mirror page]] that needs to be deleted

Mirrors

2011-08-24T10:53:18Z

Chris Caven: /* LinuxMCE 0810 */

__NOTOC__

[[Category: Software]]
[[Category: Install]]

= LinuxMCE 0810 =
Although LinuxMCE 0710 is the latest official release, its development and features haven't been touched for number of years. Currently all development is done in LinuxMCE 0810. 
Even if there are some issues (LinuxMCE 0810 is still a Beta), it is recommended for most users to download and install the latest LinuxMCE 0810 DVD snapshot image. 
Latest snapshot DVDs can be found at http://linuxmce.iptp.org/snapshots/ 

= Installation Help =
'''Before installing, check out the [[Known Issues|Known issues]], and please read the [[Installation Guide]] and/or the [[DVD Installation]] guide.''' Installing from DVD is the fastest. Installing from CD .iso images on your hard disk is second fastest (you will need to install [http://old-releases.ubuntu.com/releases/kubuntu/8.10/ Kubuntu 8.10] first), and installing from burned CDs is slowest.

'''NOTE:''' It is a good idea to use md5sum and the checksums to verify your download is not corrupted.

'''NOTE:''' It is ''essential'' that you burn your CDs and DVDs using the slowest possible speed your burner supports - faster speeds regularly cause corruptions on the burn which will be fatal to your install.

== What you have to download ==
To install LinuxMCE you need to download the DVD (which includes everything needed for the installation) or you can download [http://old-releases.ubuntu.com/releases/kubuntu/8.10/ Kubuntu 8.10] and use LinuxMCE install script.

'''''Warning: The DVD installation will wipe the entire disk of the machine -- all previous data will be permanently lost!'''''
(Note: There is a new "keep settings" option which will preserve data in the home directory for most, '''''but not all''''', installations. Also, there are instructions on how to use the [[DVD Install And Custom Partitions|DVD Install with custom partitions]])

====NOTES:====
If you have some issues with LinuxMCE 0810 you can use the [http://forum.linuxmce.org/ forum] for support, and if you want you can also install [[Mirrors_710|older LinuxMCE 0710]]

==Download locations==

'''NOTE''': Please use the Bit Torrent downloads wherever possible, to ensure a clean, uncorrupted download, and then leave it seeding as long as possible. Important: Always burn these DVDs at the slowest possible speed your drive supports ... this is critical!

This wiki page is editable so users can add additional mirrors. If you would like to mirror LinuxMCE, please contact danielk@cuymedia.net. He will give you rsync access to the linuxmce.org servers so you can automatically download the releases ahead of time.

Please see the [http://www.linuxmce.org/index.php/news release announcement] on the front page for the md5sums of the files. Since this wiki page is editable we can not keep the md5sums here without the risk of tampering.

=Additional Links=
* [[Mirrors_710|LinuxMCE 0710 Install mirrors]]
* [[Mirrors_old|Old LinuxMCE Mirror page]] that needs to be deleted

Hiding LinuxMCE windows from KDE desktop

2010-05-16T15:32:42Z

Chris Caven:

[[Category:Tutorials]]
By default, there are 3 LinuxMCE windows from desktop #5 displayed in the taskbar, even when you are on desktops 1-4. You can adjust the settings to not display them in the taskbar (and avoid occasional clicking on them): right click on the task bar, then "Configure Panel => Taskbar => unmark tick 'Show windows from all desktops'".

[[Image:Kicker-snapshot.jpg]]

LinuxMCE

2010-05-01T15:19:35Z

Chris Caven: /* Telecom */

[[Category: Documentation]]
{| align="right"
| __TOC__
|}
==Core==

The '''Core''' is the heart and brain of the LinuxMCE system. The [[Core]] is a single PC acting as a dedicated server and interface for all the sub-components. The Core includes a plug-and-play back-end, so it listens for and auto configures all sorts of devices, like network audio players (e.g. Squeeze Box), IP phones and cameras. The Core can automatically provide a network boot for thin-client PCs (which can then be used as [[Media Directors]]). A Media Director is hooked up to your TV or stereo and becomes an integrated media player, PVR, video conferencing, intercom and portal to monitor and control everything in the home. All Media Directors work together seamlessly as a whole-house solution.

[[Core|More about the Core]]

==Orbiters==

'''Orbiters''' are high-tech remote controls. LinuxMCE allows a wide variety of devices to function as Orbiters. Ordinary laptops, wireless tablet PCs, PDAs, mobile phones running Symbian or Microsoft Mobile, or any PC with a web interface that is able to connect to your LinuxMCE LAN can be used as an Orbiter.

[[Orbiters|More about Orbiters]]

==Media Directors==

A '''Media Director''' (also known as a '''Media Station''') is a dedicated PC that streams music and video from the Core to your TV and speakers for an awesome multimedia experience. You can even use it as a Kubuntu PC, right on your TV!

[[Media Directors|More about Media Directors]]

==Network Attached Storage (NAS)==

You can extend your Core's storage with an NAS device. LinuxMCE can recognize it and automatically integrate it into the system. Use the NAS for file storage, including your music and video collection, or for PVR functions.

[[Network Attached Storage|More about NAS]]

==Security==

'''Security''' is a big part of LinuxMCE. Functions include light control, surveillance camera monitoring, and motion detection. Events can be triggered based on detected motion. It can send alerts to your mobile phone. It can set your alarm based on different schedules and scenarios. It can even lock the door when you leave your home.

[[Security|More about Security]]

==Telecom==

'''Telecom''' is integrated into LinuxMCE in a sophisticated fashion. The VoIP system provides great flexibility. Each member of your family may have his/her own personal voice mailbox. The system can keep track of where you are in your home and route incoming calls to the nearest phone (or to your mobile phone when you're not at home). Incoming calls automatically pause media, allowing you to take calls without interrupting your relaxation time.

[[Telecom|More about Telecom]]

==Home Automation==

The '''Home Automation''' features of LinuxMCE are convenient and energy-efficient. With Home Automation you can control lights, climate and even the whereabouts of music or video played in your home. Mobile phones can also be turned into remote controls for your entire house.

[[Home Automation|More about Home Automation]]

==Multimedia==
'''Multimedia''' in LinuxMCE is always available throughout your house. If you have more than one home, you can even join the homes together into a single multimedia/home automation system. Your media will follow you everywhere you go. It will even show your video files on the device closest to you, even if you go from one room or home to another!

[[Usage_Intro#Managing_your_media|More about Multimedia]]

==Personal Computing==
'''Personal Computing''' can be done in LinuxMCE. After all, there's an ordinary PC with Kubuntu Linux running in the background, complete with Office suites and all the programs you need for everyday use.

[[Personal Computing|More about Personal Computing]]

==Building a new Home around LinuxMCE==
Linux MCE is the ultimate '''smart home'''. With proper planning, a new construction home can integrate LinuxMCE as the brains of the house.

In the past, a Home Entertainment Center would house a Home Theater PC. With LinuxMCE, the Core server and all communications hubs can be kept in a separate area. This makes home construction easier, allows centralization of data services, and allows for updating the home automation and multimedia system without altering the Home Entertainment Center in your living room.

[[Building_a_new_Home_around_LinuxMCE|More about Home Construction using LinuxMCE]]

==What can I do with LinuxMCE?==

[[What_can_I_do_with_LinuxMCE%3F|What can I do with LinuxMCE?]]

Also see: [[:Category:Tutorials|Tutorials Category]]

Core

2010-05-01T15:10:05Z

Chris Caven:

[[Category: Cores| ]]

'''Core''' is the term given to the main LinuxMCE server in your home automation/multimedia network.

All settings for the network are stored in the Core Server. Even if a device is connected to a [[Media Director]] PC in another part of the house, it is detected by the Core server and information about that device (its location, functions, and options) is stored on the Core.

In this way, plug-and-play function is provided throughout the LinuxMCE system for all [[AV devices]] connected anywhere within the system.

The Core Server provides a standardized [[LinuxMCE Admin Website]] to every Media Director, which can be viewed through a browser on any Media Director. The entire system can therefore be administered from any Media Director.

This allows the Core Server to be "headless" (i.e. without a monitor, keyboard, mouse, or any other input or output device), if desired. It is a true server.

The Core PC is also able to provide standardised [[netboot]] services to the Media Directors on the home network. In this way, the Media Director PCs do not require their own OS and can act essentially as thin clients. System administration and updates are therefore much easier, as only the Core software needs to be upgraded.

==Hardware requirements==

Because the Core handles processing for the whole network, it should be the "brawniest" PC in regards to processing power. A dual-core 64 bit processor with a lot of RAM is very nice to have in the Core Server.

Since a Core can be hidden in a closet (or in the garage or basement somewhere) and therefore does not need to be in your living room (unless it is functioning as a [[hybrid]]), fan noise is usually not an issue.

The Core PC does require a large amount of storage. This can be large capacity internal hard drives, a large capacity external hard drive, or even perhaps a [[NAS]] (network-attached storage) device, that is accessible by being connected somewhere on the home automation/multimedia network.

Of course you need a DVD/CD drive (at least for software installation -- grin)!

The Core should have 2 NICs (network interface cards) -- one for connecting to an "external" network (such as your cable modem, DSL modem, or home LAN router) and one for connecting to the "internal" home automation/multimedia network (your LinuxMCE system network).

Further, it is best to have the [[:Category:TV_Cards|TV card]] in the Core server, as well as the [[:Category:Video_Capture_Boards|video capture board]] for any surveillance [[:Category:Cameras|cameras]]. A [[Automation|home automation]] interface is usually attached to the Core as well. Therefore, a PC to be used as a Core must have plenty of expansion slots, and cooling fans proportionate to the load.

Output and sound cards are relatively unimportant for the Core, because output is usually channeled through the Media Director PCs.

Nevertheless, some home automation/multimedia systems channel output through a central whole-house multi-channel amplifier which is connected directly to the Core. If you plan to do this, make the Core into a [[hybrid]], instead, and fit a good (nVidia) [[:Category:Video|graphics]] card and a good [[:Category:Soundcards|sound card]] (with surround sound jacks -- 5.1, 7.1, or even 11.1).

===Example PCs used as Core servers===

See the [[:Category:Cores|Core Category]] for examples of PCs used as Core Servers.

===A Dedicated Core===
[[Image:Diagram1.jpg|200px|right]]
The Core is the central point of the Linux MCE system and runs applications and daemons needed for the other devices to exchange messages. A dedicated core will run only backend applications and will not provide any frontend, except the web interface. This means it won't act as a media center. You'll need to use Media Directors to be able to play movies, listen to music and watch TV. This kind of setup is recommended when you have plenty of extra devices; this way the backend applications will have full access to the Core's resources.

How are media files organized?

2010-04-30T20:50:46Z

Chris Caven:

[[category: tutorials]]
For Windows users, you can access the files on the core in Windows explorer's network neighborhood, or by choosing 'Start' 'Run' and typing \\ plus the IP of your core. You will need to login with your user-name and password; it's the same one you use with LinuxMCE Admin. You will see 2 folders: 'public' and 'john', assuming your name is 'John'. Any files that you want everyone in the House to have access to go into the public folder. The folder with your name, John in this case, is your private folder where you can put files that only you will have access to. Often times when you choose to save media using the orbiter, it will ask you if you want the media to be public or private. If you choose public the media will be saved under the public folder, and if you choose private it will be saved under the private folder with your name. Within those folders you will find some folders called: 'music' (where all ripped CDs go), 'movies' (where all ripped DVDs go), 'videos' (where videos recorded from TV or camcorders go), 'pictures' (where your pictures go), and 'documents' (where your documents go). When you go to play some media in the orbiter by choosing the buttons music, movies, videos, pictures or documents, you will see combined together all the media from the family's public folder as well as the media from your own personal private folder.

So, for example, if you rip a CD 'Madonna' and make it public, and rip a CD 'Rolling Stones' and make it private, and your spouse rips a CD 'Fleetwood Mac' and makes it private, then when you touch music on the orbiter you will see 'Madonna' and 'Rolling Stones', and when your spouse touches music your spouse will see 'Fleetwood Mac' and 'Madonna'. Assuming your name is john and your spouse is susan, then if you browse the network share, you will find 'Madonna' in the folder public\music and you will find 'Rolling Stones' in the folder john\music. If, in LinuxMCE admin your user has 'can modify configuration' checked, then that means you are also able to browse everybody else's private folders too. So in addition to 'public' and 'john', you will also see a folder 'susan', which contains 'music' which contains 'Fleetwood Mac'. If that option is not checked for Susan, then she will only see the folder 'public' and 'susan' and will not see your private folder 'john'.

Note that even if you check that option giving yourself access to everyone's private folders, when you go to browse media on the orbiter you will still only see public files plus your own private files, just so you're not bothered with everyone else's.

To maintain the media files, including copying deleting and renaming, you can either use another PC and a network share, such as a Windows PC with Windows Explorer, or in the LinuxMCE admin web site you can choose Media & Files, Browse.

Note that LinuxMCE maintains an internal database of all your media, including various attributes such as the actors in a movie or the composer of a song. This makes searching very comfortable. For example if you touch the music button, then start typing, you will see all attributes. For example after you touch 'G', you may see 'Geffen Studios (studio)', 'Get You Back (song)', 'GNR Live (album)', and 'Guns N Roses (performer)'. You can continue typing to narrow your entries down further, and touch any entry then 'view' to see all the music that matches. The resulting screen even does cross matching and shows pictures for each attribute.

When you rip media within LinuxMCE, the attributes are created automatically. You can view attributes or change them in the LinuxMCE admin site. LinuxMCE also monitors any media that you may add or change outside of LinuxMCE, such as using Windows Explorer. For example, if you copy files over in Windows Explorer, LinuxMCE will automatically scan the files and add the attributes to its internal database so you can still search. Also if you rename or delete files, LinuxMCE will automatically update your database accordingly.

If you add a plug-and-play network attached storage device, within each media folder you will see a subfolder for that device and you will be able to move files to and from it.

Technical explanation for Linux users: The public directory maps to /home/public/data, and each user's private directory maps to /home/user_xxxx/data, where xxxx is the internal user ID. The name 'john' is a symlinc to user_xxxx for convenience. The program /usr/pluto/bin/UpdateMedia uses INotify to monitor all /home/public/data and /home/user_xxxx/data folders, so it can rescan whenever the directory is changed. All attributes are stored in the MySql database pluto_media. Each file is a record in the 'File' table. UpdateMedia creates an extended attribute called 'ID' for each file with the primary key of each file. That way, if you move or rename a file, pdateMedia will see the extended attribute and your attributes will not be lost--it just updates the database. When you add a plug-and-play network attached storage, LinuxMCE automatically adds a folder within every single directory, such as /home/public/data/music/new_nas, /home/public/data/movies/new_nas, /home/user_xxxx/data/videos/new_nas, and these are automatically mapped to corresponding folders on the NAS. This makes it very easy for a novice to just plug in a NAS and immediately use it without any technical knowledge.

Adjust Font Size

2010-04-30T20:10:57Z

Chris Caven: /* Adjusting The Font Size */

=Adjusting The Font Size=
In some cases, it may be necessary to adjust the font size for the on-screen orbiter. These instructions allow you to change that font size, but please be careful when using phpmyadmin as it can create serious issues if mistakes are made. That being said, you will need phpMyadmin installed. Instructions found at http://wiki.linuxmce.org/index.php/Phpmyadmin

==Changing the Fonts==
*Go to http://192.168.80.1/phpmyadmin or point to http://your-core-ip-address/phpmyadmin
user=root no pass.
*Choose db pluto main.
*Still on the left side pick table style variations
*Choose browse and you will be presented the font settings.
*Make your changes, then make sure to completely regen the orbiter using the webadmin.
*Done

==Example==

* To see all defined fonts just run following query:
SELECT PK_StyleVariation, Font, PixelHeight, Description FROM Style a INNER JOIN StyleVariation b ON a.PK_Style=b.FK_Style;
* To increase font size on the right panel in the UI2 audio/video/photos grid run that query:
UPDATE StyleVariation SET PixelHeight=65 WHERE PK_StyleVariation IN(1,22);

Thanks to Itsik for providing the instructions.
[[category: Displays]]
[[category: tutorials]]
[[category: accessibility]]

Adding new web links

2010-04-30T20:07:42Z

Chris Caven:

It is possible to add new web links to the computing page.

In order for web links to show up on the Computing page within an orbiter, you have to add the link in Firefox from a [[Media Director]]. Here is the easiest method for adding new bookmarks.
* Browse to Computing screen and select one of the preloaded "Web bookmarks". This will open up a Firefox browser on the Media Director.
* Browse the web like any normal web browser and when you find a page of interest
* Add your new bookmark
* ''' NOTE: you must close the browser with File->Quit.'''
* Reopen the Computing screen,
** Your new bookmarks will be visible.

'''IMPORTANT: If you close the browser by using the LinuxMCE buttons at the bottom of the screen your bookmarks will not be saved!'''

[[Category : Tutorials]]

Make things happen at sunrise/sunset

2010-04-30T19:52:37Z

Chris Caven:

[[Category: tutorials]]
<h1>How to set it up</h1>
 Needs to know your longitude and latitude in order to fire the sunrise and sunset events. In LinuxMCE admin, choose a wizard, basic info, installation. Our database has the longitude and latitude information for approximately 30,000 cities worldwide. Just choose your city from the list. In the unlikely event that you are not near any of those cities in the list, then you'll need to provide your longitude and latitude yourself. Note that any changes you make on that page will take effect after the next reboot or quick reload router. 

 At each sunrise and sunset, LinuxMCE will fire a sunrise/sunset event. In LinuxMCE admin, choose a wizard, events handler, respond to events. Type a logical description for your event, such as "turn on lights at sunrise". Then choose sunrise or sunset from the list, click add, and then specify the command you want to be executed. Note that you can create as many event handlers for each type of event as you want. So you can have "turn on lights at sunrise" and "start watering lawn at sunrise" which both respond to the same event. 



<h1>How to use it</h1>

<h1>Programmer's guide</h1>
The logic is in Event_Plugin.

Web Orbiter

2010-04-29T16:27:21Z

Chris Caven: /* Connect failed */

{| align="right"
| __TOC__
|}
[[Category: Orbiters]]
[[Category: Tutorials]]

A Web Orbiter is any device (such as a laptop, PC, etc.) that accesses the Orbiter user interface (UI) through a Web browser.

== Setup ==
The procedure to setup a Web Orbiter is simple but the order of steps is important.
#First of all, add a new Generic Web Device as a Child Device for your Core:
##Goto the LinuxMCE Admin website-->Show devices tree-->CORE. The CORE's detail page should appear.
##Click 'Create Child Device'.
##In the Description, enter the name of the specific web orbiter.
##In the Add child device window, click the button 'Pick device template'. The new pop-up window containing device templates will be opened.
##In the 'Device Category' dropdown list, choose 'Peripherals'.
##In the 'Device Template' dropdown list, find and select "Generic Web Device" (or just type the template id: 1748 and press go).
##Click the button 'Pick Device Template'. The Add Child Device Window will close, and the Generic Web Device will be added to the Core, as the updated Device Tree will show.
##A new Generic Proxy Orbiter will also be created automatically. Watch the Orbiter generation process on the Orbiters page: Wizard-->Devices-->Orbiters.
#Wait till the Orbiter generation procedure finishes. A message on an active Orbiter or on the Orbiter page will indicate when it has completed.
#Do a "[[Quick reload router]]". Otherwise, the Orbiter won't work properly.

==Access to the Web Orbiter==

===From within your home===
You can access the Web Orbiter from any web browser (Mozilla Firefox, IE, Safari):

'''If you are currently using the 810 alpha releases the correct URL is:'''
''<nowiki>http://<core_ip>/lmce-admin/weborbiter.php</nowiki>''

'''The current release 710 uses the information below.'''

*In the browser address bar, type the URL ''<nowiki>http://<core_ip>/pluto-admin/weborbiter.php</nowiki>''.
:* From within the "internal" LinuxMCE LAN, for example:
::::''http://192.168.80.1/pluto-admin/weborbiter.php'' (0710)
::::''http://192.168.80.1/lmce-admin/weborbiter.php'' (0810)
:::::(This assumes the IP address range set by default at installation.)
:*You can also use the network name of the Core in place of the IP address. For example, if the Core was named "dcerouter" during the default installation, you could use:
::::''<nowiki>http://dcerouter/pluto-admin/weborbiter.php</nowiki>''
:*From the "external" home LAN, the core_ip would be the LAN IP address of the core. If, for example, the core is at 192.168.0.50 on the home LAN, use:
:::: ''<nowiki>http://192.168.0.50/pluto-admin/weborbiter.php</nowiki>''

:::::(Note: To use this method, [[Outside Access]] must be enabled.)

===From the Internet===
You could use the IP address:port for your home LAN, with port forwarding to the Core's LAN IP address (enabled by your home LAN router).
*''This is an advanced topic and may not be secure in the current version.''

By default, LinuxMCE is not accessible outside your home. This makes the system secure, but it prevents you from accessing the web site via the Internet while away from home. You can [[Outside_Access|turn on Internet access]], allowing access to the admin website anywhere. For your own security, however, we recommend you first read about [[Security & Privacy Issues]].

===Login page===
*A simple login page should be displayed. Input an existing user name and password, then click "Login".
*From the dropdown list of devices, choose Generic Web Device.
*A page that looks similar to this should appear: [[Image:Web Orbiter.jpg|center]]

==Troubleshooting==
===Connect failed===
If you try to connect to the Web Orbiter and see this message:
<code>"Connect to proxy orbiter failed, please try again"</code>,
this means that Orbiter generation hasn't finished yet, or that you forgot to do a [[Quick_reload_router|quick restart of the router]].

=== Size ===
I was able to change the size of the rendered image in the Wizard-->Orbiters page. Find the Web Orbiter device in the list and resize it. After another orbiter regen, it was the right size for me. (''Source http://forum.linuxmce.org/index.php?topic=3833.0'')

=== Problems with rapid refresh rate ===

Problem:
When using the Web Orbiter over the Internet (instead of from within my home LAN), it refreshed every 5 seconds, making it difficult to use. The images were repeatedly downloaded each time.

Solution:
*Go to [[LinuxMCE Admin Website]]-->Device tree-->CORE-->Generic Web Device-->Device Data
*Set the Refresh Interval to a higher value (I used 60 seconds for mine).

=== Changing default room ===
Changing the default room in the Wizard-->Devices-->Orbiters page has no effect.

Solution:
*Go to [[LinuxMCE Admin Website]]-->Device tree-->CORE-->Generic Web Device
*Check the box for the room to control

===Screen Deadlock===
If the screen of your orbiter becomes "frozen" or stuck and orbiter regens and router reloads do not resolve the issue, run this from the core:
sudo killall -9 Proxy_Orbiter
(Source: http://forum.linuxmce.org/index.php?topic=6844.0)
= See also =
Another example of a web orbiter is the [[IOrbiter]]

Web Orbiter

2010-04-29T16:22:25Z

Chris Caven: /* From the Internet */

Web Orbiter

2010-04-29T15:23:31Z

Chris Caven: /* Setup */

{| align="right"
| __TOC__
|}
[[Category: Orbiters]]
[[Category: Tutorials]]

A Web Orbiter is any device (such as a laptop, PC, etc.) that accesses the Orbiter user interface (UI) through a Web browser.

== Setup ==
The procedure to setup a Web Orbiter is simple but the order of steps is important.
#First of all, add a new Generic Web Device as a Child Device for your Core:
##Goto the LinuxMCE Admin website-->Show devices tree-->CORE. The CORE's detail page should appear.
##Click 'Create Child Device'.
##In the Description, enter the name of the specific web orbiter.
##In the Add child device window, click the button 'Pick device template'. The new pop-up window containing device templates will be opened.
##In the 'Device Category' dropdown list, choose 'Peripherals'.
##In the 'Device Template' dropdown list, find and select "Generic Web Device" (or just type the template id: 1748 and press go).
##Click the button 'Pick Device Template'. The Add Child Device Window will close, and the Generic Web Device will be added to the Core, as the updated Device Tree will show.
##A new Generic Proxy Orbiter will also be created automatically. Watch the Orbiter generation process on the Orbiters page: Wizard-->Devices-->Orbiters.
#Wait till the Orbiter generation procedure finishes. A message on an active Orbiter or on the Orbiter page will indicate when it has completed.
#Do a "[[Quick reload router]]". Otherwise, the Orbiter won't work properly.

==Access to the Web Orbiter==

===From within your home===
You can access the Web Orbiter from any web browser (Mozilla Firefox, IE, Safari):

'''If you are currently using the 810 alpha releases the correct URL is:'''
''<nowiki>http://<core_ip>/lmce-admin/weborbiter.php</nowiki>''

'''The current release 710 uses the information below.'''

*In the browser address bar, type the URL ''<nowiki>http://<core_ip>/pluto-admin/weborbiter.php</nowiki>''.
:* From within the "internal" LinuxMCE LAN, for example:
::::''http://192.168.80.1/pluto-admin/weborbiter.php'' (0710)
::::''http://192.168.80.1/lmce-admin/weborbiter.php'' (0810)
:::::(This assumes the IP address range set by default at installation.)
:*You can also use the network name of the Core in place of the IP address. For example, if the Core was named "dcerouter" during the default installation, you could use:
::::''<nowiki>http://dcerouter/pluto-admin/weborbiter.php</nowiki>''
:*From the "external" home LAN, the core_ip would be the LAN IP address of the core. If, for example, the core is at 192.168.0.50 on the home LAN, use:
:::: ''<nowiki>http://192.168.0.50/pluto-admin/weborbiter.php</nowiki>''

:::::(Note: To use this method, [[Outside Access]] must be enabled.)

===From the Internet===
You could use the IP address:port for your home LAN, with port forwarding to the Core's LAN IP address (enabled by your home LAN router).
*''This is an advanced topic and may not be secure in the current version.''.

By default, LinuxMCE is not accessible outside your home. This makes the system secure, but it prevents you from accessing the web site via the Internet while away from home. You can [[Outside_Access|turn on Internet access]], allowing access to the admin website anywhere. For your own security, however, we recommend you first read about [[Security & Privacy Issues]].

===Login page===
*A simple login page should be displayed. Input an existing user name and password, then click "Login".
*From the dropdown list of devices, choose Generic Web Device.
*A page that looks similar to this should appear: [[Image:Web Orbiter.jpg|center]]

==Troubleshooting==
===Connect failed===
If you try to connect to the Web Orbiter and see this message:
<code>"Connect to proxy orbiter failed, please try again"</code>,
this means that Orbiter generation hasn't finished yet, or that you forgot to do a [[Quick_reload_router|quick restart of the router]].

=== Size ===
I was able to change the size of the rendered image in the Wizard-->Orbiters page. Find the Web Orbiter device in the list and resize it. After another orbiter regen, it was the right size for me. (''Source http://forum.linuxmce.org/index.php?topic=3833.0'')

=== Problems with rapid refresh rate ===

Problem:
When using the Web Orbiter over the Internet (instead of from within my home LAN), it refreshed every 5 seconds, making it difficult to use. The images were repeatedly downloaded each time.

Solution:
*Go to [[LinuxMCE Admin Website]]-->Device tree-->CORE-->Generic Web Device-->Device Data
*Set the Refresh Interval to a higher value (I used 60 seconds for mine).

=== Changing default room ===
Changing the default room in the Wizard-->Devices-->Orbiters page has no effect.

Solution:
*Go to [[LinuxMCE Admin Website]]-->Device tree-->CORE-->Generic Web Device
*Check the box for the room to control

===Screen Deadlock===
If the screen of your orbiter becomes "frozen" or stuck and orbiter regens and router reloads do not resolve the issue, run this from the core:
sudo killall -9 Proxy_Orbiter
(Source: http://forum.linuxmce.org/index.php?topic=6844.0)
= See also =
Another example of a web orbiter is the [[IOrbiter]]

Adding new web links

2010-04-28T17:17:19Z

Chris Caven:

It is possible to add new web links to the computing page.

In order for web links to show op on the Computing page within an orbiter, you have to add the link in Firefox from a [[Media Director]]. Here is the easiest method for adding new bookmarks.
* Browse to Computing screen and select one of the preloaded "Web bookmarks". This will open up a Firefox browser on the Media Director.
* Browse the web like any normal web browser and when you find a page of interest
* Add your new bookmark
* ''' NOTE: you must close the browser with File->Quit.'''
* Reopen the Computing screen,
** Your new bookmarks will be visible.

'''IMPORTANT: If you close the browser by using the LinuxMCE buttons at the bottom of the screen your bookmarks will not be saved!'''

[[Category : Tutorials]]

How to setup secure outbound web access

2010-04-27T17:25:31Z

Chris Caven: /* How Browsing Works */

[[Category: Tutorials]]
{| align="right"
| __TOC__
|}
=Background=
This tutorial has come about as a result of a discussion on the [http://forum.linuxmce.org/index.php?topic=8692.0 forums]. It details setting up a chain of security devices on the core which should help optimize web browsing from the internal network.

''Please note, much of this is shamelessly plagarised from others. What I have done is to try to bring their work together and provide a comprehensive end-to-end solution. If you are one of those whose work has been used, please take it as a compliment and feel free to add appropriate credits at the end!''

==How Browsing Works==
Without wishing to state the obvious, a basic understanding of web browsing helps us to understand the setup described here. Browsing is a fairly simple process. The client (known as a browser) sends a request using a protocol called HTTP to a server. By default, this request is sent to port 80. The server responds with the requested file. This file may well contain HTML, which the browser will display and will result in the browser making further requests for graphics files, etc.

It is also possible to put a third entity in the middle of this chain. This entity is known as a proxy.

In this case, the requests from the browser are sent to the proxy. The proxy sends the requests to the server, which responds to the proxy. Finally, the proxy responds to the browser. Proxys are used for many reasons, often security-related.

The system we will be setting up will consist of a chain of 3 proxies which will perform the following functions:
* Caching. This allows the proxy to store a copy of the files requested. If a second request is received for the same file, it is already held locally and a second request does not need to be sent to the server. This reduces traffic on the external network and also improves performance overall. The Caching proxy we will be using is known as Squid.

* Virus Scanning. As the file will be passing through the proxy, that proxy can examine its contents. In this case, viruses can be scanned for and blocked. The virus scanning proxy we will be using is called HavP and is used in conjunction with a regular scanner, in our case ClamAV.

*Content Scanning. As well as being examined for viruses, the text of the HTML can be processed and scored. This allows inappropriate (for example sexual) content to be blocked. We will be setting up using one of the best known content scanners, Dan's Guardian.

==Transparent Proxying==
There was much discussion on the forum thread concerning this. It is an additional feature which is entirely optional. In order for a proxy to be used, the browser has to "know" to send its requests to the proxy rather than to the actual server. This is achieved by configuring the browser with the proxy's details. There are, however, one or two problems with this.
#Each browser must be individually configured. Not too much of a problem with a home network and not many browsers, but particularly with portable devices which may or may not be used elsewhere (for example at work) it can be inconvenient to have to keep turning the proxy on and off.
#It can be easy to bypass. Without additional firewall rulesc to prevent direct browsing of the internet, bypassing the proxy (and therefore gaining access to blocked content) is as simple as turning it off in the browser.
The solution to this is known as transparent proxying. This works by having the proxy running on the router (in our case the core) and configuring it to intercept all outbound web traffic (i.e. destined for port 80) and redirect it to the proxy. The process is transparent to the end browser / user, hence the name.

'''NOTE''' Transparent proxying should not be seen as an alternative to setting a proxy on static machines, only as an addition. There are still ways to circumvent the system (for example, some webservers don't operate on port 80) so transparent proxying should be seen as an additional layer of security, not an alternative!

=The Software=
We will be installing a series of packages. The full details of configuring each will not be discussed here. For an in depth discussion, please visit the respective websites.
==Squid==
Squid is a very powerful caching web proxy server. This means that it keeps a copy of all files it is asked to retrieve (unless the various http headers dictate that the file cannot be cached). When a file is requested, Squid first checks to see if it has a cached copy. If so, that is returned, if not, it is fetched from the webserver. It is common for certain websites to be visited frequently and Squid will rapidly build up cached copies of things like logo graphics etc. which can (in some cases) drasticly reduce the requests to the internet with resulting speed advantages. If you also pay for data useage, Squid can save money as well! Full details can be found on the [http://www.squid-cache.org/ Squid website]. In our configuration, Squid will be the proxy that actually makes the requests to the internet and is, therefore, the "end" of the chain.
==ClamAV==
ClamAV is a linux-based virus scanning solution. It is not ''directly'' part of the proxy chain, but will be used by HavP. It will be configured to download updates on a regular basis and anecdotal evidence is that it is often "first to press" with new virus definitions. Further information at the [http://www.clamav.net/ ClamAV website].
==HavP==
HavP (Http Anti Virus Proxy) is used to scan each file being downloaded using a standard AV scanner. In our case, we are going to use ClamAV (above) to scan. HavP will be configured to use Squid as is proxy. It is important that this order is used as a new virus may otherwise end up in the cache (before ClamAV is updated) and then continue to be served up even after the virus database is updated. Once again, full details on the [http://www.server-side.de/ HavP website.]
==Dan's Guardian==
The final stage in the Proxy chain is Dan's Guardian. This is the proxy that the clients will connect to and it will, in turn, pass the requests on to HavP. Dan's Guardian is a well known content scanner that can control access to websites based not only on the URL, but also on the actual content of the files. It, like Squid, is hugely flexible and a full discussion is beyond the scope of this document, but if you need more, point your browser at the [http://dansguardian.org/ Dan's Guardian Website].
==Shorewall==
=Installation=
'''I am writing this as I perform the steps on my own core. So, while this line is here, it's a work in progress and as yet unfinished!!!!'''

We are going to work "backwards" testing each link in the chain as we go. I am going to assume you have a browser-enabled device on the "inside" network that you can easily re-configure with proxies (a PSP is NOT ideal for this!!) I also accessed my core from an ssh session on my client.
==Squid==
Firstly, we install Squld. There is already a wiki page on [[Squid|installing Squid]] which works pretty well. The only differences I experienced concerned the squid configuration file. This is located in /etc/squid/squid.conf. Locate the lines that say(Lines 607, 608 & 609 in mine):
acl localnet src 10.0.0.0/8 # RFC1918 possible internal network
acl localnet src 172.16.0.0/12 # RFC1918 possible internal network
acl localnet src 192.168.0.0/16 # RFC1918 possible internal network
comment them out(put a # at the beginning) and insert a single line which says:
acl localnet src 192.168.80.0/24
Then uncomment the line (remove the initial #) from the line(675)
#http_access allow localnet

Configure your browser to use a proxy on 192.168.80.1, port 3128 and try to access some sites. Use tail on /var/log/squid/access.log to ensure squid was used. If all is ok, proceed to the next line. (Note, you may want to reverse the changes to squid.conf to prevent this proxy being used directly.)

==ClamAv==
Next, we need a virus scanner. If you want to install without AV scanning, skip this step.

ClamAV is part of the repositories, so install using:
apt-get install clamav-daemon
We ant the virus definition databases to download automatically. This is performed by freshclam. Quick test: run freshclam (as superuser) with no parameters and check the output. If everything is OK you may create the log file in /var/log (owned by clamav or another user freshclam will be running as):

touch /var/log/freshclam.log
chmod 600 /var/log/freshclam.log
chown clamav /var/log/freshclam.log

I have set mine up to use cron, so add the following to crontab:
12 * * * * /usr/local/bin/freshclam --quiet
(This will update at 12 minutes past the hour).

==HavP==
Next we install a proxy that will scan using ClamAV. This can be obtained from the main HavP website on [http://www.server-side.de/] and should be unpacked with tar. As this isn't available as a package, the installation is the usual:
./configure --disable-clamav (if you don't want /usr/local, use --prefix=/other/path)
make
make install
Note: I couldn't get it to detaect the ClamAV libraries, possibly die to using a packaged ClamAV. If you manage to fix this, please update here!
also, a havp user and group should be created:
groupadd havp
useradd -g havp havp
Finally, edit /usr/local/etc/havp.conf.
=Setting up Transparent Proxying=
--[[User:Wierdbeard65|Wierdbeard65]] 13:31, 8 September 2009 (CEST)

Custom Display Resolutions

2010-04-25T09:53:32Z

Chris Caven: /* Orbiter size */

{| align="right"
| __TOC__
|}
[[Category:Documentation]]
[[Category:Tutorials]]
If you have a display designed for use with a computer rather than as a regular TV, such as a plasma display, it is possible that the native resolution of the display is not one of the options presented by the [[AVWizard]]. In this case, with a small amount of tweaking it is possible to get the media director to drive the display at its native resolution, which will give you optimum picture quality.

==Enable EDID==

By default, LinuxMCE disables EDID - please see the [[EDID]] page for the details. However in this case you are probably better off re-enabling it. This should be done by editing <code>/usr/pluto/templates/xorg.conf.in</code>, which is the template from which the [[AVWizard]] automatically creates new Xorg configurations. You will find a line in this file like:

Option "UseEDID" "false"

Simply change <code>false</code> to <code>true</code> and save the file. Now we need to regenerate the Xorg config, but first we need to ensure that the right resolution is visible in the [[AVWizard]].

==Adding new resolutions to the A/V Wizard==

The resolutions visible in the wizard are set in the file <code>/usr/pluto/share/Resolutions.conf</code>. The resolution you need may well already be in there, but with visibility disabled. For instance, 1360x768 is already in there, and only requires the visibility flag to be toggled to make it appear in the wizard.

If your required resolution is not in there, copy a block from one of the other resolutions and modify it accordingly.

=== Resolutions.conf ===
The Resolutions.conf file is parsed using the libconfuse library. libconfuse provides means of creating structured, yet simple, configuration files. This particular file is composed by entries like this:

resolution
{
name = "640x480" #(1)
width = 640 #(2)
height = 480 #(2)
aspect_ratio = "4:3" #(3)
modeline #(4)
{
refresh = 60 #(4.1)
builtin = true #(4.2)
x11 = "" #(4.3)
workaround #(4.4)
{
driver = {"nvidia"}
x11 = "25.18 640 656 752 800 480 490 492 525"
}
}
modeline
{
refresh = 75
builtin = true
}
visible = true #(5)
}

==== (1) The "name" field ====
This field is used as the name of the resolution when it is displayed by the A/V Wizard, and when retrieving ModeLines with <code>/usr/pluto/bin/X-GetModeline</code>
==== (2) The "width" and "height" fields ====
These fields give the dimensions for the screen for the specified resolution. A resolution can have any name (even "WagaWaga" could be used, if meaningful to someone), and these values would then define the dimensions in pixels for that resolution.
==== (3) The "aspect_ratio" field ====
This field is for display purposes alone. It is displayed by the A/V Wizard next to the resolution name.
==== (4) The "modeline" section ====
This section is optional. It can be skipped. In that case, a modeline will be generated by xtiming.pl.

You can have multiple modeline sections in a resolution block.

* (4.1) The "refresh" selector
If you include a modeline section, you must specify the "refresh" field. This field specifies to which refresh rate of the current resolution does the modeline apply.

* (4.2) The "builtin" directive
When set to "true", this says that the X server has a built-in modeline for this resolution and refresh rate combination and no modeline should be generated

* (4.3) The "x11" field
This field contains the modeline for this resolution and refresh rate combination, minus the modeline name, i.e. starting from the dot clock value.

If the mode is built-in, the x11 directive is ignored. If the mode is not built-in, and x11 is empty, then xtiming.pl is used to generate a modeline.

* (4.4) The "workaround" sub-section
This section is optional. This section is used for cases when it is known that the general settings described in the section are buggy for certain display drivers.

If you include this section, you need to specify the "driver" selector. The "driver" selector is a list of the following form: <code>{"driver1","driver2",...}</code>

This subsection can have the "x11" and "builtin" fields, with the same meaning and syntax as described above.

==== (5) The "visible" directive ====
This directive is used by A/V Wizard to decide if to display the resolution in the resolutions box or not.

=== Caveat ===
'''Furthermore''', unfortunately these resolutions are also hardcoded in <code>/usr/pluto/bin/AVWizard-Common.sh</code> - look for the line starting <code>Resolutions_HDTV</code> and add your custom resolution to the shell array. This is arguably a bug where the code does not gracefully handle resolutions which are listed in <code>/usr/pluto/share/Resolutions.conf</code> but not listed in <code>/usr/pluto/bin/AVWizard-Common.sh</code>.

=== Orbiter size ===
When you add a resolution, you may also want to add an Orbiter size to match it.

The Orbiter sizes are kept in the '''Size''' table. This is a good SQL statement to add a size:
INSERT INTO Size SET Description='Size Name', Width=Width, Height=Height, ScaleX=ScaleX*, ScaleY=ScaleY*, ScaleMenuBg='S', ScaleOtherGraphics='F';

I don't know what ScaleMenuBg and ScaleOtherGraphics mean, but except for the Nokia 770 size, all the other entries have them like that.

==== ScaleX and ScaleY ====
You can't set ScaleX and ScaleY just to any values. The end result depends greatly on these. If you get them wrong, the size of your Orbiter will be incorrect (and OrbiterGen will die if you set any of them to 0).

Here's how to compute the right values:
* For 4:3 resolutions
ScaleX = int(Width / 2.84444444444)
ScaleY = int(Height / 1.6)
* For 16:9 resolutions
ScaleY = int(Width / 2.13333333333)
ScaleY = int(Height / 1.6)

These formulas are using the value ratios determined from the existing sizes.

'''Fix me''': Determine a general formula for general aspect ratios.

==Run the A/V Wizard==
Running the A/V Wizard will regenerate the correct Xorg configuration

[[AVWizard Step by Step|Proceed through the wizard]], selecting the resolution which you have just made appear, and make sure the display is happy with the setting. If not, switch to the tty1 virtual console via Control-Alt-F1, log in, and check the most recently modified Xorg logfile written by the wizard's test (this is probably <code>/var/log/Xorg.1.log</code>) to find out why it didn't work.

==Prevent LinuxMCE from changing the Xorg config==

This is a bit of an ugly hack, and if the above is done correctly I'm not sure if it's even needed. Nevertheless, if you want to get really creative and write your own xorg.conf, this is the way to protect it from being overwritten:

Edit <code>/usr/pluto/bin/Xconfigure.sh</code> and add the following lines immediately below the <code>#!/bin/bash</code>:

echo "$0 neutered to preserve custom xorg.conf"
exit 0

==Diskless Media Director==

Chroot into the MD and perform the steps mentioned above to add the custom resolution.

To chroot into the MD, first make sure it is turned off

From the web admin, determine the ID of the MD you wish to modify.

cd /usr/pluto/diskless/
chroot <mediadirector-id>

Then perform the above steps.

*This worked for me, if someone could verify and remove this remark -Pnuts

How to setup secure outboud web access

2010-04-24T18:41:48Z

Chris Caven: How to setup secure outboud web access moved to How to setup secure outbound web access: Obvious spelling error in page title

#REDIRECT [[How to setup secure outbound web access]]

How to setup secure outbound web access

2010-04-24T18:41:48Z

Chris Caven: How to setup secure outboud web access moved to How to setup secure outbound web access: Obvious spelling error in page title

[[Category: Tutorials]]
{| align="right"
| __TOC__
|}
=Background=
This tutorial has come about as a result of a discussion on the [http://forum.linuxmce.org/index.php?topic=8692.0 forums]. It details setting up a chain of security devices on the core which should help optimize web browsing from the internal network.

''Please note, much of this is shamelessly plagarised from others. What I have done is to try to bring their work together and provide a comprehensive end-to-end solution. If you are one of those whose work has been used, please take it as a compliment and feel free to add appropriate credits at the end!''

==How Browsing Works==
Without wishing to state the obvious, an basic understanding of web browsing helps us to understand the setup described here. Browsing is a fairly simple process. The client (known as a browser) sends a request using a protocol called HTTP to a server. By default, this request is sent to port 80. The server responds with the requested file. This file may well contain HTML which the broser will display and will result in the browser making further requests for graphic files etc etc.

It is also possible to put a third entity in the middle of this chain. This entity is known as a proxy. In this case, the requests from the browser are sent to the proxy. The proxy sends the requests to the server, which responds to the proxy. Finally, the proxy responds to the browser. Proxys are used for many reasons, often security related. The system we will be setting up will consist of a chain of 3 proxies which will perform the following functions:
* Caching. This allows the proxy to store a copy of the files requested. If a second request is recieved for the same file, it is already held locally and a second request does not need to be sent to the server. This reduces traffic on the external network and also improves performance overall. The Caching proxy we will be using is known as Squid.
* Virus Scanning. As the file will be passing through the proxy, that proxy can examine its contents. In this case, viruses can be scanned for and blocked. The virus scanning proxy we will be using is called HavP and is used in conjunction with a regular scanner, in our case ClamAV.
*Content Scanning. As well as being examined for viruses, the text of the HTML can be processed and scored. This allows inappropriate (for example sexual) content to be blocked. We will be setting up using one of the best known content scanners, Dan's Guardian.

==Transparent Proxying==
There was much discussion on the forum thread concerning this. It is an additional feature which is entirely optional. In order for a proxy to be used, the browser has to "know" to send its requests to the proxy rather than to the actual server. This is achieved by configuring the browser with the proxy's details. There are, however, one or two problems with this.
#Each browser must be individually configured. Not too much of a problem with a home network and not many browsers, but particularly with portable devices which may or may not be used elsewhere (for example at work) it can be inconvenient to have to keep turning the proxy on and off.
#It can be easy to bypass. Without additional firewall rulesc to prevent direct browsing of the internet, bypassing the proxy (and therefore gaining access to blocked content) is as simple as turning it off in the browser.
The solution to this is known as transparent proxying. This works by having the proxy running on the router (in our case the core) and configuring it to intercept all outbound web traffic (i.e. destined for port 80) and redirect it to the proxy. The process is transparent to the end browser / user, hence the name.

'''NOTE''' Transparent proxying should not be seen as an alternative to setting a proxy on static machines, only as an addition. There are still ways to circumvent the system (for example, some webservers don't operate on port 80) so transparent proxying should be seen as an additional layer of security, not an alternative!

=The Software=
We will be installing a series of packages. The full details of configuring each will not be discussed here. For an in depth discussion, please visit the respective websites.
==Squid==
Squid is a very powerful caching web proxy server. This means that it keeps a copy of all files it is asked to retrieve (unless the various http headers dictate that the file cannot be cached). When a file is requested, Squid first checks to see if it has a cached copy. If so, that is returned, if not, it is fetched from the webserver. It is common for certain websites to be visited frequently and Squid will rapidly build up cached copies of things like logo graphics etc. which can (in some cases) drasticly reduce the requests to the internet with resulting speed advantages. If you also pay for data useage, Squid can save money as well! Full details can be found on the [http://www.squid-cache.org/ Squid website]. In our configuration, Squid will be the proxy that actually makes the requests to the internet and is, therefore, the "end" of the chain.
==ClamAV==
ClamAV is a linux-based virus scanning solution. It is not ''directly'' part of the proxy chain, but will be used by HavP. It will be configured to download updates on a regular basis and anecdotal evidence is that it is often "first to press" with new virus definitions. Further information at the [http://www.clamav.net/ ClamAV website].
==HavP==
HavP (Http Anti Virus Proxy) is used to scan each file being downloaded using a standard AV scanner. In our case, we are going to use ClamAV (above) to scan. HavP will be configured to use Squid as is proxy. It is important that this order is used as a new virus may otherwise end up in the cache (before ClamAV is updated) and then continue to be served up even after the virus database is updated. Once again, full details on the [http://www.server-side.de/ HavP website.]
==Dan's Guardian==
The final stage in the Proxy chain is Dan's Guardian. This is the proxy that the clients will connect to and it will, in turn, pass the requests on to HavP. Dan's Guardian is a well known content scanner that can control access to websites based not only on the URL, but also on the actual content of the files. It, like Squid, is hugely flexible and a full discussion is beyond the scope of this document, but if you need more, point your browser at the [http://dansguardian.org/ Dan's Guardian Website].
==Shorewall==
=Installation=
'''I am writing this as I perform the steps on my own core. So, while this line is here, it's a work in progress and as yet unfinished!!!!'''

We are going to work "backwards" testing each link in the chain as we go. I am going to assume you have a browser-enabled device on the "inside" network that you can easily re-configure with proxies (a PSP is NOT ideal for this!!) I also accessed my core from an ssh session on my client.
==Squid==
Firstly, we install Squld. There is already a wiki page on [[Squid|installing Squid]] which works pretty well. The only differences I experienced concerned the squid configuration file. This is located in /etc/squid/squid.conf. Locate the lines that say(Lines 607, 608 & 609 in mine):
acl localnet src 10.0.0.0/8 # RFC1918 possible internal network
acl localnet src 172.16.0.0/12 # RFC1918 possible internal network
acl localnet src 192.168.0.0/16 # RFC1918 possible internal network
comment them out(put a # at the beginning) and insert a single line which says:
acl localnet src 192.168.80.0/24
Then uncomment the line (remove the initial #) from the line(675)
#http_access allow localnet

Configure your browser to use a proxy on 192.168.80.1, port 3128 and try to access some sites. Use tail on /var/log/squid/access.log to ensure squid was used. If all is ok, proceed to the next line. (Note, you may want to reverse the changes to squid.conf to prevent this proxy being used directly.)

==ClamAv==
Next, we need a virus scanner. If you want to install without AV scanning, skip this step.

ClamAV is part of the repositories, so install using:
apt-get install clamav-daemon
We ant the virus definition databases to download automatically. This is performed by freshclam. Quick test: run freshclam (as superuser) with no parameters and check the output. If everything is OK you may create the log file in /var/log (owned by clamav or another user freshclam will be running as):

touch /var/log/freshclam.log
chmod 600 /var/log/freshclam.log
chown clamav /var/log/freshclam.log

I have set mine up to use cron, so add the following to crontab:
12 * * * * /usr/local/bin/freshclam --quiet
(This will update at 12 minutes past the hour).

==HavP==
Next we install a proxy that will scan using ClamAV. This can be obtained from the main HavP website on [http://www.server-side.de/] and should be unpacked with tar. As this isn't available as a package, the installation is the usual:
./configure --disable-clamav (if you don't want /usr/local, use --prefix=/other/path)
make
make install
Note: I couldn't get it to detaect the ClamAV libraries, possibly die to using a packaged ClamAV. If you manage to fix this, please update here!
also, a havp user and group should be created:
groupadd havp
useradd -g havp havp
Finally, edit /usr/local/etc/havp.conf.
=Setting up Transparent Proxying=
--[[User:Wierdbeard65|Wierdbeard65]] 13:31, 8 September 2009 (CEST)

Have LinuxMCE automatically control the TV and Stereo

2010-04-24T18:22:46Z

Chris Caven:

[[Category:Tutorials]]
==How to set it up==

* First add the TVs and stereos in '''[[LinuxMCE Admin Website]]->Wizard->Devices->[[AV Devices|A/V Equipment]]''' page.
* Then go to '''Wizard->Devices->[[Media Directors]]'''. In the Pipes column click 'Edit' and specify an audio pipe for the device you want the audio to go to, including the input to use on that device, and the same for the video device.

==How to use it==

It's all automatic. LinuxMCE will automatically manage the a/v equipment once you've specified the a/v pipe.

If the A/V equipment is controlled in some way that LinuxMCE can get feedback from it, such as RS232 or Ethernet, then you can also physically turn on or adjust any relevant device and set it's input to whatever the Media Director is connected to. LinuxMCE will then assume you want to watch TV with the PVR on that media director and set everything up automatically.

==Programmer's guide==

The message translation class is used within the infrared devices (like gc100), and within GSD (generic serial device) to translate commands and handle things like toggle vs discrete inputs. Devices which are controlled using GSD and a serial/ethernet interface will fire events AV_Input_Changed and Device_OnOff which Media_Plugin has interceptors for and will use the a/v pipes to figure out what device you're trying to use.

Doorbell

2010-04-24T17:27:23Z

Chris Caven: /* LinuxMCE DoorBell */

==LinuxMCE DoorBell==
Part of LinuxMCE's capabilities include the ability to setup a doorbell that connects to the system and can provide you with many extended features such as:

*Remote Unlocking of doors
*Viewing callers to your home

===Adding A Doorbell===
:This functionality can be achieved by:
::*Obtaining a compatible door-phone and registering it with LinuxMCE as extension '''996'''. Compatible means:
::**A IP-phone door-phone capable of registering with LinuxMCE.
::**An analog door-phone system that can be connected to an analog telephone adapter that can register with LinuxMCE.

::After this is done, whenever the extension is triggered, it will ring mobile orbiters and any cell phone orbiters listed in the webadmin.

===Other Features===
::*Picture: Adding a camera in the area of the doorbell should initiate LinuxMCE adding a picture of the door
::*Depending on the device, other features such as remote unlocking can be added.

[[Category:Tutorials]]
[[Category:Telecom]]

Clean Core

2010-04-24T17:14:48Z

Chris Caven: /* Introduction */

[[category: tutorials]]
[[Category: User Setups]]
{| align="right"
| __TOC__
|}
== Introduction ==

This page is meant to document the efforts to turn the LinuxMCE core into one or more Linux "services" that are automatically started at boot time. In other words, we would like to be able to boot a dedicated LinuxMCE Core server without using the Launch Manager application and without the dependency upon a graphic environment.

Please don't be shy to add any related knowledge you have.

== Runlevels ==

Runlevels are an easy way to change how the system boots. LinuxMCE (as Kubuntu) uses runlevel 2 for normal operation (depending on the selections you made during installation) and runlevel 1 is used for ''rescue mode''. The runlevels 0 and 6 are used for doing a ''shutdown'' or a ''reboot''. Which leaves the runlevels 3, 4 and 5 free for us to experiment with.

As an example we will be setting up the following scheme in this document:
# rescue (as it is now)
# KDE (as installed by Kubuntu, like '''mainly-PC''' is now)
# Core (as in textmode, ideal for headless systems)
# Core + KDE (best of both worlds)
# LaunchManager (as the classic '''dedicated-MC''' setup is now)

Of course you can just adapt the example to your specific wishes or needs.

=== Starting another runlevel ===

If you just want to start a different runlevel once without modifying your startup scripts to much (as described below) You can simply boot into ''rescue mode'' by pressing [Esc] if grub tells you to and selecting it from the boot menu. That should boot up to a text console in single user mode, from there you can easily switch to another runlevel, for example runlevel 3:
telinit 3

The "runlevel" command will show you the previous and current runlevel.

=== Setting up the runlevels ===

Traditionally the runlevels are controlled by manipulating a set of "symbolic links" in the ''/etc/rc'''X'''.d/'' directory, where '''X''' is the runlevel (0-6,S), however the Kubuntu system uses upstart, which has other ways as well.

When you are done with this you can switch to a different runlevel using one of the methods described elsewhere in this document, be sure to reboot in order to make a clean start.

Before starting it is always wise to make a backup of a few things, just in case:
tar cjvf ~/backup-`date '+%Y%m%d:%H%M'`.tar.bz2 /etc/init.d /etc/rc*.d

==== Preparation ====

Here are additional scripts needed to start the core devices, normally these task are performed by the launch-manager and it's startup script.

First a script for init (upstart):
cd /
cat >etc/init.d/core <<"EOF"
#!/bin/sh

case "$1" in
start)
/usr/pluto/bin/startCore.sh
;;
stop)

/usr/pluto/bin/StopCoreServices.sh
;;

*)
echo "Usage: /etc/init.d/core {start|stop}"
exit 1
;;
esac

exit 0
EOF
chmod +x etc/init.d/core

Which calls a script that determines the device number of the core device:

cd /
cat >usr/pluto/bin/startCore.sh <<"EOF"
#!/bin/sh

BASEDIR=/usr/pluto/bin
DeviceTemplate_Core=7

source $BASEDIR/SQL_Ops.sh

$BASEDIR/Config_Device_Changes.sh
$BASEDIR/Start_OrbiterGen.sh
$BASEDIR/UpdateMediaDaemonControl.sh -enable

$BASEDIR/Start_DCERouter.sh

$BASEDIR/checkforRaids.sh
$BASEDIR/UpdateAvailableSerialPorts.sh

QUERY="SELECT PK_Device FROM Device JOIN DeviceTemplate ON Device.FK_DeviceTemplate=DeviceTemplate.PK_DeviceTemplate WHERE PK_DeviceTemplate=${DeviceTemplate_Core}"
RESULT=$(RunSQL "$QUERY")
for ROW in $RESULT
do
CoreDev=$(Field 1 "$ROW")
$BASEDIR/startDevices.sh $CoreDev
done

EOF
chmod +x usr/pluto/bin/startCore.sh

And in turn calls this script to start the whole device family, excluding any media directors:

cd /
cat >usr/pluto/bin/startDevices.sh <<"EOF"
#!/bin/sh

BASEDIR=/usr/pluto/bin
DeviceTemplate_MeDi=28

source $BASEDIR/SQL_Ops.sh

DEVICES=$*

for DEVICE in $DEVICES
do

QUERY="SELECT ImplementsDCE, IsPlugin, Disabled, IF(PK_DeviceTemplate=${DeviceTemplate_MeDi},1,0) AS IsMeDi, REPLACE(DeviceTemplate.Description,' ','_') AS Description, CommandLine FROM Device JOIN DeviceTemplate ON Device.FK_DeviceTemplate=DeviceTemplate.PK_DeviceTemplate WHERE PK_Device=${DEVICE}"

RESULT=$(RunSQL "$QUERY")
for ROW in $RESULT
do
IMPLEMENTSDCE=$(Field 1 "$ROW")
ISPLUGIN=$(Field 2 "$ROW")
DISABLED=$(Field 3 "$ROW")
ISMEDI=$(Field 4 "$ROW")
DESCRIPTION=$(Field 5 "$ROW")
COMMANDLINE=$(Field 6 "$ROW")

# echo $RESULT, $IMPLEMENTSDCE $ISPLUGIN $DISABLED $ISMEDI $DESCRIPTION \"$COMMANDLINE\"

if [ "$ISMEDI" != "0" ]
then
echo "Device $DEVICE ($DESCRIPTION) is a Media Director"
continue
fi

if [ "$IMPLEMENTSDCE" = "0" ]
then

echo "Device $DEVICE ($DESCRIPTION) no DCE, going after the children"

CHILDREN=""
QUERY="SELECT PK_Device FROM Device WHERE FK_Device_ControlledVia=$DEVICE"
RESULT=$(RunSQL "$QUERY")
for ROW in $RESULT
do
CHILD=$(Field 1 "$ROW")
CHILDREN="$CHILDREN $CHILD"
done

if [ "$CHILDREN" ]
then

$0 $CHILDREN
else
echo "Device $DEVICE ($DESCRIPTION) has no children"
fi

else

if [ "$ISPLUGIN" = "0" ]
then

if [ "$DISABLED" = "0" ]
then

if [ -z "$COMMANDLINE" ]
then
COMMANDLINE=$DESCRIPTION
fi

if [ -x "$BASEDIR/${COMMANDLINE}" ]
then

# echo "/usr/bin/screen -d -m -S ${DESCRIPTION}-${DEVICE} $BASEDIR/Spawn_Device.sh ${DEVICE} ${DCERouter} ${COMMANDLINE}"
/usr/bin/screen -d -m -S ${DESCRIPTION}-${DEVICE} $BASEDIR/Spawn_Device.sh ${DEVICE} ${DCERouter} ${COMMANDLINE}
echo "Device $DEVICE ($DESCRIPTION) started ${COMMANDLINE}"

else
echo "Device $DEVICE ($DESCRIPTION) unable to start ${COMMANDLINE}"
fi

else
echo "Device $DEVICE ($DESCRIPTION) is disabled"
fi

else
echo "Device $DEVICE ($DESCRIPTION) is a plugin"
fi

fi

done

done

EOF
chmod +x usr/pluto/bin/startDevices.sh

===== On a Mainly Personal Computer installation =====

If you chose this install type you will need to create an extra startup script. In other words: when your core machine starts up with a KDE desktop. Here is a slightly simplified version of the one included in the "Dedicated Media Center" install type:

cd /
cat >etc/init.d/launch-manager <<"EOF"
#!/bin/sh
if [ "$1" == "start" ]
then
/usr/pluto/bin/Startup_Core-Hybrid.sh
fi

EOF
chmod +x etc/init.d/launch-manager

===== On a Dedicated Media Center installation =====

To make things a little bit easier for ourselves we're going to move a few things around a bit, this should give us about the same starting point as when using a "Mainly Personal Computer" setup. Do this if your core machine normally starts up with the launch manager:

cd /
mv -iv etc/init.d/kdm etc/init.d/launch-manager
cp -iv etc/init.d/kdm.saved etc/init.d/kdm

==== Changing the symlinks ====

In order to make the system boot only the core in runlevel 3, simply copy the symlinks of runlevel 2 and replace the ones that start KDE and the AVWizard with a symlink to the init script we created earlier during the preparations:
cd /
rm -rfv etc/rc3.d/*
cp -av etc/rc2.d/* etc/rc3.d/
ln -sfv ../init.d/core etc/rc3.d/S99core
rm -fv etc/rc3.d/S99kdm etc/rc3.d/S990start_avwizard

Making the system boot the core + KDE in runlevel 4 is even simpeler as we don't even have to remove the symlinks:
cd /
rm -rfv etc/rc4.d/*
cp -av etc/rc2.d/* etc/rc4.d/
ln -sfv ../init.d/core etc/rc4.d/S99core

Starting the launchmanager in runlevel 5:
cd /
rm -rfv etc/rc5.d/*
cp -av etc/rc2.d/* etc/rc5.d/
ln -sfv ../init.d/launch-manager etc/rc5.d/S99launch-manager
rm -fv etc/rc5.d/S99kdm

==== Additional upstart files to modify ====

You can edit these with your favorite text editor. In this example they are changed to start in runlevels 3-5 as well.

''/etc/event.d/media-center-startup''

start on runlevel 2
start on runlevel 3
start on runlevel 4
start on runlevel 5

stop on shutdown

script
/usr/pluto/bin/startup-script.sh
end script

''/etc/event.d/pluto-dhcpd-plugin''

start on runlevel 2
start on runlevel 3
start on runlevel 4
start on runlevel 5

stop on shutdown

script
screen -d -m -S DhcpdPlugin /usr/pluto/bin/Dhcpd-Plugin.sh
end script

On a sidenote: ''/etc/event.d/pluto-dhcpd-plugin'' seems redundant as it appears to be started from ''/usr/pluto/bin/startup-script.sh'' as well.

=== Changing the default runlevel ===

The default runlevel is 2, unless specified otherwise in the ''/etc/inittab'' file, here is an example on how to create such a file (it will override an existing one):
cd /
cat >etc/inittab <<"EOF"
# WARNING: Do NOT set the default runlevel to 0 (shutdown) or 6 (reboot).
id:2:initdefault: # KDE
#id:3:initdefault: # Core
#id:4:initdefault: # Core + KDE
#id:5:initdefault: # Launch Manager
EOF

This specifies a default runlevel 2 (which it already was without this file anyway), you can use your favorite text editor to edit it to your desire when you permanently want to switch.

Note that the ''runlevel='' options specified in the grub menu override this, at least if you have updated the ''/etc/event.d/rc-default'' file as described below.

=== Selecting a runlevel at boot time ===

This is a convenient way to experiment by simply selecting an alternative target from the boot-menu. If it doesn't work out you can always simply reboot to another runlevel.

First we need to replace one of ''upstart'''s files, ''/etc/event.d/rc-default''. (It wasn't a big addition, but I didn't like the inconsistent way it was written originally, so I just cleaned it up a bit.)
cd /
cat >etc/event.d/rc-default <<"EOF"
# rc - runlevel compatibility
#
# This task guesses what the "default runlevel" should be and starts the
# appropriate script.

start on stopped rcS

script
runlevel --reboot || true

if grep -q -w -- "-s\|single\|S" /proc/cmdline
then
RL="S"
else
RL="$(sed -n -e 's/.*runlevel=$[1-5]$.*/\1/p' /proc/cmdline || true)"
fi

if [ -z "$RL" -a -r /etc/inittab ]
then
RL="$(sed -n -e 's/^id:$[1-5]$:initdefault:.*/\1/p' /etc/inittab || true)"
fi

if [ -z "$RL" ]
then
RL="2"
fi

telinit $RL

end script
EOF

Now edit ''/boot/grub/menu.lst'' with your favorite text editor as follows:

Comment out the "hiddenmenu" option as follows (this will show you the boot menu without having to press [Esc]):
## hiddenmenu
# Hides the menu by default (press ESC to see the menu)
#hiddenmenu

Copy the first boot target once for every runlevel you want to be able to start, and modify it to look something like this:
title '''LMCE 1.1 (0704) KDE'''
root (hd''#'',''#'')
kernel /boot/vmlinuz-2.6.20-15-generic root=UUID=''xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'' ro quiet splash '''runlevel=2'''
initrd /boot/initrd.img-2.6.20-15-generic
quiet
savedefault

title '''LMCE 1.1 (0704) Core'''
root (hd''#'',''#'')
kernel /boot/vmlinuz-2.6.20-15-generic root=UUID=''xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'' ro quiet splash '''runlevel=3'''
initrd /boot/initrd.img-2.6.20-15-generic
quiet
savedefault

title Ubuntu, kernel 2.6.20-15-generic
root (hd''#'',''#'')
kernel /boot/vmlinuz-2.6.20-15-generic root=UUID=''xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'' ro quiet splash
initrd /boot/initrd.img-2.6.20-15-generic
quiet
savedefault

The last one is the original boot target, this will start whatever runlevel is set as the default (or runlevel 2 if none specified in ''/etc/inittab''). It shouldn't take to much imagination to add targets for runlevels 4 and 5 as well.

You can also remove the ''quiet splash'' part if you want to see what is going on during boot.

Another section of interest could be:
## default num
# Set the default entry to the entry number NUM. Numbering starts from 0, and
# the entry number 0 is the default if the command is not used.
#
# You can specify 'saved' instead of a number. In this case, the default entry
# is the entry saved with the command 'savedefault'.
# WARNING: If you are using dmraid do not change this entry to 'saved' or your
# array will desync and will not let you boot your system.
default 0

== Personal experience ==

Moved to the [[Talk:Clean_Core|discussion/talk]] page.

Display Alert Email Notification

2010-04-22T12:08:27Z

Chris Caven:

[[Category: Tutorials]]
The concept around this article is pretty simple:

*Make the core monitor as many POP3 email accounts as you want for new messages
*Pop up a Display Alert window indicating who the new message is from and the subject
*Track messages we've dealt with so we aren't constantly reminded about the same message over and over
*Provide an 'ignore message with this text in the subject line' function

This allows me to use the LMCE boxes in the house and keep an eye in incoming email messages. If I see a message that I think I may need to deal with I can then pause whatever is going on, go to my email, and then come back.

You need to get the pop3.class.inc file from this location:

http://www.phpclasses.org/browse/package/1120.html

'''Just scroll to the bottom where you can click on DOWNLOAD and save it. There's also a version available for PHP5.'''

For those that some how miss the fact you can click on the class and download it ''without being logged in'' (you probably didn't scroll all the way to the bottom!) I've put a copy of pop3.class.inc online here:

http://ww2.interpool.ca/files/pop3.class.inc

You can also get a copy of my php script here:

http://ww2.interpool.ca/files/chkmail.php

as the formatting on this page may not work well for the source code below.

Now you'll need to copy and paste this code into a file (I called it chkmail.php):

----

<pre>
<?php

// A little php script to check for new mail messages and sent a display_alert
// command to alert LinuxMCE users of new email messages
// Put this script and the pop3.class.inc somewhere. Data files will be created
// in this directory to store data about incoming messages.
// To run it: php chkmail.php
// and press Ctrl-C to stop. Or make it a background job:
// php chkmail.php &
//
// -------------------------------------------------------------
// Add your mail account info to the $mail_accounts array
// Separate your different accounts with opening/closing quotes
// Separeate your account info with a semi-colon (;)
// $mail_accounts = array("pop3.servername;pop.username;pop3.password")
// Add as many accounts as you like
// $mail_accounts = array("pop3.servername;pop.username;pop3.password","pop3.servername2;pop.username2;pop3.password2")
//

$mail_accounts = array("pop.server1;username1;password1","pop.server2;username2;password2");

$ignore_subjects = array("Cron");

// # of seconds between mail checks. 300 = 5 mins.
$waitfor = 300;

//
// You shouldn't have to edit anything below
// -------------------------------------------------------------

require_once('pop3.class.inc');

$pop3 = new POP3;

while (1) {

foreach ($mail_accounts as $account) {

list($mailserver,$username,$password) = explode(";", $account);

// Read in data file for this account
$file_name = $mailserver . "-" . $username . ".cfg";
$ids = read_file($file_name);
if ($ids == false) {
// That's ok, no previous data
$ids = array();
$orig_count = 0;
} else {
$orig_count = count($ids);
for ($i = 0; $i < $orig_count; $i++) {
// Want to strip carraige returns and line feeds so our array
// comparisons later match correctly
$ids[$i] = ereg_replace("\n\r|\r\n|\n", "", $ids[$i]);
}
}

// Connect to mail server
$do = $pop3->connect($mailserver);
if ($do == false) {
echo $pop3->error;
continue;
}

// Login to your inbox
$do = $pop3->login($username, $password);
if ($do == false) {
echo $pop3->error;
continue;
}

// Get office status
$status = $pop3->get_office_status();

if ($status == false) {
echo $pop3->error;
continue;
}

$count = $status['count_mails'];

for ($i = 1; $i <= $count; $i++) {
$email = $pop3->get_mail($i);

$email = parse_email($email);

if ($email == false) {
echo $pop3->error;
continue;
}

// Check to see if the Message-ID is in our ids array.
// Only announce if it's a new message and NOT in the existing array
$testid = trim($email['headers']['Message-ID']);
$testid = get_simple_email($testid);
if (empty($testid) || $testid == " ") {
// Try different spelling
$testid = trim($email['headers']['Message-Id']);
$testid = get_simple_email($testid);
}
if (empty($testid)) {
print_r($email[headers]);
$testid = $file_name;
}

if (!in_array($testid, $ids)) {
// add this one to the ids array
if (count($ids)==0) {
$ids = array($testid);
} else {
array_push($ids, $testid);
}
// echo a few things to the terminal for monitoring purposes
echo "Message-ID: [$testid]\n";
$efrom = $email['headers']['From'];
$efrom = get_simple_email($efrom);
echo date("Y-m-d H:i:s") . " New messages from: $efrom\n";
echo 'Subject: ' . $email['headers']['Subject'] . "\n\n";
// send message to dcerouter if subject isn't in ignore list
$found = 0;
foreach ($ignore_subjects as $subj) {
if (eregi($subj, $email['headers']['Subject'])) {
$found = 1;
break;
}
}
if (!$found) {
$message = "Email from $efrom regarding " . $email['headers']['Subject'];
exec("/usr/pluto/bin/MessageSend localhost 0 -305 1 809 9 \"$message\" 70 \"\" 182 10 251 0");
echo "Broadcasted this message to dcerouter.\n";
// Let the pop up show for multiple messages
sleep(10);
}
}

}

if ($count == 0) {
echo date("Y-m-d H:i:s") . " There are no new e-mails\n";
// This is a good place to clear out the data file since the mailbox is now empty
if (file_exists($file_name)) {
@unlink($file_name);
}
}

// See if there's been any additions to the ids array
// and if so, write back the new info
$new_count = (count($ids));
if ($orig_count < $new_count) {
write_file($file_name, $ids);
}

$pop3->close();

}
unset($msgids);
unset($ids);
sleep($waitfor);
}

function parse_email ($email) {
// Split header and message
$header = array();
$message = array();

$is_header = true;
foreach ($email as $line) {
if ($line == '<HEADER> ' . "\r\n") continue;
if ($line == '<MESSAGE> ' . "\r\n") continue;
if ($line == '</MESSAGE> ' . "\r\n") continue;
if ($line == '</HEADER> ' . "\r\n") { $is_header = false; continue; }

if ($is_header == true) {
$header[] = $line;
} else {
$message[] = $line;
}
}

// Parse headers
$headers = array();
foreach ($header as $line) {
$colon_pos = strpos($line, ':');
$space_pos = strpos($line, ' ');

if ($colon_pos === false OR $space_pos < $colon_pos) {
// attach to previous
$previous .= "\r\n" . $line;
continue;
}

// Get key
$key = substr($line, 0, $colon_pos);

// Get value
$value = substr($line, $colon_pos+2);
$headers[$key] = $value;

$previous =& $headers[$key];
}

// Parse message
$message = implode('', $message);

// Return array
$email = array();
$email['message'] = $message;
$email['headers'] = $headers;

return $email;
}

function get_simple_email($str) {

$open = strpos($str, "<");
$close = strpos($str, ">");

if (($open === false) && ($close === false)) {
return $str;
}

return substr($str, $open + 1, $close - $open - 1);

}

function read_file($name) {

if (file_exists($name)) {
$ids = file($name);
return $ids;
} else {
return false;
}

}

function write_file($name, $data) {

if ($fd = @fopen($name, "w")) {
foreach ($data as $line) {
if (!empty($line)) {
fwrite($fd, $line . "\n");
}
}
fclose($fd);
return true;
} else {
return false;
}
}

?>
</pre>
----

When you put the two files (in the same directory) on the core, make sure the user you start the script with has permission to write files in that directory, otherwise it won't be able to keep a tally of the messages it has already seen.

Email

2010-04-22T11:45:07Z

Chris Caven: /* Access web based email using Firefox */

[[Category:Tutorials]]
==Run an email program by switching to the Kubuntu desktop==
* The KDE desktop (Kubuntu) is accessible from a Media Director. Press CTRL-ALT-F7 to bring up the Kubuntu desktop.
:*Open either the Kmail, Evolution, or Thunderbird email program from the Kubuntu menu. Use the program as normal.
*Press CTRL-ALT-F11 to return to LinuxMCE.

==Access web-based email using Firefox==
The [[LinuxMCE Admin Website]] runs from within a normal Firefox web browser window. You can use the Firefox browser for any web-browsing purpose as well. If you have Yahoo mail or similar web-browser based email, you can access it from Firefox as usual.

==Using Email from an Orbiter==

To use email from an on-screen Orbiter on a Media Director, you must designate an email "installed program" first.

*See the [[Computing screen|Computing]] guide to see how to add and use an external "installed program".

Graphics Test

2010-04-22T11:24:55Z

Chris Caven: /* Start UI Diagnostic Tool */

[[Category: Video| ]]
[[Category: Tutorials]]
[[Category: Testing]]
{| align="right"
| __TOC__
|}
==Testing Graphics Capabilities of Video Card==
There are two ways to reach the graphics test tool for your system: LinuxMCE installer and LinuxMCE Launch Manager. This tool will test the video capabilities of your system (depending on your CPU and graphic card).

'''NOTE''': Depending by how fast the images are running on your screen, you will choose the correct UI. For example, if the images are running slow, choose a lower graphic interface like UI1 or UI2 (masking). If the images are running fast without any problem, then use UI2 (masking) or UI2 (alpha blending).

===LinuxMCE Installer===
'''1.''' ''The first way to test your graphic system is from LinuxMCE installer. One of the last steps of the installation will ask you about what UI you want on your system. There, you have two buttons. One of them, '''Read Online Documenation''' will open this wiki web page. The second button, '''Run Graphical Test Application''' will open the graphical test tool. For testing, the tool will need the Xine player which will be downloaded and installed automatically. Then, you can run the test. Here is a screenshot with what you should get when you reach that step in LinuxMCE installation:''

[[Image:Installertool.jpg|400px]]

====Run Graphical Test Application====
'''a.''' If you are pressing '''Run Graphical Test Application''', you'll see this initial screen.

[[Image:Initial111.jpg|400px]]

====Check for Composite Capabilities====
'''b.''' Pressing c key will test video capabilities for composite.

[[Image:Initial112.jpg|400px]]

====Check for Masking Capabilities====
'''c.''' To test your system for masking possibilities you have to press m key.

[[Image:Initial113.jpg|400px]]

====Check for Masking and Composite Together====
'''d.''' To test composite and masking together, press first c and after that press m

[[Image:Initial114.jpg|400px]]

====This is What you should See====
'''e.''' And this is how it should look when you are running the tool in full screen.

[[Image:Initial115.jpg|400px]]

===LinuxMCE Launch Manager===
'''2.''' T''he other way to run the graphics test tool is from Linux MCE Launch Manager. In the following lines, you'll see every test, how it should look (using a Nvidia card). Please remember that the same tests images and keys combinations are applied also to the first way of running the test tool.
''
====Start UI Diagnostic Tool====
'''a.''' This is the initial display of Linux MCE Launch Manager. Choose a UI type and then Start UI diagnostic tool to test the video capabilities of your system.

[[Image:Initial2.jpg|400px]]

====Check for Composite Capabilities====
'''b.''' The next image will show you the Composite capabilities of your graphic system.

[[Image:Composite.jpg|400px]]

====Check for Masking Capabilities====
'''c.''' This image will test the Masking capabilities of the graphical system, which is used by LinuxMCE interface.

[[Image:Masking.jpg|400px]]

====Check for Masking and Composite Together====
'''d.''' This is how it should look when you are using masking and composite in the same time. The test will show if the system can run successfully Linux MCE interface

[[Image:Comp-mask.jpg|400px]]

====This is What you should See====
'''e.''' Any of the tests can be run also in full screen. This picture shows one of the tests in action.

[[Image:Full_screen.jpg|400px]]

Doorbell

2010-04-21T19:45:58Z

Chris Caven:

==LinuxMCE DoorBell==
Part of LinuxMCE's capabilities include the ability to setup a doorbell that connects to the system and can provide you many extended features such as:

*Remote Unlocking of doors
*Viewing callers to your home

===Adding A Doorbell===
:This functionality can be achieved by:
::*Obtaining a compatible door-phone and registering it with LinuxMCE as extension '''996'''. Compatible means:
::**A IP-phone door-phone capable of registering with LinuxMCE.
::**An analog door-phone system that can be connected to an analog telephone adapter that can register with LinuxMCE.

::After this is done, whenever the extension is triggered, it will ring mobile orbiters and any cell phone orbiters listed in the webadmin.

===Other Features===
::*Picture: Adding a camera in the area of the doorbell should initiate LinuxMCE adding a picture of the door
::*Depending on the device, other features such as remote unlocking can be added.

[[Category:Tutorials]]
[[Category:Telecom]]

Add a USB printer

2010-04-21T19:00:14Z

Chris Caven: /* Adding a USB Printer */

[[Category :Tutorials]]
[[category :Printers]]

=Adding a USB Printer=
You can easily add a USB printer to your core or to an MD to share over the network, even with Windows PCs.

==Installing the Printer on a PC==
*Connect the USB printer to the PC (in my case, I chose to connect to the core so the printer would be in my server closet).
*Using LinuxMCE, navigate to the KDE desktop.
*Navigate to System settings and select the "Printers" icon. This should bring up the Printer System Settings menu.
*Click on the dropdown for "Add", and select "Add Printer/Class". This will bring up the Add Printer Wizard, click "Next"
::*you may experience a known bug with KDE here. Sometimes the radio button where you would select "Local printer(parallel,serial,USB)" will be unavailable/grayed out. If you know that your USB ports and Printer are both functioning properly, try using this command from a terminal.
cd /etc/cups
sudo cp cupsd.conf.default cupsd.conf
sudo /etc/init.d/cupsys restart
*Select the radio button for "Local Printer", then select your printer from the list.
::*KDE has quite alot of printer drivers already available in the OS, so you should be able to select your printer Brand and Model in the next screen.
*Once you do so, it will bring up a list of possible drivers that you can select and test to see which one works best. Once you are done, click "Finish".

You have now installed your USB printer to this PC.

==Share Printer on Local Network==
You can now share your newly installed printer with other PCs on your network.
*Navigate back to System Settings and select the "Printers" icon.
*Select the drop down for "Print Server", then select "Share Printers on Local Network". Click "Enable Sharing" on the popup.

===Adding Shared printer to a Windows PC===
Now that you have your printer installed and set to share on your network, you will need to show windows how to get to the printer. My windows laptop running Vista would not automatically locate this printer, so this is how I set it up.
*On your Windows machine go to Start>Control Panel>Printers and Faxes
*Select "Add a printer"
*Click "Next"
*Select the radio dial for network printer and click "Next"
*Click the radio for "Connect to this Printer" and fill in the blank. You must make sure to add the port :631 after your server IP address.
::*ex. \\192.168.80.1:631\printer\'what_you_named_your_printer. You will be asked for your LinuxMCE password and it should connect to the printer. After that, you will just have to tell Windows what type of printer it is and specify the driver and you should be set.

===Adding a shared printer to an MD or Kubuntu-based PC===
*This is pretty straightforward using the KDE printer wizard. Feel free to fill this section in; if not, I will get to it later.

Currently in 810, smb.conf is stripped. Follow these instructions to get the printer to show up on Windows networks

Add to GLOBAL section:

########## Printing ##########
# If you want to automatically load your printer list rather
# than setting them up individually then you'll need this
load printers = yes
# lpr(ng) printing. You may wish to override the location of the
# printcap file
; printing = bsd
; printcap name = /etc/printcap
# CUPS printing. See also the cupsaddsmb(8) manpage in the
# cupsys-client package.
printing = cups
printcap name = cups

Add AFTER ## END : InternalStorageDevices"

[printers]
comment = All Printers
browseable = no
path = /var/spool/samba
printable = yes
guest ok = no
read only = yes
create mask = 0700
# Windows clients look for this share name as a source of downloadable
# printer drivers
[print$]
comment = Printer Drivers
path = /var/lib/samba/printers
browseable = yes
read only = yes
guest ok = no
# Uncomment to allow remote administration of Windows print drivers.
# You may need to replace 'lpadmin' with the name of the group your
# admin users are members of.
# Please note that you also need to set appropriate Unix permissions
# to the drivers directory for these users to have write rights in it
; write list = root, @lpadmin

Network Settings

2010-04-21T18:42:03Z

Chris Caven: /* Recommended configuration */

{| align="right"
| __TOC__
|}
[[Category: Networking]]
[[Category: Admin Website]]
[[Image:NetworkSettings.jpg|thumb|200px|Network Settings Admin Page]]

The settings on this page are used to configure the network in your Core.

==Recommended configuration==
The recommended configuration for a LinuxMCE Core is to have 2 network cards, and plug 1 of them into the external internet (the cable or DSL modem), and the other into the internal switch that the other computers and devices in the house connect to.
This allows the LinuxMCE Core to act as a firewall to protect the devices in the house, and also to manage your network bandwidth to ensure that phone calls, video calls and other time-sensitive traffic take priority over web pages and file downloads. In such a configuration you would enable DHCP on the internal network, and the external network would obtain an IP address either statically or through the DHCP server in your DSL/Cable modem, depending on how your internet service provider configured it.

Every device connected to the local area network in your home needs a unique IP address. The "DHCP Server" is the device that assigns every other device its own IP. If you have multiple computers in your home, you probably have a router, DSL or cable modem that is your DHCP Server. Normally you should only have 1 DHCP server on the network. If you have more than 1, they can 'fight' over the assignment of IP addresses. If you have dual network cards in the Core, this solves the problem since the 'external' internet connection provided by your DSL or cable modem is physically a separate network from the internal network in your home. In that case, it is okay to have LinuxMCE act as the DHCP server for the internal network, while the Cable/DSL modem is the DHCP server for the external network.

===Diskless media directors===
If you want to have diskless media directors, where they do not boot LinuxMCE from their local hard drive, but rather use the LinuxMCE Core, the Core needs to be the DHCP server for those media directors. Also, for the Core to be able to automatically configure your devices, such as telephones, the Core needs to be their DHCP server. The easiest solution is, therefore, to make the Core the sole DHCP server in your house. It will then assign IP addresses for every computer in your home, whether it's running LinuxMCE's software or not.

==Single network card==
If you do not have dual network cards, or want to use another DHCP server, you can disable DHCP on the LinuxMCE Core altogether. Or, you can tell the Core to "give IP addresses to LinuxMCE devices only". This means the LinuxMCE Core will assign IP addresses for LinuxMCE devices, but ignore everything else in your home. If you do this, LinuxMCE can work with your other DHCP servers if they likewise do not try to assign IP addresses to your LinuxMCE devices. But this means that plug-and-play will not work since LinuxMCE will only give IP addresses to devices it already knows--not new devices.

===Example configuration===
If you do not have two network cards, and want your existing homenetwork to remain using your DSL-Modem/Router/WLANAcessPoint-All-in-One-Standalone-Box (e.g. a Fritzbox) you`ll end up with two subnetworks in your home. - Or you manage to tell the Core to only use 1 subnetwork, which I didn`t ...

If this is the case your existing network most likely contains a "DSL-Modem/Router/WLANAcessPoint" (192.168.1.1) which connects your local Computer (192.168.1.2) and your Laptop (192.168.1.3) to your Internetprovider (which assigns a dynamic Internet-IP to your Router).

! You need to disable the DHCP-Sever in the "DSL-Modem/Router/WLANAcessPoint". Assign static IPs to all your homenetwork-computers. Later on everytime a computer/device which uses dhcp is started, the dhcp-request must be answered by the core/hybrid in order to use MD pxe boot.

Now you install a Core/Hybrid with one physical networkcard (eth0). LinuxMCE automatically adds a second virtual networkcard (eth0:0). Change your "external" IP to be static and to be part of your existing homenetwork (e.g. IP 192.168.1.4).
So far I`m only telling old stories ... The particular NEWS: To use your existing wiring (incl. wlan) you need to tell the router that the gateway to the "external" (from the homenetwork`s point of view) (sub)net 192.168.80.0 is 192.168.1.4
This is done by creating a static route on your "DSL-Modem/Router/WLANAcessPoint". Sometime you`ll find this in the NAT-settings. If using a Fritzbox: System / Networksetting / IP-Routs / Add. IP-network: 192.168.80.0 Subnetmask: 255.255.255.0 Gateway: 192.168.1.4

Hint: If you disabled the dhcp-server of the "DSL-Modem/Router/WLANAcessPoint" and created the route before installing LinuxMCE you`ll end up with an internal-eth0:0 192.168.80.1 and your external-eth0 (which uses "Obtain an IP adress from DHCP") having an IP from the subnet 192.168.80.xxx as well. This means everything is working!
Your "external" interface did ask for a dhcp-server and your "interal" interface answered that it got one ... - Of course you have to change your "external"-eth0-IP to be static and be part of you (sub)homenetwork, as well.

==See also==
* [[Why dual network cards?]]
* [[How to setup ADSL access?]]
* [[DHCP Plug and Play]]
* [[How to setup Local Authoritative DNS]]

Network Setup

2010-04-21T18:11:51Z

Chris Caven: /* Fully Configured Smart Home Solution */

[[Category:Networking]]
[[Category:Tutorials]]
[[Category:Networking Setups]]
=Overview=

There is regularly some confusion over how much of your existing home network LinuxMCE requires you to change. Many people incorrectly believe that significant changes are required. In the most common case of home networks, almost no change at all is required. The Core server requires 2 NICs (Network Interface Cards). One is known as the "External" NIC and the other as the "Internal" NIC.

=Existing Home Network=

[[Image:Before.PNG]]

Above we see a very simple home network setup. All devices are connected to a switch, which in turn is connected to the LAN port of a broadband router. In this topology, most people have their broadband router provide dynamic IP addresses to all other devices via DHCP.

=Network After LinuxMCE is Installed=

[[Image:After.PNG]]

Above we see the same network, now LinuxMCE enabled. NOTE: The ''only'' change is the Core LinuxMCE server has been inserted between the switch and the broadband router. In practice, this means disconnecting the Cat5e/6 patch cable, shown in the first diagram, from the broadband router and connecting it into the "Internal" NIC of the of the Core server (shown here on the right of the red box). Next, get a new Cat5e/6 patch cable and connect one end to the "External" NIC of the Core server (shown here on the left of the red box), and the other end back into the LAN port of the broadband router. Your setup is now complete!

In this network, your broadband router can continue providing dynamic IP addresses to the "External" NIC of the core - however, there is nothing stopping you fixing this IP address if you prefer. In which case your broadband router's DHCP server is no longer needed. For the Internal or LinuxMCE network, the Core now provides DHCP services to all devices. IMPORTANT: LinuxMCE needs to be the (only) DHCP server for the Internal network because it provides much more than just IP addresses to these devices. So it is important that you allow it to do this, and leave all your internal devices set to acquire their IP address via DHCP so that LinuxMCE works correctly. This is the only supported configuration - however, as you can see, the impact is either negligible or non-existent.

It is also well worth noting that your PCs will be detected as "file servers" by LinuxMCE, and when the DHCP server assigns an IP address this is effectively permanent/static. You do not need to worry about the IP address changing all the time, it doesn't! This information will be of particular interest to those who want to NAT or port forward services from the Internet to specific PCs, such as Remote Desktop sessions and Bit Torrent clients.

In this page, a reference to the "Core server" can either be a dedicated Core or a Hybrid - a core, plus Media Director functionality - either way, it doesn't effect the network topology or any other details described here. The important point is that a "Core server" at the least contains the LinuxMCE core services, and this is the functionality that needs to be the gateway between the Internal network and the External network.

=Fully Configured Smart Home Solution=

[[Image:Complete.PNG]]

In the above diagram, you can see the same LinuxMCE-enabled network after it has matured - the owner has gone nuts, adding stuff! You may only wish to use LinuxMCE for media playback, in which case you will be more interested in the "MD"s in the diagram. However, you can continue expanding it at will into its designed functionality by adding telephones, security systems, home automation networks (lights, environmental controls, irrigation systems, etc).

It should be understood that this article is attempting to show that in the simplest implementation, LinuxMCE does not require large, wholesale changes to your existing home network - in fact, in many cases it requires no change at all, just an extra Cat5e/6 patch cable. This does not mean that this is the only, recommended or best network design. It is a minimal implementation that satisfies all of the requirements and is here to show how simple LinuxMCE can actually be. There are many other designs that are extensions of this one, or completely different, that also work and may be chosen based on more sophisticated requirements you may have, but this is a starting point.

Network Setup

2010-04-21T13:05:06Z

Chris Caven:

[[Category:Networking]]
[[Category:Tutorials]]
[[Category:Networking Setups]]
=Overview=

There is regularly some confusion over how much of your existing home network LinuxMCE requires you to change. Many people incorrectly believe that significant changes are required. In the most common case of home networks, almost no change at all is required. The Core server requires 2 NICs (Network Interface Cards). One is known as the "External" NIC and the other as the "Internal" NIC.

=Existing Home Network=

[[Image:Before.PNG]]

Above we see a very simple home network setup. All devices are connected to a switch, which in turn is connected to the LAN port of a broadband router. In this topology, most people have their broadband router provide dynamic IP addresses to all other devices via DHCP.

=Network After LinuxMCE is Installed=

[[Image:After.PNG]]

Above we see the same network, now LinuxMCE enabled. NOTE: The ''only'' change is the Core LinuxMCE server has been inserted between the switch and the broadband router. In practice, this means disconnecting the Cat5e/6 patch cable, shown in the first diagram, from the broadband router and connecting it into the "Internal" NIC of the of the Core server (shown here on the right of the red box). Next, get a new Cat5e/6 patch cable and connect one end to the "External" NIC of the Core server (shown here on the left of the red box), and the other end back into the LAN port of the broadband router. Your setup is now complete!

In this network, your broadband router can continue providing dynamic IP addresses to the "External" NIC of the core - however, there is nothing stopping you fixing this IP address if you prefer. In which case your broadband router's DHCP server is no longer needed. For the Internal or LinuxMCE network, the Core now provides DHCP services to all devices. IMPORTANT: LinuxMCE needs to be the (only) DHCP server for the Internal network because it provides much more than just IP addresses to these devices. So it is important that you allow it to do this, and leave all your internal devices set to acquire their IP address via DHCP so that LinuxMCE works correctly. This is the only supported configuration - however, as you can see, the impact is either negligible or non-existent.

It is also well worth noting that your PCs will be detected as "file servers" by LinuxMCE, and when the DHCP server assigns an IP address this is effectively permanent/static. You do not need to worry about the IP address changing all the time, it doesn't! This information will be of particular interest to those who want to NAT or port forward services from the Internet to specific PCs, such as Remote Desktop sessions and Bit Torrent clients.

In this page, a reference to the "Core server" can either be a dedicated Core or a Hybrid - a core, plus Media Director functionality - either way, it doesn't effect the network topology or any other details described here. The important point is that a "Core server" at the least contains the LinuxMCE core services, and this is the functionality that needs to be the gateway between the Internal network and the External network.

=Fully Configured Smart Home Solution=

[[Image:Complete.PNG]]

In the above diagram you can see the same LinuxMCE enabled network after it has matured - the owner has gone nuts, adding stuff! You may only wish to use LinuxMCE for media playback, in which case you will be more interested in the "MD"s in the diagram. However, you can continue expanding it at will into its designed functionality by added telephones, security systems, home automation networks (lights, environmental controls, irrigation systems, etc)

It should be understood that this article is attempting to show that in the simplest implementation, LinuxMCE does not require large, wholesale changes to your existing home network - in fact, in many cases it requires no change at all, just an extra Cat5e/6 patch cable. This does not mean that this is the only, recommended or best network design. It is a minimal implementation that satisfies all of the requirements, and is here to show how simple LinuxMCE can actually be. There are many other designs that are extensions of this one, or completely different that also work and may be chosen based on more sophisticated requirements you may have, but this is a starting point.

Wiring Considerations

2010-04-21T12:43:06Z

Chris Caven: /* Audio cabling */

{| align="right"
| __TOC__
|}
[[Category: Networking]]
==Introduction==

Older, proprietary home automation and security systems traditionally have required their own dedicated wiring. Placing that wiring was often the biggest hurdle in installing such systems, and usually entailed tearing open walls in order to run the special cables (which were often very thick and difficult to manage).

In contrast, LinuxMCE uses standard Ethernet wiring and jacks. Because it is IP (Internet Protocol) based (the same protocol that runs the Internet and most local home and office networks), it runs directly over an Ethernet network. Ethernet networks use standard CAT5 (or CAT5e/CAT6) wiring with RJ-45 jacks. This wiring is often already pre-installed in recently-constructed homes, since it is now also used for many phone systems as well as for home networks. Even if your home does not already have CAT5e/CAT6 wiring pre-installed, CAT5e/CAT6 wires are some of the smaller, easier wires to install. Installing CAT5e/CAT6 wiring in a house is well worth the cost and will increase the resale value, even without a LinuxMCE system. Home networks (LANs) that are run over CAT5e-wired Ethernet connections are increasingly popular for Internet access and file/printer sharing throughout the home.

Thus, the only wiring requirement for LinuxMCE is that you have Ethernet (CAT5e/CAT6) wiring. All wired LinuxMCE devices (such as a PC used as a Media Director) will be able to directly plug into the RJ45 jack.

==Wired vs. wireless connections==

Note, however, that not all LinuxMCE devices require a wired connection. Many can connect [[Wireless Networking|wirelessly]], if you have a wireless access point connected to the LinuxMCE [[Core]] server. However, it is easiest for the main components, the [[Core]] and the [[Media Directors]], to be connected in a wired fashion.

==CAT5 vs. CAT5e vs. CAT6 vs. Fiber-optic==

*CAT5 wiring uses the smallest gauge wires, which are stranded. It was the standard for many years and can be used for data speeds up to 100 Mb/sec. However, the increased speeds and loads of modern LANs place a strain on the characteristics of this wire. It is no longer recommended as the wiring standard. In general 100 Mb/sec speeds can transmit 7 simultaneous DVD quality video streams.

*CAT5e wiring was recently used as the wiring standard, and uses a somewhat higher gauge solid wire. This enables the transmission of data at 250 Mb/sec to 1000 Mb/sec (Gigabit), used by newer LANs. At these speeds, it is more reliable over long distances. In general, Gigabit data transmission speeds can transmit 100 simultaneous DVD quality video streams (over short distances).

*CAT6 wiring uses even higher gauge wires. It is preferred for Gigabit speeds (1000 Mb/sec to 10,000 Mb/sec), especially over long distances. Until recently, such speeds were not common, but rapid advancements in routers have made Gigabit networks the norm. Therefore, CAT6 wire should be installed whenever possible.

Obviously, even if you use higher gauge CAT5e and CAT6 wires, you will not achieve the higher data transmission speeds unless all your network components (cables, connectors, network cards, switches, etc.) also support higher data transmission speeds.

*Fiber optic cables theoretically have the highest transmission rate, but are currently expensive and difficult to install (because if they are bent during installation the fibers can break). Routers to connect to fiber optic cables are not readily available for the consumer, either. However, this is the ultimate in forward-thinking cabling for your house, and it will not be long before fiber optic cable will be standard in home construction. Fiber optic cables will replace your phone, television cable, and ethernet cables, so that one fiber optic cable will carry all those signals.

*Many commercial buildings use conduits for cabling, to allow easy cable runs and replacement of existing cables in the future. Conduits can be made of simple PVC pipes (like those used for irrigation), but most builders are reluctant to install them. Nevertheless, they do not take much effort to install during a new home construction, are not expensive, and provide superior protection for cables, especially fragile fiber optic cables. They will also prevent chewing on cables by varmints (such as squirrels and mice).

==Using pre-installed CAT5 placed for telephone systems==

It is possible but not wise to use the same wire for the telephone system and the LAN (see the discussion page for more details). Telephone systems run their own power over the CAT5 lines in a configuration different from Ethernet devices. If you connect an Ethernet device to a live telephone line, you can burn out the Ethernet device unless you are very careful about tracing the leads. While some users have wired analog phone and ethernet on the same CAT5 wire, it is strongly discouraged.

However, most new telephone installations include redundant CAT5 wires that are not connected to the telephone system. (For example, my home is wired with two CAT5 wires to each location, one connected to a telephone jack and one left unconnected.)

It is very easy to use a redundant CAT5 wire for the LAN by connecting it to an additional RJ-45 jack, which can then be added to the same outlet. The wire must then be traced to the other end, which will almost always be at the telephone patch panel for your home (where hopefully it will also be unconnected) and connected to the LAN there, instead. (This presumes, of course, that at the location of the telephone patch panel you have a router, switch, or RJ45 connection (to the rest of your LAN) to which you can connect this wire (using an RJ-45 connector).)

==Ethernet wiring standards==
It is important to note that there are two wiring standards for Ethernet, T568A and T568B. My local electrician was clueless about this and wired all my CAT5 connections wrong.

For a quick tutorial, see [http://www.ertyu.org/steven_nikkel/ethernetcables.html this guide on wiring Ethernet connections].

Most Ethernet wiring is currently done using the T568B standard, and I highly recommend you stick to it. However, you must be aware of deviations from this standard. For example, my Ethernet-wired surveillance cameras all use the T568A standard. This took me a long time to figure out, and, again, my electrician wired them all incorrectly.

It is tricky to adapt T568A to T568B -- you need a special type of cross-over cable. This is somewhat complex. For the most part, I recommend you just wire everything using the T568B standard.

==Audio cabling==
In some instances, you may wish to install cabling for audio signals (line in/out audio, speakers, etc.) to or from your LinuxMCE system. If an audio cable is close to the power lines, the audio cable will pick up 50 or 60 Hz frequency power line noise. This will cause a "humming" in your audio signal which is very annoying. In general low-volt audio wires should be at least 18 inches away from power lines, not run parallel to power lines for more than 2 feet, and should cross perpendicular to power lines whenever possible. If you are planning to install audio cabling in your home, take a look at the [http://www.hometech.com/learn/audio.html Whole-House Audio Tutorial] from HomeTech Solutions. (It is not LinuxMCE specific but is very informative.)

Also see:
[http://en.wikipedia.org/wiki/EIA_568A What is proper CAT5 cabling?]

[http://www.crutchfield.com/Learn/learningcenter/home/inwall_wiring.html In-wall Wiring Guide]

Wiring Considerations

2010-04-21T11:58:12Z

Chris Caven: /* Introduction */

{| align="right"
| __TOC__
|}
[[Category: Networking]]
==Introduction==

Older, proprietary home automation and security systems traditionally have required their own dedicated wiring. Placing that wiring was often the biggest hurdle in installing such systems, and usually entailed tearing open walls in order to run the special cables (which were often very thick and difficult to manage).

In contrast, LinuxMCE uses standard Ethernet wiring and jacks. Because it is IP (Internet Protocol) based (the same protocol that runs the Internet and most local home and office networks), it runs directly over an Ethernet network. Ethernet networks use standard CAT5 (or CAT5e/CAT6) wiring with RJ-45 jacks. This wiring is often already pre-installed in recently-constructed homes, since it is now also used for many phone systems as well as for home networks. Even if your home does not already have CAT5e/CAT6 wiring pre-installed, CAT5e/CAT6 wires are some of the smaller, easier wires to install. Installing CAT5e/CAT6 wiring in a house is well worth the cost and will increase the resale value, even without a LinuxMCE system. Home networks (LANs) that are run over CAT5e-wired Ethernet connections are increasingly popular for Internet access and file/printer sharing throughout the home.

Thus, the only wiring requirement for LinuxMCE is that you have Ethernet (CAT5e/CAT6) wiring. All wired LinuxMCE devices (such as a PC used as a Media Director) will be able to directly plug into the RJ45 jack.

==Wired vs. wireless connections==

Note, however, that not all LinuxMCE devices require a wired connection. Many can connect [[Wireless Networking|wirelessly]], if you have a wireless access point connected to the LinuxMCE [[Core]] server. However, it is easiest for the main components, the [[Core]] and the [[Media Directors]], to be connected in a wired fashion.

==CAT5 vs. CAT5e vs. CAT6 vs. Fiber-optic==

*CAT5 wiring uses the smallest gauge wires, which are stranded. It was the standard for many years and can be used for data speeds up to 100 Mb/sec. However, the increased speeds and loads of modern LANs place a strain on the characteristics of this wire. It is no longer recommended as the wiring standard. In general 100 Mb/sec speeds can transmit 7 simultaneous DVD quality video streams.

*CAT5e wiring was recently used as the wiring standard, and uses a somewhat higher gauge solid wire. This enables the transmission of data at 250 Mb/sec to 1000 Mb/sec (Gigabit), used by newer LANs. At these speeds, it is more reliable over long distances. In general, Gigabit data transmission speeds can transmit 100 simultaneous DVD quality video streams (over short distances).

*CAT6 wiring uses even higher gauge wires. It is preferred for Gigabit speeds (1000 Mb/sec to 10,000 Mb/sec), especially over long distances. Until recently, such speeds were not common, but rapid advancements in routers have made Gigabit networks the norm. Therefore, CAT6 wire should be installed whenever possible.

Obviously, even if you use higher gauge CAT5e and CAT6 wires, you will not achieve the higher data transmission speeds unless all your network components (cables, connectors, network cards, switches, etc.) also support higher data transmission speeds.

*Fiber optic cables theoretically have the highest transmission rate, but are currently expensive and difficult to install (because if they are bent during installation the fibers can break). Routers to connect to fiber optic cables are not readily available for the consumer, either. However, this is the ultimate in forward-thinking cabling for your house, and it will not be long before fiber optic cable will be standard in home construction. Fiber optic cables will replace your phone, television cable, and ethernet cables, so that one fiber optic cable will carry all those signals.

*Many commercial buildings use conduits for cabling, to allow easy cable runs and replacement of existing cables in the future. Conduits can be made of simple PVC pipes (like those used for irrigation), but most builders are reluctant to install them. Nevertheless, they do not take much effort to install during a new home construction, are not expensive, and provide superior protection for cables, especially fragile fiber optic cables. They will also prevent chewing on cables by varmints (such as squirrels and mice).

==Using pre-installed CAT5 placed for telephone systems==

It is possible but not wise to use the same wire for the telephone system and the LAN (see the discussion page for more details). Telephone systems run their own power over the CAT5 lines in a configuration different from Ethernet devices. If you connect an Ethernet device to a live telephone line, you can burn out the Ethernet device unless you are very careful about tracing the leads. While some users have wired analog phone and ethernet on the same CAT5 wire, it is strongly discouraged.

However, most new telephone installations include redundant CAT5 wires that are not connected to the telephone system. (For example, my home is wired with two CAT5 wires to each location, one connected to a telephone jack and one left unconnected.)

It is very easy to use a redundant CAT5 wire for the LAN by connecting it to an additional RJ-45 jack, which can then be added to the same outlet. The wire must then be traced to the other end, which will almost always be at the telephone patch panel for your home (where hopefully it will also be unconnected) and connected to the LAN there, instead. (This presumes, of course, that at the location of the telephone patch panel you have a router, switch, or RJ45 connection (to the rest of your LAN) to which you can connect this wire (using an RJ-45 connector).)

==Ethernet wiring standards==
It is important to note that there are two wiring standards for Ethernet, T568A and T568B. My local electrician was clueless about this and wired all my CAT5 connections wrong.

For a quick tutorial, see [http://www.ertyu.org/steven_nikkel/ethernetcables.html this guide on wiring Ethernet connections].

Most Ethernet wiring is currently done using the T568B standard, and I highly recommend you stick to it. However, you must be aware of deviations from this standard. For example, my Ethernet-wired surveillance cameras all use the T568A standard. This took me a long time to figure out, and, again, my electrician wired them all incorrectly.

It is tricky to adapt T568A to T568B -- you need a special type of cross-over cable. This is somewhat complex. For the most part, I recommend you just wire everything using the T568B standard.

==Audio cabling==
In some instances, you may wish to install cabling for audio signals (line in/out audio, speakers, etc.) to or from your LinuxMCE system. If an audio cable is close to the power lines, the audio cable will pick up 50 or 60 Hz frequency power line noise. This will cause a "humming" in your audio signal which is very annoying. In general low-volt audio wires should be at least 18 inches away from power lines, not run parallel to power lines for more than 2 feet, and should cross perpindicular to power lines whenever possible. If you are planning to install audio cabling in your home, take a look at the [http://www.hometech.com/learn/audio.html Whole-House Audio Tutorial] from HomeTech Solutions. (It is not LinuxMCE specific but is very informative.)

Also see:
[http://en.wikipedia.org/wiki/EIA_568A What is proper CAT5 cabling?]

[http://www.crutchfield.com/Learn/learningcenter/home/inwall_wiring.html In-wall Wiring Guide]

MTU

2010-04-20T19:27:01Z

Chris Caven:

[[Category: Networking]]
[[Category: Troubleshooting]]

Ever had problems with your MTU being set to 576 on eth0 because of your ISP or other reasons. You can fix that.

You can check your MTU settings with the terminal command:
ifconfig eth#
where eth# is the NIC you are trying to affect; in my case this was eth0

Realtime you can open a terminal and use:
sudo ifconfig eth0 mtu ####
The #### is the number of the MTU you want to use; in my case 1500, so the realtime command would be: sudo ifconfig eth0 mtu 1500

Of course, if you reboot or the network gets restarted it will change to 576 again, so to make it permanent we have to edit some files, in particular the /etc/network/interfaces file.

/etc/network/interfaces looks like this for a normal core on LinuxMCE:

auto lo
iface lo inet loopback
auto eth0
iface eth0 inet dhcp
auto eth1
iface eth1 inet static
address 192.168.80.1
netmask 255.255.255.0

So eth0 is getting its IP from your ISP through DHCP and therefore also the MTU setting; eth1 is getting a static IP that's provided.

Now the changes you want to make to ensure the MTU is 1500 for everything are the following....

For the DHCP eth0, you need to add a line telling the NIC to set the MTU at 1500 which looks like this:-

post-up /sbin/ifconfig $IFACE mtu 1500

For the static eth1, it's easier to add a line telling the MTU to be 1500 (or whatever you like, you can experiment with your internal network for better package handling. I've heard up to 9000, but this is up to you)

mtu 1500

Your interfaces file should now look something like this:-

auto lo
iface lo inet loopback
auto eth0
iface eth0 inet dhcp
post-up /sbin/ifconfig $IFACE mtu 1500
auto eth1
iface eth1 inet static
address 192.168.80.1
netmask 255.255.255.0
mtu 1500

After a networking restart:
/etc/init.d/networking restart

look at your ifconfig again and it should have the correct MTU settings.

Hope this helps. Please add additional information if needed/wanted.

How to setup ADSL access?

2010-04-20T19:05:45Z

Chris Caven:

[[Category: Tutorials]]
[[Category: Networking]]

Setting up ADSL connection is not yet fully supported under LinuxMCE. But there is a relatively simple procedure to get it up and running. I'm posting my notes (hopefully didn't forget anything important)... 

== PPPoE ==
# setup two network cards as normally
# run pppconfig (follow instructions on screen)
# go into database - this is the SQL query for the database to see the current setting: 
select * from Device_DeviceData where FK_Device=1 and FK_DeviceData=32; 
the data will look something like this: 
eth1,10.0.0.85,255.255.255.0,10.0.0.1,10.0.0.150|eth0,192.168.80.1,255.255.255.0 

you'll have to change the proper ethX in that string (eth1 in my case) with ppp0 

4. put /etc/init.d/start_pppoe.sh and link it to /etc/rc2.d/S10start_pppoe 

Content of start_pppoe.sh : 

#!/bin/bash
export PATH="/usr/pluto/bin:$PATH"
. /usr/pluto/bin/pluto.func
if [[ -e /usr/pluto/install/.notdone ]]; then exit 1
fi
Logging "server" "1" "$0" "Running 'start_pppoe.sh' '' ( \"/etc/init.d/start_pppoe.sh\" )"
ifconfig eth1 up
pon dsl-provider

 

4.a Alternative: Instead of doing 4 you can do following:

You could also simply append two lines
/sbin/ifconfig eth0 up
/usr/bin/pon dsl-provider

at the end of /etc/init.d/networking before "exit(0)", but I guess this will be overwritten by LinuxMCE. For me it works.

I hope that this will soon be easier to setup over web-admin page.

Installation

2010-04-20T18:32:55Z

Chris Caven: /* Ripping Format for CD's */

[[Image:Installation.jpg|200px|thumb|Linux Admin Website page which allows for entering of general installation settings.]]
[[Category: Admin Website]]

This page allows you to input several pieces of information regarding your location and some basic settings that LinuxMCE will use.

==Location==
Here you can input your name and location.
==Longitude/Latitude==
Complete the drop down menus in order to find your exact map coordinates.
==Current Time Zone==
You can review and set your time zone.

==Miscellaneous==
===Ripping Format for CDs===
Here you can set the Format for how you want your CDs to be ripped. Current choices are:
* MP3
* Ogg
* FLAC
* WAV

For a more detailed description of the ripping process, see how to [[Rip a CD/DVD to the Core]]

===Bit Rate===
Here you can set the Bit Rate for which you want to encode.
===CBR or VBR===
* '''Constant Bit Rate (CBR)''' In video coding, the bitrate of the compressed video is fixed at a certain rate. This usually results in variable perceived quality of the video.
* '''Variable Bit Rate (VBR)''' A way of encoding video such that the data rate varies over time. This allows more complex scenes to use a higher data rate, balanced by using lower data rates in easily compressed scenes.

Installation

2010-04-20T18:24:55Z

Chris Caven: /* Current Time Zone */

[[Image:Installation.jpg|200px|thumb|Linux Admin Website page which allows for entering of general installation settings.]]
[[Category: Admin Website]]

This page allows you to input several pieces of information regarding your location and some basic settings that LinuxMCE will use.

==Location==
Here you can input your name and location.
==Longitude/Latitude==
Complete the drop down menus in order to find your exact map coordinates.
==Current Time Zone==
You can review and set your time zone.

==Miscellaneous==
===Ripping Format for CD's===
Here you can set the Format for how you want your CD's to ripped. Current choices are:
* MP3
* Ogg
* Flac
* Wav
for a more detailed description of the ripping process see how to [[Rip a CD/DVD to the Core]]
===Bit Rate===
Here you can set the Bit Rate for which you want to encode.
===CBR or VBR===
* '''Constant Bit Rate (CBR)''' In video coding, the bitrate of the compressed video is fixed at a certain rate. This usually results in variable perceived quality of the video.
* '''Variable Bit Rate (VBR)''' A way of encoding video such that the data rate varies over time. This allows more complex scenes to use a higher data rate, balanced by using lower data rates in easily compressed scenes.

Devices

2010-04-19T15:33:13Z

Chris Caven:

These wizard pages are used to add devices to your installation.
The "Interfaces" section is for devices that interface with some sort of master control, or devices that control other non-DCE devices. For example, a lighting control system, a security alarm panel, or a home automation master controller are all interfaces. These devices will connect directly to your LinuxMCE system via some interface, like RS232, and then they will control their own devices which are connected to them, such as a light switch, motion detector, etc. Interface Modules, like the Global Cache GC100, are also added in the "Interfaces" page.
After you add the interface, then you can add the other devices that will use that interface. For example, you may have some X10 light switches in your house. These are not LinuxMCE DCE Devices--LinuxMCE cannot control them directly. LinuxMCE can only control them using an X10 interface module. So, before you can add the X10 light switches, you must first go to the interface section and add an x10 lighting interface. Then you can go to 'lights' and add lights that will use that interface. Similarly if you have a normal, infrared controlled TV, that TV does not communicate directly with the LinuxMCE system. It needs an interface module like the GC100 that LinuxMCE does communicate with, and which then sends the infrared codes to control the TV. So before adding the TV in the AV Section, first add the interface.
The "AV" section is for all your audio/video devices, like TVs, DVD Players, Stereo Receivers, Satellite Boxes, etc.
*Core
*[[Interfaces]]
*[[AV Devices| A/V Equipment]]
*[[Media Directors]]
*[[Orbiters]]
*[[Lights]]
*[[Climate]]
*[[Irrigation Devices]]
*[[Devices Security | Security]]
*[[Surveillance Cameras]]
*[[Phone Extensions| Phones]]
*[[Phone Lines]]
*[[Generic Serial Devices]]
*[[Floorplans |Floorplan Wizard]]
[[Category: Admin Website]]

Rooms

2010-04-19T14:45:00Z

Chris Caven:

[[Image:rooms.jpg|thumb|right|250px|Rooms Page ]]

List all the rooms in your house here. A room does not have to be a physical room, but is really more of a general area. Whenever you add devices, you will pick the "room" they are in. So you can add rooms for the garage, a back porch, maybe the pool area, or some part of the yard if those areas will have devices.

If a room has any type of media device, such as a media director, TV, stereo, or audio player, the room is considered to be an entertainment area. To make everything easier for the user, when you start one media in the room, LinuxMCE will automatically stop any other media that is playing. For example, if you start watching a video in your VCR and then insert a DVD into your media director, LinuxMCE will automatically stop the VCR since this is almost always the desired behavior and saves you one extra step. It also means you only have to press one "OFF" button and any media you were playing shuts off.

== Multiple Entertainment Areas in One Room ==

In some situations, a user may want multiple media sources in the same room. For example, in the master bedroom perhaps there is a 'his' and 'hers' TV, and each wants to watch something different. Or, in the main theater there may be 1 big, primary screen, and several smaller screens. In these situations you will need to check the 'Manually Configure' box to setup multiple entertainment areas in the same room. You will add an entertainment area for each unique media stream you will want, such as the 'his TV' and 'her TV' in the bedroom, or the 'main TV', 'TV #1', 'TV #2', etc in the theater example. Try to logically group your devices into the entertainment areas. If you are configuring the entertainment areas manually, you will need to go to the 'Advanced/Devices' page for each device and put it into one or more entertainment areas.

Take the example with a master bedroom that has a 'his' and 'hers' TV. You will check the 'Manually Configure' box for the Master Bedroom, and then create 2 entertainment areas in that room: 'his' and 'hers'. His TV will go in the 'his' entertainment area, and her TV will go in the 'hers'. There are 2 separate VCRs, one for each tv. So each VCR will also go in the respective entertainment area. Let's say there is a common DVD player that both devices share. Perhaps you use a Y splitter or maybe the DVD player has multple outputs. There will be just 1 DVD player device, but it will be in both the 'his' and 'hers' entertainment areas, as specified on the 'Advanced/Devices' page. This allows LinuxMCE to handle all the media logically and intuitively and makes the user experience much simpler. If the husband is watching a videotape on his TV and then hits the button on his remote to watch a DVD, LinuxMCE will know to stop his VCR without touching the wife's. The husband and wife control their individual VCRs separately. If the wife then touches the 'watch a DVD' button, LinuxMCE figures out that both the husband and wife share the same DVD player, and will automatically setup the wife's TV so that she can watch the same movie that her husband is already watching, and both will control the DVD player.

When a room has multiple entertainment areas, then when you choose "Rooms" on the orbiter, you will see those entertainment areas. In the case of the master bedroom "his" and "hers" example, touching "Rooms" would include a "Master Bedroom - his" and "Master Bedroom - hers". All scenarios except media are arranged by room. So whether you choose "Master Bedroom - his" or "Master Bedroom - hers", you will still have the same lighting, climate, security and phone options. However, the orbiter will control only the "his" or "hers" entertainment area.

[[Category:Admin Website]]

LinuxMCE Admin Website

2010-04-18T17:52:40Z

Chris Caven: /* Files&Media */

[[Category: Documentation]]
{| align="right"
| __TOC__
|}
''<center>If you were directed here from your Admin page, see the [[:Help:Contents|Help section]].</center>''
The LinuxMCE Admin web site is used to setup and configure your LinuxMCE system. It also allows you to do a lot of other tasks, such as to check your voice-mail, organize your media, etc. The web site runs on the LinuxMCE Core. You can access it from the Core web browser, or from any other computer connected to the network.

==Access to the LinuxMCE Admin Website==
===From a Core or Media Director desktop===
A button is available on the [[Launch Manager]] that is displayed on a Core or Media Director desktop:
* ''Open admin website''

===From within your home===
You can access the LinuxMCE Admin website from any web browser (Mozilla Firefox, IE, Safari):

*In the browser address bar, type the URL ''<nowiki>http://<core_ip>/pluto-admin</nowiki>''.
* From within the "internal" LinuxMCE LAN, for example:
**''<nowiki>http://192.168.80.1/pluto-admin</nowiki>''
***(This assumes the IP address range set by default at installation.)

*You can also use the network name of the Core in place of the IP address. For example, if the Core was named "dcerouter" during the default installation, you could use:
**''<nowiki>http://dcerouter/pluto-admin</nowiki>''

*From the "external" home LAN, the core_ip would be the LAN IP address of the core. If, for example, the core is at 192.168.0.50 on the home LAN, use:
**''<nowiki>http://192.168.0.50/pluto-admin</nowiki>''

===From the Internet===
You could use the IP address:port for your home LAN, with port forwarding to the Core's LAN IP address (enabled by your home LAN router).
*''This is an advanced topic and may not be secure in the current version.''.

By default, the LinuxMCE Admin web site is not accessible outside your home. This makes the system secure, but it prevents you from accessing the web site via the Internet while away from home. You can [[Outside_Access|turn on Internet access]], allowing access to the admin website anywhere. For your own security, however, we recommend you first read about [[Security & Privacy Issues]].

===Login page===
*The login page should be displayed. Input an existing user name and password, then click "Login".

=LinuxMCE Admin Website Sections=

==Admin page structure==
LinuxMCE is a modular platform with a wide variety of optional modules and devices. Generally, each module will have one or more web pages to configure when using that module. The LinuxMCE Admin web site has a pull-down menu that lets you quickly access any of those pages. The menu options for each particular home will be unique, depending on the configuration.

Two menu options will always be displayed.

*The ''[[Wizard Pages|Wizard]]'' is the commonly used way to configure and setup your LinuxMCE system. When you choose Wizard, you will see a series of steps that depends on what devices you have installed in your home. The pages in the Wizard section are intended to be simple for the average user. Context-sensitive help is provided through a "Help" button.

*There are more low level options under the ''Advanced'' option.

==Wizard==
*[[Wizard Pages]]
===[[Basic Info]]===
*[[Installation]]
*[[Users]]
*[[Rooms]]
*[[Keyboard Layout]]
===[[Devices]]===
*Core
*[[Interfaces]]
*[[AV Devices| A/V Equipment]]
*[[Media Directors]]
*[[Orbiters]]
*[[Lights]]
*[[Climate]]
*[[Irrigation Devices]]
*[[Devices Security | Security]]
*[[Surveillance Cameras]]
*[[Phone Extensions| Phones]]
*[[Phone Lines]]
*[[Generic Serial Devices]]
*[[Floorplans |Floorplan Wizard]]
===[[Scenarios]]===
*[[Lighting Scenarios]]
*[[Media Scenarios]]
*[[Climate Scenarios]]
*[[Irrigation Scenarios]]
*[[Security Scenarios]]
*[[Telecom Scenarios]]
*[[Mobile Orbiter Scenarios]]
*[[Sleeping Scenarios]]

===[[Events | Events Handler]]===
*[[Respond to Events]]
*[[Timed Events]]
===Security===
*[[Settings By Alert Type]]
*[[Active sensors]]
*[[Security-Video Links]]
*[[Notifications| Cellphone Notifications]]
*[[Outside Access]]
===[[Restart]]===

==Advanced==
===Software===
*[[Add Software]]
*[[Software Versions]]
*[[Boot Sequence]]
*[[Packages]]

===Network===
*[[Network Settings]]
*[[Firewall Rules]]
*[[WAP/GPRS Settings]]
*[[Dynamic DNS Settings]]

===Configuration===
* [[Advanced Pages Devices| Devices]]
* Unknown Devices
* [[Device Templates]]
** [[Edit Device Template]]
* Device Category Device Data
* [[Advanced Pages Scenarios | Scenarios]]
* [[Advanced Pages Events | Events]]
* [[Phones Setup]]
* [[Backup and Restore | Backups]]
* [[Create_RAID_in_LMCE#Creating_RAID| RAID]]

===[[Privacy Settings]]===
* [[Users#Users and Orbiters|Users-Orbiters]]
* [[Users#Users and Rooms|Users-Rooms]]
* [[Users#Restrict Access|Restrict Access]]

===sqlCVS===
* Update
* Checkin
* Diff
* View Batch

===[[DCE]]===
* Device Data
* Commands
* Events

==Automation==
*[[Device Status]]
*[[Execute Scenarios]]
==Security==
*[[Alert Logs]]
*[[Mode Change Logs]]
*[[Status]]
*[[View Cameras]]
==Files & Media==
* Media Browser
* [[Media Files Sync]]
* Playlist
* Media Providers
* Bookmarks
* [[Cover Art]]
* Ripping Status

==Telecom==
* My Voicemail
* General Voicemail
* Phone book
* Call Routing
* Priority Callers
* Callers for me

The following is leftover from another page:

==Adding custom entries in LinuxMCE Admin menus==

Currently only option is to enter entries into Pluto_main database, table PageSetup. There you'll find other entries already, go to the end and add yours (but be careful not to break anything and also save your changes, cause they can probably lost in migration or updates - not sure)...

Anyway for simple test I've created two entries: "Tinia" as main menu entry (after Telecom) and then subentry for phpmyadmin that I frequently use. If I highlight only important fields, my entries look like this :

'''PK_PageSetup FK_..._Parent Website OrderNum FK_Package Description pageURL showInTopMenu'''
190 NULL 1 70 NULL Tinia 1
191 190 1 0 NULL PHPMyAdmin http://192.168.0.1/phpmyadmin/ 1

If FK_PageSetup_Parent is empty, then you'll have main entry on green main bar. If you want subentry, then you just specify PK_PageSetup of your parent in FK_PageSetup_Parent. You can also add URL

Media Player Wizard

2010-04-18T11:25:14Z

Chris Caven: /* Current Room */

{| align="right"
| __TOC__
|}
[[Category:Tutorials]]
This is a setup wizard which runs automatically on the first startup after installation and can be run from the orbiters by selecting the '''Advanced > Setup Wizard'''.
The Media Player Wizard was designed to make the setup of each piece of audio/visual equipment more user friendly. Obviously, not all devices can be installed via the setup wizard. If you are not finding the equipment you currently have, then you will need to add this equipment via the [[LinuxMCE Admin Website]].
 
=Choosing the Correct Wizard=
[[Image:SeeAndHearMe.jpg|thumb|250px|
First Page of the Setup Wizard]]After selection of the Setup Wizard you will see an additional screen. If the audio and video are properly setup you should see and hear a video. If this is correct please select Next.
 
[[Image:Which_Wizard.jpg|thumb|250px|Which Wizard to Choose]]
The next screen you will encounter asks which wizard would you like to start: [[Media Player Wizard]] or the [[House Setup Wizard]]. Please select the wizard you want to begin.
If you have already completed the setup wizard and you are returning to add additional information and/or equipment then simply choose the button for the portion of the setup wizard you would like to visit.
 
==Media Player Wizard==
After choosing the Media Player Wizard you will be taken through a series of screens designed to make setup easier.
===Current Room===
[[Image:This_Room.jpg|thumb|250px|Which Room are you in?]]
The first thing LinuxMCE needs to know about the setup is which room is this located in. If you have not already set up the rooms in your house, please finish the [[House Setup Wizard]] before returning to the Media Player Wizard.
 

===TV===
[[Image:ControlTV.jpg|thumb|250px|How do you want to control your TV?]]
LinuxMCE wants to know how to control your TV. The first thing to determine is if your TV is a [[plug&play]] model. There are only a few currently available models that are [[plug&play]]. If you are lucky enough to have one of these models then you will only need to plug the TV into the serial port when directed. You will receive on screen instruction from the setup video.
If your TV is not [[plug&play]] then you will need to determine if LinuxMCE is going to control it and if so how. Currently the only option via this wizard is [[Infrared]]. Please select the Infrared button to enter this information.
 
===Receiver/Amp===
[[Image:ReceiverAmp.jpg|thumb|250px|Are you using an Receiver or Amp?]]
 
===A/V Devices===
[[Image:Avdevices.jpg|thumb|250px|Add A/V Devices to your Setup]]
Here is where you will be adding any additional A/V Devices to your setup. The list on top represents that types of devices that you can add to your system. The smaller window below represents the devices are currently added to your system. Starting with the device which is going to have the most other devices connected is the best first step. For most people it is either the TV or the Receiver/Amp, as this will allow for a more fluid setup.

# Select the type of Device you would like to add.
# Select the Manufacture of the Device you would like to add.
# Select the Model number of the Device you would like to add.
# Select whether or not this device is connected to any of your other devices, if so select that device.
# Select the input of the previous device this new device is connected to (ie AV, RGB, etc.)

If your device is not currently present on the lists then there is no support for that device currently, but support can be added by build a new device template for your device. [[LinuxMCE Admin Website]] is currently the only method available for building new device templates.
 

===Inputs===
[[Image:Inputs.jpg|thumb|250px|Add Inputs for A/V Equipment and TV Tuner Cards]]
Here is where the user can start to interconnect different capture devices with different pieces of AV equipment, such as a Satellite/Cable Box.

# Select the Inputs that the A/V Devices will be using.
# Select the A/V Device connected to this input.
# Select the proper Input for the A/V Device (ie AV, RGB, etc.)

Once the association is made LinuxMCE will make the necessary connections and allow you to start using your A/V Device in concert with the capture device.

 

===Providers===
[[Image:Providers.jpg|thumb|250px|Add Provider for TV Guide Information]]
Providers of TV Guide information. Currently the automatic setup is for Schedules Direct. If you do not already have registered ID then sign up and complete this step.
*http://www.schedulesdirect.org/
**The cost of the service is currently US$20/year, with a 7 day trial.
There are ways to gather additional data, users will need to make these changes in the Mythtv-Setup which can be accessed from the Computing screen on any orbiter.
 
===Add Software===
[[Image:Addsoftware.jpg|thumb|250px|Add Software to LinuxMCE]]
Make sure that you have the additional software needed to play all of your media. Please remember that there are restrictions on some of this software, so please obey all local restrictions.
 
===Done===
[[Image:Done.jpg|thumb|250px|You are done.]]
Start Using System will cause the [[DCERouter]] to reload and activate the devices that where just inputted into the system.

Media Player Wizard

2010-04-18T11:19:40Z

Chris Caven:

{| align="right"
| __TOC__
|}
[[Category:Tutorials]]
This is a setup wizard which runs automatically on the first startup after installation and can be run from the orbiters by selecting the '''Advanced > Setup Wizard'''.
The Media Player Wizard was designed to make the setup of each piece of audio/visual equipment more user friendly. Obviously, not all devices can be installed via the setup wizard. If you are not finding the equipment you currently have, then you will need to add this equipment via the [[LinuxMCE Admin Website]].
 
=Choosing the Correct Wizard=
[[Image:SeeAndHearMe.jpg|thumb|250px|
First Page of the Setup Wizard]]After selection of the Setup Wizard you will see an additional screen. If the audio and video are properly setup you should see and hear a video. If this is correct please select Next.
 
[[Image:Which_Wizard.jpg|thumb|250px|Which Wizard to Choose]]
The next screen you will encounter asks which wizard would you like to start: [[Media Player Wizard]] or the [[House Setup Wizard]]. Please select the wizard you want to begin.
If you have already completed the setup wizard and you are returning to add additional information and/or equipment then simply choose the button for the portion of the setup wizard you would like to visit.
 
==Media Player Wizard==
After choosing the Media Player Wizard you will be taken through a series of screens designed to make setup easier.
===Current Room===
[[Image:This_Room.jpg|thumb|250px|Which Room are you in?]]
The first thing LinuxMCE needs to know about the setup is which room is this located in. If you have not already set up the rooms in your house please finish the [[House Setup Wizard]] before returning to the Media Player
Wizard.
 
===TV===
[[Image:ControlTV.jpg|thumb|250px|How do you want to control your TV?]]
LinuxMCE wants to know how to control your TV. The first thing to determine is if your TV is a [[plug&play]] model. There are only a few currently available models that are [[plug&play]]. If you are lucky enough to have one of these models then you will only need to plug the TV into the serial port when directed. You will receive on screen instruction from the setup video.
If your TV is not [[plug&play]] then you will need to determine if LinuxMCE is going to control it and if so how. Currently the only option via this wizard is [[Infrared]]. Please select the Infrared button to enter this information.
 
===Receiver/Amp===
[[Image:ReceiverAmp.jpg|thumb|250px|Are you using an Receiver or Amp?]]
 
===A/V Devices===
[[Image:Avdevices.jpg|thumb|250px|Add A/V Devices to your Setup]]
Here is where you will be adding any additional A/V Devices to your setup. The list on top represents that types of devices that you can add to your system. The smaller window below represents the devices are currently added to your system. Starting with the device which is going to have the most other devices connected is the best first step. For most people it is either the TV or the Receiver/Amp, as this will allow for a more fluid setup.

# Select the type of Device you would like to add.
# Select the Manufacture of the Device you would like to add.
# Select the Model number of the Device you would like to add.
# Select whether or not this device is connected to any of your other devices, if so select that device.
# Select the input of the previous device this new device is connected to (ie AV, RGB, etc.)

If your device is not currently present on the lists then there is no support for that device currently, but support can be added by build a new device template for your device. [[LinuxMCE Admin Website]] is currently the only method available for building new device templates.
 

===Inputs===
[[Image:Inputs.jpg|thumb|250px|Add Inputs for A/V Equipment and TV Tuner Cards]]
Here is where the user can start to interconnect different capture devices with different pieces of AV equipment, such as a Satellite/Cable Box.

# Select the Inputs that the A/V Devices will be using.
# Select the A/V Device connected to this input.
# Select the proper Input for the A/V Device (ie AV, RGB, etc.)

Once the association is made LinuxMCE will make the necessary connections and allow you to start using your A/V Device in concert with the capture device.

 

===Providers===
[[Image:Providers.jpg|thumb|250px|Add Provider for TV Guide Information]]
Providers of TV Guide information. Currently the automatic setup is for Schedules Direct. If you do not already have registered ID then sign up and complete this step.
*http://www.schedulesdirect.org/
**The cost of the service is currently US$20/year, with a 7 day trial.
There are ways to gather additional data, users will need to make these changes in the Mythtv-Setup which can be accessed from the Computing screen on any orbiter.
 
===Add Software===
[[Image:Addsoftware.jpg|thumb|250px|Add Software to LinuxMCE]]
Make sure that you have the additional software needed to play all of your media. Please remember that there are restrictions on some of this software, so please obey all local restrictions.
 
===Done===
[[Image:Done.jpg|thumb|250px|You are done.]]
Start Using System will cause the [[DCERouter]] to reload and activate the devices that where just inputted into the system.

House Setup Wizard

2010-04-17T20:37:35Z

Chris Caven:

{| align="right"
| __TOC__
|}
[[Category: Tutorials]]
This is a setup wizard which runs automatically on the first startup after installation and can be run from the orbiters by selecting the Advanced > Setup Wizard.
The setup wizard is an automated series of screens which allow the user to enter information and devices that LinuxMCE will control. The Setup Wizard is broken down into two modes: Media Player Wizard and House Setup Wizard.
 
=Choosing the Correct Wizard=
[[Image:SeeAndHearMe.jpg|thumb|250px|
First Page of the Setup Wizard]]After selection of the Setup Wizard you will see an additional screen. If the audio and video are properly setup you should see and hear a video. If this is correct please select Next.
 
[[Image:Which_Wizard.jpg|thumb|250px|Which Wizard to Choose]]
The next screen you will encounter asks which wizard would you like to start: [[Media Player Wizard]] or the [[House Setup Wizard]]. Please select the wizard you want to begin.

 

===House Setup Wizard===
The House Setup Wizard is designed to assist in the inputting of important data relating to the users of your LinuxMCE system and the setup of your House. The various screens are really pretty self-explanatory and this guide is designed to help you prepare for a complete and thorough installation and setup.
====Names====
[[Image:UsersWizard.jpg|thumb|250px|Who will be using the system?]]
This is the screen from which you can add users to the system. It is important to remember that they are users of the LinuxMCE software and are not Kubuntu users. If using the [[DVD Installation]], the Kubuntu user created will NOT be one of the LinuxMCE users.
 
====Location====
[[Image:LocationHouseWizard.jpg|thumb|250px|Where are you located?]]
You will be asked a series of questions regarding geographic location. Simply answer the questions as asked.

 
====Rooms====
[[Image:RoomsHouseWizard.jpg|thumb|250px|Adding Rooms of Your House]]
Since LinuxMCE is much more than a Media Center, you will be asked to enter all of the rooms of your house. Highlight each type of room and then hit either the add button or the remove button to adjust to the desired number. Proceed through every room in the house. It is best to take the time now to enter all of the rooms, as it will make things easier as you expand your system later on.

 
====Lights====
[[Image:LightsHouseWizard.jpg|thumb|250px|Adding Lights]]
From this screen the House Setup Wizard will try and automatically detect plug and play lighting interfaces, and if found will ask a series of questions to ensure proper setup. If you do not have a lighting interface, then simply choose "Continue without one"
 
====Alarm Panel====
[[Image:AlarmPanel.jpg|thumb|250px|Adding an Alarm Panel]]
From this screen the House Setup Wizard will try and automatically detect plug and play alarm panel, and if found will ask a series of questions to ensure proper setup. If you do not have a security system, then simply choose "Continue without one"
 
====VOIP Provider====
[[Image:VOIPHouseWizard.jpg|thumb|250px|VOIP Provider Selection]]
This screen will automatically setup the VOIP Providers listed, provided you already have an account. It will not set up an account for you. Selection of VOIP Provider will start a series of questions which will require information about your existing account, including phone number, user id, password, etc. If you have not setup an account then skip this section, you will want to skip the section if you do not see your provider listed. Do not worry if your Provider is not listed. Other provider can be automatically setup from the [[LinuxMCE Admin Website]] after completing this wizard.
 
====Floorplan====
[[Image:FloorplanHouseWizard.jpg|thumb|250px|Adding a Floorplan of Your House]]
If you have an existing floorplan of your house you can add it now. If not it can be added later. Floorplan is not required for successful setup and/or usage of LinuxMCE.
 
====Done====
[[Image:DoneHouseWizard.jpg|thumb|250px|Finishing Up the House Wizard]]
Once the House Setup Wizard is complete it will take you to the [[Media Player Wizard]]

Usage Intro

2010-02-08T16:22:04Z

Chris Caven: /* Controlling an Orbiter */

{| align="right"
| __TOC__
|}
LinuxMCE's main concepts are [[Devices]], Commands (aka [[Scenarios]] and Activities), and [[Events]]. An [[Orbiter]] is the device that displays the User Interface. It can be a [[Media Director|Media Station]], web pad, mobile phone, or other remote control device. The Orbiter User Interface is standardized for all Orbiters.

== Devices ==

A device is generally a piece of hardware or software, like the Xine Media Player, a light switch, or a mobile phone. Devices have three functions, abbreviated "DCE" (Data, Commands, Events):

# Retrieve configuration '''data'''
# Perform a '''command''' (turn on, turn off, fast forward, etc.)
# Report certain triggered '''events''' (e.g. 'motion detected', 'playback started', etc.)

== Scenarios ==

"[[Scenarios]]", "Activities", and "Command Groups" are interchangeable terms -- they mean the same thing. A scenario is a group of commands that can be sent to a device (or series of devices). In LinuxMCE, the default Orbiter main menu consists of several scenario categories, grouped by room. These categories are:-

* Lighting
* Media
* Climate
* Telecom
* Security

(These default categories are arbitrary and are set up at installation.) To perform an action in LinuxMCE, a scenario is chosen from one of these categories (located on the main menu of an Orbiter).

For example, in rooms which have both a TV and lights, LinuxMCE automatically creates a scenario called 'Showtime.' This scenario dims the lights to 10% whenever the TV starts playing. In rooms with a PVR or other TV-enabled device, another scenario is created called 'TV' (in the 'Media' category) to start the TV. Another scenario in the 'Media' category called 'Video' sends a command to the Orbiter to list your video content. Telecom scenarios are created to make phone calls. Security scenarios are created to view cameras and to arm an alarm.

Some [[What_scenarios_are_created_automatically%3F|default scenarios]] are created for you at installation. A fully-functional system can run using only the default scenarios, if you choose. You can also change or remove the default scenarios or add new ones. This is done though the '''[[LinuxMCE Admin Website]]-->Wizard-->[[Scenarios]]''' menu. When creating a scenario, the [[LinuxMCE Admin Website]] will show you the most appropriate wizard, based on the category you pick. If you're adding an activity in the lighting category, for example, the wizard will display a list of the lights in the room and let you pick which ones to turn off. If you're creating a scenario in the security category, it will list the installed cameras and will allow you to select which ones to display.

A scenario can send a command to any device in the system. By default, scenarios in the lighting category show you the room lights, allowing you to select which ones to send commands. However, from the '''Wizard-->[[Scenarios]]''' menu for the specific scenario, you can also specify a command to any device in your home. You could make a phone call, for example, even from a scenario in the lighting category.

Certain scenarios are assigned to certain rooms by default. This can be customized, however. When you manually select a room from the Orbiter main menu, the default scenarios for that room are displayed. In general they control devices in that room, but this can also be changed. If your kitchen is near the garage and you want a scenario to 'turn off the garage light', you can assign a scenario to the room 'kitchen' that will do just that. It doesn't matter that the light is in the garage.

For a Media Director, the on-screen Orbiter User Interface appears on the TV screen. It is manipulated by the mouse/keyboard or remote control connected to your Media Director. By default it is set to display the scenarios for the room in which the Media Director is located.

In contrast, a mobile Orbiter (such as a webpad) can be carried throughout the house. It must be able to select the scenarios for multiple rooms. Fortunately, the option to manually select which room you are currently in is available on every Orbiter's main menu.

This can occasionally cause some confusion. Perhaps both the Living Room and the Bedroom have a scenario called 'TV'. You may have a web pad that is in the Bedroom, but you then carry it to the Living Room. You may forget to tell the web pad that it's now in the Living Room (at the bottom of the Orbiter screen it will still say 'Bedroom'). You hit the 'TV' button expecting the Living Room TV to come on, but in fact you're still controlling the Bedroom and the TV comes on there instead. Finally, you may realize that you must change your room location to Living Room, then you can control the TV there.

Once you get used to this concept, though, you'll find it very useful. Conveniently, any Orbiter can be set to control any room and choose from the scenarios assigned to that room. No matter which Orbiter you use, the same set of scenarios will be displayed for each specific room. For example, the kitchen scenarios will always be the same, no matter which Orbiter you are using. (The scenarios are assigned by room -- not by Orbiter.) No matter whether you pick up your mobile phone, your web pad, or your remote control, you will always be shown the same list of scenario options for the Living Room.

You have the option of preventing some family members from using certain scenarios. From the [[LinuxMCE Admin Website]], certain scenarios and rooms can be [[Users#Restrict_Access|restricted to certain users]]. Maybe little Suzy's mobile phone Orbiter should be restricted so that she is only able to control her room and the living room, for example. She would only be able to execute the scenarios in those rooms, but not the Master Bedroom. Other possible options include [[Users#Restrict_Access|requiring a pin code]] to access the scenarios for a particular room.

== Events ==

Devices report events, such as 'Playback started' and 'Motion Sensor tripped'. If you want something to happen automatically in LinuxMCE, you create Event Handlers that react to these events. For example, you can create an event handler that listens for the 'Motion Sensor tripped' event from a motion detector and turns on the lights in response. An event handler might listen for the 'Sunrise' event, which could then prompt the sprinklers to come on.

LinuxMCE creates several default event handlers. In rooms in which you have a TV and lights, an event handler is created that listens for the 'Watching Media' event sent by a media player. When the event is detected, the Showtime scenario (which dims the lights) is executed in response. When you start a movie, therefore, the Showtime activity will be executed and the lights will be dimmed. There are other default event handlers that monitor for events like 'Security Breach' and 'Fire Alarm' (from a home security system).

== Controlling an Orbiter ==

To control the system, you use an [[Orbiter]], which is the LinuxMCE term for a remote control. All [[Orbiters]] have the same basic function: to display the scenarios in the room you're in and let you select one. The different Orbiters may [[Selecting_the_Right_UI|display the User Interface slightly differently]], depending on their screen size, but the function and the list of scenarios is always the same. For example, the [[Selecting_the_Right_UI|"UI1" interface]] (which is used on webpads and PDAs) displays the scenarios in horizontal rows. (If there are more than will fit on a row, there will be a "more" button.) A home button is always displayed that takes you to the main menu. On smaller displays, as on mobile phones or desktop phones, there's not enough room to show the scenarios themselves. The top level menu shows only the categories: Lights, Media, Climate, Security and Telecom. Selecting a category displays the scenarios in that category.

[[Selecting_the_Right_UI|"UI2"]] is the [[Selecting_the_Right_UI|preferred User Interface]] for Media Stations. Using a traditional IR remote is not much different from using any other Media Center PC remote. The menu button brings up the main menu, and you use the ''left/right/up/down/enter'' buttons to navigate it. The ''fast forward/rewind/skip +/skip -'' keys are used for media playback.

If you have a pointing device like a mouse or gyro air mouse, the UI2 interface also supports a unique control architecture that lets you do everything with 3 (programmable) buttons (plus ok and cancel). The 3 buttons are "MEDIA", "MENU", "AMBIANCE".

On a mouse with 3 programmable buttons (such as the [[Using_the_Gyration_Remote_GYR3101US_%28Non-Fiire_Chief%29|gyration]]), these functions correspond to the buttons from left to right. If you are using a traditional 3 button mouse, you can use the F6, F7 and F8 keys on the keyboard for the three programmable functions instead. In both cases, the left mouse button is "ok", and the right mouse button is "cancel/go back".

Mouse button behavior is "absolute" when you press and hold the media/menu/ambiance button and "relative" when you tap and release.

The "absolute" behavior is generally more efficient. For example, in the case of the middle button (F7), "absolute" behavior means the action is executed without having to additionally click "ok". If you press and hold the middle button (F7) while moving your mouse pointer to the option, then let go, that option is executed. If you instead tap and release the menu button ("relative" behavior), you will only highlight the menu option. You must then press ok (the left mouse button) to execute the option.

Categories appear along the bottom of the screen, and the scenarios in each category popup vertically (like a pull-down menu in a PC, except upside down). If the main menu isn't already visible, bring it up by pressing the "start" button on a Windows IR remote, or the "menu" button on a 3-button mouse. To exit a menu, use the back button on the IR remote, the cancel button (right mouse button on a 3-button mouse), or the ESC key on a keyboard.

In UI2, the media is always full screen. If you're not playing your own media, the background media (i.e. screensaver images) is gallery art from the Internet (using flickr) or [[Use_my_own_pictures_in_the_Screen_Saver|pictures you select]]. If only the screensaver images are displayed on the Media Station, press the menu/middle/F7 button to bring up the menu. Right click/ESC to get rid of it. (This works even if your own media is playing.)

If you're using UI2's 3-button navigation model, the normal media control options on a traditional remote are replaced with a single button: "media" (left soft button or F6). Press this and move the pointer up and down for your skip functions (''ch+, ch-, skip fwd, skip back''). Move the pointer left and right for speed control (''rewind, fast forward''). The further you move, the faster the media playback changes. If you hold the button down (the left soft button or F6), your movement will be "absolute". Instead of the traditional "jog shuttle-type" control, movement to the right skips to the end of your media, and movement to the left skips to the beginning. Once you get used to it, you will find that navigating media is orders of magnitude faster and easier with this model than with a traditional remote. You can find a spot in a 2 hour movie in only a couple seconds with a click of a single button (compared to a slew of button clicks required using a traditional remote).

Also, in UI2 you can press the "ambiance" button (right soft button or F8). Move up/down to adjust the lights, and left/right to adjust the volume. As with the media playback, if you hold the F8/right soft button down while you move left and right, your volume control is in "absolute" mode (not "relative"). Moving hard right turns up the volume full blast; hard left is mute. This requires you have a TV or receiver that is serial-controlled, however. LinuxMCE can then directly and instantly set the volume position in sync with your hand movements. (Few TVs and receivers have this feature, unfortunately.)

There are other media control functions besides the most commonly used ''fast fwd/rewind/skip up/skip down''. You can, for example, choose 'subtitles' while watching a DVD, 'guide' while watching TV, and 'random' while listening to an audio CD. In the UI2 3 button model, these functions appear on the main menu (on the left-most pad, entitled 'now playing') and changes according to the type of media you're playing. Press the menu button (middle button/F7) to select these options.

This 3 button model is a new concept and very different from traditional navigation. Most people find it much faster once they become accustomed to it.

==Reload Router & Regen Orbiters==

While using LinuxMCE you'll see sometimes a message asking if you want to [[Quick reload router|reload the router]], or if you want to [[Orbiter Generator|regenerate the Orbiter UIs]] (User Interfaces). In general, these options refresh the LinuxMCE databases so that changes to the system can be recognized.

===Reload Router===
All devices in LinuxMCE obtain their configuration information from the [[DCERouter]], which is the central piece of software on the Core. All devices request a list of the other devices in the home from the router, so they can respond to them appropriately. (For example, an IP camera device might turn on the lights in the room whenever you're viewing the camera. To do so, the IP camera needs to know what lights are in the room.) Typically a device requests this information only when it's starting up. When you connect additional plug and play devices to the system, these new devices generally will work immediately, but their functionality may not be fully enabled within the LinuxMCE system until the DCE router is reloaded. When the router reloads, it signals all devices on the system to simultaneously reload and re-request the system data. Each existing device can then work with each new device. This process is known as a 'reload'. It generally takes about 10 seconds. Every time you add or remove devices, or change a device's configuration, you may be asked to do a reload. If you're going to add more devices or make more device changes, you can do the reload once you're done. If you're in the middle of watching a movie or TV, you can postpone the reload, since media players generally stop playing during reloads. Phone calls aren't affected, though, and TV shows being recorded by MythTV in the background are also unaffected.

===Regen the Orbiter===
LinuxMCE's [[Selecting_the_Right_UI|Orbiter User Interfaces]] are all "pre-rendered" in order to be more efficient. The User Interface source images are all very high resolution, but need to be resized to accommodate the resolution of each Orbiter screen. The Core server has a list of the Orbiters used by your system, and will generate the appropriate User Interface screen for each Orbiter. It will do this each time you request a "regen". If you have five different types of Orbiters (each with a different type of screen), then five different images will be generated during each regen.

These User Interface screen images are stored in the Core. The appropriate UI image is sent to an Orbiter whenever it is activated. For many low-power devices (like mobile phones or desktop phones) there just isn't the processing power to do scaling and rendering of a User Interface screen on the fly. They need to be pre-rendered (with text pre-embedded in the images) to be efficient.

Adding new scenarios may result in the creation of new buttons for the User Interface, or changes to the text on existing buttons. Perhaps an entirely new screen will be created.

Until the User Interface images are regenerated, though, you won't be able to see these new buttons (or screens) on your Orbiter. During the regen, new User Interface images for each type of Orbiter is generated by the Core. This can take about 2-5 minutes, depending on how many Orbiter types you have in your system.

You needn't do a regen every time you add a scenario. You can wait until you have finished adding all the scenarios. Furthermore, you can also regen only the Orbiter you are currently using by doing a "Quick regen". This allows you to see the new User Interface (following the addition of new scenarios) without having to do a full regen for all the Orbiters. Once you have finished adding scenarios, then you can do a full regen.

This regen process can be a bit annoying, but is necessary. In future editions of LinuxMCE, it is planned to allow Media Directors, which have a lot more processing power, to render their on-screen Orbiter User Interfaces on the fly (so you don't have to do a regen each time you add or remove a scenario).

You can do a [[Orbiter Generator#Running OrbiterGen (performing a "regen")|full Orbiter regen or a Quick regen]] at any time by using buttons on the Core's LinuxMCE [[Launch Manager]].

==Managing your media==
LinuxMCE is always scanning for network shares, on Network-Attached Storage (NAS) devices and other Hard Disk Drives (HDDs) of PCs connected to the system (including Windows PCs). Universal Serial Bus (USB) drives are also detected. Every time a LinuxMCE finds a network share, you will be asked if you would like to use it. Whenever you reply "Yes", the file share can be used by any Media Director on the system. The file share is scanned for media, such as audio, video and photos, and any that are found are then cataloged in the Core's central database. For example, when you plug in a USB drive on a Media Station in the living room and tell LinuxMCE to use it, the media on the drive will be available to Media Directors in other rooms.

At the moment there is no way to restrict your media for 'local use only'; all Media Stations in the LinuxMCE system share the media catalog stored on the Core. (This is a limitation that will be addressed in the near future. Sometimes it is desirable to attach a USB drive in the master bedroom and not allow it to be shared, for example. ''Note: However, see [[folder lock|this article that describes a method to address this problem]].'')

Storage devices (NAS, USB drives, extra HDDs on the Core or Media Directors) are referred to as "Extra Drives". When an extra drive is added, it is listed in the device tree in '''[[LinuxMCE Admin Website]]-->Advanced-->Configuration-->[[Devices]]'''. Under 'Core' you'll see a device listed for each HDD in the Core, as well as for each NAS device. Under each Media Station will be listed the HDDs in that Media Station. By clicking on the device you can change the device's properties, such as the mount username/password. Each NAS device, and each file share on another PC, will show as a device listed under the Core; each is considered a child of the Core.

===Access control for shared media===
LinuxMCE creates a top level folder for 'public' media. This folder can be used by every user in the system. A 'private' media folder is also created for each user. Within each of those folders are sub-folders, labeled 'audio', 'video', 'pictures', 'data' and 'other'. Within each of those will also be sub-folders for the extra storage devices (NAS, USB, extra internal drives, etc). When you attach an extra storage device, you can specify whether the default directory structure should be used for it. Alternatively, you can specify 'just make it public' or 'make it private'.

Here's an example. Let's say you have 2 users: john and mary. You connect 3 storage devices:
# a NAS, for which you specify 'use default directory structure'. It is named 'Generic Network Storage [50]'
# a USB drive for which you specify 'make it all public'. It is named 'USB Drive [51]'
# a SATA drive for which you choose 'make it private for john'. It is named 'General Internal HDD [52]

Now let's say you're running Windows. Go to Network Neighborhood and find the LinuxMCE Core server. The directory tree ought to look like this:
<pre>
public
video
Generic Network Storage [50]
audio
Generic Network Storage [50]
pictures
Generic Network Storage [50]
data
Generic Network Storage [50]
other
USB Drive [51]
john
video
Generic Network Storage [50]
audio
Generic Network Storage [50]
pictures
Generic Network Storage [50]
data
Generic Network Storage [50]
other
General Internal HDD [52]
mary
video
Generic Network Storage [50]
audio
Generic Network Storage [50]
pictures
Generic Network Storage [50]
data
Generic Network Storage [50]
other
</pre>
Whether you put your media under video, audio, pictures, data or other is unimportant. It will be scanned by LinuxMCE anyway. The contents of "General Internal HDD [52]" will be displayed in the folder john/other/General Internal HDD [52]. The contents of USB Drive [51] will be displayed in the folder public/other/USB Drive [51]. When John browses the contents in Network Neighborhood, he will be asked for his username and password. He can then access the content in both the public folder as well as the "john" folders (including General Internal HDD [52]). When Mary browses the contents with her username and password, she will see both the public and "mary" folders. She will not be able to see anything on General Internal HDD [52], however, since that drive was specified to be private for John.

In the case of John's private media, it won't be displayed in the LinuxMCE media browser unless you click 'Sources'-->'John'. However you ''can'' see the contents of General Internal HDD [52] (unless you deselect 'Sources'-->'Public' from the media browser). Generic Network Storage [50] would be different, however, since you specified to use the default directory structure for it. LinuxMCE will have created public directories on Generic Network Storage [50] for public video and public audio, as well as for john's video and mary's audio. The media file browser will show only the media that is in the public directories. (The same is true with the Windows Network Neighborhood browser.)

If Generic Network Storage [50] has existing media in the top (root) folder, you won't see it listed anywhere.

It is generally recommended, therefore, that when you add a new (blank) "extra" storage device, you choose to use the default directory structure on it. When you rip media to that device, the media can then be made either public or private, and LinuxMCE will automatically put it in the correct folder (audio, video, etc.).

If you connect an extra storage device that already has media on it, however, and that media isn't already organized in LinuxMCE's default directory structure, it's easiest if you simply 'make it all public' or 'make it all private'. If you were to 'use the default directory structure', you would need to manually move the files from the existing folders into one of the directory folders that LinuxMCE would then create for you.

When you rip files, you have the option of copying them to the Core. If you rip a CD and make it public, it will be stored in public/audio. If you go into Network Neighborhood and add a folder under public/audio, you would essentially be adding a folder on the Core. If you add a folder under public/audio/Generic Network Storage [50], you would be adding it to Generic Network Storage [50].

===Drive and network drive management===
This concept behind drive/network drive management is not the same as the method to which Linux and Windows users are accustomed. In Windows, for example, each network device shows up separately; they are never grouped together. There is an advantage to the way LinuxMCE manages drives. It's much simpler to add devices when you're a novice and don't understand networking. Further, if you're using an infrared remote control, you can manage drives with a single 'yes' or 'no,' click, which is very convenient. Lastly, all your media content is cataloged and presented in the same structure throughout the system, no matter which Media Director you're using or what room you're in.

In Windows, by comparison, if you connect a USB drive to a Windows PC in the bedroom, you won't see that content in the living room unless you 1) open file explorer, 2) create a new network share for it, 3) go into the living room, and 4) create a new mapped network drive there. (That isn't so easy to do with an infrared remote and without some knowledge of networking.) Further, you wouldn't be able to see the media in any other room in the house unless you were to also create mapped network shares in those rooms as well.

With LinuxMCE, when you connect a USB drive, for example, you can 'make it all public'; the media will be available everywhere. No other typing is required. With LinuxMCE, instead of managing multiple network shares and mapped drives, you can choose the Core's public folders in the Network Neighborhood browser from anywhere in the home, without having to know which storage devices the media is actually on. When you remove a USB drive from a Media Station, that media instantly disappears from the catalog displayed in every room. If you reattach it, it will re-appear.

You can also backup the media securely on the Core. LinuxMCE has built-in [http://en.wikipedia.org/wiki/RAID RAID] 5 (see '''[[LinuxMCE Admin Website]]-->Advanced-->[[RAID]]'''), so its HDD has similar backup capabilities to a [[NAS]] device.

To change the name of an extra device, go to the '''[[LinuxMCE Admin Website]]-->Advanced-->Configuration-->[[Devices]]''' and under the Core you will see listed the HDDs in the core and any connected NAS devices. Under each Media Station you will see the HDDs in that Media Station. All are given default names. You can change the description, which will also change the folder name. In the above example, changing "USB Drive [51]" to "Tokyo" means the directory public/other/USB Drive [51] would change to public/other/Tokyo.

You can see a list of the files in the system by folder In the '''[[LinuxMCE Admin Website]]-->Files & Media-->[[Media Files Sync]]''' menu. If a file is shown with a check box, the file exists both on the local disk as well as in LinuxMCE's master catalog. If it has a different icon, then LinuxMCE hasn't finished cataloging the media; just be patient. It should appear with a check mark soon (depending on how much new media was added).

Use this interface to manage change cover art and attributes. Under Files & Media there is also a cover art scan utility that will find cover art, as well as other attributes (actor, genre, etc.) obtained from Amazon.

===Linux operational details of network and disk mounts===
[[UpdateMedia]] is a daemon that constantly scans for media files in the /home/public and the /home/user_xxx folder created for each user. Any added media is cataloged in the pluto_media database File table, and attributes and cover art go into the Attribute and Picture tables. Under /home/public and /home/users_xxx is a data subfolder which contains the actual video, audio, pictures folders. (The /home/user_xxx directories themselves contain the system files for each user (like email boxes) as well as the main login for that user (in a "data" subfolder).

Extra devices are mounted as /mnt/device/xxx (where xxx is the device number). The mount point is the same whether it's a local drive or not. For example, USB drive [50] in a Media Station may be mounted as a local device named /mnt/device/50, but is also mounted as a Samba mount on other Media Stations as /mnt/device/50. The Core and the Media Stations all use the same mount names (/mnt/device/).

Within the /home/public/data and /home/user_xxx/data are symlinks to the physical directories specified by /mnt/device/xxx. Since the Core and all Media Stations mount the same /home directory (and all have the same /mnt/device mounts), they will all show the same files. Therefore, if the [[UpdateMedia]] daemon locates the file /home/public/data/audio/Generic Internal Drive [50]/The Beatles/Let it be.mp3, that file will be listed on every Media Station, too.

[[Category: Tutorials]]

Usage Intro

2010-02-08T16:12:52Z

Chris Caven: /* Scenarios */

{| align="right"
| __TOC__
|}
LinuxMCE's main concepts are [[Devices]], Commands (aka [[Scenarios]] and Activities), and [[Events]]. An [[Orbiter]] is the device that displays the User Interface. It can be a [[Media Director|Media Station]], web pad, mobile phone, or other remote control device. The Orbiter User Interface is standardized for all Orbiters.

== Devices ==

A device is generally a piece of hardware or software, like the Xine Media Player, a light switch, or a mobile phone. Devices have three functions, abbreviated "DCE" (Data, Commands, Events):

# Retrieve configuration '''data'''
# Perform a '''command''' (turn on, turn off, fast forward, etc.)
# Report certain triggered '''events''' (e.g. 'motion detected', 'playback started', etc.)

== Scenarios ==

"[[Scenarios]]", "Activities", and "Command Groups" are interchangeable terms -- they mean the same thing. A scenario is a group of commands that can be sent to a device (or series of devices). In LinuxMCE, the default Orbiter main menu consists of several scenario categories, grouped by room. These categories are:-

* Lighting
* Media
* Climate
* Telecom
* Security

(These default categories are arbitrary and are set up at installation.) To perform an action in LinuxMCE, a scenario is chosen from one of these categories (located on the main menu of an Orbiter).

For example, in rooms which have both a TV and lights, LinuxMCE automatically creates a scenario called 'Showtime.' This scenario dims the lights to 10% whenever the TV starts playing. In rooms with a PVR or other TV-enabled device, another scenario is created called 'TV' (in the 'Media' category) to start the TV. Another scenario in the 'Media' category called 'Video' sends a command to the Orbiter to list your video content. Telecom scenarios are created to make phone calls. Security scenarios are created to view cameras and to arm an alarm.

Some [[What_scenarios_are_created_automatically%3F|default scenarios]] are created for you at installation. A fully-functional system can run using only the default scenarios, if you choose. You can also change or remove the default scenarios or add new ones. This is done though the '''[[LinuxMCE Admin Website]]-->Wizard-->[[Scenarios]]''' menu. When creating a scenario, the [[LinuxMCE Admin Website]] will show you the most appropriate wizard, based on the category you pick. If you're adding an activity in the lighting category, for example, the wizard will display a list of the lights in the room and let you pick which ones to turn off. If you're creating a scenario in the security category, it will list the installed cameras and will allow you to select which ones to display.

A scenario can send a command to any device in the system. By default, scenarios in the lighting category show you the room lights, allowing you to select which ones to send commands. However, from the '''Wizard-->[[Scenarios]]''' menu for the specific scenario, you can also specify a command to any device in your home. You could make a phone call, for example, even from a scenario in the lighting category.

Certain scenarios are assigned to certain rooms by default. This can be customized, however. When you manually select a room from the Orbiter main menu, the default scenarios for that room are displayed. In general they control devices in that room, but this can also be changed. If your kitchen is near the garage and you want a scenario to 'turn off the garage light', you can assign a scenario to the room 'kitchen' that will do just that. It doesn't matter that the light is in the garage.

For a Media Director, the on-screen Orbiter User Interface appears on the TV screen. It is manipulated by the mouse/keyboard or remote control connected to your Media Director. By default it is set to display the scenarios for the room in which the Media Director is located.

In contrast, a mobile Orbiter (such as a webpad) can be carried throughout the house. It must be able to select the scenarios for multiple rooms. Fortunately, the option to manually select which room you are currently in is available on every Orbiter's main menu.

This can occasionally cause some confusion. Perhaps both the Living Room and the Bedroom have a scenario called 'TV'. You may have a web pad that is in the Bedroom, but you then carry it to the Living Room. You may forget to tell the web pad that it's now in the Living Room (at the bottom of the Orbiter screen it will still say 'Bedroom'). You hit the 'TV' button expecting the Living Room TV to come on, but in fact you're still controlling the Bedroom and the TV comes on there instead. Finally, you may realize that you must change your room location to Living Room, then you can control the TV there.

Once you get used to this concept, though, you'll find it very useful. Conveniently, any Orbiter can be set to control any room and choose from the scenarios assigned to that room. No matter which Orbiter you use, the same set of scenarios will be displayed for each specific room. For example, the kitchen scenarios will always be the same, no matter which Orbiter you are using. (The scenarios are assigned by room -- not by Orbiter.) No matter whether you pick up your mobile phone, your web pad, or your remote control, you will always be shown the same list of scenario options for the Living Room.

You have the option of preventing some family members from using certain scenarios. From the [[LinuxMCE Admin Website]], certain scenarios and rooms can be [[Users#Restrict_Access|restricted to certain users]]. Maybe little Suzy's mobile phone Orbiter should be restricted so that she is only able to control her room and the living room, for example. She would only be able to execute the scenarios in those rooms, but not the Master Bedroom. Other possible options include [[Users#Restrict_Access|requiring a pin code]] to access the scenarios for a particular room.

== Events ==

Devices report events, such as 'Playback started' and 'Motion Sensor tripped'. If you want something to happen automatically in LinuxMCE, you create Event Handlers that react to these events. For example, you can create an event handler that listens for the 'Motion Sensor tripped' event from a motion detector and turns on the lights in response. An event handler might listen for the 'Sunrise' event, which could then prompt the sprinklers to come on.

LinuxMCE creates several default event handlers. In rooms in which you have a TV and lights, an event handler is created that listens for the 'Watching Media' event sent by a media player. When the event is detected, the Showtime scenario (which dims the lights) is executed in response. When you start a movie, therefore, the Showtime activity will be executed and the lights will be dimmed. There are other default event handlers that monitor for events like 'Security Breach' and 'Fire Alarm' (from a home security system).

== Controlling an Orbiter ==

To control the system, you use an [[Orbiter]], which is the LinuxMCE term for a remote control. All [[Orbiters]] have the same basic function: to display the scenarios in the room you're in and let you select one. The different Orbiters may [[Selecting_the_Right_UI|display the User Interface slightly differently]], depending on their screen size, but the function and the list of scenarios is always the same. For example, the [[Selecting_the_Right_UI|"UI1" interface]] (which is used on webpads and PDAs) displays the scenarios in horizontal rows. (If there are more than will fit on a row, there will be a "more" button.) A home button is always displayed that takes you to the main menu. On smaller displays, as on mobile phones or desktop phones, there's not enough room to show the scenarios themselves. The top level menu shows only the categories: Lights, Media, Climate, Security and Telecom. Selecting a category displays the scenarios in that category.

[[Selecting_the_Right_UI|"UI2"]] is the [[Selecting_the_Right_UI|preferred User Interface]] for Media Stations. Using a traditional I/R remote is not much different from using any other Media Center PC remote. The menu button brings up the main menu, and you use the ''left/right/up/down/enter'' buttons to navigate it. The ''fast forward/rewind/skip +/skip -'' keys are used for media playback.

If you have a pointing device like a mouse or gyro air mouse, the UI2 interface also supports a unique control architecture that lets you do everything with 3 (programmable) buttons (plus ok and cancel). The 3 buttons are "MEDIA", "MENU", "AMBIANCE".

On a mouse with 3 programmable buttons (such as the [[Using_the_Gyration_Remote_GYR3101US_%28Non-Fiire_Chief%29|gyration]]), these functions correspond to the buttons from left to right. If you are using a traditional 3 button mouse, you can use the F6, F7 and F8 keys on the keyboard for the three programmable functions instead. In both cases, the left mouse button is "ok", and the right mouse button is "cancel/go back".

Mouse button behavior is "absolute" when you press and hold the media/menu/ambiance button and "relative" when you tap and release.

The "absolute" behavior is generally more efficient. For example, in the case of the middle button (F7), "absolute" behavior means the action is executed without having to additionally click "ok". If you press and hold the middle button (F7) while moving your mouse pointer to the option, then let go, that option is executed. If you instead tap and release the menu button ("relative" behavior), you will only highlight the menu option. You must then press ok (the left mouse button) to execute the option.

Categories appear along the bottom of the screen, and the scenarios in each category popup vertically (like a pull-down menu in a PC, except upside down). If the main menu isn't already visible, bring it up by pressing the "start" button on a Windows I/R remote, or the "menu" button on a 3-button mouse. To exit a menu, use the back button on the I/R remote, the cancel button (right mouse button on a 3-button mouse), or the ESC key on a keyboard.

In UI2 the media is always full screen. If you're not playing your own media, the background media (i.e. screensaver images) is gallery art from the Internet (using flickr) or [[Use_my_own_pictures_in_the_Screen_Saver|pictures you select]]. If only the screensaver images are displayed on the Media Station, press the menu/middle/F7 button to bring up the menu. Right click/ESC to get rid of it. (This works even if your own media is playing.)

If you're using UI2's 3-button navigation model, the normal media control options on a traditional remote are replaced with a single button: "media" (left soft button or F6). Press this and move the pointer up and down for your skip functions (''ch+, ch-, skip fwd, skip back''). Move the pointer left and right for speed control (''rewind, fast forward''). The further you move, the faster the media playback changes. If you hold the button down (the left soft button or F6), your movement will be "absolute". Instead of the traditional "jog shuttle-type" control, movement to the right skips to the end of your media, and movement to the left skips to the beginning. Once you get used to it, you will find that navigating media is orders of magnitude faster and easier with this model than with a traditional remote. You can find a spot in a 2 hour movie in only a couple seconds with a click of a single button (compared to a slew of button clicks required using a traditional remote).

Also, in UI2 you can press the "ambiance" button (right soft button or F8). Move up/down to adjust the lights, and left/right to adjust the volume. As with the media playback, if you hold the F8/right soft button down while you move left and right, your volume control is in "absolute" mode (not "relative"). Moving hard right turns up the volume full blast; hard left is mute. This requires you have a TV or receiver that is serial-controlled, however. LinuxMCE can then directly and instantly set the volume position in sync with your hand movements. (Few TVs and receivers have this feature, unfortunately.)

There are other media control functions besides the most commonly used ''fast fwd/rewind/skip up/skip down''. You can, for example, choose 'subtitles' while watching a DVD, 'guide' while watching TV, and 'random' while listening to an audio CD. In the UI2 3 button model, these functions appear on the main menu (on the left-most pad, entitled 'now playing') and changes according to the type of media you're playing. Press the menu button (middle button/F7) to select these options.

This 3 button model is a new concept and very different from traditional navigation. Most people find it much faster once they become accustomed to it.

==Reload Router & Regen Orbiters==

While using LinuxMCE you'll see sometimes a message asking if you want to [[Quick reload router|reload the router]], or if you want to [[Orbiter Generator|regenerate the Orbiter UIs]] (User Interfaces). In general, these options refresh the LinuxMCE databases so that changes to the system can be recognized.

===Reload Router===
All devices in LinuxMCE obtain their configuration information from the [[DCERouter]], which is the central piece of software on the Core. All devices request a list of the other devices in the home from the router, so they can respond to them appropriately. (For example, an IP camera device might turn on the lights in the room whenever you're viewing the camera. To do so, the IP camera needs to know what lights are in the room.) Typically a device requests this information only when it's starting up. When you connect additional plug and play devices to the system, these new devices generally will work immediately, but their functionality may not be fully enabled within the LinuxMCE system until the DCE router is reloaded. When the router reloads, it signals all devices on the system to simultaneously reload and re-request the system data. Each existing device can then work with each new device. This process is known as a 'reload'. It generally takes about 10 seconds. Every time you add or remove devices, or change a device's configuration, you may be asked to do a reload. If you're going to add more devices or make more device changes, you can do the reload once you're done. If you're in the middle of watching a movie or TV, you can postpone the reload, since media players generally stop playing during reloads. Phone calls aren't affected, though, and TV shows being recorded by MythTV in the background are also unaffected.

===Regen the Orbiter===
LinuxMCE's [[Selecting_the_Right_UI|Orbiter User Interfaces]] are all "pre-rendered" in order to be more efficient. The User Interface source images are all very high resolution, but need to be resized to accommodate the resolution of each Orbiter screen. The Core server has a list of the Orbiters used by your system, and will generate the appropriate User Interface screen for each Orbiter. It will do this each time you request a "regen". If you have five different types of Orbiters (each with a different type of screen), then five different images will be generated during each regen.

These User Interface screen images are stored in the Core. The appropriate UI image is sent to an Orbiter whenever it is activated. For many low-power devices (like mobile phones or desktop phones) there just isn't the processing power to do scaling and rendering of a User Interface screen on the fly. They need to be pre-rendered (with text pre-embedded in the images) to be efficient.

Adding new scenarios may result in the creation of new buttons for the User Interface, or changes to the text on existing buttons. Perhaps an entirely new screen will be created.

Until the User Interface images are regenerated, though, you won't be able to see these new buttons (or screens) on your Orbiter. During the regen, new User Interface images for each type of Orbiter is generated by the Core. This can take about 2-5 minutes, depending on how many Orbiter types you have in your system.

You needn't do a regen every time you add a scenario. You can wait until you have finished adding all the scenarios. Furthermore, you can also regen only the Orbiter you are currently using by doing a "Quick regen". This allows you to see the new User Interface (following the addition of new scenarios) without having to do a full regen for all the Orbiters. Once you have finished adding scenarios, then you can do a full regen.

This regen process can be a bit annoying, but is necessary. In future editions of LinuxMCE, it is planned to allow Media Directors, which have a lot more processing power, to render their on-screen Orbiter User Interfaces on the fly (so you don't have to do a regen each time you add or remove a scenario).

You can do a [[Orbiter Generator#Running OrbiterGen (performing a "regen")|full Orbiter regen or a Quick regen]] at any time by using buttons on the Core's LinuxMCE [[Launch Manager]].

==Managing your media==
LinuxMCE is always scanning for network shares, on Network-Attached Storage (NAS) devices and other Hard Disk Drives (HDDs) of PCs connected to the system (including Windows PCs). Universal Serial Bus (USB) drives are also detected. Every time a LinuxMCE finds a network share, you will be asked if you would like to use it. Whenever you reply "Yes", the file share can be used by any Media Director on the system. The file share is scanned for media, such as audio, video and photos, and any that are found are then cataloged in the Core's central database. For example, when you plug in a USB drive on a Media Station in the living room and tell LinuxMCE to use it, the media on the drive will be available to Media Directors in other rooms.

At the moment there is no way to restrict your media for 'local use only'; all Media Stations in the LinuxMCE system share the media catalog stored on the Core. (This is a limitation that will be addressed in the near future. Sometimes it is desirable to attach a USB drive in the master bedroom and not allow it to be shared, for example. ''Note: However, see [[folder lock|this article that describes a method to address this problem]].'')

Storage devices (NAS, USB drives, extra HDDs on the Core or Media Directors) are referred to as "Extra Drives". When an extra drive is added, it is listed in the device tree in '''[[LinuxMCE Admin Website]]-->Advanced-->Configuration-->[[Devices]]'''. Under 'Core' you'll see a device listed for each HDD in the Core, as well as for each NAS device. Under each Media Station will be listed the HDDs in that Media Station. By clicking on the device you can change the device's properties, such as the mount username/password. Each NAS device, and each file share on another PC, will show as a device listed under the Core; each is considered a child of the Core.

===Access control for shared media===
LinuxMCE creates a top level folder for 'public' media. This folder can be used by every user in the system. A 'private' media folder is also created for each user. Within each of those folders are sub-folders, labeled 'audio', 'video', 'pictures', 'data' and 'other'. Within each of those will also be sub-folders for the extra storage devices (NAS, USB, extra internal drives, etc). When you attach an extra storage device, you can specify whether the default directory structure should be used for it. Alternatively, you can specify 'just make it public' or 'make it private'.

Here's an example. Let's say you have 2 users: john and mary. You connect 3 storage devices:
# a NAS, for which you specify 'use default directory structure'. It is named 'Generic Network Storage [50]'
# a USB drive for which you specify 'make it all public'. It is named 'USB Drive [51]'
# a SATA drive for which you choose 'make it private for john'. It is named 'General Internal HDD [52]

Now let's say you're running Windows. Go to Network Neighborhood and find the LinuxMCE Core server. The directory tree ought to look like this:
<pre>
public
video
Generic Network Storage [50]
audio
Generic Network Storage [50]
pictures
Generic Network Storage [50]
data
Generic Network Storage [50]
other
USB Drive [51]
john
video
Generic Network Storage [50]
audio
Generic Network Storage [50]
pictures
Generic Network Storage [50]
data
Generic Network Storage [50]
other
General Internal HDD [52]
mary
video
Generic Network Storage [50]
audio
Generic Network Storage [50]
pictures
Generic Network Storage [50]
data
Generic Network Storage [50]
other
</pre>
Whether you put your media under video, audio, pictures, data or other is unimportant. It will be scanned by LinuxMCE anyway. The contents of "General Internal HDD [52]" will be displayed in the folder john/other/General Internal HDD [52]. The contents of USB Drive [51] will be displayed in the folder public/other/USB Drive [51]. When John browses the contents in Network Neighborhood, he will be asked for his username and password. He can then access the content in both the public folder as well as the "john" folders (including General Internal HDD [52]). When Mary browses the contents with her username and password, she will see both the public and "mary" folders. She will not be able to see anything on General Internal HDD [52], however, since that drive was specified to be private for John.

In the case of John's private media, it won't be displayed in the LinuxMCE media browser unless you click 'Sources'-->'John'. However you ''can'' see the contents of General Internal HDD [52] (unless you deselect 'Sources'-->'Public' from the media browser). Generic Network Storage [50] would be different, however, since you specified to use the default directory structure for it. LinuxMCE will have created public directories on Generic Network Storage [50] for public video and public audio, as well as for john's video and mary's audio. The media file browser will show only the media that is in the public directories. (The same is true with the Windows Network Neighborhood browser.)

If Generic Network Storage [50] has existing media in the top (root) folder, you won't see it listed anywhere.

It is generally recommended, therefore, that when you add a new (blank) "extra" storage device, you choose to use the default directory structure on it. When you rip media to that device, the media can then be made either public or private, and LinuxMCE will automatically put it in the correct folder (audio, video, etc.).

If you connect an extra storage device that already has media on it, however, and that media isn't already organized in LinuxMCE's default directory structure, it's easiest if you simply 'make it all public' or 'make it all private'. If you were to 'use the default directory structure', you would need to manually move the files from the existing folders into one of the directory folders that LinuxMCE would then create for you.

When you rip files, you have the option of copying them to the Core. If you rip a CD and make it public, it will be stored in public/audio. If you go into Network Neighborhood and add a folder under public/audio, you would essentially be adding a folder on the Core. If you add a folder under public/audio/Generic Network Storage [50], you would be adding it to Generic Network Storage [50].

===Drive and network drive management===
This concept behind drive/network drive management is not the same as the method to which Linux and Windows users are accustomed. In Windows, for example, each network device shows up separately; they are never grouped together. There is an advantage to the way LinuxMCE manages drives. It's much simpler to add devices when you're a novice and don't understand networking. Further, if you're using an infrared remote control, you can manage drives with a single 'yes' or 'no,' click, which is very convenient. Lastly, all your media content is cataloged and presented in the same structure throughout the system, no matter which Media Director you're using or what room you're in.

In Windows, by comparison, if you connect a USB drive to a Windows PC in the bedroom, you won't see that content in the living room unless you 1) open file explorer, 2) create a new network share for it, 3) go into the living room, and 4) create a new mapped network drive there. (That isn't so easy to do with an infrared remote and without some knowledge of networking.) Further, you wouldn't be able to see the media in any other room in the house unless you were to also create mapped network shares in those rooms as well.

With LinuxMCE, when you connect a USB drive, for example, you can 'make it all public'; the media will be available everywhere. No other typing is required. With LinuxMCE, instead of managing multiple network shares and mapped drives, you can choose the Core's public folders in the Network Neighborhood browser from anywhere in the home, without having to know which storage devices the media is actually on. When you remove a USB drive from a Media Station, that media instantly disappears from the catalog displayed in every room. If you reattach it, it will re-appear.

You can also backup the media securely on the Core. LinuxMCE has built-in [http://en.wikipedia.org/wiki/RAID RAID] 5 (see '''[[LinuxMCE Admin Website]]-->Advanced-->[[RAID]]'''), so its HDD has similar backup capabilities to a [[NAS]] device.

To change the name of an extra device, go to the '''[[LinuxMCE Admin Website]]-->Advanced-->Configuration-->[[Devices]]''' and under the Core you will see listed the HDDs in the core and any connected NAS devices. Under each Media Station you will see the HDDs in that Media Station. All are given default names. You can change the description, which will also change the folder name. In the above example, changing "USB Drive [51]" to "Tokyo" means the directory public/other/USB Drive [51] would change to public/other/Tokyo.

You can see a list of the files in the system by folder In the '''[[LinuxMCE Admin Website]]-->Files & Media-->[[Media Files Sync]]''' menu. If a file is shown with a check box, the file exists both on the local disk as well as in LinuxMCE's master catalog. If it has a different icon, then LinuxMCE hasn't finished cataloging the media; just be patient. It should appear with a check mark soon (depending on how much new media was added).

Use this interface to manage change cover art and attributes. Under Files & Media there is also a cover art scan utility that will find cover art, as well as other attributes (actor, genre, etc.) obtained from Amazon.

===Linux operational details of network and disk mounts===
[[UpdateMedia]] is a daemon that constantly scans for media files in the /home/public and the /home/user_xxx folder created for each user. Any added media is cataloged in the pluto_media database File table, and attributes and cover art go into the Attribute and Picture tables. Under /home/public and /home/users_xxx is a data subfolder which contains the actual video, audio, pictures folders. (The /home/user_xxx directories themselves contain the system files for each user (like email boxes) as well as the main login for that user (in a "data" subfolder).

Extra devices are mounted as /mnt/device/xxx (where xxx is the device number). The mount point is the same whether it's a local drive or not. For example, USB drive [50] in a Media Station may be mounted as a local device named /mnt/device/50, but is also mounted as a Samba mount on other Media Stations as /mnt/device/50. The Core and the Media Stations all use the same mount names (/mnt/device/).

Within the /home/public/data and /home/user_xxx/data are symlinks to the physical directories specified by /mnt/device/xxx. Since the Core and all Media Stations mount the same /home directory (and all have the same /mnt/device mounts), they will all show the same files. Therefore, if the [[UpdateMedia]] daemon locates the file /home/public/data/audio/Generic Internal Drive [50]/The Beatles/Let it be.mp3, that file will be listed on every Media Station, too.

[[Category: Tutorials]]

Architecture Intro

2010-02-08T15:58:13Z

Chris Caven: /* LinuxMCE and DHCP */

LinuxMCE is divided in two parts: the '''Core''' (aka the backend) and the '''Media Director''' (aka the frontend).

==The Core==
The '''[[Core]]''' has no user interface other than an [[LinuxMCE Admin Website|administration page]] (unless it is a [[hybrid]]). It provides processing services throughout the home, however. It acts as the central database that catalogues your media. It routes home automation messages and commands, and provides net boot images for the [[Media Directors]]. It can even act as your phone system. You only have one Core in the house because it is the central point through which all devices connect. Your Core is generally left on all the time. If it is turned off, LinuxMCE functionality everywhere else in the home stops working.

==Media Directors==
A '''[[Media Directors | Media Director]]''' (aka a Media Station) is connected to your TV. It is a PC running LinuxMCE, but you do not need to install any software on a Media Director, as long as you enable the Media Director to ''[[netboot]]'' LinuxMCE from the Core server.

Network booting is a capability that almost all PCs have. Through the BIOS setup on any PC, netboot can be enabled as the first bootup device. When this setting is chosen and the PC is rebooted, the PC will search the network for a boot image and boots that image as its OS (rather than the OS on the hard drive). In a LinuxMCE network, the Core provides the boot image over the network.

The local PC that functions as a Media Director is essentially a thin client to the Core. You can leave Windows, Fedora, or any other operating system you want on your PC's hard drive. When you want to use that PC as a LinuxMCE Media Director, enable netboot in the BIOS. When you want to use the OS that is stored on that PC's hard drive, reset the BIOS so that the hard drive is again the first boot device. (You can't do both at the same time.)

When LinuxMCE netboots, the software will not interfere with the software or operating system on the hard drive; it's like having 2 systems in one. You only have to install LinuxMCE software on one PC -- the Core -- and you can then have thin client Media Stations on PCs throughout the house. The whole process is fully automated and plug and play (whether or not you understand the concept of a netboot). The only technical thing you need to do is turn on netboot in the BIOS of a PC you want to use as a Media Director. Your PC manufacturer instructions should tell you how to change the BIOS settings.

It is possible for the PC that functions as the LinuxMCE Core to also function as a Media Director. This is known as a [[hybrid]], and it can be used as a standalone Home Theater solution. Later, you can add other Media Directors (using the netboot method described above). A hybrid, like a standalone Core, will provide netboot images across a network. The UI (user interface) on all Media Directors looks exactly the same as the UI on the hybrid Core/Media Director. The hybrid should not be shut down, either, since it is acting as a Core. If you do, all the other Media Directors will stop working.

==Orbiters==
'''[[Orbiters]]''' are the control interfaces, or remote controls, for the system. Each Media Director has an on-screen Orbiter user interface. In addition, multiple devices, such as a Nokia Internet Tablet N810, web-enabled equipment, or mobile phones can be used as Orbiters. The Orbiter User Interface (stored on and accessed from the Core) can also be accessed from any web browser.

==LinuxMCE and DHCP==
It is fairly important that within your LinuxMCE home automation/multimedia network, the Core must be the DHCP server. The DHCP server allocates IP addresses to all the devices within your LinuxMCE automation/multimedia network. Generally you can only have 1 DHCP server per network. In most cases you will already have a DHCP server on your "external" home LAN, usually as part of your router. (If you don't have a router and you have a dynamic (changing) IP address from your cable or DSL service provider, the DHCP server is at your cable or DSL provider's central office.)

Your LinuxMCE automation/multimedia network can be '''nested''' ''within'' an existing home LAN, leaving some devices "external" to the LinuxMCE automation/multimedia network. Or you can make your entire home LAN and the LinuxMCE automation/multimedia LAN one and the same, making every device in your home LAN part of the LinuxMCE automation/multimedia network as well.

When every PC and ethernet-connected device in your home LAN is also part of your LinuxMCE automation/multimedia LAN, then the Core must act as the router/DHCP server for the entire LAN. The DHCP on your existing router (if any) must be disabled and the Core then handles the DHCP functions for the entire LAN.

If you choose the nested "network within a network" configuration, the LinuxMCE Core will act as the DHCP router for the "internal" automation/multimedia network only. Your existing router would still handle DHCP functions for the "external" home LAN.

The easiest way to do this is to have 2 network cards (NICs) in the PC that will be the LinuxMCE Core. One NIC would connect to the external network (the home router, or perhaps directly to a cable or DSL modem) and gets an IP address from the DHCP of your home router or ISP provider. The other NIC would connect to your "internal" LinuxMCE automation/multimedia LAN (through a switch or a router with the DHCP disabled). All your other PCs and devices ''within'' your LinuxMCE automation/multimedia LAN connect to the switch (or the DHCP-disabled router) and therefore use the Core as the DHCP server.

This is the default configuration that the LinuxMCE installer expects by default. This is the configuration recommended if you aren't experienced with networking.

In some situations it is possible for the Core to get by with a single network card (NIC), but it is not recommended. For example, if your home has a static, unchanging IP address assigned by your cable or DSL provider, and every device in your home LAN will also be part of your home automation/multimedia LAN, then you will only need one network card. The Core will be the DHCP server for your entire LAN.

In the rare instance when you will have a single PC acting as a hybrid Core/Media Director and do not plan to have any additional devices (i.e. you don't have a home LAN at all), then the Core does not need to be configured to provide DHCP. In this scenario, one PC would act as a standalone Home Theater PC. None of the network capabilites of LinuxMCE would be available.

The [[Usage Intro]] explains the concepts about how to use LinuxMCE.

[[Category:Documentation| ]]

Architecture Intro

2010-02-08T15:52:06Z

Chris Caven: /* Orbiters */

LinuxMCE is divided in two parts: the '''Core''' (aka the backend) and the '''Media Director''' (aka the frontend).

==The Core==
The '''[[Core]]''' has no user interface other than an [[LinuxMCE Admin Website|administration page]] (unless it is a [[hybrid]]). It provides processing services throughout the home, however. It acts as the central database that catalogues your media. It routes home automation messages and commands, and provides net boot images for the [[Media Directors]]. It can even act as your phone system. You only have one Core in the house because it is the central point through which all devices connect. Your Core is generally left on all the time. If it is turned off, LinuxMCE functionality everywhere else in the home stops working.

==Media Directors==
A '''[[Media Directors | Media Director]]''' (aka a Media Station) is connected to your TV. It is a PC running LinuxMCE, but you do not need to install any software on a Media Director, as long as you enable the Media Director to ''[[netboot]]'' LinuxMCE from the Core server.

Network booting is a capability that almost all PCs have. Through the BIOS setup on any PC, netboot can be enabled as the first bootup device. When this setting is chosen and the PC is rebooted, the PC will search the network for a boot image and boots that image as its OS (rather than the OS on the hard drive). In a LinuxMCE network, the Core provides the boot image over the network.

The local PC that functions as a Media Director is essentially a thin client to the Core. You can leave Windows, Fedora, or any other operating system you want on your PC's hard drive. When you want to use that PC as a LinuxMCE Media Director, enable netboot in the BIOS. When you want to use the OS that is stored on that PC's hard drive, reset the BIOS so that the hard drive is again the first boot device. (You can't do both at the same time.)

When LinuxMCE netboots, the software will not interfere with the software or operating system on the hard drive; it's like having 2 systems in one. You only have to install LinuxMCE software on one PC -- the Core -- and you can then have thin client Media Stations on PCs throughout the house. The whole process is fully automated and plug and play (whether or not you understand the concept of a netboot). The only technical thing you need to do is turn on netboot in the BIOS of a PC you want to use as a Media Director. Your PC manufacturer instructions should tell you how to change the BIOS settings.

It is possible for the PC that functions as the LinuxMCE Core to also function as a Media Director. This is known as a [[hybrid]], and it can be used as a standalone Home Theater solution. Later, you can add other Media Directors (using the netboot method described above). A hybrid, like a standalone Core, will provide netboot images across a network. The UI (user interface) on all Media Directors looks exactly the same as the UI on the hybrid Core/Media Director. The hybrid should not be shut down, either, since it is acting as a Core. If you do, all the other Media Directors will stop working.

==Orbiters==
'''[[Orbiters]]''' are the control interfaces, or remote controls, for the system. Each Media Director has an on-screen Orbiter user interface. In addition, multiple devices, such as a Nokia Internet Tablet N810, web-enabled equipment, or mobile phones can be used as Orbiters. The Orbiter User Interface (stored on and accessed from the Core) can also be accessed from any web browser.

==LinuxMCE and DHCP==
It is fairly important that within your LinuxMCE home automation/multimedia network, the Core must be the DHCP server. The DHCP server allocates IP addresses to all the devices within your LinuxMCE automation/multimedia network. Generally you can only have 1 DHCP server per network. In most cases you will already have a DHCP server on your "external" home LAN, usually as part of your router. (If you don't have a router and you have a dynamic (changing) IP address from your cable or DSL service provider, the DHCP server is at your cable or DSL provider's central office.)

Your LinuxMCE automation/multimedia network can be '''nested''' ''within'' an existing home LAN, leaving some devices "external" to the LinuxMCE automation/multimedia network. Or you can make your entire home LAN and the LinuxMCE automation/multimedia LAN one and the same, making every device in your home LAN part of the LinuxMCE automation/multimedia network as well.

When every PC and ethernet-connected device in your home LAN is also part of your LinuxMCE automation/multimedia LAN, then the Core must act as the router/DHCP server for the entire LAN. The DHCP on your existing router (if any) must be disabled and the Core then handles the DHCP functions for the entire LAN.

If you choose the nested "network within a network" configuration, the LinuxMCE Core will act as the DHCP router for the "internal" automation/multimedia network only. Your existing router would still handle DHCP functions for the "external" home LAN.

The easiest way to do this is to have 2 network cards (NICs) in the PC that will be the LinuxMCE Core. One NIC would connect to the external network (the home router, or perhaps directly to a cable or DSL modem) and gets an IP address from the DHCP of your home router or ISP provider. The other NIC would connect to your "internal" LinuxMCE automation/multimedia LAN (through a switch or a router with the DHCP disabled). All your other PC's and devices ''within'' your LinuxMCE automation/multimedia LAN connect to the switch (or the DHCP-disabled router) and therefore use the Core as the DHCP server.

This is the default configuration that the LinuxMCE installer expects by default. This is the configuration recommended if you aren't experienced with networking.

In some situations it is possible for the Core to get by with a single network card (NIC), but it is not recommended. For example, if your home has a static, unchanging IP address assigned by your cable or DSL provider, and every device in your home LAN will also be part of your home automation/multimedia LAN, then you will only need one network card. The Core will be the DHCP server for your entire LAN.

In the rare instance when you will have a single PC acting as a hybrid Core/Media Director and do not plan to have any additional devices (i.e. you don't have a home LAN at all), then the Core does not need to be configured to provide DHCP. In this scenario, one PC would act as an standalone Home Theater PC. None of the network capabilites of LinuxMCE would be available.

The [[Usage Intro]] explains the concepts about how to use LinuxMCE.

[[Category:Documentation| ]]

Architecture Intro

2010-02-08T15:49:44Z

Chris Caven: /* Media Directors */

LinuxMCE is divided in two parts: the '''Core''' (aka the backend) and the '''Media Director''' (aka the frontend).

==The Core==
The '''[[Core]]''' has no user interface other than an [[LinuxMCE Admin Website|administration page]] (unless it is a [[hybrid]]). It provides processing services throughout the home, however. It acts as the central database that catalogues your media. It routes home automation messages and commands, and provides net boot images for the [[Media Directors]]. It can even act as your phone system. You only have one Core in the house because it is the central point through which all devices connect. Your Core is generally left on all the time. If it is turned off, LinuxMCE functionality everywhere else in the home stops working.

==Media Directors==
A '''[[Media Directors | Media Director]]''' (aka a Media Station) is connected to your TV. It is a PC running LinuxMCE, but you do not need to install any software on a Media Director, as long as you enable the Media Director to ''[[netboot]]'' LinuxMCE from the Core server.

Network booting is a capability that almost all PCs have. Through the BIOS setup on any PC, netboot can be enabled as the first bootup device. When this setting is chosen and the PC is rebooted, the PC will search the network for a boot image and boots that image as its OS (rather than the OS on the hard drive). In a LinuxMCE network, the Core provides the boot image over the network.

The local PC that functions as a Media Director is essentially a thin client to the Core. You can leave Windows, Fedora, or any other operating system you want on your PC's hard drive. When you want to use that PC as a LinuxMCE Media Director, enable netboot in the BIOS. When you want to use the OS that is stored on that PC's hard drive, reset the BIOS so that the hard drive is again the first boot device. (You can't do both at the same time.)

When LinuxMCE netboots, the software will not interfere with the software or operating system on the hard drive; it's like having 2 systems in one. You only have to install LinuxMCE software on one PC -- the Core -- and you can then have thin client Media Stations on PCs throughout the house. The whole process is fully automated and plug and play (whether or not you understand the concept of a netboot). The only technical thing you need to do is turn on netboot in the BIOS of a PC you want to use as a Media Director. Your PC manufacturer instructions should tell you how to change the BIOS settings.

It is possible for the PC that functions as the LinuxMCE Core to also function as a Media Director. This is known as a [[hybrid]], and it can be used as a standalone Home Theater solution. Later, you can add other Media Directors (using the netboot method described above). A hybrid, like a standalone Core, will provide netboot images across a network. The UI (user interface) on all Media Directors looks exactly the same as the UI on the hybrid Core/Media Director. The hybrid should not be shut down, either, since it is acting as a Core. If you do, all the other Media Directors will stop working.

==Orbiters==
'''[[Orbiters]]''' are the control interfaces, or remote controls, for the system. Each Media Director has an on-screen Orbiter user interface. In addition, multiple devices, such as a Nokia Internet Tablet (n810), web enabled equipment, or mobile phones can be used as Orbiters. The Orbiter User Interface (stored on and accessed from the Core) can also be accessed from any web browser.

==LinuxMCE and DHCP==
It is fairly important that within your LinuxMCE home automation/multimedia network, the Core must be the DHCP server. The DHCP server allocates IP addresses to all the devices within your LinuxMCE automation/multimedia network. Generally you can only have 1 DHCP server per network. In most cases you will already have a DHCP server on your "external" home LAN, usually as part of your router. (If you don't have a router and you have a dynamic (changing) IP address from your cable or DSL service provider, the DHCP server is at your cable or DSL provider's central office.)

Your LinuxMCE automation/multimedia network can be '''nested''' ''within'' an existing home LAN, leaving some devices "external" to the LinuxMCE automation/multimedia network. Or you can make your entire home LAN and the LinuxMCE automation/multimedia LAN one and the same, making every device in your home LAN part of the LinuxMCE automation/multimedia network as well.

When every PC and ethernet-connected device in your home LAN is also part of your LinuxMCE automation/multimedia LAN, then the Core must act as the router/DHCP server for the entire LAN. The DHCP on your existing router (if any) must be disabled and the Core then handles the DHCP functions for the entire LAN.

If you choose the nested "network within a network" configuration, the LinuxMCE Core will act as the DHCP router for the "internal" automation/multimedia network only. Your existing router would still handle DHCP functions for the "external" home LAN.

The easiest way to do this is to have 2 network cards (NICs) in the PC that will be the LinuxMCE Core. One NIC would connect to the external network (the home router, or perhaps directly to a cable or DSL modem) and gets an IP address from the DHCP of your home router or ISP provider. The other NIC would connect to your "internal" LinuxMCE automation/multimedia LAN (through a switch or a router with the DHCP disabled). All your other PC's and devices ''within'' your LinuxMCE automation/multimedia LAN connect to the switch (or the DHCP-disabled router) and therefore use the Core as the DHCP server.

This is the default configuration that the LinuxMCE installer expects by default. This is the configuration recommended if you aren't experienced with networking.

In some situations it is possible for the Core to get by with a single network card (NIC), but it is not recommended. For example, if your home has a static, unchanging IP address assigned by your cable or DSL provider, and every device in your home LAN will also be part of your home automation/multimedia LAN, then you will only need one network card. The Core will be the DHCP server for your entire LAN.

In the rare instance when you will have a single PC acting as a hybrid Core/Media Director and do not plan to have any additional devices (i.e. you don't have a home LAN at all), then the Core does not need to be configured to provide DHCP. In this scenario, one PC would act as an standalone Home Theater PC. None of the network capabilites of LinuxMCE would be available.

The [[Usage Intro]] explains the concepts about how to use LinuxMCE.

[[Category:Documentation| ]]

Architecture Intro

2010-02-08T15:35:31Z

Chris Caven: /* The Core */

LinuxMCE is divided in two parts: the '''Core''' (aka the backend) and the '''Media Director''' (aka the frontend).

==The Core==
The '''[[Core]]''' has no user interface other than an [[LinuxMCE Admin Website|administration page]] (unless it is a [[hybrid]]). It provides processing services throughout the home, however. It acts as the central database that catalogues your media. It routes home automation messages and commands, and provides net boot images for the [[Media Directors]]. It can even act as your phone system. You only have one Core in the house because it is the central point through which all devices connect. Your Core is generally left on all the time. If it is turned off, LinuxMCE functionality everywhere else in the home stops working.

==Media Directors==
A '''[[Media Directors | Media Director]]''' (aka a Media Station) is connected to your TV. It is a PC running LinuxMCE, but you do not need to install any software on a Media Director as long as you enable the Media Director to ''[[netboot]]'' LinuxMCE from the Core server. (Network booting is a capability that almost all PCs have. Through the BIOS setup on any PC, netboot can be enabled as the first bootup device. When this setting is chosen and the PC is rebooted, the PC will search the network for a boot image and boots that image as its OS (rather than the OS on the hard drive).) In a LinuxMCE network, the Core provides the boot image over the network. The local PC that functions as a Media Director is essentially a thin client to the Core. (You can leave Windows, Fedora, or any other operating system you want on your PC's hard drive. When you want to use that PC as a LinuxMCE Media Director, enable netboot in the BIOS. When you want to use the OS that is stored on that PC's hard drive, reset the BIOS so that the hard drive is again the first boot device. (You can't do both at the same time.)) When LinuxMCE netboots, the software will not interfere with the software or operating system on the hard drive; it's like having 2 systems in one. You only have to install LinuxMCE software on one PC, the Core, and you can then have thin client Media Stations on PCs throughout the house. The whole process is fully automated and plug and play (whether or not you understand the concept of a netboot). The only technical thing you need to do is turn on netboot in the BIOS of a PC you want to use as a Media Director. Your PC manufacturer instructions should tell you how to change the BIOS settings.

It is possible for the PC that functions as the LinuxMCE Core to also function as a Media Director. This is known as a [[hybrid]], and it can be used as a standalone Home Theater solution. Later, you can add other Media Directors (using the netboot method described above). A hybrid, like a standalone Core, will provide netboot images across a network. The UI (user interface) on all Media Directors looks exactly the same as the UI on the hybrid Core/Media Director. The hybrid should not be shut down, either, since it is acting as a Core. If you do, all the other Media Directors will stop working.

==Orbiters==
'''[[Orbiters]]''' are the control interfaces, or remote controls, for the system. Each Media Director has an on-screen Orbiter user interface. In addition, multiple devices, such as a Nokia Internet Tablet (n810), web enabled equipment, or mobile phones can be used as Orbiters. The Orbiter User Interface (stored on and accessed from the Core) can also be accessed from any web browser.

==LinuxMCE and DHCP==
It is fairly important that within your LinuxMCE home automation/multimedia network, the Core must be the DHCP server. The DHCP server allocates IP addresses to all the devices within your LinuxMCE automation/multimedia network. Generally you can only have 1 DHCP server per network. In most cases you will already have a DHCP server on your "external" home LAN, usually as part of your router. (If you don't have a router and you have a dynamic (changing) IP address from your cable or DSL service provider, the DHCP server is at your cable or DSL provider's central office.)

Your LinuxMCE automation/multimedia network can be '''nested''' ''within'' an existing home LAN, leaving some devices "external" to the LinuxMCE automation/multimedia network. Or you can make your entire home LAN and the LinuxMCE automation/multimedia LAN one and the same, making every device in your home LAN part of the LinuxMCE automation/multimedia network as well.

When every PC and ethernet-connected device in your home LAN is also part of your LinuxMCE automation/multimedia LAN, then the Core must act as the router/DHCP server for the entire LAN. The DHCP on your existing router (if any) must be disabled and the Core then handles the DHCP functions for the entire LAN.

If you choose the nested "network within a network" configuration, the LinuxMCE Core will act as the DHCP router for the "internal" automation/multimedia network only. Your existing router would still handle DHCP functions for the "external" home LAN.

The easiest way to do this is to have 2 network cards (NICs) in the PC that will be the LinuxMCE Core. One NIC would connect to the external network (the home router, or perhaps directly to a cable or DSL modem) and gets an IP address from the DHCP of your home router or ISP provider. The other NIC would connect to your "internal" LinuxMCE automation/multimedia LAN (through a switch or a router with the DHCP disabled). All your other PC's and devices ''within'' your LinuxMCE automation/multimedia LAN connect to the switch (or the DHCP-disabled router) and therefore use the Core as the DHCP server.

This is the default configuration that the LinuxMCE installer expects by default. This is the configuration recommended if you aren't experienced with networking.

In some situations it is possible for the Core to get by with a single network card (NIC), but it is not recommended. For example, if your home has a static, unchanging IP address assigned by your cable or DSL provider, and every device in your home LAN will also be part of your home automation/multimedia LAN, then you will only need one network card. The Core will be the DHCP server for your entire LAN.

In the rare instance when you will have a single PC acting as a hybrid Core/Media Director and do not plan to have any additional devices (i.e. you don't have a home LAN at all), then the Core does not need to be configured to provide DHCP. In this scenario, one PC would act as an standalone Home Theater PC. None of the network capabilites of LinuxMCE would be available.

The [[Usage Intro]] explains the concepts about how to use LinuxMCE.

[[Category:Documentation| ]]

Z-Wave Hardware Installation

2010-02-08T15:15:09Z

Chris Caven: /* Important things */

== Precautions ==
Installing Z-Wave hardware should be performed with great care, as you will be working with the electrical system in your home or apartment. In any case, these are a few things you should always remember:

*Shutoff all power.
*Test the lines that you will be working on to ensure they are off.

Outside of this, please follow the instructions that came with your Z-Wave hardware or consult a licensed electrician to install it for you. In the case of older homes, you may need a special Z-Wave device for fixtures with no neutral wire. In any case, consult the manufacturer's website if you cannot locate proper installation instructions.

== 2wire/3wire ==
Depending on the type of device, it may require a neutral wire in the rockerbox (e.g. relay-based switches). Make sure to get the right ones fitting your cabling and lamp types.

== Important things ==
*Don't move your Z-Wave nodes (except portable controllers) around after inclusion. Always remove them from the network and add them again. If you run SIS mode, please don't forget to quick reload the router after deleting the device. After the quick reload, add it again.

[[category: Tutorials]]
[[category: ZWave]]

Z-Wave Hardware Installation

2010-02-08T15:07:26Z

Chris Caven: /* 2wire/3wire */

== Precautions ==
Installing Z-Wave hardware should be performed with great care, as you will be working with the electrical system in your home or apartment. In any case, these are a few things you should always remember:

*Shutoff all power.
*Test the lines that you will be working on to ensure they are off.

Outside of this, please follow the instructions that came with your Z-Wave hardware or consult a licensed electrician to install it for you. In the case of older homes, you may need a special Z-Wave device for fixtures with no neutral wire. In any case, consult the manufacturer's website if you cannot locate proper installation instructions.

== 2wire/3wire ==
Depending on the type of device, it may require a neutral wire in the rockerbox (e.g. relay-based switches). Make sure to get the right ones fitting your cabling and lamp types.

== Important things ==
* Don't move around your Z-Wave nodes (except portable controllers) after inclusion. Always remove them from the network and add them again. If you run SIS mode please don't forget to quick reload the router after deleting the device. After the quick reload add it again.

[[category: Tutorials]]
[[category: ZWave]]

Z-Wave Hardware Installation

2010-02-08T15:04:59Z

Chris Caven: /* Precautions */

== Precautions ==
Installing Z-Wave hardware should be performed with great care, as you will be working with the electrical system in your home or apartment. In any case, these are a few things you should always remember:

*Shutoff all power.
*Test the lines that you will be working on to ensure they are off.

Outside of this, please follow the instructions that came with your Z-Wave hardware or consult a licensed electrician to install it for you. In the case of older homes, you may need a special Z-Wave device for fixtures with no neutral wire. In any case, consult the manufacturer's website if you cannot locate proper installation instructions.

== 2wire/3wire ==
Depending on the type of device it may require a neutral wire in the rockerbox (e.g. relay based switches). Make sure to get the right ones fitting your cabling and lamp types.

== Important things ==
* Don't move around your Z-Wave nodes (except portable controllers) after inclusion. Always remove them from the network and add them again. If you run SIS mode please don't forget to quick reload the router after deleting the device. After the quick reload add it again.

[[category: Tutorials]]
[[category: ZWave]]

Z-Wave Hardware Installation

2010-02-08T15:02:21Z

Chris Caven:

== Precautions ==
Installing Z-Wave hardware should be performed with great care, as you will be working with the electrical system in your home or apartment. In any case, these are a few things you should always remember:

*Shutoff all power.
*Test the lines that you will be working on to ensure they are off.

Outside of this, please follow the instructions that came with your Z-Wave hardware or consult a licensed electrician to install it for you. In the case of older homes, you may need a special Z-Wave device for fixtures with no neutral wire. In any case, consult the manufacturers website if you cannot locate proper installation instructions.

== 2wire/3wire ==
Depending on the type of device it may require a neutral wire in the rockerbox (e.g. relay based switches). Make sure to get the right ones fitting your cabling and lamp types.

== Important things ==
* Don't move around your Z-Wave nodes (except portable controllers) after inclusion. Always remove them from the network and add them again. If you run SIS mode please don't forget to quick reload the router after deleting the device. After the quick reload add it again.

[[category: Tutorials]]
[[category: ZWave]]