MainLobby / HomeSeer Plugin4 Overview If you've been searching for a polished, professional front end for your sophisticated HomeSeer automated home, look no further. MainLobby offers

MainLobby / HomeSeer Plugin (MLHSPlugin)

Installation Manual and User Guide

January, 8th 2005

Latest version of this documentation can be download via http://www.Krumpholzenterprises/MLHSPlugin/MLHSPluginUserGuide.PDF

Copyright © 2005, Krumpholz Enterprises, All Rights Reserved

+

PDF created with pdfFactory trial version www.pdffactory.com

http://www.Krumpholzenterprises/MLHSPlugin/MLHSPluginUserGuide.PDF

http://www.pdffactory.com

2

Table of Contents TABLE OF CONTENTS ........................................................................................................................................ 2 PREFACE ............................................................................................................................................................... 3 OVERVIEW............................................................................................................................................................ 4

PRODUCT REQUIREMENTS...................................................................................................................................... 7 DISCLAIMER/LICENSE AGREEMENT........................................................................................................................ 8 VISIT THE MLHSPLUGIN SUPPORT FORUM FREQUENTLY........................................................................................ 9

INSTALLATION INSTRUCTIONS (START HERE)......................................................................................... 10 DOWNLOADING, INSTALLING, AND CONFIGURING THE HOMESEER MLHSPLUGIN ................................................. 10 DOWNLOADING/INSTALLING/AND CONFIGURING MAINLOBBY SERVER AND MAINLOBBY CLIENT ......................... 13

Downloading MainLobby (ML) Trial or Licensed Product View...................................................................... 13 Installing/Configuring the MainLobby Server MLHSPlugin ............................................................................ 14

SETTING UP A NETWORK ATTACHED MAINLOBBY CLIENT MACHINE: .................................................................. 18 MLHSPLUGIN METHODOLOGY:........................................................................................................................... 21

Summary:....................................................................................................................................................... 22 CREATING YOUR FIRST MAINLOBBY INTERFACE SCREEN .................................................................. 23

MAINLOBBY USER MANUAL OVERVIEW (PLEASE READ)...................................................................................... 23 MainLobby Screen Components...................................................................................................................... 23 Menu Bar....................................................................................................................................................... 24 Assigning actions to a button or graphic: Button Properties Panel.................................................................. 26 Scene Options Panels ..................................................................................................................................... 30

WORKING WITH THE MLHSPLUGIN EXAMPLE ML SCENE..................................................................................... 35 MORE TO COME – UNDER CONSTRUCTION… ........................................................................................................ 38

APPENDIX............................................................................................................................................................ 39 MAINLOBBY BUTTON LIBRARY ........................................................................................................................... 39 MAINLOBBY TO HOMESEER COMMANDS ............................................................................................................. 45

HS_Run: ........................................................................................................................................................ 45 HS_RunEX:.................................................................................................................................................... 46 HS_SendIR: ................................................................................................................................................... 47 HS_WriteLog: ................................................................................................................................................ 48 HS_TriggerEvent: .......................................................................................................................................... 49 HS_DisableEvent: .......................................................................................................................................... 50 HS_EnableEvent: ........................................................................................................................................... 50 HS_SetDeviceString:...................................................................................................................................... 51 HS_SetDeviceStringByName: ......................................................................................................................... 52 HS_SetDeviceValue: ...................................................................................................................................... 53 HS_SetDeviceValueByName:.......................................................................................................................... 54 HS_ExecX10:................................................................................................................................................. 55 HS_ExecX10ByName: .................................................................................................................................... 55 HS_Speak: ..................................................................................................................................................... 58 HS_MuteSpeech:............................................................................................................................................ 59 HS_ClearLog:................................................................................................................................................ 60 HS_Launch:................................................................................................................................................... 61 HS_ControlThermostat: ................................................................................................................................. 62

HOMESEER TO MAINLOBBY COMMANDS ............................................................................................................. 63 HS.Plugin (“MLHSPlugin”).MLServeCMD:................................................................................................... 63 To Send a Text Message to ML Clients for 60 Seconds .................................................................................... 63 Send MLServeCMD from HomeSeer script to change MainLobby Client Scene ............................................... 63



3

Preface I would like to thank all the individuals that have assisted in making this project a reality:

• Smoothtlk • Cinemar (Mario and Dan) • HomeSeer Technologies • Brave Sir Robin (Co-wrote documentation) • GregoryX • JRFUDA • pdfFactory (http://www.pdffactory.com/) – Allows me to publish this document as a pdf

file. • InnoSetup (http://www.jrsoftware.org/) – Application Install Package Utility

You may download the latest version of the MainLobby – HomeSeer Plugin Installation and User Guide from http://www.KrumpholzEnterprises.com/MLHSPlugin/MLHSPluginUserGuide.pdf.


http://www.pdffactory.com/)

http://www.jrsoftware.org/

http://www.KrumpholzEnterprises.com/MLHSPlugin/MLHSPluginUserGuide.pdf


4

Overview

If you've been searching for a polished, professional front end for your sophisticated HomeSeer automated home, look no further. MainLobby offers a configurable high-end graphical front end for media library and control software and HomeSeer provides a flexible and powerful back end. Tie the two together with the MLHSPlugin, and you can create awesome, custom looking screens for your sophisticated automated home. You will get much more value out of your HA investment by easily designing user friendly screens that anyone in your home can use. Not to mention the wows that you will hear by your family and friends!

Want to see some examples of screens that some talented users have created? The enclosed link will connect you to the User Screen Interface Samples page on the MLHSPlugin Message Forum: http://forums.homeseer.com/showthread.php?t=90016


http://forums.homeseer.com/showthread.php?t=90016


5

1.) HomeSeer: (www.homeseer.com) - Backend Automation interface tool

HS is a very powerful home automation system that essentially can control everything from the alarm system, to the devices in the home theater, the weather management system, to lights throughout the home via X10 and ZWave lighting controls. Throughout the five years of using HomeSeer, I have been able to interface and control just about everything and anything using the HomeSeer scripting and plugin architecture, but have always desired a simple to implement yet professional looking front end user interface to my home. So hence came the interest in MainLobby after a 4 hour conversation with Cinemar in summer of 2003 regarding the integration between HomeSeer and MainLobby.

2.) MainLobby/MainLobby Server – Professional Graphical User Interface Tool

MainLobby is the user interface system that allows one to create and display the desired visual interface for your automated home and is installed on all client devices/computers. Supported devices currently are any recent Windows based computer, touch screen, and TabletPC. MainLobby Server is the engine/database and connectivity interface between all Cinemar product offerings, and provides your MainLobby client devices the "status/state" information. MainLobby Server combined with MainLobby (without HomeSeer) has the capability of controlling certain hardware devices directly.

What can you do with MainLobby?

• Control All HomeSeer Home Automation Components • Launch programs, batch files, mp3, cds, dvds, etc. • Add an unlimited number of buttons • Exchange themes with other MainLobby users • Design your own Music or Media Jukebox • Assign keyboard shortcuts to any button • Drag-and-drop elements on to screen (Time clock display) • Create a movie trailers page • Link to family photos and slideshows


http://www.homeseer.com)


6

• Design a simple to use interactive home theater wizard that the whole family can use

• Launch movies from your hard drive and much more • Optional MainLobby add-on Packages (Need to be purchased separately from

Cinemar directly). TVLobby, XMLobby, DVDLobby, MusicLobby, WeatherLobby, and more). For more information, please refer to http://www.cinemaronline.com.

