/* This actor senses specified X10 commands.
Copyright (c) 2003-2005 The Regents of the University of California.
All rights reserved.
Permission is hereby granted, without written agreement and without
license or royalty fees, to use, copy, modify, and distribute this
software and its documentation for any purpose, provided that the above
copyright notice and the following two paragraphs appear in all copies
of this software.
IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
ENHANCEMENTS, OR MODIFICATIONS.
PT_COPYRIGHT_VERSION_2
COPYRIGHTENDKEY
*/
package ptolemy.actor.lib.x10;
import ptolemy.actor.TypedIOPort;
import ptolemy.data.BooleanToken;
import ptolemy.data.IntToken;
import ptolemy.data.expr.Parameter;
import ptolemy.data.expr.StringParameter;
import ptolemy.data.type.BaseType;
import ptolemy.kernel.CompositeEntity;
import ptolemy.kernel.util.IllegalActionException;
import ptolemy.kernel.util.NameDuplicationException;
import x10.Command;
//////////////////////////////////////////////////////////////////////////
//// CommandListener
/**
This actor will output a <i>true</i> whenever a specified command with the
specified house and unit code is detected. Only commands that are present
or absent are supported by this actor. Use LevelSensor for commands (like
BRIGHT and DIM) that have levels associated with them.
<p>
A typical use of this actor is to have a
motion sensor (or "occupancy sensor") with the specified house and unit
code. If there is a such a motion sensor, then this actor will output
true when it detects command.
<p>Note that an X10 motion sensor can be used to turn on and off devices
directly if they have the same house and unit codes. The motion sensor
will broadcast an on command and after some time an off command for that
house and unit code. This actor, however, only reacts to the on command
by producing an output <i>true</i>.
<p>Note also that the CM17A wireless interface is unidirectional, only sending
commands to the X10 network, and not receiving from it. Thus, this
actor will not work with it (or more precisely, it will only report
commands that are sent out from the same serial port).
@see LevelListener
@author Colin Cochran, Edward A. Lee
@version $Id$
@since Ptolemy II 4.0
@Pt.ProposedRating Yellow (eal)
@Pt.AcceptedRating Red (ptolemy)
*/
public class CommandListener extends Receiver {
/** Construct an actor with the given container and name.
* @param container The container.
* @param name The name of this actor.
* @exception IllegalActionException If the actor cannot be contained
* by the proposed container.
* @exception NameDuplicationException If the container already has an
* actor with this name.
*/
public CommandListener(CompositeEntity container, String name)
throws NameDuplicationException, IllegalActionException {
super(container, name);
// Create output port.
detected = new TypedIOPort(this, "detected", false, true);
// Output true if detected is detected.
detected.setTypeEquals(BaseType.BOOLEAN);
// Identify the command to detect.
command = new StringParameter(this, "command");
command.addChoice("ON");
command.addChoice("OFF");
command.addChoice("ALL_LIGHTS_ON");
command.addChoice("ALL_LIGHTS_OFF");
command.addChoice("ALL_UNITS_OFF");
command.setExpression("ON");
// Parameters.
houseCode = new StringParameter(this, "houseCode");
houseCode.setExpression("A");
unitCode = new Parameter(this, "unitCode");
unitCode.setTypeEquals(BaseType.INT);
unitCode.setExpression("1");
}
///////////////////////////////////////////////////////////////////
//// ports and parameters ////
/** The X10 command to listen for. This is a string with a value
* that is one of ALL_LIGHTS_OFF, ALL_LIGHTS_ON, ALL_UNITS_OFF,
* OFF, or ON. The default is ON.
*/
public StringParameter command;
/** An output with value true is produced on this port when the specified
* X10 command is detected for the specified house and unit codes.
*/
public TypedIOPort detected;
/** This string is the house code for the command that this
* actor listens for. The default value is "A".
*/
public StringParameter houseCode;
/** This parameter is the unit code for the command that this
* actor listens for. This is an integer that defaults to 1.
*/
public Parameter unitCode;
///////////////////////////////////////////////////////////////////
//// public methods ////
/** Output true if the specified command is sensed with the specified
* house and unit codes, and output false otherwise.
* @exception IllegalActionException If the super class throws it.
*/
public void fire() throws IllegalActionException {
super.fire();
// Check whether a command is ready
if (_commandReady()) {
Command sensedCommand = _getCommand();
byte function = sensedCommand.getFunctionByte();
byte functionOfInterest = Command.ON;
String commandValue = command.stringValue();
if (commandValue.equals("OFF")) {
functionOfInterest = Command.OFF;
} else if (commandValue.equals("ALL_LIGHTS_ON")) {
functionOfInterest = Command.ALL_LIGHTS_ON;
} else if (commandValue.equals("ALL_LIGHTS_OFF")) {
functionOfInterest = Command.ALL_LIGHTS_OFF;
} else if (commandValue.equals("ALL_UNITS_OFF")) {
functionOfInterest = Command.ALL_UNITS_OFF;
}
String sensedHouseCode = "" + sensedCommand.getHouseCode();
int sensedUnitCode = sensedCommand.getUnitCode();
String houseCodeValue = houseCode.stringValue();
int unitCodeValue = ((IntToken) unitCode.getToken()).intValue();
if (sensedHouseCode.equals(houseCodeValue)
&& (sensedUnitCode == unitCodeValue)
&& (function == functionOfInterest)) {
detected.send(0, BooleanToken.TRUE);
} else {
detected.send(0, BooleanToken.FALSE);
}
} else {
detected.send(0, BooleanToken.FALSE);
}
}
}