|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.sourceforge.cruisecontrol.publishers.X10Publisher
This Publisher implementation sends a on/off signal to a X10 capable device via the X10 Activehome computer interface, model CM11A. This allows you to control an electronic device when the build breaks. For example, use a flashing red light to indicate a broken build.
NOTE: THIS PUBLISHER HAS ONLY BEEN TESTED WITH WINDOWS Quick Start:JAVA_HOME/bin
directory<x10 houseCode="A" deviceCode="3" port="COM1"/>
JAVA_HOME/bin
directory.
NOTE: If you receive the following error:
Error loading win32com: java.lang.UnsatisfiedLinkError: no win32com in java.library.path
it probably means that the Windows DLL named win32com.dll needs to be copied
from CruiseControl's lib directory into your JDK (or JRE) bin directory, i.e.
the same directory that java.exe is found.
The standard behavior for this publisher is to send the device the "on"
signal when the build breaks and then the "off" signal when the build is
successful. If you want the opposite, i.e. on when successful and off when
broken, set the onWhenBroken attribute to false.
Publisher Attributes:
Constructor Summary | |
X10Publisher()
|
Method Summary | |
protected com.jpeterson.x10.Transmitter |
getTransmitter()
|
void |
handleBuild(boolean isBroken)
|
void |
publish(org.jdom.Element cruisecontrolLog)
Define the publishing. |
void |
setDeviceCode(java.lang.String code)
|
void |
setHouseCode(java.lang.String code)
|
void |
setInterfaceModel(java.lang.String model)
|
void |
setOnWhenBroken(boolean shouldTurnOn)
|
void |
setPort(java.lang.String portName)
The x10 cm11a library defaults to com2 for the port, so this attribute is optional. |
void |
turnOff()
|
void |
turnOn()
|
void |
validate()
Called after the configuration is read to make sure that all the mandatory parameters were specified.. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public X10Publisher()
Method Detail |
public void publish(org.jdom.Element cruisecontrolLog) throws CruiseControlException
Publisher
publish
in interface Publisher
cruisecontrolLog
- JDOM Element representation of the main cruisecontrol build log
CruiseControlException
public void handleBuild(boolean isBroken) throws CruiseControlException
CruiseControlException
public void turnOn() throws CruiseControlException
CruiseControlException
public void turnOff() throws CruiseControlException
CruiseControlException
protected com.jpeterson.x10.Transmitter getTransmitter() throws CruiseControlException
CruiseControlException
public void validate() throws CruiseControlException
Publisher
validate
in interface Publisher
CruiseControlException
- if there was a configuration error.public void setHouseCode(java.lang.String code)
public void setDeviceCode(java.lang.String code)
public void setPort(java.lang.String portName)
public void setOnWhenBroken(boolean shouldTurnOn)
public void setInterfaceModel(java.lang.String model)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |