Get Started on Windows - XPLProject

Contents

Introduction

A basic Windows xPL installation consists of two components, an xPL Hub and xPLHal.

An xPL hub is the most important part of a Windows xPL installation. Without a hub installed, no other xPL applications will work. The hub listens for xPL messages on the network and relays them to all xPL applications that are connected to it. This allows more than one xPL application to run on a single PC but a hub is required even if you only want to run one xPL application on your PC. For more information on hubs, please see the hub section of the FAQ.

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.


Overview of the Installation Process

The latest version of xPLHal (version 1.53) is only available as an update at present and, due to a recent change in the xPL specification, version 1.53 does not include a built-in hub. In order to use xPLHal 1.53, a separate standalone hub must be installed. This is done after the update to xPLHal 1.53 to avoid any clashes between the hub built in to xPLHal 1.44 and the standalone hub.

The installation process is therefore:

  • Install and configure xPLHal version 1.44
  • Update xPLHal to version 1.53
  • Install an xPL hub
  • Check Windows XP Firewall settings
  • Test installation using xPLDiag


Installing and configuring xPLHal 1.44

Follow the instructions in HowTo Install xPLHal on a Windows PC


Updating xPLHal to version 1.53

  • Download the xPLHal 1.53 update from http://www.xplhal.org/downloads/xplhal.zip (340KB)
  • Unzip the contents of xplhal.zip into a temporary directory
  • Stop the xPLHal service
  • Copy the files xpllib.dll and xplhal.exe to your xPLHal program directory (which is probably c:\program files\xpl\xplhal) overwriting the current versions (if you also want to update xPLHal Manager, copy all of the files and folders from the zip file to your xPLHal directory)
  • restart the xPLHal service.


Installing an xPL Hub

Follow the instructions in HowTo Install the xPL Monkey Windows xPL Hub


Check Windows XP Firewall Settings

By default the Windows XP Firewall will block xPL messages. To fix this, open the Firewall from the Control Panel, go to the Exceptions tabs and add two entries, one for TCP port 3865 and one for UDP port 3865. If this doesn't work, you might also have to add a program entry for the xPLHAL, if it's not there already.


Test Installation using xPLDiag

To gain confidence that your install is working correctly, run the xplMonkey Diag tool. The built in help can be used to aid rectification of any problems.

This page was last modified on 27 April 2007, at 10:10. This page has been accessed 16,207 times.