LinuxMCE - User contributions [en]

Make a DCE Device in 5 minutes

2012-01-22T01:37:36Z

Buggman:

[[Category: Programmer's Guide]]

There are 2 ways to add a new device.
* For most external devices that are controlled by RS232, USB or Ethernet, you can use GSD (Generic Serial Device). There is a 'fill-in-the-blanks' web form for you to specify the protocol--no programming is required. GSD also includes an embedded Ruby-language processor, so you can do almost anything and even complex, sophisticated devices can be created easily. Whatever protocol and Ruby commands you input are automatically sent back to our master database and shared with all other LinuxMCE users, so everyone can use the device (you can turn this option off). Nearly all external devices, like home automation components, use GSD.
* We also have a generator that will build you a cross-platform C++ project. LinuxMCE's sophisticated, internal devices like Bluetooth communication, software media players, etc. are all written in C/C++.

Either way,
# Define the data, commands and events for your device. Go to the [[LinuxMCE Admin Website]] that was installed on your computer when you installed LinuxMCE. Login, and choose "Advanced", "Device Templates".
## Find an existing device that has a similar function to the one you want to create
## Choose an existing manufacturer and/or category to see some the devices in the "Models" list
## Click edit to view the device's data, commands and events
## Note that the commands are put into 'groups', so you will need to click on the command group to see the commands that device implements
## Now figure out what data, commands and events your device will use. You can also click on "Advanced", "DCE" to view a list of all the commands in the system and which devices implement them. The data parameters is not really important. It can be anything your device will need to run. For example, if the device is going to control some equipment via RS232, you'll want a parameter to indicate the COM port.
# Figure out what command your device will want to implement. Here it's more important to try to use the same commands in the same way as other, similar devices. This will mean that the remote controls (Orbiters) for those devices will work for yours too.
# Also, other developers may expect your device to implement a logical command. For example, someone may develop a doorbell device, which allows the user to pause all his media when someone is at the door so he will hear the bell. The doorbell device may, therefore, send a "Pause" command destined to every device in the house of the category "Media Player", expecting that any media player should know what that means.
# From the Device Template list page there is also a link to manage commands which lets you see all the existing commands, what parameters they take, what devices implement them, and how, so that you can be sure your device is capable of behaving in a similar manner. Of course, you can add as much custom functionality as you want, but it's recommended that your device implements at least the basics in a consistent manner. On/Off, skip forward, skip back, etc.
# Decide on what events your device should fire. Again, try to use the same events in the same way as similar devices. The user may have created an event handler, for example, that turns on a siren when the "Security Breach" event is detected. If you are making a device for an alarm panel and see that the other panels fire the "Security Breach" event, then if yours fires the same event other users can swap his current panel for yours and know that all his event handlers will still work. Once you decided on the data, commands and events, you've done the hard part.
# Now just go back to the [[List Page]] page, choose the manufacturer, or add one, and choose a category.
# Once those are chosen, the 'add new' box is available under the Models list. Type in a descriptive name for your device, and click 'add'.
# You are now on the [[Edit Page]] page. Check that the device implements DCE. You can leave alone the remotes, controlled via, package and a/v sections for now.
# Add your device's data parameters. You can use an existing parameter if it's applicable, or add one. The name is really just a description.
# You will see here all the Command Groups that other devices in this category already implement. Click 'Edit Commands' to see what commands are in that group.
# If there is a group that is appropriate for your device, just enable it to add those commands to your device.
# You can also create one more new groups. All commands in all groups you select will be implemented by your device.
# Then add the commands to your device, explaining how your device implements them.
# You can also add new commands. When adding the parameters for your commands, you can make the parameters "out" parameters. This means when another device sends you the command, you will get a pointer to this parameter--rather than the parameter itself. You just assign the value you want to return, and the other device that sent you the command will see it.
# Lastly, add the events, and click save.
# Now, decide how you want to implement your device. Choose one of the following: [[GSD]] or [[Cpp]].

LinuxMCE Admin Website

2012-01-21T23:41:29Z

Buggman:

[[Category: Documentation]]

[[Category: Programmer's Guide]]
{| 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===
* Choose '''Advanced''' -> '''Computing''' -> '''Web Admin''' from the menu

===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:

=Development=
Doing development against the linuxMCE web administration requires acessing the files either locally with your editor of choice, or even remotely. Its also a good idea to install phpmyadmin, which will let you view the tables and such associated with the linuxMCE installation your working with. The web admin is located on your core in '''/var/www/lmce-admin''' and in the svn under 'web'.

It currently employs a large index file with case switching for the majority of pages, with those pages then leading to others relating to their specific function. The database also employs ADODB for most of the operations involving database transactions. Pages involve the use of template's with javascript objects writing data to the page. Please note, this is '''quite the basic''' overview.

==Network Share Method==

The most simple method of making '''/lmce-admin''' available for editing outside of the core on your local network involves modifying samba. Please note: samba fixes itself on reboot and you will need to modify the config again to regain access to the files.

Edit '''/etc/samba/samba.conf''' and add this before the last line:

[www]
comment = Web server files
browseable = yes
writable = yes
create mask = 0770
directory mask = 0770
path = /var/www
public = no
guest ok = no
force user = www-data
force group = www-data

Then restart samba by typing into the console
/etc/init.d/samba restart

And now the lmce-admin directory will appear as a share on the local network.

==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

Installation Guide

2012-01-21T02:49:27Z

Buggman:

{| align="right"
| __TOC__
|}
==About Installation (Version 0810 Final)==

This page covers what we'll call mainstream installation. It shows how to get a LinuxMCE hybrid running with minimum bells and whistles. Once the basic installation is complete, users can look at the other sections of the wiki to learn how to add more advanced features. The basic hardware consists of the computer, display, and speakers. Look at the "Core & Hybrid" section of the wiki for hardware selection articles. Here is some pre-flight advice before installation.

*The computer must be connected to the internet for a successful installation.
*Recommend using a monitor for the initial install. Monitors are better than TVs for adapting to a wacky resolution setting (it could happen). You probably don't want to mess about with xorg.conf on your first install. Also recommend using a VGA cable because that is the default setting when the LMCE wizard pops up. I'd specifically advise against using an HDMI cable and expecting it to pass video and sound to your TV. It might work, but more likely it will require extensive tinkering. Its easy to swap to a different display or connection after things are up and running.
*For sound, you can use computer speakers, or use an spdif connection to an external AV receiver. This is also easy to change later.
*If you have a TV capture card, it will be configured during the installation. The wizard will ask where to get program guide information. In the US this is usually "schedulesdirect.org". Set up your account and know your username and password before starting the install.

==Caveats==

*LinuxMCE is an extremely powerful, fantastic piece of software; have no doubt about that. But, please bear in mind that it is a project, not a product.

*LinuxMCE 0810 is based on Ubuntu 8.10, which means that brand new hardware might not work out of the box. For this reason, if you are buying hardware specifically for your home automation system, you might want to use hardware that is a little older and save yourself some money at the same time. That said, in nearly all cases you will be able to get through any issues with a little patience and some help from the community. Unrecognised NICs is the most common issue.

*Please please please be patient. Some parts of the installation can sometimes take hours. If in doubt, leave it overnight.

==Basic Installation Steps==

I might help to think of installation as a 3-step process.
*Run the DVD. This formats your drive, installs Kubuntu, and preps for LMCE installation. This step finishes by prompting reboot and DVD removal.
*Install LinuxMCE. The reboot will take you to the Kubuntu screen. You'll recheck your internet connection, then click the LMCE install icon. More software will load and it will prompt another reboot.
*Complete the 3 wizards (AV, House Setup, Media). This is where you tell LMCE about your system.

===Run the DVD===

'''Caution: Installing LinuxMCE 0810 Final will wipe your entire drive! It is not designed to be dual-booted!'''

'''If you just want to quickly try LinuxMCE, then consider setting it up temporarily as a virtual machine on your Linux, Mac, or Windows box. [http://www.virtualbox.org/ VirtualBox] will allow you to do this'''

# Download the LinuxMCE 0810 Final ISO from [http://linuxmce.iptp.org/release/LinuxMCE-8.10-final.iso here]. ''Note: Always burn at your DVD drive's lowest speed to reduce the chance of errors.''
# Boot from the DVD.
# Select your language
# Select the top option "LinuxMCE"
# Wait until the installer loads, and then...
## '''Welcome''' - Select your language.
## '''Where are you?''' - Select your location and time zone.
## '''Keyboard layout''' - Select your keyboard layout.
## '''Prepare disk space''' - Set up your partitions as you wish, but the second option "Guided - use entire disk" is perfectly OK.
## '''Who are you?''' - Set up your username, password and the system name (call it whatever you want). This username/password is specifically for the underlying system i.e. Kubuntu, it is NOT for LinuxMCE; this is handled separately.
## '''Ready to install''' - Check everything is as it should be, and press "Install".
# Let installation run through, and then remove disk and press enter when instructed to do so.

===Install LinuxMCE===

# Once the new Kubuntu installation has finished booting back up, check that your internet connections are working. If you have a NIC that is not plug-and-play (like the Intel gigabit card) then now is the time to install the driver and confirm operation. Then click the "LinuxMCE" icon on the desktop. This will start the LinuxMCE installation. You may need to enter your Kubuntu password.
# Wait until the LinuxMCE installation has finished running through. You will see the following message when the installation is complete:

The first phase of the install process is completed
Reboot the system to start the final process.

===Complete the Wizards===

Upon reboot, you will not see Kubuntu. More software will load, then the AV Wizard will start. If you connected the display with something other than a VGA cable, the screen will go black. You will have to press a number on your keyboard (just the number, don't hit "enter") to tell the wizard what connection to use. The default value is 2: VGA.

<pre> Keys for choosing a connector:

1: DVI
2: VGA
3: Component
4: Composite
5: S-Video
Q: DVI-2
W: VGA-2
L: LVDS</pre>

Then follow the wizards as described in the following links.

*[[AVWizard_Step_by_Step|AV Wizard]]
*[[House_Setup_Wizard|House Setup Wizard]]
*[[Media_Player_Wizard|Media Setup Wizard]].

Tip: After LMCE is up and running, the LinuxMCE installation icon on the Kubuntu desktop becomes a hazard. Clicking it will begin a reinstall and ruin your day. Best to right click and delete the icon!
==Links==

*[[:Category:AV_Wizard|AV Wizard]]
*[[:Category:Installation_Tutorials|General Installation Tutorials]]