3.) The MainLobby-HomeSeer Two-Way Communication Plugin operates as a technology "data" bridge between HomeSeer and MainLobby Server. This architecture was chosen because it allows each of these services to reside on a single or separate networked computer. The communication between both systems is almost instantaneous.

The MLHSPlugin is actually two components, one plugin for MainLobby Server, and another plugin for HomeSeer. Both of the two plugins connect to each other on startup and immediately communicate information that was configured by the user. Whenever a HomeSeer device state change occurs, the HomeSeer MLHSPlugin is notified and then will send the data to its MainLobby Server MLHSPlugin counterpart. The MainLobby Server will then notify all MainLobby client computers of the updated device state.

When a user clicks on a button via a MainLobby interface screen that is designated to turn on a light, MainLobby Server sends the "Turn light ON" command request via the MLHSPLugin to HomeSeer. HomeSeer then performs the requested task, automatically triggers a device state change, and sends the updated information back to MainLobby Server. MainLobby Server then records the state change and notifies all active MainLobby clients. All of this is seamless to the user.

This architecture allows you the ultimate in flexibility to install HomeSeer and MainLobby Server either on the same computer, or on separate network accessible computers (even separated by the Internet). The MainLobby client software can be available on network connected PC's, wireless touch screen tablets, or even operable using standard remote control devices and a TV.

How it works:

• During execution, the MLHSPlugin HomeSeer plugin creates variables within MainLobby Server (MLServer).

• Subscribed HomeSeer device "value" and device "string" status changes are sent by the MLHSPlugin HomeSeer plugin to the MainLobby Server variables - which can then be displayed on MainLobby clients.

• MainLobby clients can initiate HomeSeer commands and events to manage lights, thermostats, security system, and audio/video devices already controlled by HomeSeer.

• The HomeSeer scripting interface can now initiate MainLobby Server MLServeCmd's. (Very powerful)

New Enhancements:


http://www.cinemaronline.com


7

• HomeSeer Events are now enhanced with an MLHSPlugin Actions tab that will allow you to directly enter an MLServer MLServeCMD. This is useful is situations where you want to configure a event trigger based on some occurrence (for example alarm intrusion) and then want all of the MainLobby client computer to display a message or change to a specific screen.

• Dynamic Graphic Support. You can now configure icons that dynamically change on a MainLobby screen based on the HomeSeer device state.

For more information on what HomeSeer home automation software entails please visit http://www.homeseer.com . For more information on MainLobby, which also has other software packages including Music Lobby, Weather Lobby and DVD Lobby, please visit http://www.cinemaronline.com.

Product Requirements The MainLobby-HomeSeer (MLHSPlugin) requires the following:

Ø Purchase or 30 day trial of MainLobby (MainLobby provides license to MainLobby Server) - www.cinemaronline.com You may enhance your MainLobby visual capability by extending it to manage your Music and DVD collection via MusicLobby and Dvdlobby, Weather updates from Internet via WeatherLobby, and web browsing capability via WebLobby). Products can be purchased individually or as an entire package. Note: 30 day trial offers evaluation of all products in one download!

Ø Purchase or 30 day trial of HomeSeer Home Automation Software - www.homeseer.com

