/* This actor senses specified X10 commands.
Copyright (c) 2003-2009 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.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;
//////////////////////////////////////////////////////////////////////////
//// LevelListener
/**
This actor will output an integer between 0 and 100 whenever a specified
command with the specified house and unit code is detected. If this actor
fires and no such command has been issued, then it outputs -1. Only commands
that have levels associated with them are supported, namely DIM and BRIGHT.
For on-off commands, use {@link CommandListener}.
<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 CommandListener
@author Colin Cochran, Edward A. Lee
@version $Id$
@since Ptolemy II 4.0
@Pt.ProposedRating Yellow (eal)
@Pt.AcceptedRating Red (ptolemy)
*/
public class LevelListener 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 LevelListener(CompositeEntity container, String name)
throws NameDuplicationException, IllegalActionException {
super(container, name);
// Create output port.
level = new TypedIOPort(this, "level", false, true);
level.setTypeEquals(BaseType.INT);
// Identify the command to detect.
command = new StringParameter(this, "command");
command.addChoice("BRIGHT");
command.addChoice("DIM");
command.setExpression("BRIGHT");
// 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 BRIGHT or DIM. The default is BRIGHT.
*/
public StringParameter command;
/** An output with value 0-100, inclusive, is produced on this port
* when the specified X10 command is detected for the specified
* house and unit codes.
*/
public TypedIOPort level;
/** 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. It is an integer that defaults to 1.
*/
public Parameter unitCode;
///////////////////////////////////////////////////////////////////
//// public methods ////
/** Output an integer between 0 and 100 if the specified command
* is sensed with the specified house and unit codes, and output
* -1 otherwise. If there are additional commands pending, then
* request another firing at the current time before returning.
* @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.BRIGHT;
String commandValue = command.stringValue();
if (!commandValue.equals("BRIGHT")) {
functionOfInterest = Command.DIM;
}
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)) {
level.send(0, new IntToken(sensedCommand.getLevel()));
} else {
level.send(0, _NO_COMMAND_TOKEN);
}
} else {
level.send(0, _NO_COMMAND_TOKEN);
}
}
///////////////////////////////////////////////////////////////////
//// private members ////
// Token to produce when no command is detected.
private static final IntToken _NO_COMMAND_TOKEN = new IntToken(-1);
}