xPLHal is the engine at the heart of a Windows xPL-based home automation system. It is responsible for processing incoming xPL messages, executing scripts, providing timed events, and allowing configuration of xPL devices. For more information on xPLHal, please see the xPLHal section of the FAQ or the xPLHal website.
This HowTo guides you through the process of installing and setting up this core component.
What You Need
- A PC running either Windows NT 4.0, Windows 2000, Windows XP or Windows Server 2003
- The Microsoft .NET Framework v1.1. This can be downloaded free-of-charge from the Microsoft .NET Web site or installed through Windows Update.
Downloading the Software
Download the installation package from http://www.xplhal.org/downloads/oldversions/xPLHalSetup.zip (498KB)
Installing the Software
- Unzip the xPLHal installation files into a temporary directory.
- In Windows Explorer, double-click the file xPLHalSetup.msi
- Click next
- Agree to the GPL Licence, and Click Next
- Select "Everyone" and Click Next
- Click Next
- Installation will take around thirty seconds.
- Click Close, xPLHal is now Installed
- Go into Control Panel -> Administrative Tools -> Services.
- Locate the xPLHal service and make sure it is running.
Configuring the Software
xPLHal itself has no user interface and is configured using a separate administration tool. For this HowTo, we will use the xPLHal Manager for Windows, which is a Windows application (there is also a browser-based tool available). A copy of xPLHal Manager is installed along with the xPLHal Service, however, if you wish to do the configuration from another PC you can download and install the standalone version of xPLHal Manager (417KB)
Updating xPLHal Manager's Plugin Library
The xPLHal Manager uses an intelligent plugin system to determine the capabilities of installed applications. These plugins are updated from the websites of application vendors. It is always advisable to get the latest plugins when installing a new application.
- Click Start -> Programs -> xPLHal -> xPLHal Manager
- The xPLHal Manager will appear.
- When you run the xPLHal Manager, it will try to connect to the xPLHal service on the local computer. If it fails, you will be asked to enter the name of the computer that is running the xPLHal service.
- Select Help, and Update Plugin Library.
- The available Plugins are shown. Click "Select All" and Next.
- A success Message is Displayed. Click OK
- Exit xPLHal Manager by Clicking File -> Exit
Configuring xPLHal using the xPLHal Manager
- Click Start -> Programs -> xPLHal -> xPLHal Manager.
- The xPLHal Manager will again appear.
- Expand the xPL Devices tree node and click Awaiting Configuration.
- You should see xPLHal listed as awaiting configuration. Double-click on xpl-xplhal.<computername>1 to configure it.
- From the list of configurable items, select "newconf".
- Enter the name by which you want this instance of xPLHal to be identified.
- Click OK.
- If you click on the xPL Devices node, you should now see xPLHal listed, along with the new name that you assigned to it.
Congratulations! You have now installed and configured xPLHal.