Ø Purchase or 30 day trial of MLHSPlugin (You will receive the HomeSeer and MainLobby Server plugins available for download via HomeSeer Updater (From HomeSeer, select Help, select Updates)


http://www.homeseer.com



http://www.homeseer.com


8

Disclaimer/License Agreement This plug-in provides two-way communication between the MainLobby Server and HomeSeer home automation systems. In order for this plug-in to provide any functionality, the user is therefore required to purchase (or implement the 30 day trial versions) and agree to the software licensing and support terms of all three respective software products. MLHSPlugin is licensed as “personal hobby use only” and requires a license for each HomeSeer installation. Commercial licenses are available and inquiries should be directed to developer. While we make every effort to provide quality software products, and since we cannot test this software in every potential computing environment, the developer of this software does not guarantee that this product is free from defects. The user therefore accepts that this product is provided "AS IS" and its usage is therefore at the users own risk. The developer of this software makes no warranties as to the performance, merchantability, fitness for a particular purpose, upgradeability/compatibility to future MainLobby Suite and/or HomeSeer product versions, or warranties of any kind whether expressed or implied. Product support inquiries regarding Cinemar (MainLobby Suite - www.cinemaronline.com) and HomeSeer Technologies (HomeSeer- www.homeseer.com) should be directed to the respective software provider support forums. Support questions for this product, should be directed to the MLHSPlugin forum on the HomeSeer technologies message board. The developer of this software retains the right to release an advanced version of this plugin with additional MainLobby / HomeSeer integration features in the future. An upgrade charge to switch from the consumer to the advanced version may apply. At the time of this writing, the author of this plugin has had limited accessibility to validate functionality of this software with HomeSeer 2.0. The above statements of pricing and future compatibility are based on "best guess" anticipated development efforts, and therefore, the above statements may change according to the actual efforts required to certify this application with HomeSeer 2.0. Thank you for your support and understanding.


http://www.cinemaronline.com)

http://www.homeseer.com)


9

Visit the MLHSPlugin Support Forum Frequently Be sure to visit the MLHSPlugin support forum frequently as it provides:

• Latest product support information and additional “How to” steps • Latest interim product updates • Related Cinemar product announcements • Interaction with other MLHSPlugin users

The MLHSPlugin support forum is accessible via the HomeSeer Message board via (http://forums.homeseer.com/forumdisplay.php?f=683). We have hosted a Tips, Tricks, and How To guide section in the MainLobby – HomeSeer Plugin-In support forum located here: http://board.homeseer.com/showthread.php?t=101009


http://forums.homeseer.com/forumdisplay.php?f=683

http://board.homeseer.com/showthread.php?t=101009


10

Installation Instructions (Start Here)

This tutorial will help install the software needed, and properly set-up integration to insure proper communication exists between MainLobby and HomeSeer. A sample “switch” setup will also be provided for a MainLobby screen (so it can control a HomeSeer device). Please note that this plugin is really composed of two separate plugins, one for HomeSeer and one for MainLobby. Each plugin will have a setup screen that will need to be configured.

Downloading, Installing, and Configuring the HomeSeer MLHSPlugin The first step is to download the latest MLHSPlugin installation package via the HomeSeer Updater. This installation package will include the plugin for the MainLobby Server (MLHSPlugin.DLL) and the plugin for the HomeSeer application (HSPI.MLHSPlugin.OCX). Once downloaded/installed via the HomeSeer Updater, you will need to add the plugin to the HomeSeer Active Interfaces and configure the plugin. Start the HomeSeer updater by clicking “Help”, then “Updates” from within the HomeSeer main device screen.

Select the “Next” button through the next three screen selections. You will see the HomeSeer Updater launch. When it launches, wait for the multiple colors to appear on the plugin selections. Select the MLHSPlugin (check box). Write down the trial code given in the bottom of this display then click on OK in the lower right corner. The updater will download the compressed plugin files, stop HomeSeer, and then proceed to install the plugin on your computer.



11

Select “Return to HomeSeer” after the plug-in is finished installing. Now go to the “View”, “Options” menu in the main HomeSeer screen. An Options interface box will appear. Click on the “Interfaces” tab. Then click on the combo box down arrow in the Plug-Ins (RF, I/O, Security, Custom) dialog box as shown below. Select the MLHSPlugin:

After selecting the MLHSPlugin, you may now be informed that a valid license key has not been entered and then prompted to enter your serial number or license key (see menu below). At this time, enter the serial number or license key that was allocated to you by the HomeSeer store (www.HomeSeer.Com/Buy.html) or the appropriate trial key via the HomeSeer Updater.


http://www.HomeSeer.Com/Buy.html


12

Once you have completed entering the serial number/license key, click on OK/TRY/UNLOCK to continue. Click on the “OK” button to close the OPTIONS screen and then restart the HomeSeer program. This will properly load the HomeSeer MLHSPlugin.

Once the HomeSeer program restarts you should see the MLHSPlugin option in the top menu bar. Select “MLHSPlugin”, then “Show/Configure Plugin”. If the MLHSPlugin menu is not visible on your menu bar, then select VIEW and Options from the HomeSeer menu bar. You are now presented with the OPTIONS configuration screen. Now select the MLHSPlugin in the ACTIVE INTERFACES dialog box and click on SETUP. The ABOUT MLHSPlugin screen will appear (as shown below). At this time, please read the disclaimer/license agreement. If you agree to these terms, check the “I agree to the license agreement…” and then click OK:

This HomeSeer MLHSPlugin configuration/status screen will now be displayed:



13

Important: Select the “Enable this plugin” option on the bottom left of this screen. Then select the devices you wish to use with MainLobby. Then click on “Subscribe to Above Devices”. Take note of the port that is set to communicate with MainLobby Server’s MLHSPlugin (in this example it is 2410). You have now completed the plugin setup with HomeSeer.

Downloading/Installing/and Configuring MainLobby Server and MainLobby Client Downloading MainLobby (ML) Trial or Licensed Product View

1. Go to the Cinemar website (http://www.cinemaronline.com/mainlobby.html) and click on the “Free Trial” button below the price display to request a fully functional MainLobby trial suite. An Email will be shortly sent to you with the download link.

2. Once you get the Email download the MainLobby/Music Lobby/DVD Lobby trial program file.

3. Now go to the Cinemar website and download the MainLobby Server program (http://www.cinemaronline.com/mlserver.html).

Note all of these software packages have a 30-day (fully functional) free trial. Setting Up MainLobby Server (MLServer):

IMPORTANT: It is suggested to Shutdown HomeSeer before installing the MainLobby Server.


http://www.cinemaronline.com/mainlobby.html

http://www.cinemaronline.com/mlserver.html


14

Shut down HomeSeer. Then double click on the MainLobby Server (mlserversetup_135.exe) file you downloaded from the above link. Accept all the default values during this installation. (It is highly recommended that the default installation path of C:\Program Files\MLServer not be altered!) While HomeSeer is still shut down, go ahead and install the Music Lobby/DVD Lobby/Music Lobby trial. Unzip the file downloaded above (file name is mainlobby_dvdlobby_musiclobbytrial.zip). This will uncompress a “setup.exe” file. Double click on this file to start the setup program. Use all the default settings for this installation as well. (Again, it is highly recommended not to alter the default C:\Program Files\Cinemar main installation path).

Installing/Configuring the MainLobby Server MLHSPlugin

Important: If you forget this step, all of this will not work!

1.) Open your HomeSeer application folder. Usually, this is C:\PROGRAM FILES\HOMESEER. There should be an UPDATES folder, and within the Updates folder should be the MainLobby-HomeSeer Plug-in1.1.0.xx (xx=version #) source directory that the HomeSeer Updater downloaded. By default this would be C:\Program Files\HomeSeer\updates\MainLobby-HomeSeer Plug-In1.1.0.XX. We will now refer to this path as the “MLHSPlugin source installation folder”. 2.) From the MLHSPlugin source installation folder, copy the MLServer MLHSPlugin Install.EXE to the computer that you have installed MLServer on. Now execute the MLServer MLHSPlugin Install.EXE file from the computer that you have installed MLServer on. The following screen should be displayed:



15

Click NEXT

Please read. If you are executing this file on the computer where MLServer is installed on then click NEXT.

Now enter the path to where the MLServer\Plugins directory is. By default MLServer\Plugins directory is in the c:\program

files\mlserver\plugins folder. Click NEXT



16

Click INSTALL followed by FINISH.

3.) Copy the MLHSPluginExample.MLS file (located in the MLHSPlugin source installation folder) to your MainLobby Cinemar folder. On a default installation, this folder is located in C:\Program Files\Cinemar. If MainLobby has not been installed (per the instructions, you have only installed MainLobby Server so far), then remember to perform this step later. After installing and registering all of the Cinemar MainLobby software according to the above directions, double-click on the MainLobby Server’s icon to launch the MainLobby Server program. You should see the menu below:



17

You can select the check boxes “Start Server on Startup” and “Minimize on Startup” depending on your desired restart methods. Do not start the MainLobby Server at this time. In the bottom “Plug-Ins” text box select the MLHSPlugin and then click on the “Settings” button (to the right). This will now bring up the following menu:



18

This menu looks very similar to the HomeSeer MainLobby’s plugin setup screen. You can tell the difference by looking at the top title bar (MainLobby Server says “MainLobby Server MLHSPlugin – Settings Screen”, HomeSeer says “HomeSeer MLHS Plugin”). Note that for this particular example we are going to place the MainLobby Server on the same computer as the HomeSeer server. Therefore the HomeSeer Computer Name of “localhost” and HomeSeer Computer TCP Port need to be 2410 in both the HomeSeer and MainLobby setup screens mentioned above. Also, select the “Enable this plugin” setting on the lower left. Then click on “OK”. Your MainLobby HomeSeer plugins setup is now complete.

Setting Up A Network Attached MainLobby Client Machine: Running a MainLobby screen on a client machine requires the machine to be on your internal “LAN” network. For this example we are assuming the client machine and server machines are behind the same firewall and do not require any ports to be opened or forwarded via a firewall/router. Install the MainLobby Client on the client machine by copying the “setup.exe” file that was uncompressed from the Email linked zip file (from above). Insure no instances of HomeSeer are



19

running on this client machine, and then double click on that file to launch its setup program. Again, make sure you use all the default installation settings. Copy the sample MainLobby screen that was used above to this client’s C:\Program Files\Cinemar directory. Start the MainLobby client program on this client machine. Open the sample MLHSPluginexample.mls example screen. Move your mouse to the top of the screen so the setup dialog box is visible. Click on “Options” to bring up the screen shown below:

Now instead of using the “localhost” setting under the Computer Name (Server) enter the IP Address of the MainLobby Server’s IP address. Also enter the name of this client’s machine in the “MLServer Client ID” text block. Save this screen then exit and restart the MainLobby client program on this client machine. Open the example screen above. You should now be able to control the lights via this screen from this client machine. Go to the MainLobby Server machine and look at the MainLobby Server’s main screen. You should see now see the client machine connected to this server in the “Clients Connected” text box. Notice that you can have a maximum of ten client machines connected to this server machine. The screen below (old screenshot of MLServer) shows a “Kitchen” client machine (whose IP address is 192.168.1.102) connected to the MainLobby Server.



20



21

MLHSPlugin Methodology: When a HomeSeer device changes state (from Off to On) the device house and unit code, along with this new device value gets sent to the MainLobby Server. The MainLobby Server then offers this information to MainLobby. When a command for a device change is issued from MainLobby (to turn a HomeSeer device On), this communication works in the opposite fashion. Now start HomeSeer and wait until HomeSeer has completed its start up sequence. Now start the MainLobby Server by clicking on the “Start” button on the top of the MainLobby Server screen (as shown in the menu below). You should see HomeSeer connected to the MainLobby Server by looking at the message bar on top of both HomeSeer and MainLobby Server’s setup status screens, and also by looking at the values being passed to the MainLobby server. Look at MainLobby Server’s main screen (screen initially displayed when you first started MainLobby Server) and click on the “View in Window” button in the variables group. You should similar Name and Value displays:



22

mlhsplugin_statustext CONNECTED

mlhsplugin_connectionstate

7=Means connected

mlhsplugin_hssystemuptime

x Days x Hours x Minutes x Seconds (HomeSeer “up” time, updated every 10 minutes)

mlhsplugin_sunrise

Sunrise time set by HomeSeer

mlhsplugin_XX …… “Devices Value”

Device Value

This insures that HomeSeer is communicating with the MainLobby Server. MLHSPlugin will attempt to properly translate as MLS variables the various HomeSeer device state (On, Off, Dim), device string, and device value information as best as possible. MLHSPlugin will assign the state or device string into a MLS variable as MLHSPlugin_C10 and the value of a device into MLS variable as MLHSPlugin_C10_Value. For example, when a HomeSeer device is dimmed, the MLS variable MLHSPlugin_C10 will contain “Dim 50%” and the MLS variable MLHSPlugin_C10_Value will contain the numeric value 50.The numeric value is important when using sliders and button states as they require a numeric value instead of text string information.

Summary: Your Client and Server machines are now setup for MainLobby communication to HomeSeer. Most users using this plugin will probably be new to MainLobby, so some time must be spent learning how to use this program (designing screens/library buttons). If all is not working properly please check the above communications checks and guidelines between the two plugins, between the MainLobby Server and Homeseer, and the MainLobby Server and any client machines that are used. For further help and information on MainLobby please visit the MainLobby Forums at http://www.caseserve.com/cinemar/phpBB2/index.php. For further help with HomeSeer visit http://board.homeseer.com/. For help with both programs, plus additional information on home automation and home theater (such as port forwarding How-to’s) visit http://cocoontech.com


http://www.caseserve.com/cinemar/phpBB2/index.php

http://board.homeseer.com/

http://cocoontech.com


23

Creating Your First MainLobby Interface Screen Now it is time to try your first MainLobby interface screen. As part of the MLHSPlugin download, the HomeSeer Updater has placed an “MLHSPluginExample.MLS” example file in the HomeSeer\Updates folder. Please copy this example file from the HomeSeer\Updates folder (usually c:\program files\HomeSeer\Updates\MainLobby-HomeSeer xxxxx where xxxxx is the version number) to the MainLobby directory (Usually c:\program files\Cinemar). Prerequisites:

• Installed and functioning HomeSeer software. • Installed and functioning MLServer software. • Installed and functioning MLHSPlugin software. Some HomeSeer devices should already

be subscribed and device data should be stored into MLServer variables. • MainLobby client software installed and configured on at least one workstation.

MainLobby User Manual Overview (Please Read) The overall objective of this chapter is to first provide you a basic overview of the MainLobby environment. The following are excerpts of the MainLobby User Manual and are used with permission from Cinemar. The entire MainLobby user manual is available via the following web site: http://www.cinemaronline.com/support/documentation/mainlobby2usermanual.pdf If you have not already started the MainLobby client software then please do so now. If this is your first time (or if no settings have been modified) a default screen should appear. Depending on the configuration of the default startup scene configuration, your screen may not exactly represent the picture below, but will essentially be contain the same components. MainLobby Screen Components A MainLobby client screen contains the following components:

The Stage Buttons can be dragged and dropped onto the stage area. It is essentially your painting canvas. When all buttons are placed on the stage and saved, this is called a Scene. MainLobby automatically loads MainLobby.mls whenever you first load MainLobby. You can change the default startup Scene from the Scene Options Panel. The mls extension stands for MainLobby Scene. Scene’s can be linked together to produce highly complex navigational structures.


http://www.cinemaronline.com/support/documentation/mainlobby2usermanual.pdf


24

Background Skins Background skins are non-progressive jpg images. A large collection has already been created and more are in the works. You can also customize them to your needs or create your own. They are saved into the skins directory; however, they can be saved anywhere on your computer or across your network. If you notice that your selected/default background skin is not filling your entire screen, you may need to increase the scaling for that image from the Scene Options Panel. Backgrounds are created in a variety of image sizes such as 848x480, 1024x768, etc. Buttons The buttons are what allow the user to interact with your interface. Each button can be assigned a variety of tasks from the Button Properties Panel. You can also change the look and style from our pre-designed styles. Labels Each button has a label field to identify that buttons function strictly for the user. Button labels will allow you to display subscribed HomeSeer device information represented as MLServer variables that were assigned via the MLHSPlugin.

Menu Bar When you first start MainLobby, the menu bar is hidden. It is activated when you tap your mouse pointer on the top of the Stage area, or move your mouse to the very top of the screen, or press F9 from the computer keyboard. To hide the menu bar select the Hide button. To minimize the entire MainLobby application, press the Down arrow to the right of the Scene filename in the upper right corner of the menu bar.



25

File Operations On the right side of the menu bar are file operation buttons. Be sure to save your file before pressing New. All information will be lost without warning. Once you’ve opened at least two files, the Back button functions much like a web browser. It recalls the last file opened. Again, make sure you’ve saved your Scene before pressing this button. All data will be lost. You can also open and save Scenes and pass them onto your friends using MainLobby. Although you can save a scene to any directory, the Save button will always save to the same directory where MainLobby.exe is located. It is highly recommend that you save scenes to this same directory as well. The name of the mls file currently open is located in the right hand corner. The Version Information is located on the left hand side of the Menu Bar to the right of the text MainLobby. Button Commands/Library You can add buttons to your stage area by pressing the Add button or the Library button. It defaults to the first button style unless you’ve added and changed a button style. If you plan on adding all of the same buttons, it is recommended that you Edit the first button and select the style, then continue to Add more buttons. The buttons added will be the same as the one you previously selected. All buttons are assigned a buttonID. Buttons are removed in numerical order. If you have 12 buttons on the stage, it will only remove buttonID 12. Future versions will offer the user to select which button they wish to remove. When removing a button, all data assigned to that button in that buttons Properties Panel will also be lost as well. If you would like to remove all of the buttons from the Stage, select Clear. You can Hide a button from displaying on the Stage by checking the Hide check box in that buttons Properties. Clicking on the Library button will present the button library window. Notice that with MainLobby 2.75d fourteen pages totaling 326 graphic images exist:



26

Button Modes Three modes exist to create and execute buttons. Edit mode allows you to assign and change button properties. Just select Edit then select the button on the stage you would like to edit. This will open up the Button Properties Panel for that button. Design mode is used to position your buttons on the stage. Once in design mode, simply drag and drop the button where you’d like it. The button position is then restored later as long as you press the Save button before exiting or opening another Scene. Once you’ve assigned actions to your Button and positioned it where you like it, it’s time to test it out. Launch mode makes every button active on the stage. Pressing the buttons while in this mode triggers that button’s actions assigned in the Button Properties. Copy/Paste (New feature added in MainLobby 2.80) You now have the capability to Copy/Paste buttons between scenes and on the same scene. Simply change the button mode to DESIGN mode and hold down the CTRL key and select multiple buttons. Then press COPY. You can either paste the same set of buttons and their properties to the existing scene or Press NEW or load a scene. Then from the Menu Bar and select PASTE. Note: In order for the Copy/Paste function to work you need to change the button mode to DESIGN mode. Your buttons will be placed in the exact position you copied them along with their respective properties and commands.

Assigning actions to a button or graphic: Button Properties Panel Once you select and add a button from the button library to the MainLobby scene you can edit the button properties to tell MainLobby what that button will do. Any button can perform one or multiple tasks. For instance, one button press could jump to another MainLobby Scene, play an MP3 sound effect, launch a web page and send commands to HomeSeer all at the same time. If no entries are found in an input field those actions are simply ignored.



27

Buttons and Graphics Several button styles, animations, invisible buttons, text fields and elements are included with MainLobby. You can also import your own JPG images as well as Flash swf format files. The top drop down represents the Library the graphics are from and are sorted in categories such as MainLobby, Components and Logos. As you add Lobby products to your Suite, more graphics will be available that pertains to that particular application. Also, visit our website for more updates and expanding your graphics arsenal. Additional graphic libraries will be available. Every button is assigned a unique number in sequential order. The ID represents the name of the button that is stored in the MainLobby Scene file. This information is supplied for 3rd party developers to easily populate MainLobby Scene files. MLS files are simply text files. Hide Button Checkbox When checked, the associated button/graphic will be invisible on the Stage. All Button Properties will be saved when the Scene is saved and the data will be recovered upon reloading. To unhide, just uncheck the Hide checkbox. Hide Value Checkbox Some buttons (for example slider button) will display their value along the size of the object. Selecting this checkbox will configure the button/object to not display the value. Label You can put text on or around the button by typing in the label field. Depending on the button, the text may be positioned below or around the button. You may also adjust font size, color, alignment and the actual font used. All fonts are embedded within MainLobby. It does not look on the user’s system for additional fonts. This is where you can display HomeSeer device information that has been subscribed and sent to MLServer via the MLHSPlugin. Enter the following using the HomeSeer X10 House/Unit code (replace C10 with HS device house/unit code): {{MLHSPlugin_C10}} for device state/device string textural information {{MLHSPlugin_C10}} for device value information Alpha Adjust the transparency of your graphic. 100% meaning fully visible and 0% invisible. Scale Enlarge or shrink the selected graphic. Rotate Enter in a positive or negative number to rotate the graphic the specified degree. Position The x and y coordinate of the graphic on the Stage. Hide Display



28

When you are editing a graphic, most graphics will appear in the upper left corner. Some graphics may overlap your Panel, clicking on this button will make the Button Display invisible. Key Any button can be assigned a keyboard keystroke. Just type the letter or number into the input field and that button will respond while in Edit or Launch mode. Link to MainLobby Scene (.mls – MainLobby Scene) MainLobby allows you to create your own interactive environment. Much like a web page can link to other web pages; MainLobby Scenes can link to other MainLobby Scenes. Once you’ve created and saved multiple Scenes, you can then browse to them. When that button is pressed, you will be brought to that next Scene. Make sure you’ve saved the Scene before going to another Scene – all data on the prior Scene is lost once you leave the Scene without saving it first. JPG Image or Flash (.jpg, .swf) Click the browse button to load any non-progressive JPG image or Macromedia Flash swf file. Similar to buttons, you can assign actions to these elements. Application/Media Browse your hard drive to launch any application or file from your hard drive. You may also launch scripts as well as pass variables to your specified program. Results may vary depending on the file type. Examples of passing variables (Do not check Shell):

• D:\Program Files\girder32\Girder.exe, -eventstring notepad You may also determine whether the application you open is maximized, minimized, hidden or normal. Some applications will over-ride MainLobby and not allow you to change this. Play Sound (.mp3) This action starts a sound or sound effect when the button is pressed in Launch mode. Sounds will continue to play until another button is pressed. This is setup this way so users can create MP3 jukeboxes without the sounds overlaying on top of each other because of user error. Future versions will allow layering of sounds and the ability to turn this feature on/off. You can preview your selected sound by pressing the Play button. Be sure to stop the sound before exiting the Button Properties Panel. Otherwise the sound will continue until finished. All sounds are streamed into the Computer running MainLobby. If you want to trigger sounds to play on another computer you can use Girder. Batch Files (.bat) Batch files have been around for ages. More advanced users may benefit from this option to create more complex scripting or repetitive tasks. For more information on creating batch files, a good resource is available online at ComputerHope.



29

Web (.html) You can launch a web page by filling in this field. Again, you may be able to use other extensions such as .asp, .htm, etc. Results may vary. MLServeCMD (Send Cmd’s to MLServer or to HomeSeer via MLHSPlugin) This is a command structure that sends commands between MainLobby clients and MLServer. MainLobby Server is a new Server side application written for MainLobby and other Cinemar software. It allows the Cinemar applications to have mutliple clients and send information back to the server. MainLobby clients can now communicate bi-directionally with a server to issue commands to control hardware and other software connected to the server as well as send macros. It is available for download and requires MainLobby 2.30a or higher. MainLobby creates a file called mlserverconnect.ini in your Cinemar folder. If you are trying to connect to MLServer located on a networked computer, edit the ini file using Notepad changing the serverDomain to the name of the computer you are connecting to. From MainLobby, when you edit a button you will notice an MLServeCMD line in the button properties. You need to install the MainLobby Server software on the computer you'd like to control. Entering the command sequence MLServeCMD.MLHSPlugin|HS_ExecX10:C10~ON would send the command to HomeSeer (via MLHSPlugin) and turn of the HomeSeer device C10. ML Command Line Currently these commands are available from the Drop Down (The drop down represents a better definition of the function, while the line below is actually the command used to execute the script – as the language develops, users may want to just type in the command line. NOTE: The ML Command Line is case sensitive):

• None • MLexit – Exits MainLobby. • MLBackScene – Goes Back to the previously loaded MainLobby Scene. • MLminimize – Minimizes MainLobby. • MLsendtoback – Sends MainLobby Interface to the back of all other windows open. • MLMenu – Displays the MainLobby Menu bar if it isn’t already open. • ShutDownWindows – WARNING: Closes the user system without requesting

permission. • GotoFrame2 – This may be used for developers who want the button to move to

frame 2. • FadeIn – Fades in the Button when the Scene is loaded. • FadeOut – Fades the Button out when the Scene is loaded. • FadeUp20 – Set the button opacity to 80% or less and when pressed the buttons

alpha will increase by 20%. • TaskBarHide – Hides the Windows Task Bar. • TaskBarShow – UnHides the Windows Task Bar. • Plus many more…..



30

Browsing for Files (Path Names) If you plan to use MainLobby with networked computers, browse for files through My Network Places on your computer instead of My Computer. If you do this, you can run one instance of MainLobby on both or multiple computers. A file browsed through My Computer might look like this (absolute path): D:\Program Files\Cinemar\dvdlobby\dvdlobbypro.exe When trying to access the file via another computer, it won’t find the reference to the file location above. A file browsed through My Network Places might look like this (network path): \\Main\D\Program Files\Cinemar\dvdlobby\dvdlobbypro.exe Any computer running that instance of MainLobby can find the location using the above syntax. The .exe will load onto the computer running MainLobby. Some programs won’t function properly over a network so results may vary. DVDLobbyPro will load onto any other computer across the network. If you would like to distribute your entire theme (MainLobby Scene, background skins, sound effects) to another registered MainLobby user, you will want to edit each input field to use a relative path. Please do not distribute the MainLobby application itself. Users must be registered with Cinemar. A relative path uses back slashes (\) and periods (.) to move through directories from the exact location of MainLobby.exe. Periods will move you back directories depending on how many you use. It’s recommended to save any files that you use with MainLobby somewhere within the MainLobby directory itself or a folder after it (ie skins). A relative path for a background skin would look like this:

skins\screeninterface14.jpg An absolute path for a background skin might look like this:

D:\Program Files\MainLobby\skins\screeninterface14.jpg

Scene Options Panels The Scene Options Panel is available by selecting Options from the Menu Bar.



31

To the left of each input field is a right arrow. This will populate the field based on the last Scene loaded. If you just started MainLobby without going to another Scene, it will clear the field. The Browse button opens a Windows dialog box so you can scan your hard drive for the appropriate media. The “X” to the right of the Browse button is used to clear the respective input field.

Scene Configuration Panel MainLobby makes it easy for you to customize your interface with the introduction of layers. The diagram below shows how these layers are organized/stacked. Layers allow you to add animated FX, import plugins, add page titles, etc. Some samples are included with MainLobby. Visit the Cinemar website to download more.

RemoteFX (.MLS,.swf): RemoteFX appear on top of everything else on the stage except for the screensaver. Although you can import any Flash swf file into this layer, it may serve for importing Remote Control graphics that are either created by the user or Cinemar.



32

In MainLobby 2.80, Cinemar added a new RemoteFX feature: Once installed, load one of the new scenes (overlay_dvd.mls) that take advantage of the loadOverlay importer from the Scene Options Panel. You'll notice bottom navigation with four buttons along the bottom. This is actually a separate scene. This scene and buttons are only available while in launch mode to prevent the user from editing the scene. This scene is identified by pressing OPTIONS. At the top of the Scene Options Panel you'll notice the field: Remote FX or OverlayScene. This is where you specify which MLS file to load on top of your scene. You no longer need to modify countless scenes when you want to modify the menu system. Just load the overlay_navigation.mls scene and make the change, then save. This will affect this scene in every other instance that it appears within other scenes.

OverlayFX (.swf): OverlayFX can be used to import plugins (calendar, media player, jukebox, password protection), overlay your logo in the corner, and add animated eye candy and much more. Any Macromedia Flash SWF can be imported. Check the Cinemar website for more OverlayFX. BackgroundFX (.swf): The BackgroundFX may either totally replace the Background Skin layer or through the use of transparent backgrounds, be combined with the Background Skin to create a unique effect. Your backgrounds can now be animated versus static jpg’s. Background Skin (.jpg): You can import any non-progressive jpg image into MainLobby. Several Background Skins are included in the skins directory. More will be available for all registered users. Play Sound (.mp3): When you first launch a Scene, you can have an MP3 sound start playing. You may want a sound effect or an entire song depending on the Scene.

Display Options Panel From the Display Options Panel you can configure your display device resolution. Perfectly position MainLobby anywhere on your screen and scale the interface. Hide the Window’s TaskBar, enable keyboard arrow key control and disable/enable the MainLobby Menu Bar.



33

Custom Resolution: Pre-configured display settings are included with MainLobby. You can enter any resolution if yours is not available. X and Y Scale: Computing the X and Y Scale varies for each resolution. Use the following formula to computer the X and Y Scale for your monitor or TV: X and Y Scale = 480 / Monitor Pixel Height * 100 Sample Display Resolution: 1024 x 768 480 / 768 * 100 = 62.5 (X and Y Scale) X and Y Shift: These values may vary depending on your monitor resolution. Use the left and right arrows to align the top left corner of MainLobby to the upper left corner of your monitor. Screensaver (.swf): A Screensaver comes with MainLobby and is located in the screensavers directory. All DVDLobbyPro screensavers are compatible with MainLobby. You can set the delay time to trigger the screensaver based on no activity either by the mouse or keyboard. Visit Cinemar’s website to download them for free. If you have experience with Macromedia Flash you can create your own screensavers.



34

Startup Options Panel The startup options panel configures MainLobby environment to which MainLobby scene file will be loaded on startup, this client id name, the computer name or IP address of your MLServer.

Important: • Each MainLobby client computer should have a different MLServer Client ID name

configured. • Please configure the appropriate Computer Name or IP address of your MLServer.

If you have MainLobby and MLServer installed on the same computer, then please enter localhost.

• Please do not change the MLServer TCP Port unless otherwise necessary. Unless you have specific network requirements, the MLServer Port should stay configured with the default value of 5004.

• Since MainLobby by default utilizes the ESC key as a shortcut to exit the program without saving its data, we recommend that you should the Exit Key Shortcut to blank or none.

One important step is to change the default way MainLobby exits the program (presently it is via the “Esc” key). By default pressing the ESC key in MainLobby will exit the program without allowing you to save your work. Click on the “Options” followed by the “Startup” (left side of screen) button in this dialog box. You will see the menu below:



35

Under the “Exit Key Shortcut” drop down box, select “NONE”. Also note that in this example, the “Computer Name (For MLServer) is “localhost” because MainLobby Server (MLServer) is running on the same machine in the example. If this were the client machine, this entry would need to be the name or IP of the machine that was running MainLobby Server. Also note the “ML Server Port” is 5004. This is the port number that needs to match the port setting in MainLobby Server’s main screen above. We recommend that you do not change the MLServer port. You can also change the “ML Server Client ID” text block to reflect the name of the machine where this MainLobby Server is residing on. Click on the “OK” button on the lower right after completing the above settings.

Working with the MLHSPlugin Example ML Scene Move the mouse to the top (middle) of the screen. The Menu Bar should appear. Click on the “OPEN” button in the top right of the drop down dialog box and select the MLHSPluginExample.mls screen, and then click on “OPEN”. The MainLobby example screen should now be displayed. We will be editing the group of buttons shown below for the first example:

This group is currently set to control the HomeSeer Device C10. The left “OFF” button will turn the device off, the right “ON” button will turn the device on, the “-“ button will dim the device, the “+” button will brighten the device and the center “OFF” button will display the device’s present state (in this case On, Off, or Dim to xx%).



36

To edit a button click on the “Edit” button under the “Button Mode” dialog box selection on the Menu Bar top of this MainLobby screen. Then click on the right “ON” button. You will now see a button edit dialog box as shown below:

The command syntax to send commands to the MainLobby Server is MLServeCMD. MLHSPlugin followed by the typical HomeSeer command to turn a device on (for this C10 device’s case it is MLServeCMD.MLHSPlugin|HS_ExecX10:C10~On). Notice this command is already displayed in the MLServeCMD dialog box. Change this command for one of your HomeSeer devices that you registered with the plugin in the steps above. You can immediately test the command by clicking on the “test” button to the right of the dialog box. Click the “OK” button on the lower right. Now lets edit the “+” button. Since you are still in the “edit” mode click on the “+” button. You should see the following dialog box appear:



37

Notice the command syntax in the MLServeCMD dialog box needed to brighten the HomeSeer device C10. Change this command for your device you would like to test, then click on the “OK” button. Change the “-“ and the “OFF” commands to suite your device you are testing. Click on the center rectangular gray button below the “Device C10” text in the center of this group. You will now see the following dialog box:

This box will display the current status of the HomeSeer Device C10. Notice the syntax entered in the “Label” text box. The command is mlhsplugin_”Device” surrounded by double brackets. For example, for device C10 enter {{MLHSPlugin_C10}}. Change this entry for your device you are testing.



38

Important Note: MLHSPlugin will attempt to properly translate as MLS variables the various HomeSeer device state (On, Off, Dim), device string, and device value information as best as possible. MLHSPlugin will assign the state or device string into a MLS variable as MLHSPlugin_C10 and the value of a device into MLS variable as MLHSPlugin_C10_Value. For example, when a HomeSeer device is dimmed, the MLS variable MLHSPlugin_C10 will contain “Dim 50%” and the MLS variable MLHSPlugin_C10_Value will contain the numeric value 50.The numeric value is important when using sliders and button states as they require a numeric value instead of text string information.

A summary of the above examples commands and their proper syntax for turning the example HomeSeer device C10 ON, OFF, Bright, and Dim as well as showing the devices current status are listed below:

The command to turn device C10 ON is: MLServeCMD.MLHSPlugin|HS_ExecX10:C10~On The command to turn device C10 OFF is: MLServeCMD.MLHSPlugin|HS_ExecX10:C10~Off The command to brighten C10 (in 20% increments) is: MLServeCMD.MLHSPlugin|HS_ExecX10:C10~BRIGHT~20 The command to dim C10 (in 20% increments) is: MLServeCMD.MLHSPlugin|HS_ExecX10:C10~DIM~20 The command to toggle the device state for C10 is: MLServeCMD.MLHSPlugin|ToggleDevice:C10 To display device C10’s current state or device string information enter: {{mlhsplugin_c10}} in the “Label” dialog box. To display device C10’s current value information enter {{MLHSPlugin_C10_Value}}.

An entire set of the commands available is listed at the end of this document.

More to come – Under Construction…



39

Appendix

MainLobby Button Library



40



41



42



43



44



45

MainLobby to HomeSeer Commands

HS_Run:

Overview Runs HomeSeer located script. Scripts must be located in the scripts directory in the HomeSeer application directory.

Parameter Type Description scr string Is the filename of the

script to run. Do not include the path in the script name.

Example MLServeCMD.MLHSPlugin|HS_Run:myscriptname.txt



46

HS_RunEX: Overview

Runs a function in a script with a parameter. This will also return a value from the called script. Scripts must be located in the scripts directory in the HomeSeer application directory.

Parameter Type Description scr string is the filename of the script to run.

Do not include the path in the script name.

func string The name of the function to execute.

param variant A parameter to send to the function. This can be a string or numeric value.

Example MLServeCMD.MLHSPLugin|HS_RUNEX:scriptname~function~parameter



47

HS_SendIR: Overview Send an I/R command to an attached infrared device. Each extra

comma adds a 1/4 delay.

This example sets the "vcr" to "record"

Parameter Type Description ir string Is a string of I/R text

commands. These are the same commands that are listed for each of the keys for a particular device.

Return value

Type Description

none

Example MLServeCMD.MLHSPLugin|HS_SendIR:VCR,Record



48

HS_WriteLog: Overview Write a message to the HomeSeer event log

Parameter Type Description class string Is a string that defines the type

of event like "Error" or "Info". It can be anything you like. Common message types are "Info”, “Warning", and "Error".

message string Is the text to be displayed in the log, like a descriptive error message.

Return value

Type Description

none Example

MLServeCMD.MLHSPLugin|HS_WriteLog:Info~Any Text Message



49

HS_TriggerEvent: Overview Force HomeSeer to trigger an event.

Parameter Type Description name string Is the name of the event you

want to trigger. The actions for the event are executed. Note that the name is not case sensitive. Events "Evening" and "evening" would be considered the same. If there were duplicate event names, only the first one found would run.

Return value

Type Description

integer 1 if error, else 0 if no error. If an error is detected, and error message is written to the event log.

Example MLServeCMD.MLHSPLugin|HS_TriggerEvent:TurnOutSideLightsOn



50

HS_DisableEvent: Overview Marks a HomeSeer event as disabled. All triggers are suspended

until the event is re-enabled.

Parameter Type Description evname string Is the event name to disable.

Note that the name is not case sensitive.

Return value

Type Description

none Example

MLServeCMD.MLHSPLugin|HS_DisableEvent:TurnOutSideLightsOn

HS_EnableEvent:

Overview Marks an HomeSeer event as enabled.

Parameter Type Description evname string Is the event name to enable.

Note that the name is not case sensitive, and the event must have already been disabled.

Return value

Type Description

none Example

MLServeCMD.MLHSPLugin|HS_EnableEvent:TurnOutSideLightsOn



51

HS_SetDeviceString: Overview Sets a string as the device status. The string "message" is displayed

in the device status column. This appears on the web page and the local device list. This can be used to display the status of special devices like thermostats and weather stations. Note that this does not affect the actual X10 status for the device, which can be accessed by DeviceValue().

Parameter Type Description device string Is the X10 housecode unitcode

of the device like "A1" message string Is the status string for the

device, like "72 degrees" (without quotes)

Return value

Type Description

none

Example MLServeCMD.MLHSPLugin|HS_SetDeviceString:A1~72 degrees



52

HS_SetDeviceStringByName: Overview Sets a string as the device status. The string "message" is displayed

in the device status column. This appears on the web page and the local device list. This can be used to display the status of special devices like thermostats and weather stations. Note that this does not affect the actual X10 status for the device, which can be accessed by DeviceValue().

Parameter Type Description Device string Is the name of the device

including it location like den table lamp. Note the name is not case sensitive and is made up of device location and device name.

Message string Is the status string for the device, like "72 degrees" (without quotes)

Return value

Type Description

None

Example MLServeCMD.MLHSPLugin|HS_SetDeviceStringByName:Den Table Lamp~72 degrees



53

HS_SetDeviceValue: Overview Sets a value that is associated with this device. Values are used to

hold the dim level of a device. You can also use them as user variables in your scripts. Note that HomeSeer will overwrite this value if an X10 command was received for this device. If you are going to use this as storage for your own information, pick a device that does not exist in your home. You can also use virtual devices (devices in the range "q->z", or unit codes between 17 and 99), as these devices will never be affected by X10 power line activity.

Parameter Type Description device string Device code like “A1”. value long A numeric value like 50.

Return value

Type Description

none

Example MLServeCMD.MLHSPLugin|HS_SetDeviceValue:A1~50



54

HS_SetDeviceValueByName: Overview Sets a value that is associated with this device. Values are used to

hold the dim level of a device. You can also use them as user variables in your scripts. Note that HomeSeer will overwrite this value if an X10 command was received for this device. If you are going to use this as storage for your own information, pick a device that does not exist in your home. Same function as SetDeviceValue except you pass this function the actual text name of the device.

Parameter Type Description device_name string The name of the device must

contain both the location and name. If the device was name lamp, and its location was living room, the device_name parameter would be living room lamp.

value long

Return value Type Description none

Example MLServeCMD.MLHSPLugin|HS_SetDeviceValueByName:Living Room lamp~50



55

HS_ExecX10: HS_ExecX10ByName:

Overview Execute a device command using the actual house code and device code.

Parameter Type Description Code string Is a string of devices like "A1" or

"A1plus2plus3plus9". HS_ExecX10ByName would require device name (Living Room Lights) instead of House and Unit Code.

Cmd string Is the name of the command as a string. See the table below for more information.

Dimval integer

(optional)

Is the % dim for "Dim" and "Bright" commands. For the "Pre-set Dim" command, this is a value between 0 and 31.

data2 integer

(optional)

Is the second data byte for the "Extended" X10 command. The dimval parameter is the first data byte if the command is "Extended"

wait boolean

(optional)

This command is not implemented by MLHSPLugin.

Return value Type Description integer 1 if successful else 0 if error

Commands are not case sensitive. Commands valid for Z-Wave devices are shown in BLUE.

Command Description NoCmd This is used to send X-10 address

information only - no X-10 commands are sent.

All Units Off Sends the X-10 All Units Off command to the house code provided.

All Lights On Sends the X-10 All Lights On command to the house code provided.



56

On Turns on the device. Off Turns off the device. Dim Dims the device to the level specified

in DimVal (Relative dim for X-10 devices, absolute dim for Z-Wave devices)

DDim Dims the device to the level specified in DimVal regardless of device type. (Absolute dim) If the device is configured as a Leviton Extended Dim, then an Extended Data command is sent. If the device is PCS Preset Dim, then Preset Dim is sent. If the device is Z-Wave, then a Z-Wave set level command is sent.

Bright Sends the X-10 Bright command to the device.

Dim to Off Sends several X-10 dim commands to the device to insure it is off.

DimAB Dims to the absolute level specified in DimVal by sending bright or dims according to its present last known level in HomeSeer.

DimBF Dims to an absolute level specified by DimVal after going to full brightness first

All Lights Off Sends the X-10 All Lights Off command to the house code provided. Note: Not many devices support the All Lights Off command.

Extended Sends an X-10 Extended Data Command - the first byte of data goes in DimVal, and the 2nd byte goes in Data2

Hail Request Sends an X-10 Hail Request command Hail Ack Sends an X-10 Hail Acknowledge

command Preset Dim Sends an X-10 Preset Dim command.

DimVal is the preset dim level specified between 0 and 31

Status On Sends an X-10 Status Response "On"



57

Status Off Sends an X-10 Status Response "Off" Status Request Sends an X-10 Status Request

message Example

MLServeCMD.MLHSPLugin|HS_ExecX10:H8~On MLServeCMD.MLHSPLugin|HS_ExecX10:H8~Off MLServeCMD.MLHSPLugin|HS_ExecX10:H8~Dim To Off MLServeCMD.MLHSPLugin|HS_ExecX10:H8~DDim~50 MLServeCMD.MLHSPLugin|HS_ExecX10:H8plus9plus10~On MLServeCMD.MLHSPLugin|HS_ExecX10:H8plus9plus10~Off MLServeCMD.MLHSPLugin|HS_ExecX10ByName:Bath lights~On MLServeCMD.MLHSPLugin|HS_ExecX10ByName:Bath lights~Off MLServeCMD.MLHSPLugin|HS_ExecX10ByName:Bath lights~Dim To Off



58

HS_Speak: Overview Speak some text.

Parameter Type Description text string Is the string you want to

speak. It may also be the complete path to a WAV file, and the WAV file will be played.

Return value

Type Description

none

Example MLServeCMD.MLHSPLugin|HS_Speak:Hello World



59

HS_MuteSpeech: Overview Read/Write property. Temporarily mutes the speech output. By

setting this property to FALSE, all speech output is silenced until this property is set back to true. This mutes ALL speech, including speech sourced from scripts.

The status bar in the main HomeSeer display window will display Mute while speech is muted.

Parameter Type Description TRUE boolean speech output is silenced. FALSE boolean speech output is enabled.

Return value

Type Description

none Example

MLServeCMD.MLHSPLugin|HS_MuteSpeech:True MLServeCMD.MLHSPLugin|HS_MuteSpeech:False



60

HS_ClearLog: Overview Clears the HomeSeer event log in memory. The event log file

"ah.log" is untouched.

Return value Type Description none n/a n/a

Example MLServeCMD.MLHSPLugin|HS_ClearLog



61

HS_Launch: Overview Launches a given application. The function will return before the

application finishes launching.

Parameter Type Description name string Is the name of the exe file to

launch. It can be a simple application name (the path to the application would have to be in your system path) or it can be a full pathname to the file. Application files can also be launched and the application that owns the file will be executed. For example, you could set the name to "c:\docs

parameters string Any parameters or command line switches that are to be passed to the application

direc string The working directory the application is launched from. Leave an empty string for most applications.

Example

MLServeCMD.MLHSPLugin|HS_Launch:c:\filename.exe~command~c:\



62

HS_ControlThermostat: Overview This function gives direct access to thermostats. Thermostats are

supported with special .THM scripts. The command parameter is the entry function that is called. Keep in mind that the functionality of these commands is dependent on your THM script/hardware. The functions available are:

SetSetPoint = Sets the current heat (or Cool) set point SetFan = Sets the current fan mode (0=On?, 1=Off?) SetMode = Sets the current operation mode (1=Heat, 2=Cool) SetCoolSetPoint = Sets the current cool set point (if supported by thermostat)

Parameter Type Description device string Device code of thermostat

like "J1". This is configured device code.

Command String Command : SetSetPoint, SetFan, SetMode, SetCoolSetPoint

Value String Value to set if setting temperature, mode, or fan.

Return value Type Description

Example MLServeCMD.MLHSPLugin|HS_ControlThermostat:J1~SetSetPoint~78 MLServeCMD.MLHSPLugin|HS_ControlThermostat:J1~SetFan~0 MLServeCMD.MLHSPLugin|HS_ControlThermostat:J1~SetFan~1 Macro to set thermostat to cool and set SetPoint to 78 degrees: MLServeCMD.Macro|MLHSPlugin|HS_ControlThermostat:Y1~SetMode~2!MLHSPlugin|HS_ControlThermostat:Y1~SetSetPoint~78 Macro to set thermostat to heat and set SetPoint to 70 degrees: MLServeCMD.Macro|MLHSPlugin|HS_ControlThermostat:Y1~SetMode~1!MLHSPlugin|HS_ControlThermostat:Y1~SetSetPoint~70



63

HomeSeer to MainLobby Commands

HS.Plugin (“MLHSPlugin”).MLServeCMD: The HomeSeer MLHSPlugin allows you to send MLServeCMD’s to MainLobby. This is very powerful as it allows HomeSeer scripts or HomeSeer Events to send commands to your MainLobby infrastructure. Please see the HomeSeer MLHSPlugin Message Forum for additional “How to” type of instructions. Enclosed are a few of the many possibilities:

To Send a Text Message to ML Clients for 60 Seconds hs.plugin("MLHSPlugin").MLServeCMD "MLServeCmd.MLCmd|Msg~All~Testing~This is a test of the emergency broadcast system~60"

Send MLServeCMD from HomeSeer script to change MainLobby Client Scene

hs.plugin("MLHSPlugin").MLServeCMD "MLServeCmd.MLCmd|ChangeScene~All~newscenename.mls"



64



Documents

MainLobby / HomeSeer Plugin4 Overview If you've been searching for a polished, professional front end for your sophisticated HomeSeer automated home, look no further. MainLobby offers