Difference between revisions of "User Manual"

From LinuxMCE
Jump to: navigation, search
(→‎Configuring Myth TV)
(→‎How to get started with LinuxMCE)
 
(152 intermediate revisions by 11 users not shown)
Line 2: Line 2:
 
   | __TOC__
 
   | __TOC__
 
   |}
 
   |}
−
[[Category:Tutorials]]
+
[[Category:Documentation| ]]
 +
[[Category:Tutorials| 0]]
  
−
*[[LinuxMCE|What is LinuxMCE?]]
+
<center>
 +
<big><big><big>Welcome to LinuxMCE,<br>
 +
home of the home of the future.</big></big></big>
 +
</center>
  
−
*[[software components | Software Components]]
+
== What is LinuxMCE? ==
 +
Though this distribution is called Linux Media Center Edition ({{l}}), it is not just a media center. It was so named because its main component was a replacement for other Operating Systems that at the time were called Media Center Editions. LinuxMCE's primary functions are integration and automation. It is much more than a media powerhouse. With LinuxMCE, you can integrate most automation technologies and enable them to inter-operate using their native [[automation | automation protocols]] because at its core, LinuxMCE is a multi-protocol automation gateway.
  
−
*[[What can I do with LinuxMCE?]]
+
Built on the solid foundation laid down by Debian and Ubuntu, LinuxMCE is a free and open source Linux distribution designed to allow a computer to act as:
 +
:* a home automation, lighting, and climate control system
 +
:* a home theater PC (HTPC) for the living-room TV
 +
:* a personal video recorder (PVR)
 +
:* a surveillance and security system
 +
:* a VoIP phone system
  
