agentland.output
Interface X10

All Known Subinterfaces:
LynX10, TwoWayX10
All Known Implementing Classes:
X10Agent

public interface X10
extends Device

Universal for all X10 controllers. To make the interface really uniform, whenever we talk about the brightness level, we will express it in % therefore the range should be 0-100 regardless of what your particular controller takes. (our old controller takes 0-15, Two way takes 0-20 so some way of normalizing it was needed)

See Also:
Agent

Fields inherited from interface metaglue.Agent
ALIVE, DIED, NO_METAGLUE, NOT_RUNNING, STARTING
 
Fields inherited from interface metaglue.Agent
ALIVE, DIED, NO_METAGLUE, NOT_RUNNING, STARTING
 
Method Summary
 boolean brightenBy(char housecode, int module, int delta)
           
 boolean brightenBy(String housecode, int module, int delta)
           
 boolean brightenBy(Vector devs, int delta)
           
 boolean brightenBy(X10Data dev, int delta)
           
 boolean brightenTo(char housecode, int module, int level)
           
 boolean brightenTo(String housecode, int module, int level)
           
 boolean brightenTo(Vector devs, int level)
           
 boolean brightenTo(X10Data dev, int level)
           
 boolean dimBy(char housecode, int module, int delta)
           
 boolean dimBy(String housecode, int module, int delta)
           
 boolean dimBy(Vector devs, int delta)
           
 boolean dimBy(X10Data dev, int delta)
           
 boolean dimTo(char housecode, int module, int level)
           
 boolean dimTo(String housecode, int module, int level)
           
 boolean dimTo(Vector devs, int level)
           
 boolean dimTo(X10Data dev, int level)
           
 boolean fadeOff(char housecode, int module)
           
 boolean fadeOff(String housecode, int module)
           
 boolean fadeOff(Vector devs)
           
 boolean fadeOff(X10Data dev)
           
 DeviceState getDimState(String housecode, int module)
           
 DeviceState getOnState(String housecode, int module)
           
 void resetSerialX10()
           
 boolean turnOff(char housecode, int module)
           
 boolean turnOff(String housecode, int module)
           
 boolean turnOff(Vector devs)
           
 boolean turnOff(X10Data dev)
           
 boolean turnOn(char housecode, int module)
           
 boolean turnOn(String housecode, int module)
           
 boolean turnOn(Vector devs)
           
 boolean turnOn(X10Data dev)
           
 
Methods inherited from interface agentland.device.Device
addName, getName, getNames, getState, getState, getStateNames, hasName, resetAllStates, resetName, resetState, resetState, setName, setState
 
Methods inherited from interface agentland.resource.Managed
getNeed, replace, resources, yank, yank
 
Methods inherited from interface agentland.util.Good
getHistory, getHistoryElement, resetHistory
 
Methods inherited from interface agentland.util.Spy
tell
 

Method Detail

resetSerialX10

public void resetSerialX10()
                    throws RemoteException

turnOn

public boolean turnOn(char housecode,
                      int module)
               throws RemoteException

turnOn

public boolean turnOn(String housecode,
                      int module)
               throws RemoteException

turnOn

public boolean turnOn(X10Data dev)
               throws RemoteException

turnOn

public boolean turnOn(Vector devs)
               throws RemoteException

turnOff

public boolean turnOff(char housecode,
                       int module)
                throws RemoteException

turnOff

public boolean turnOff(String housecode,
                       int module)
                throws RemoteException

turnOff

public boolean turnOff(X10Data dev)
                throws RemoteException

turnOff

public boolean turnOff(Vector devs)
                throws RemoteException

fadeOff

public boolean fadeOff(char housecode,
                       int module)
                throws RemoteException

fadeOff

public boolean fadeOff(String housecode,
                       int module)
                throws RemoteException

fadeOff

public boolean fadeOff(X10Data dev)
                throws RemoteException

fadeOff

public boolean fadeOff(Vector devs)
                throws RemoteException

dimBy

public boolean dimBy(char housecode,
                     int module,
                     int delta)
              throws RemoteException

dimBy

public boolean dimBy(String housecode,
                     int module,
                     int delta)
              throws RemoteException

dimBy

public boolean dimBy(X10Data dev,
                     int delta)
              throws RemoteException

dimBy

public boolean dimBy(Vector devs,
                     int delta)
              throws RemoteException

dimTo

public boolean dimTo(char housecode,
                     int module,
                     int level)
              throws RemoteException

dimTo

public boolean dimTo(String housecode,
                     int module,
                     int level)
              throws RemoteException

dimTo

public boolean dimTo(X10Data dev,
                     int level)
              throws RemoteException

dimTo

public boolean dimTo(Vector devs,
                     int level)
              throws RemoteException

brightenBy

public boolean brightenBy(char housecode,
                          int module,
                          int delta)
                   throws RemoteException

brightenBy

public boolean brightenBy(String housecode,
                          int module,
                          int delta)
                   throws RemoteException

brightenBy

public boolean brightenBy(X10Data dev,
                          int delta)
                   throws RemoteException

brightenBy

public boolean brightenBy(Vector devs,
                          int delta)
                   throws RemoteException

brightenTo

public boolean brightenTo(char housecode,
                          int module,
                          int level)
                   throws RemoteException

brightenTo

public boolean brightenTo(String housecode,
                          int module,
                          int level)
                   throws RemoteException

brightenTo

public boolean brightenTo(X10Data dev,
                          int level)
                   throws RemoteException

brightenTo

public boolean brightenTo(Vector devs,
                          int level)
                   throws RemoteException

getOnState

public DeviceState getOnState(String housecode,
                              int module)
                       throws RemoteException

getDimState

public DeviceState getDimState(String housecode,
                               int module)
                        throws RemoteException