Rationale

The lighting scheme for XPL is a scheme that abstracts away from various home-automation protocols . Currently, there is a binding for UPB. The XPLCM11A gateway is a binding for X10 and more specifically the CM11A device. It re-uses the UPB gateway code largely, and it re-uses Peterson's Java API for the CM11A.

Functionality

The gateway has the following functionality:

• Support for X10 On/Off devices, Dimmers (with switch-on level being last dim level, or predefined value), and two way devices (not: devices that use X10 extended messages)
• The gateway checks if the command sequence that will be send, really results in the desired state (change) (which is not always the case if a X10 command of a remote control comes in between).
• Implementation of the XPL Lighting scheme with scenes (which are emulated by the gateway)
• The gateway keeps the state over power failures. This means that in case of a power failure, the gateway will bring the X10 network in state as known before the power failure (for this, you need version 0.3 or higher).

Installation

The distribution below is a jar with the gateway. Additionally you need (in your classpath):

• log4j (I used version 1.2.13).
• RXTX (serial API for Java). You have to install the runtime files of RXTX (in short putting rxtxParallel.dll and rxtxSerial.dll in the bin directory of your Java distribution, see the RXTX documentation for more information), and have the jar in your classpath.
• XPL4Java the jar with a programming framework for XPL.

Furthermore, you need cm11axpl.jar, which you need to start (see cm11axpl.cmd for an example).

You also need a configuration file (see example.txt for a commented example) that describes the devices connected to your X10 network.

First, you can test your config file by starting the X10Tester (X10Tester.cmd). Then you can start the gateway (cm11Axpl.cmd) and config the gateway using some XPL config tool (e.g. DCM).

The gateway can also be used in combination with Gerry Duprey's xpl4java server.

There are two parameters to configure: the serial port your CM11A is connected to (COM1,...) and the location of the configfile that contains the configuration of your X10 network.

Then, e.g. by using examples.LightingExplorer of XPL4Java, you can test things.

If you want to use this, please empty your CM11A. Specifically, it should not contain macro's. The gateway can not deal with this.

At www.gordijn.org/gordijn.xml you find a plug-in for use with XPLHal tools.

Limitations

• As told earlier, not all CM11A functionality is covered, and also not all X10 functionality (e.g. no extended codes, and no macros)

• This is version 0.5. Meaning: experimental, not stable, use at your own risk, and so on. But you may give it a try

Acknowledgements

The CM11A uses Jesse Peterson's Java API, and re-uses many of the UPB classes from Gerry Duprey. Actually all CM11AXPL does, is bridging these two.

This software is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

Download the files here