−
==Hardware==
 
  
−
===Picking The Right Components===
+
LinuxMCE is loaded with all kinds of features for the home of the future.  It is designed to completely control the environment both inside and outside your home. Along with media features including the ability to record and playback audio and video, LinuxMCE is capable of enhancing your home environment by setting the desired room temperature and luminosity (controlling the blinds, curtains, lights, and thermostat), silencing the phone (or pausing the media while you're on the phone), setting the alarm, locking the doors, and switching devices on (and off) at any time you desire.  With the level of integration that LinuxMCE provides, you can control your home, and, enjoy the added benefit of the use of the included telephone and intercom system, security system monitor, media controller, etc... <br>
  
−
====The Core====
+
LinuxMCE ties them all together using an advanced messaging infrastructure that enables it to act as your whole home automation controller.  
−
 
+
−
The most important component is the "[[Core]]."  This is the main LinuxMCE server that runs all the applications.  A good Pentium 4 with at least 80 GB of storage and two network cards (Gigabit ideally) is often sufficient. A high-end server with RAID-5 storage is best.
+
−
 
+
−
It is best to dedicate one PC as the Core server. You can put this computer somewhere out of the way and not connect a monitor to it.  If there will be only one computer in your LinuxMCE system, that computer will be  a "[[hybrid]]" Core server and [[Media Director|media player]]. It will defnitiely require a connection to a TV. 
+
−
 
+
−
[[:Category:Cores|Here are some possible Core server platforms.]]
+
−
 
+
−
====Media Directors====
+
−
 
+
−
[[Media Directors]] (MDs) are PCs with outputs to connect to a television (such as S-video or RCA jacks). Sound outputs to speakers, from a good sound card, is also important.  The MDs play all your streaming music and video from the Core, from network attached storage (NAS), and from other MDs in your system.  Output to a TV and speakers can create an awesome multimedia experience.
+
−
 
+
−
[[:Category:Media_Directors|Here are some possible Media Director platforms.]]
+
−
 
+
−
====Orbiters====
+
−
 
+
−
[[Orbiters]] are high-tech remote controls.  LinuxMCE provides for multiple orbiter options such as a generic PC, wireless tablet PC, PDAs, mobile phones running Symbian or Microsoft Mobile, or through a web interface accessible to any computer within your LinuxMCE network, or even from the Internet.  (The web interface requires user authentication.)
+
−
 
+
−
[[:Category:Orbiters|Here are some possible Orbiter platforms.]]
+
−
 
+
−
====Network Attached Storage====
+
−
 
+
−
An alternative to having a lot of storage space in the Core PC itself is to store your files on a [[Network Attached Storage|network attached storage]] (NAS) server.  An example is the [[Buffalo Terastation]], a 1.0 TeraByte RAID-5 hard drive for under US$1000.  You can store large music and video collections this way.  Your LinuxMCE system can also record TV shows (using MythTV) and video from your security cameras (using Motion). Both require lots of hard drive storage space.
+
−
 
+
−
[[:Category:Network Attached Storage|Here are some possible NAS solutions.]]
+
−
 
+
−
====Additional Devices====
+
−
 
+
−
Home automation devices for controlling your lights, security cameras, a plasma screen TV, a streaming media music player such as the [[SlimDevices Squeezebox]], an alarm system with a serial interface, etc.  These are examples of devices that require ''another'' controller device called a [[gc100]].  The gc100 allows these and other devices that communicate using a serial port (e.g. alarm panels) or an [[infrared]] port (e.g. a TV) to connect to the network and talk with your LinuxMCE Core.
+
−
 
+
−
====Plug 'n' Play Capabilities====
+
−
 
+
−
Once LinuxMCE is installed, you can treat it like an appliance -- plug it in, turn it on, and leave it alone. You don't even need to install any software on the media PCs that will be used as [[Media Directors]]. If these PCs are connected to the Core by wired Ethernet, they can usually be set to [[Network Boot for Media Directors|boot LinuxMCE from the Core server over the network]] whenever you want to use them as a Media Director. The rest of the time they can be used as a regular PC, using whatever operating system is on their hard drives.
+
−
 
+
−
 
+
−
The LinuxMCE Core must be the DHCP server for your LinuxMCE network so that it can offer the plug-and-play and network boot services. The Core server bridges your "external" home LAN and an "internal" LinuxMCE LAN. For this to work, it is recommended to have [[Why dual network cards?|dual network cards]] -- one to connect to the "external" network (which can be your home LAN or simply your Internet connection), and one for the "internal" LinuxMCE network (to which all your LinuxMCE devices are connected). The LinuxMCE Core server effectively acts as DHCP server and firewall for the LinuxMCE network.
+
−
 
+
−
Note that you can easily have PCs outside of the LinuxMCE internal network, if you choose. Simply do not connect them to the LinuxMCE network. Alternatively, you can choose to have all PCs in your house be part of the LinuxMCE network. In this case the Core server provides DHCP and firewall services for you entire home LAN.
+
−
 
+
−
====Wiring Considerations====
+
−
The connection between the Core server and the Media Directors requires a significant amount of data transmission. It is recommended that a wired Ethernet be used between the Core and each Media Director.
+
−
 
+
−
Other devices which do not have as high data transmission requirements, such as PDAs used as Orbiter remote controls, can be used wirelessly through a wireless access point that is later connected to the LinuxMCE LAN.
+
−
 
+
−
Furthermore, wireless netbooting is not very easy. For this reason, a wired LAN is easiest and best for most users.
+
−
 
+
−
* [[Wiring Considerations]]
+
−
 
+
−
====Additional Hardware Resources====
+
−
Choosing hardware components can be difficult. There are multiple articles regarding hardware selection in the [[:Category:Hardware | Hardware Category]].
+
−
 
+
−
Also see:
+
−
* [[What hardware I will need]]
+
−
* [[Video#Equipment_used_in_the_demo | A list of hardware used in the demo video]]
+
−
 
+
−
===Setting Up The Hardware===
+
−
 
+
−
==== Using your own PCs ====
+
−
 
+
−
LinuxMCE is Linux-based. Sometimes drivers are not available for Linux as soon as they are for Windows.  If you bought some new, exotic hardware there may not yet be drivers for Linux. Check out the [[:Category:Hardware|Hardware Category]] first. Also check out [http://www.linuxcompatible.org linuxcompatible.org] for a list of Linux-compatible hardware. As a last resort to find out if your hardware might work, post a message in the LinuxMCE [http://forum.linuxmce.com/ forums]. 
+
−
 
+
−
=====Adding Additional Hardware=====
+
−
 
+
−
You can also put multiple cards in the [[Core]], such as analog phone line interfaces (e.g. from www.digium.com), or analog video capture cards for surveillance cameras.  You can put the PVR/satellite capture cards in the individual media PCs, or you can put them in the Core, which will enable sharing video throughout the house.
+
−
 
+
−
Bluetooth mobile phones can be used as remote controls by adding a USB Bluetooth Dongle to each Media Director (around $25). Each Media Director will report the signal strengths of each mobile phone (this is how the Core figures out what room you're in).  Since all resources in the whole house are shared, you will be able to control any device in any room from anywhere -- as long as you're within Bluetooth range of a Media Director (within 10m, or 30feet).
+
−
 
+
−
You can also use low-cost network audio players, like the Squeeze Box, which can be placed anywhere in the system.
+
−
 
+
−
Orbiter remote controls not only include the Media Directors themselves (through the mouse and keyboard), but can also include infrared remotes, webpads, and even PDAs.
+
−
 
+
−
====A Dedicated Core====
+
−
[[Image:Diagram1.jpg|200px|thumb|Connects to a Dedicated Core]]
+
−
The [[Core]] is the central point of the LinuxMCE system and runs applications and daemons needed for the other devices to exchange data and commands. A dedicated Core controls all of the LinuxMCE components. In this LinuxMCE configuration, the user does not use the Core as a Media Director at all. Other PCs will need to be used as Media Directors in order to play movies, listen to music, and watch TV. This kind of setup is recommended when you have lot of extra devices, all of which will have full access to the Core's resources.
+
−
 
+
−
The [[Clean Core]] project is an ongoing effort to further reduce the resource consumption of the [[Core]] server.
+
−
 
+
−
<br style="clear:both;"/>
+
−
 
+
−
====A Dedicated Hybrid====
+
−
[[Image:Diagram2.jpg|200px|thumb|Connections to a Hybrid Core]]
+
−
A "[[hybrid]]" is a PC that runs the "Core" software while also serving as a [[Media Director]]. This is often done with standalone LinuxMCE setups, with a single PC in the Home Entertainment Center. However, other Media Directors can still be added into the system later.
+
−
 
+
−
The Core server (and therefore a hybrid) generally requires more processing power, runs hotter, needs more cooling fans (and is therefore noisier), and is often a bigger PC than those used only as Media Directors. For many users it is less desirable to place such a PC in their Home Entertainment Center.
+
−
 
+
−
However, there are now multimedia-oriented PCs made with this in mind, that are quite suitable for use as hybrids.
+
−
 
+
−
A Media Director cannot run without first setting up a LinuxMCE Core (or hybrid) server.
+
−
<br style="clear:both;"/>
+
−
 
+
−
==Installation of Software Components==
+
−
There are currently two methods of installation.  The DVD installation requires a single installation disk. The CD method which requires 3 disks (one of which is the Kubuntu LiveCD), but offers more flexibility in installation.
+
−
===DVD Installation===
+
−
*[[DVD Installation]]
+
−
===CD Installation===
+
−
*[[Installation Guide]]
+
−
 
+
−
==Setting Up LinuxMCE==
+
−
===Tell LinuxMCE About Your Home===
+
−
 
+
−
[[Tell LinuxMCE about your home]] shows you how to use LinuxMCE to store information about the existing hardware in your home. In a few hours you can have your home hardware setup to be part of the LinuxMCE system -- a whole-house media server, home automation systems for your your lights and climate control, TV/Hi-Fi gear, a VOIP phone system, follow-me remote controls -- anything that you already have in your home. It's quick, painless, and non-technical.
+
−
 
+
−
Setting up your LinuxMCE system consists of 4 steps:
+
−
 
+
−
* Providing some general information, such as what kind of network you have.
+
−
* Specifying the devices in your home (lights, TVs, surveillance cameras, etc.).
+
−
* Creating scenarios. A "scenario" is a group of commands, or tasks, you want executed when you touch a button. Each scenario you create will appear on the Orbiter remote controls as an option button.
+
−
:*Scenarios are generally organized into 5 categories: lighting, media, climate, security and telephone. You can create, for example, a lighting scenario called "Entertaining" which turns on all the lights in the house and in the front yard. A button labeled "Entertaining" will then appear on the Orbiters in the lighting section--touch it to activate the scenario. Any scenario can do anything. For example, just because the "Entertaining" scenario is a lighting scenario doesn't mean the scenario only affects lights. You can make the scenario also play some music, and maybe open the front gate. You can use the "Advanced, My Scenarios" menu option for low-level control over a scenario, to make it do whatever you want. However the Wizard includes pages that make it very easy to create scenarios. For example, when you add a lighting scenario with the Wizard, it lists all the lights in the house and lets you pick the ones you want to change with the scenario.
+
−
*Creating event handlers. This is how you tell LinuxMCE you want it to do something in response to some event. For example, you may want LinuxMCE to turn on the Front Porch light when a motion detector is tripped. Or you want it to play a loud message on the TV when there is a security breach. Perhaps you would like to stop watering the lawn when it rains.
+
−
 
+
−
The developers have tried to automate has much of the set up as possible with several scripts and wizards. If the wizards are unable to customize your system the way you like it, then an admin page, accessible through the built-in web browser, is provided, for even more options.
+
−
 
+
−
* To get started, read the [[QuickStart Guide | Quick Start Guide]]
+
−
* The appearance of LinuxMCE depends on your graphics card. Read [[Graphics Test]] for information on how to determine the capabilities of your current video card.
+
−
 
+
−
===AVWizard===
+
−
The Audio/Video Wizard is designed to allow for easy setup of the components (ranging from a simple monitor to an HCTV with composite inputs and outputs) to which a [[Media Director]] outputs the multimedia content that is streamed from the [[Core]].
+
−
*[[AVWizard]]
+
−
 
+
−
===Setup Wizard===
+
−
The setup wizard is an automated series of screens which allows the user to enter information about the devices that LinuxMCE will control. First you will be prompted to set up audio and video. When audio and video are properly setup you should see and hear a video. Following that you can choose one of two configuration screens: the [[House Setup Wizard]] or the [[Media Player Wizard]].
+
−
 
+
−
====House Setup Wizard====
+
−
*[[House Setup Wizard]]
+
−
====Media Player Wizard====
+
−
*[[Media Player Wizard]]
+
−
 
+
−
===Using LinuxMCE Admin Website===
+
−
Although there are automated wizards to assist in setup, there are more options provided in the [[LinuxMCE Admin Website|LinucxMCE Admin web page]].  The user can create and modify any and all devices that LinuxMCE can control through the Admin page, which is displayed in the integrated web browser available both on the Core/Hybrid and on every Media Director.
+
 
   
 
   
−
*[[LinuxMCE Admin Website|LinuxMCE Admin web page]]
+
<br>You can read more about it [http://www.linuxmce.com/ on the LinuxMCE site] and [http://en.wikipedia.org/wiki/Linuxmce on Wikipedia].
−
 
+
{{p}}
−
===Scenarios, Events & Security===
+
−
 
+
−
In the [[Scenarios]] page, add the scenarios, or buttons, you want for each room. For example:
+
−
*A Lighting scenario in the Bedroom called 'Go to sleep' can dim the lights.
+
−
*A Security scenario in the Living Room can view a camera.
+
−
 
+
−
When you do a 'quick reload router', DCERouter will automatically add Media Scenarios for each room which will include the media devices that are located there.
+
−
 
+
−
Your new scenarios will then be visible on the Orbiter remote controls after you [[Usage_Intro#Reload_Router_.26_Regen_Orbiters|regenerate]].
+
−
 
+
−
Add [[Events]] to specify conditional events (such as turning on a light) when something else happens (a motion detector is tripped, the sun sets, etc.). This can be used for security. For example, you want to be notified (by VOIP, a message on a TV, etc.) when certain events happen in the house (motion detector is tripped). Settings will take effect next time you reboot or 'quick reload router'.
+
−
 
+
−
===Configuring Myth TV===
+
−
Most of the setup for MythTV is done automatically, but for more information take a look at the following link.
+
  
−
* [[Setting up MythTV]].
+
==== LinuxMCE software components ====
 +
LinuxMCE brings together a number of software components in an integrated environment. It is a collection of many pieces of open source software. <br>
 +
Each LinuxMCE installation is a custom mix made of a selection of devices, plug-ins, and other modules. LinuxMCE's primary documentation aims to explain how LinuxMCE works, how to install it, set it up, and use it.  Many devices have already been tested for easy setup and are Plug 'n' Play. Feel free to consult the ever growing [[hardware|HCL]].  If you are new to LinuxMCE, try to start with devices that are known to work with LinuxMCE, then move on to more advanced things.  If you are unsure, please ask on the [http://forum.linuxmce.org/ forums] or in [[IRC Chat]].<br>
  
−
===Upload Your Media===
+
Here is a list of some of the software components that make LinuxMCE run:
 +
{|
 +
!Functionality !!  !!Platform/software used
 +
|-
 +
| Operating system
 +
|   
 +
| [[Kubuntu]], [[Raspbian]]
 +
|-
 +
| TV & [[Personal video recorder|video recording]]
 +
|
 +
| [[MythTV]] / [[VDR]]
 +
|-
 +
| Telephony
 +
|  .  .  . 
 +
| [[Asterisk]]
 +
|-
 +
| Home automation
 +
|
 +
| [[Pluto]]
 +
|-
 +
| Surveillance camera recording
 +
|
 +
| [[Motion]]
 +
|-
 +
| Video plaback
 +
|
 +
| [[Xine]], [[omxplayer]], [[VLC]]
 +
|}
  
−
There will also be Microsoft Windows compatible network shares on the Core or Hybrid (uses Samba) . There is a "public" share for putting all files that the whole family can share--movies, music, etc. And there is a private share for each family member. To access these network shares in Windows, choose Start, Run, and type \\ plus the IP address of the Core or hybrid.  
+
Each software module has a detailed section which explains how to use, configure, and program it. The [[Software components#LinuxMCE Home Software Sections|LinuxMCE Home Software Sections]] is a menu that lists all the software modules included in LinuxMCE. You can use it to explore each of the software components that are part of LinuxMCE.
  
−
For example: \\192.168.80.1 Note that if you add new family members, their network share will not be available until after you reboot the Core/Hybrid. Once you copy your media into the appropriate folder, you can go into the LinuxMCE Admin Website, choose "Files & Media" and "Media Files Sync" to be sure your media is in the database, add attributes (artist, actor, etc.), and choose cover art.
+
Since each of the software components have their own websites and development communities, you will find yourself at home with the ones that are familiar to you. Feel free to expand on what the community has already done by [[Contributing to LMCE|adding your contributions]] to the {{l}} community effort.
 +
{{p}}
  
−
==Using LinuxMCE==
+
=== Open Source and licensing ===
−
LinuxMCE is a complicated piece of software, so proper understanding of each of the components makes for a better experience.  [[Usage Intro | CLICK HERE]] for a quick introduction and description of the terms needed to understand most to best use LinuxMCE.
+
More information regarding LinuxMCE's relationship to Open Source can be found on the following pages:
 +
:* [[Open Source Info|Open Source information]]  
 +
:* [[License|License information]]
 +
:* What to do if you're an [http://LinuxMCE.com/index.php?section=developer Open Source developer]
 +
:* LinuxMCE's [http://LinuxMCE.com/index.php?section=letter Open Source strategy]
  
−
* [[Usage Intro]]
+
{{p}}
−
* [[What%27s_an_Orbiter|What's an Orbiter]]
+
  
−
===Orbiter Interface===
+
== The LinuxMCE system ==
 +
This section introduces you to the components of the LinuxMCE system and explains what each system component's role is. Once familiar with the system as a whole, you'll be able proceed to the tutorials section to learn how to choose your hardware, then install, configure, and use each of the system components.
 +
{{p}}
  
−
The Orbiter is quite simple to use, and all the screens are quite straightforward. Use the [[LinuxMCE Admin Website]] to configure your LinuxMCE system, including choosing the options on your Orbiter, such as lighting scenes, climate scenarios, and define what a/v equipment you want it to control.
+
====LinuxMCE terminology====
 +
{{l}} uses a planetary system terminology to refer to its components. The original project, [[pluto|PlutoHome]], used the celestial body Pluto and its orbiting moons as an analogy, and named its components after them. {{l}} grew from it and kept the terminology. <br>
 +
This section introduces you to the terminology used when refering to {{l}} components. For a brief definition of the names of celestial objects, see [[Astronomical bodies defined]] 
 +
{{p}}
  
−
====Media Director Orbiter====
+
==== Composition of a LinuxMCE system ====
−
[[Image:Main-menu.jpg|200px|thumb|Main Orbiter Screen]]
+
LinuxMCE enables various hardware devices to operate together as a system. At the heart of the system lies a server called the Core, which coordinates the interactions of all the hardware components that make up the system. <br>
−
Orbiter is just our way of saying remote control. All the Media Directors run an on-screen Orbiter, like the one below. Choose options on the on-screen orbiter with a keyboard/mouse attached to the media director, or with an infrared remote control. The Orbiter software runs on Linux, Windows and Windows CE, and can also be run on webpads and PDA's. Either way, it works exactly the same.
+
  
−
In the lower right on the main obiter screen are the [[Who Am I, Where Am I|'who' and 'where']] buttons. This indicates what room you are in, or want to control, and which family member is using the Orbiter.
+
A LinuxMCE system is made of the following components:
 +
[[Image:Diagram1.jpg|200px|right]]
 +
:# [[#The Core | The Core]]
 +
:# [[#Media Directors | Media Directors]]
 +
:# [[#Orbiters | Orbiters]]
 +
:# [[#Security | Security]]
 +
:# [[#Home Automation|Home Automation]]
 +
:# [[#Telecom | Telecom]]
 +
:# [[#Network Attached Storage (NAS) | Network Attached Storage (NAS)]]
  
−
Touch either button if this isn't correct. Even if you are using an on-screen orbiter on the media director in the Living Room, for example, you can still change the location to the Bedroom. That means you would be using the Media Director in the Living Room as a remote control for the devices in the bedroom. Normally you don't change the location for an on-screen orbiter, since that device stays in a fixed place, but you do when you have a wireless web pad or pda you carry around.
+
==== The Core ====
−
[[Image:Litscen.jpg|200px|thumb|Lighting Scenario Page LinuxMCE Admin Website]]
+
A Core is a single dedicated PC acting as a server that interacts with all the components of the system. It is the heart and brain of the LinuxMCE system. You can read more about it on the [[Core]] page.
−
The icons on the left all lead to a [[maps]], or floorplan, of your house showing your lighting, media, climate, telecom and security devices. Next to each of the floorplan icons are the scenarios for that category and the given room. In the scenarios section of the LinuxMCE Admin web site you create the scenarios for each room. You can have a lighting scenario called 'entertaining guests' that sets some lights, plays some background music, unlocks the door, and so on.
+
  
−
'''NOTE:'''
+
===== Personal Computing with the Core =====
−
Many orbiters have relatively slow processors (like PDA's and phones) and may be running on slow wi-fi connections. So, the orbiters do not retrieve the large, full-size graphics, scaling them, drawing the text, and rendering everything on the fly.  
+
LinuxMCE is running Kubuntu Linux, complete with Office suites and all the programs you would need for everyday Personal Computing. See details on [[Personal Computing|Personal Computing with LinuxMCE]].
  
−
Rather all the graphics on your Orbiter are pre-scaled and pre-rendered by OrbiterGen. This means that if you add new scenarios or devices, or change floorplans or skins, you won't see them immediately on the Orbiter. You must go to the 'Advanced Options' page by clicking the LinuxMCE logo on the main menu, and choose 'Regenerate this Orbiter'. You'll be asked to wait about 60 seconds or so while the renderer creates new graphics, and then the Orbiter will reload.
+
==== Media Directors ====
 +
A '''Media Director'''  (also known as a '''Media Station''' or '''Media Manager''') is a system running LinuxMCE that is connected to a TV or sound system to deliver music and video. In your entertainment area, it serves as the player for media that you watch on your TV, or listen to on your sound system. The Media Director in a LinuxMCE system is hooked up to a TV or stereo, and becomes an integrated media player, PVR, video conferencing station, intercom, and, a monitoring and control portal for everything in the home. All Media Directors work together seamlessly as a whole-house solution offering the same convenience throughout the house.  
  
−
====Mobile Orbiter====
+
To learn more, read [[Media Director]].
  
−
Unless you turned off the "Auto Detect new Bluetooth Phones" option for the Media Director, compatible Bluetooth Mobile phones will automatically be detected when they are within range of any Media Director if they have Bluetooth turned on. A message will appear on all the Orbiters asking if it's a phone, and if so, to whom it belongs. Be sure you add your family members to the LinuxMCE Admin web site before doing this. Also, you may need to turn on the TV to see the message on the on-screen orbiter.
+
==== Orbiters ====
 +
'''Orbiters''' are remote controls. An [[Orbiter]] is a LinuxMCE interface device running our intelligent control software. It can run on a variety of devices ranging from mobile phones (Android/iOS/Symbian), to PCs, including PDAs, tablet PCs, laptops, and any web browser enabled device. <br>
 +
The purpose of an orbiter is to send commands to devices in the LinuxMCE system. <br>
 +
To learn all about it, read [[Orbiters]].
  
−
If you choose to install the software, the phone will beep. Just hit 'yes' to accept the software, and accept the default prompts.
+
==== Security ====
 +
Security is an integral part of LinuxMCE. Security functions include light control, surveillance camera monitoring, and motion detection. Events can be triggered based on detected motion or various sensors. LinuxMCE can send alerts to your mobile phone, set your alarm based on different schedules and scenarios, and even automatically lock the door when you leave your home. Find out more on the [[Security]] page.
  
−
The mobile orbiter works pretty much like a regular orbiter. The difference is that you don't usually need to worry about the "who" and "where" button. The "who" is determined when you chose to install the software. That family member is assumed to always be the user. And the "where" is automatic-whenever you come within range of a media director it will automatically switch to the correct location. You can press the button under the location if you want to control a location other than the one you are in.
+
==== Home Automation ====
 +
The '''Home Automation''' features of LinuxMCE attempt to be as convenient as possible and energy-efficient. With Home Automation you can control lights, climate and even the whereabouts of music or video played in your home. Many devices, including mobile phones, can be turned into remote controls for your entire house.
  
−
Since the display is smaller, rather than showing all the scenarios on the main menu, you must first choose the category, like lighting, and then choose the scenario from the sub menu that appears. You can also hold the category to toggle 'follow-me' mode, indicated with a red F. So, if you hold down the 2 button, a red F appears for media. Now as you move around the house your media will follow you. All 5 categories have follow-me.
+
[[Home Automation|More about Home Automation]]
  
−
===General Usage Pages===
+
==== 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. You can permit the system to keep track of where you are in the house and route incoming calls to the nearest phone in your home, or to your mobile phone if you're not at home.  Incoming calls will automatically pause any playing media, in the area you are in, allowing you to take calls without you missing a moment of your media experience.
  
−
====Lights====
+
[[Telecom|More about Telecom]]
−
* [[Control lights/climate using scenarios | Control Lighting Devices with Scenarios]]
+
−
* [[Control lights or climate with a floorplan | Control Lights from the Floorplan]]
+
  
−
====Media====
+
==== Network Attached Storage (NAS) ====
 +
You can extend your LinuxMCE system's storage with a NAS device for your music and video collection.  LinuxMCE can automatically use designated devices for storage requirements including PVR functions and general media storage for audio/video/photos.
  
−
=====Controlling Equipment=====
+
When you connect a NAS to the network LinuxMCE will automatically recognize it and ask you how to integrate it into the system. See [[Network Attached Storage]]
−
* [[Have LinuxMCE automatically control the TV and Stereo]]
+
−
* [[Control the media director's volume using either a receiver]]
+
−
* [[Use network audio players for a whole-house music solution]]
+
−
* [[Use a satellite/cable box with the PVR]]
+
−
* [[Control a TV or cable/satellite box]]
+
−
* [[Control regular A/V equipment]]
+
−
* [[Control A/V equipment with RS232/USB/Ethernet]]
+
  
−
=====Using Portable Media=====
+
{{p}}
−
* [[Watch a DVD/Listen to a CD]]
+
−
* [[Rip a CD/DVD to the Core]]
+
−
* [[Watch/Listen to media stored on the Core]]
+
−
* [[Play the same media in multiple rooms simultaneously]]
+
  
−
=====Media Attributes=====
+
== Understanding LinuxMCE operation ==
−
* [[Flag media stored on the core as private]]
+
At its core, LinuxMCE is a router connected to a bus, running with a communication protocol called DCE. You can think of a LinuxMCE installation as a stack of devices that connect to the bus to communicate to the DCE Router using the DCE protocol.
−
* [[Flag whatever media I am watching now as private]]
+
{{p}}
−
* [[Catalog media with attributes]]
+
−
* [[Search for media by attributes using the Orbiters]]
+
−
* [[Make LinuxMCE do something when I start media]]
+
−
* [[Have my media follow me]]
+
−
* [[How are media files organized?]]
+
−
* [[Use my own pictures in the Screen Saver]]
+
  
−
====Climate====
+
===The DCE protocol===
−
* [[Control lights/climate using scenarios | Control Climate Devices with Scenarios]]
+
DCE is the protocol used by {{l}} system components to interact. With DCE, hardware and software of different native protocols can:
−
* [[Control lights or climate with a floorplan | Control Climate from the Floorplan]]
+
* communicate with each other using a set of well defined and accepted commands (On, Off, Volume Up, Volume Down, Mute, Press 0 through 9, etc.)
 +
* emit events to notify that something happened
 +
* hold configuration (this light switch is ON, it connects to port B on the interface, etc.)
  
−
====Telecom====
 
−
* [[LinuxMCE telecom features | General Usage Guide]]
 
−
* Make phone calls using a VOIP provider listed at [[VOIP Service Providers]].
 
−
* [[Manual Phones Configuration | How to Configure Phone Lines Manually]]
 
−
* Make phone calls using a regular phone line (POTS), ISDN or T1
 
−
* Do video conferencing
 
  
−
====Security====
+
The acronym DCE comes from the three major operations performed using the protocol: Data, Commands, and Events. <br>
−
* [[Monitor surveillance cameras]]
+
−
* [[Arm or disarm the alarm using the Orbiters]]
+
−
* Arm or disarm LinuxMCE's alarm using proximity sensors
+
−
* [[Automatically take pictures when sensors are disturbed]]
+
−
* [[Have LinuxMCE notify me of security alerts]]
+
−
====Advanced====
+
  
−
===LinuxMCE Admin Website===
+
A DCE device can:
−
* [[LinuxMCE Admin Website]]
+
:# Set/Retrieve configuration which we call device ''''''<big>D</big>'''ata'''
 +
:# Perform a ''''''<big>C</big>'''ommand''' (turn on, turn off, fast forward, etc.)
 +
:# Send/Report ''''''<big>E</big>'''vents''' (e.g. 'motion detected', 'playback started', etc.)
  
−
==Troubleshooting==
+
For a list of the protocols {{l}} supports, see [[Automation#Automation protocols|Automation protocols]]
 +
{{p}}
  
−
This troubleshooting guide assumes some basic knowledge of Linux. In LinuxMCE, everything is a device. In the [[LinuxMCE Admin Website]], you can choose [[Devices]], to see a list of all the devices in your installation. We recommend you don't make changes here - you can break things! The top level device is usually a computer, either the core or a hybrid or an orbiter. All the logs for the devices on that computer are stored in /var/log/pluto. You can ssh in to the core using the root password you chose, and from there, you can ssh to all the media directors-shared keys were automatically setup.
+
=== Devices ===
 +
{{#lsth:Devices|What is a Device?}}
  
−
All current activity is logged in the file that ends in ".log". At bootup, certain device logs are archived into /var/log/pluto/*.log.*.gz files
+
=== Scenarios ===
 +
{{#lsth:Scenarios|What is a Scenario?}}
 +
=== Events ===
 +
Devices report events, such as 'Playback started' and 'Motion Sensor tripped'. If you want something to happen automatically in LinuxMCE, you can 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.  
  
−
All DCE devices are running in separate screen sessions. Type "screen -ls" to see all active screen sessions,
+
LinuxMCE will create several default event handlers. In rooms which you have a TV and lights an event handler is created that listens for the 'Watching Media' event sent by a media player and , when detected, the Showtime scenario (which dims the lights) is executed in response. So when you start a movie the Showtime Scenario will be executed and the lights will be dimmed. LinuxMCE also includes other default event handlers that monitor for events like 'Security Breach' and 'Fire Alarm' (from connected sensors or security systems).
−
and "screen -r PID" where PID is the id you saw in the -ls list to attach to the screen session. There is not much for you to do or see though since all the output on stderr and stdout is going into the logs. [[DCERouter]] is running the same way on your core or hybrid.
+
{{p}}
  
−
At bootup, all the scripts listed in the [[LinuxMCE Admin Website]] under [[Boot Sequence]] are run. If any programs crash, a core dump file is put in /usr/pluto/coredump.  
+
=== Interactions ===
 +
Commands (usually groups of commands) are arranged in Scenarios that control devices in the home when activated. Orbiters ("remote controls") load user interfaces that have buttons (Scenarios) used to send commands to the system. Devices will report events to the Core, which will then uses the information to send predefined commands (Scenarios) and setup the state of the system through the house. The Core coordinates interaction between devices. Each device responds to commands based on its intent and the magic of automation happens.
  
−
If you're a programmer, you can also check out our [[Programmer's Guide]].  If you want to learn about writing DCE Devices, see the [[DCE]].
+
{{p}}
  
−
*[[Testing and troubleshooting devices]]
+
== How to get started with LinuxMCE ==
−
*[[Development status for all modules|What works and what doesn't?]]
+
Next, go to the [[How to get started with LinuxMCE]] to learn how to install, and start using the system.
  
−
==Other Items of Concern==
+
{{p}}
−
*[[Security & Privacy Issues]]
+
−
*[[Installing Dansguardian]]
+
−
*[[Add support for new remote controls]]
+
−
*[[Automatic diskless boot of media directors]]
+
−
*[[Change the look and feel of the Orbiter]]
+
−
*[[Create my own skins or GUI for LinuxMCE]]
+
−
*[[Translate the GUI into another language]]
+

Latest revision as of 02:59, 22 March 2016

Welcome to LinuxMCE,
home of the home of the future.

What is LinuxMCE?

Though this distribution is called Linux Media Center Edition (LinuxMCE), it is not just a media center. It was so named because its main component was a replacement for other Operating Systems that at the time were called Media Center Editions. LinuxMCE's primary functions are integration and automation. It is much more than a media powerhouse. With LinuxMCE, you can integrate most automation technologies and enable them to inter-operate using their native automation protocols because at its core, LinuxMCE is a multi-protocol automation gateway.

Built on the solid foundation laid down by Debian and Ubuntu, LinuxMCE is a free and open source Linux distribution designed to allow a computer to act as:

  • a home automation, lighting, and climate control system
  • a home theater PC (HTPC) for the living-room TV
  • a personal video recorder (PVR)
  • a surveillance and security system
  • a VoIP phone system


LinuxMCE is loaded with all kinds of features for the home of the future. It is designed to completely control the environment both inside and outside your home. Along with media features including the ability to record and playback audio and video, LinuxMCE is capable of enhancing your home environment by setting the desired room temperature and luminosity (controlling the blinds, curtains, lights, and thermostat), silencing the phone (or pausing the media while you're on the phone), setting the alarm, locking the doors, and switching devices on (and off) at any time you desire. With the level of integration that LinuxMCE provides, you can control your home, and, enjoy the added benefit of the use of the included telephone and intercom system, security system monitor, media controller, etc...

LinuxMCE ties them all together using an advanced messaging infrastructure that enables it to act as your whole home automation controller.


You can read more about it on the LinuxMCE site and on Wikipedia.

LinuxMCE software components

LinuxMCE brings together a number of software components in an integrated environment. It is a collection of many pieces of open source software.
Each LinuxMCE installation is a custom mix made of a selection of devices, plug-ins, and other modules. LinuxMCE's primary documentation aims to explain how LinuxMCE works, how to install it, set it up, and use it. Many devices have already been tested for easy setup and are Plug 'n' Play. Feel free to consult the ever growing HCL. If you are new to LinuxMCE, try to start with devices that are known to work with LinuxMCE, then move on to more advanced things. If you are unsure, please ask on the forums or in IRC Chat.

Here is a list of some of the software components that make LinuxMCE run:

Functionality Platform/software used
Operating system Kubuntu, Raspbian
TV & video recording MythTV / VDR
Telephony . . . Asterisk
Home automation Pluto
Surveillance camera recording Motion
Video plaback Xine, omxplayer, VLC

Each software module has a detailed section which explains how to use, configure, and program it. The LinuxMCE Home Software Sections is a menu that lists all the software modules included in LinuxMCE. You can use it to explore each of the software components that are part of LinuxMCE.

Since each of the software components have their own websites and development communities, you will find yourself at home with the ones that are familiar to you. Feel free to expand on what the community has already done by adding your contributions to the LinuxMCE community effort.

Open Source and licensing

More information regarding LinuxMCE's relationship to Open Source can be found on the following pages:



The LinuxMCE system

This section introduces you to the components of the LinuxMCE system and explains what each system component's role is. Once familiar with the system as a whole, you'll be able proceed to the tutorials section to learn how to choose your hardware, then install, configure, and use each of the system components.

LinuxMCE terminology

LinuxMCE uses a planetary system terminology to refer to its components. The original project, PlutoHome, used the celestial body Pluto and its orbiting moons as an analogy, and named its components after them. LinuxMCE grew from it and kept the terminology.
This section introduces you to the terminology used when refering to LinuxMCE components. For a brief definition of the names of celestial objects, see Astronomical bodies defined

Composition of a LinuxMCE system

LinuxMCE enables various hardware devices to operate together as a system. At the heart of the system lies a server called the Core, which coordinates the interactions of all the hardware components that make up the system.

A LinuxMCE system is made of the following components:

Diagram1.jpg
  1. The Core
  2. Media Directors
  3. Orbiters
  4. Security
  5. Home Automation
  6. Telecom
  7. Network Attached Storage (NAS)

The Core

A Core is a single dedicated PC acting as a server that interacts with all the components of the system. It is the heart and brain of the LinuxMCE system. You can read more about it on the Core page.

Personal Computing with the Core

LinuxMCE is running Kubuntu Linux, complete with Office suites and all the programs you would need for everyday Personal Computing. See details on Personal Computing with LinuxMCE.

Media Directors

A Media Director (also known as a Media Station or Media Manager) is a system running LinuxMCE that is connected to a TV or sound system to deliver music and video. In your entertainment area, it serves as the player for media that you watch on your TV, or listen to on your sound system. The Media Director in a LinuxMCE system is hooked up to a TV or stereo, and becomes an integrated media player, PVR, video conferencing station, intercom, and, a monitoring and control portal for everything in the home. All Media Directors work together seamlessly as a whole-house solution offering the same convenience throughout the house.

To learn more, read Media Director.

Orbiters

Orbiters are remote controls. An Orbiter is a LinuxMCE interface device running our intelligent control software. It can run on a variety of devices ranging from mobile phones (Android/iOS/Symbian), to PCs, including PDAs, tablet PCs, laptops, and any web browser enabled device.
The purpose of an orbiter is to send commands to devices in the LinuxMCE system.
To learn all about it, read Orbiters.

Security

Security is an integral part of LinuxMCE. Security functions include light control, surveillance camera monitoring, and motion detection. Events can be triggered based on detected motion or various sensors. LinuxMCE can send alerts to your mobile phone, set your alarm based on different schedules and scenarios, and even automatically lock the door when you leave your home. Find out more on the Security page.

Home Automation

The Home Automation features of LinuxMCE attempt to be as convenient as possible and energy-efficient. With Home Automation you can control lights, climate and even the whereabouts of music or video played in your home. Many devices, including mobile phones, can be turned into remote controls for your entire house.

More about Home Automation

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. You can permit the system to keep track of where you are in the house and route incoming calls to the nearest phone in your home, or to your mobile phone if you're not at home. Incoming calls will automatically pause any playing media, in the area you are in, allowing you to take calls without you missing a moment of your media experience.

More about Telecom

Network Attached Storage (NAS)

You can extend your LinuxMCE system's storage with a NAS device for your music and video collection. LinuxMCE can automatically use designated devices for storage requirements including PVR functions and general media storage for audio/video/photos.

When you connect a NAS to the network LinuxMCE will automatically recognize it and ask you how to integrate it into the system. See Network Attached Storage



Understanding LinuxMCE operation

At its core, LinuxMCE is a router connected to a bus, running with a communication protocol called DCE. You can think of a LinuxMCE installation as a stack of devices that connect to the bus to communicate to the DCE Router using the DCE protocol.

The DCE protocol

DCE is the protocol used by LinuxMCE system components to interact. With DCE, hardware and software of different native protocols can:

  • communicate with each other using a set of well defined and accepted commands (On, Off, Volume Up, Volume Down, Mute, Press 0 through 9, etc.)
  • emit events to notify that something happened
  • hold configuration (this light switch is ON, it connects to port B on the interface, etc.)


The acronym DCE comes from the three major operations performed using the protocol: Data, Commands, and Events.

A DCE device can:

  1. Set/Retrieve configuration which we call device 'D'ata
  2. Perform a 'C'ommand (turn on, turn off, fast forward, etc.)
  3. Send/Report 'E'vents (e.g. 'motion detected', 'playback started', etc.)

For a list of the protocols LinuxMCE supports, see Automation protocols

Devices

For the purpose of consistency throughout this documentation, hardware equipment will be called "hardware device". The generic term "device" is used to refer to the software object in LinuxMCE that enables DCE communication between hardware and software components in the LinuxMCE system.

The LinuxMCE Core is a router that LinuxMCE system components use to communicate using the DCE protocol. Hardware devices and software without DCE capability can not send and receive communications over the DCE bus. LinuxMCE solves the problem by creating software "devices" that connect to the DCE bus for the purpose of translating hardware and software native communications into DCE. At the moment, no hardware is manufactured specifically with the DCE protocol. To control a hardware device with LinuxMCE, a corresponding software device is created. Each LinuxMCE system component has a corresponding "device" that it uses to communicate in DCE with the other LinuxMCE system components.

A device is a software object in LinuxMCE that connects a software or hardware component to the DCE bus to enable it communicate with the other LinuxMCE system components using the DCE protocol, translating various hardware and software communications into DCE when necessary.




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).
To perform an action in LinuxMCE, a scenario is chosen from the ones created by the user, or from one of the categories that are created by default during installation (located on the main menu of an Orbiter).

Each scenario is a group of commands, or tasks, that appears on the Orbiter as a button.



Events

Devices report events, such as 'Playback started' and 'Motion Sensor tripped'. If you want something to happen automatically in LinuxMCE, you can 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 will create several default event handlers. In rooms which you have a TV and lights an event handler is created that listens for the 'Watching Media' event sent by a media player and , when detected, the Showtime scenario (which dims the lights) is executed in response. So when you start a movie the Showtime Scenario will be executed and the lights will be dimmed. LinuxMCE also includes other default event handlers that monitor for events like 'Security Breach' and 'Fire Alarm' (from connected sensors or security systems).

Interactions

Commands (usually groups of commands) are arranged in Scenarios that control devices in the home when activated. Orbiters ("remote controls") load user interfaces that have buttons (Scenarios) used to send commands to the system. Devices will report events to the Core, which will then uses the information to send predefined commands (Scenarios) and setup the state of the system through the house. The Core coordinates interaction between devices. Each device responds to commands based on its intent and the magic of automation happens.



How to get started with LinuxMCE

Next, go to the How to get started with LinuxMCE to learn how to install, and start using the system.



Retrieved from "http://wiki.linuxmce.org/index.php?title=User_Manual&oldid=36595"