A B C D E F G I K L M O P R S T U X

A

ALL_LIGHTS_OFF - Static variable in class x10.Command
ALL_LIGHTS_OFF byte - the x10 function "All Lights Off".
ALL_LIGHTS_ON - Static variable in class x10.Command
ALL_LIGHTS_ON byte - the x10 function "All Lights On".
ALL_UNITS_OFF - Static variable in class x10.Command
ALL_UNITS_OFF byte - the x10 function "All Units Off".
ApplianceUnitPanel - class x10.awt.ApplianceUnitPanel.
ApplianceUnitPanel is an awt-based panel that can be used to control an X10 appliance module.
ApplianceUnitPanel(Controller, String) - Constructor for class x10.awt.ApplianceUnitPanel
ApplianceUnitPanel constructs a new awt-based panel for controling an X10 Appliance module.
ApplianceUnitPanel(Controller, String, String) - Constructor for class x10.awt.ApplianceUnitPanel
ApplianceUnitPanel constructs a new awt-based panel for controling an X10 Appliance module.
ApplicationUnitPanel - class x10.awt.ApplicationUnitPanel.
ApplicationUnitPanel is a UnitPanel that can be used to execute external programs.
ApplicationUnitPanel(String, Controller, String) - Constructor for class x10.awt.ApplicationUnitPanel
ApplicationUnitPanel constructs a new awt-based panel for controlling the execution of an external application/command.
ApplicationUnitPanel(String, Controller, String, String) - Constructor for class x10.awt.ApplicationUnitPanel
ApplicationUnitPanel constructs a new awt-based panel for controlling the execution of an external application/command.
actionPerformed(ActionEvent) - Method in class x10.awt.ApplianceUnitPanel
actionPerformed handles clicks on the On and Off buttons
actionPerformed(ActionEvent) - Method in class x10.awt.ApplicationUnitPanel
actionPerformed handles clicks on the On and Off buttons
actionPerformed(ActionEvent) - Method in class x10.awt.LightUnitPanel
actionPerformed handles clicks on the On and Off buttons
actionPerformed(ActionEvent) - Method in class x10.awt.MasterUnitPanel
actionPerformed handles clicks on the allLightsOn, allLightsOff and allUnitsOff buttons
addCommand(Command) - Method in class x10.CM11ASerialController
addCommand adds a command to the queue to be dispatched.
addCommand(Command) - Method in class x10.CM17ASerialController
addCommand adds a command to the queue to be dispatched.
addCommand(Command) - Method in interface x10.Controller
addCommand adds a Command to the queue to be dispatched to all hardware and software x10 modules.
addCommand(Command) - Method in class x10.awt.UnitPanel
addCommand is a convienience method for posting a command from the subclassed UnitPanel to the controller.
addCommand(Command) - Method in class x10.net.SocketController
addCommand adds a Command to be queued and then dispatched to the ControllerServer
addUnitListener(UnitListener) - Method in class x10.CM11ASerialController
addUnitListener registers the UnitListener for events.
addUnitListener(UnitListener) - Method in class x10.CM17ASerialController
addUnitListener registers the UnitListener for events.
addUnitListener(UnitListener) - Method in interface x10.Controller
addUnitListener registers the specified UnitListener to recieve ALL events that occur, whether initiated by hardware or software control modules.
addUnitListener(UnitListener) - Method in class x10.UnitEventDispatcher
addUnitListener adds the specified UnitListener to the list of listeners that are notified by the dispatcher.
addUnitListener(UnitListener) - Method in class x10.net.SocketController
addUnitListener registers the specified UnitListener to recieve UnitEvents
address - Variable in class x10.awt.UnitPanel
address String - the X10 device address associated with this panel.
adjustmentValueChanged(AdjustmentEvent) - Method in class x10.awt.LightUnitPanel
adjustmentValueChanged handles adjustments to the range bar for dimming and brightening
allLightsOff(UnitEvent) - Method in interface x10.UnitListener
allLightsOff is called when an x10 All Lights Off event occurs.
allLightsOff(UnitEvent) - Method in class x10.awt.UnitPanel
 
allLightsOff(UnitEvent) - Method in class x10.net.ServerDispatchProxy
allLightsOff recieves the UnitListener event to be dispatched to the SocketController
allLightsOn(UnitEvent) - Method in interface x10.UnitListener
allLightsOn is called when an x10 All Lights On event occurs.
allLightsOn(UnitEvent) - Method in class x10.awt.ApplianceUnitPanel
 
allLightsOn(UnitEvent) - Method in class x10.awt.ApplicationUnitPanel
 
allLightsOn(UnitEvent) - Method in class x10.awt.UnitPanel
 
allLightsOn(UnitEvent) - Method in class x10.net.ServerDispatchProxy
allLightsOn recieves the UnitListener event to be dispatched to the SocketController
allUnitsOff(UnitEvent) - Method in interface x10.UnitListener
allUnitsOff is called when an x10 All Units Off event occurs.
allUnitsOff(UnitEvent) - Method in class x10.awt.UnitPanel
 
allUnitsOff(UnitEvent) - Method in class x10.net.ServerDispatchProxy
allUnitsOff recieves the UnitListener event to be dispatched to the SocketController

B

BRIGHT - Static variable in class x10.Command
BRIGHT byte - the x10 function "Bright".
brighten(int) - Method in class x10.awt.ApplianceUnitPanel
 
brighten(int) - Method in class x10.awt.ApplicationUnitPanel
 
brighten(int) - Method in class x10.awt.LightUnitPanel
 
brighten(int) - Method in class x10.awt.MasterUnitPanel
 
brighten(int) - Method in class x10.awt.UnitPanel
brighten should be implemented by the subclass to handle receiving a brighten command.

C

CM11ASerialController - class x10.CM11ASerialController.
CM11ASerialController is an X10 Controller that bridges x10 hardware and software by communicating via a SerialPort with the x10 "CM11A" module.
CM11ASerialController(String) - Constructor for class x10.CM11ASerialController
CM11ASerialController constructs and starts the Controller on the specified comport.
CM17ASerialController - class x10.CM17ASerialController.
CM17ASerialController is an X10 Controller that bridges x10 hardware and software by communicating via a SerialPort with the x10 "Firecracker" module.
CM17ASerialController(String) - Constructor for class x10.CM17ASerialController
CM17ASerialController constructs and starts the Controller on the specified comport.
Command - class x10.Command.
Command represents an x10 command.
Command(byte, byte) - Constructor for class x10.Command
Command constructs a Command object with the specified address and function.
Command(byte, byte, byte) - Constructor for class x10.Command
Command constructs a Command object with the specified address, function, and level.
Command(String, byte) - Constructor for class x10.Command
Command constructs a Command object with the specified address and function.
Command(String, byte, int) - Constructor for class x10.Command
Command constructs a Command object with the specified address, function, and level.
Controller - interface x10.Controller.
Controller is implemented by any class that can act as an entry point for controlling x10 devices.
ControllerServer - class x10.net.ControllerServer.
ControllerServer is a Network daemon for providing access to a Controller over a network.
ControllerServer(Controller, int) - Constructor for class x10.net.ControllerServer
ControllerServer constructs a new ControllerServer network daemon which provides access to the specified Controller on the specified port.

D

DATA_POLL - Static variable in class x10.CM11ASerialController
DATA_POLL byte - the x10 "CM11A" protocol DATA_POLL byte.
DIM - Static variable in class x10.Command
DIM byte - the x10 function "Dim".
dequeue() - Method in class x10.util.ThreadSafeQueue
dequeue removes and returns the first object in the queue without blocking.
dequeue(Object) - Method in class x10.util.ThreadSafeQueue
dequeue removes the specified object from the queue if and only if the specified object is the first object in the queue.
dequeueNextAvailable() - Method in class x10.util.ThreadSafeQueue
dequeueNextAvailable blocks until the next object becomes available to the queue.
dim(int) - Method in class x10.awt.ApplianceUnitPanel
 
dim(int) - Method in class x10.awt.ApplicationUnitPanel
 
dim(int) - Method in class x10.awt.LightUnitPanel
 
dim(int) - Method in class x10.awt.MasterUnitPanel
 
dim(int) - Method in class x10.awt.UnitPanel
dim should be implemented by the subclass to handle receiving a dim command.
dispatchUnitEvent(UnitEvent) - Method in class x10.UnitEventDispatcher
dispatchUnitEvent adds the specified UnitEvent to the queue of events to be dispatched.

E

empty() - Method in class x10.util.ThreadSafeQueue
empty completely removes all objects that are currently in the queue.
enqueue(Object) - Method in class x10.util.ThreadSafeQueue
enqueue adds the specified object to the end of the queue

F

finalize() - Method in class x10.CM11ASerialController
finalize disconnects the serial port connection and closes the Controller.
finalize() - Method in class x10.CM17ASerialController
finalize disconnects the serial port connection and closes the Controller.

G

getAddress() - Method in class x10.Command
getAddress returns the x10 address in ready-to-send "CM11A" protocol format.
getAddress(byte) - Static method in class x10.Command
getAddress returns a String-based x10 address as a [HouseCode][UnitCode] two-character String, based on the specified address in x10 "CM11A" protocol format.
getAddress() - Method in class x10.awt.UnitPanel
getAddress returns the X10 address of this virtual Unit.
getCommand() - Method in class x10.UnitEvent
getCommand returns the command that generated this event.
getController() - Method in class x10.awt.UnitPanel
getController returns the x10.Controller that is responsible for controlling this virtual Unit.
getFunction() - Method in class x10.Command
getFunction returns the x10 function in ready-to-send "CM11A" protocol format.
getFunction(byte) - Static method in class x10.Command
getFunction returns the function as a constant (specified above), based on the specified function in x10 "CM11A" protocol format.
getFunctionByte() - Method in class x10.Command
getFunctionByte returns the function of this Command.
getHouseCode() - Method in class x10.Command
getHouseCode returns the housecode as a character.
getLevel() - Method in class x10.Command
getLevel returns the level associated with this Command.
getLogHandler() - Static method in class x10.util.LogHandler
getLogHandler obtains the system's singleton LogHandler that is shared by all systems.
getState() - Method in class x10.awt.ApplianceUnitPanel
getState returns the current state of the associated module.
getState() - Method in class x10.awt.ApplicationUnitPanel
getState returns the current state of the associated module.
getState() - Method in class x10.awt.LightUnitPanel
getState returns the current state of the associated module.
getTitle() - Method in class x10.awt.ApplianceUnitPanel
getTitle returns the title associated with this panel
getTitle() - Method in class x10.awt.ApplicationUnitPanel
getTitle returns the title associated with this panel
getTitle() - Method in class x10.awt.LightUnitPanel
getTitle returns the title associated with this panel
getTitle() - Method in class x10.awt.MasterUnitPanel
getTitle returns the title associated with this panel
getUnitCode() - Method in class x10.Command
getUnitCode returns the unitcode as an integer.
getValue() - Method in class x10.awt.LightUnitPanel
getValue returns the current brightness percentage

I

isValid(String) - Static method in class x10.Command
isValid checks the specified address to see if it is valid.

K

kill() - Method in class x10.UnitEventDispatcher
kill terminates the dispatcher thread.

L

LightUnitPanel - class x10.awt.LightUnitPanel.
LightUnitPanel is an awt-based panel that can be used to control a dimmable X10 light module.
LightUnitPanel(Controller, String) - Constructor for class x10.awt.LightUnitPanel
LightUnitPanel constructs a new awt-based panel for controling a dimmable X10 light module.
LightUnitPanel(Controller, String, String) - Constructor for class x10.awt.LightUnitPanel
LightUnitPanel constructs a new awt-based panel for controling a dimmable X10 light module.
LogHandler - class x10.util.LogHandler.
LogHandler provides a simple, standard api for handling logging of application events.
log(String, int) - Method in class x10.util.LogHandler
log outputs the specified message to the log.
log(Exception, int) - Method in class x10.util.LogHandler
log outputs the stack trace of the pecified exception to the log.
logException(Exception, int) - Static method in class x10.util.LogHandler
logException outputs the stack trace of the pecified exception to the log.
logMessage(String, int) - Static method in class x10.util.LogHandler
logMessage outputs the specified message to the log.

M

MasterUnitPanel - class x10.awt.MasterUnitPanel.
MasterUnitPanel is an awt-based panel that can be used to control all connected X10 modules.
MasterUnitPanel(Controller, String) - Constructor for class x10.awt.MasterUnitPanel
MasterUnitPanel constructs a new awt-based panel for controling all connected X10 modules.
MasterUnitPanel(Controller, String, String) - Constructor for class x10.awt.MasterUnitPanel
MasterUnitPanel constructs a new awt-based panel for controling all connected X10 modules.

O

OFF - Static variable in class x10.Command
OFF byte - the x10 function "Off".
OK - Static variable in class x10.CM11ASerialController
OK byte - the x10 "CM11A" protocol OK byte.
ON - Static variable in class x10.Command
ON byte - the x10 function "On".
OperationTimedOutException - exception x10.OperationTimedOutException.
OperationTimedOutException is an exception to be thrown when an operation times out.
OperationTimedOutException() - Constructor for class x10.OperationTimedOutException
OperationTimedOutException constructs an OperationTimedOutException with no message
OperationTimedOutException(String) - Constructor for class x10.OperationTimedOutException
OperationTimedOutException constructs an OperationTimedOutException with the specified message
off() - Method in class x10.awt.ApplianceUnitPanel
 
off() - Method in class x10.awt.ApplicationUnitPanel
 
off() - Method in class x10.awt.LightUnitPanel
 
off() - Method in class x10.awt.MasterUnitPanel
 
off() - Method in class x10.awt.UnitPanel
off should be implemented by the subclass to handle receiveing an off command.
on() - Method in class x10.awt.ApplianceUnitPanel
 
on() - Method in class x10.awt.ApplicationUnitPanel
 
on() - Method in class x10.awt.LightUnitPanel
 
on() - Method in class x10.awt.MasterUnitPanel
 
on() - Method in class x10.awt.UnitPanel
on should be implemented by the subclass to handle receiving an on command.

P

PC_READY - Static variable in class x10.CM11ASerialController
PC_READY byte - the x10 "CM11A" protocol PC_READY byte.
peek() - Method in class x10.util.ThreadSafeQueue
peek returns the next available object in the queue without physically removing the object from the queue.

R

READY - Static variable in class x10.CM11ASerialController
READY byte - the x10 "CM11A" protocol READY byte.
removeUnitListener(UnitListener) - Method in class x10.CM11ASerialController
removeUnitListener unregisters the UnitListener for events.
removeUnitListener(UnitListener) - Method in class x10.CM17ASerialController
removeUnitListener unregisters the UnitListener for events.
removeUnitListener(UnitListener) - Method in interface x10.Controller
removeUnitListener unregisters the specified UnitListener.
removeUnitListener(UnitListener) - Method in class x10.UnitEventDispatcher
removeUnitListener removes the specified listener.
removeUnitListener(UnitListener) - Method in class x10.net.SocketController
removeUnitListener unregisters the specified UnitListener.
run() - Method in class x10.CM11ASerialController
run is the thread loop that constantly blocks and reads events off of the serial port from the "CM11A" module.
run() - Method in class x10.CM17ASerialController
run is the thread loop that constantly blocks and writes events to the serial port to the "Firecracker" module.
run() - Method in class x10.UnitEventDispatcher
run blocks until an event comes in, and then dispatches it to all registered listeners.
run() - Method in class x10.awt.ApplicationUnitPanel
run executes the wait thread for the application/command that was run
run() - Method in class x10.net.ControllerServer
run loops and accepts connections from SocketControllers over a network.
run() - Method in class x10.net.ServerDispatchProxy
run reads Commands from the SocketController and propogates them along to the local Controller object.
run() - Method in class x10.net.SocketController
run loops receiving events from the ControllerServer and then dispatching the events to locally registered UnitListeners.

S

ServerDispatchProxy - class x10.net.ServerDispatchProxy.
ServerDispatchProxy is the server-side proxy which dispatches events to and recieves commands from the SocketController assigned to this object.
ServerDispatchProxy(Socket, Controller) - Constructor for class x10.net.ServerDispatchProxy
ServerDispatchProxy constructs a new ServerDispatchProxy for the specified Controller to the SocketController on the other end of the specified Socket.
SocketController - class x10.net.SocketController.
SocketController is a Client-side virtual Controller object that connects to a ControllerServer via TCP socket.
SocketController(String, int) - Constructor for class x10.net.SocketController
SocketController constructs a SocketController that automatically connects to the ControllerServer on the specified host and port.
setAddress(String) - Method in class x10.Command
setAddress sets the housecode and unitcode of this command based on the specified address.
setFunction(byte) - Method in class x10.Command
setFunction sets the function of this command.
setFunction(byte, int) - Method in class x10.Command
setFunction sets the function and level of this command.
setTitle(String) - Method in class x10.awt.ApplianceUnitPanel
setTitle sets the title that appears at the top of this panel
setTitle(String) - Method in class x10.awt.ApplicationUnitPanel
setTitle sets the title that appears at the top of this panel
setTitle(String) - Method in class x10.awt.LightUnitPanel
setTitle sets the title that appears at the top of this panel
setTitle(String) - Method in class x10.awt.MasterUnitPanel
setTitle sets the title that appears at the top of this panel
shutdown(long) - Method in class x10.CM11ASerialController
shutdown tells the controller to finish all commands in the queue and then gracefully disconnects the serial port connection.
shutdown(long) - Method in class x10.CM17ASerialController
shutdown tells the controller to finish all commands in the queue and then gracefully disconnects the serial port connection.
shutdownNow() - Method in class x10.CM11ASerialController
shutdownNow shuts down the controller and closes the serial port immediately.
shutdownNow() - Method in class x10.CM17ASerialController
shutdownNow shuts down the controller and closes the serial port immediately.

T

TIME - Static variable in class x10.CM11ASerialController
TIME byte - the x10 "CM11A" protocol TIME byte.
TIME_POLL - Static variable in class x10.CM11ASerialController
TIME_POLL byte - the x10 "CM11A" protocol TIME_POLL byte.
ThreadSafeQueue - class x10.util.ThreadSafeQueue.
ThreadSafeQueue this is an implementation of a First In First Out (FIFO) data structure.
ThreadSafeQueue() - Constructor for class x10.util.ThreadSafeQueue
ThreadSafeQueue constructs an empty ThreadSafeQueue

U

UnitEvent - class x10.UnitEvent.
UnitEvent an event representing a change in state of an x10 hardware or software module.
UnitEvent(Command) - Constructor for class x10.UnitEvent
UnitEvent constructs a UnitEvent based on the specified Command.
UnitEventDispatcher - class x10.UnitEventDispatcher.
UnitEventDispatcher is a threaded dispatcher that calls each registered UnitListener when an event comes in.
UnitEventDispatcher() - Constructor for class x10.UnitEventDispatcher
UnitEventDispatcher constructs an unstarted dispatcher.
UnitListener - interface x10.UnitListener.
UnitListener is the interface implemented by objects that wish to recieve UnitEvents.
UnitPanel - class x10.awt.UnitPanel.
UnitPanel is the superclass extended by all awt x10 virtual unit panels.
UnitPanel(Controller, String) - Constructor for class x10.awt.UnitPanel
UnitPanel constructs the UnitPanel shell and registers with the controller, and associates the X10 device address.
unitBright(UnitEvent) - Method in interface x10.UnitListener
unitBright is called when an x10 Bright event occurs.
unitBright(UnitEvent) - Method in class x10.awt.UnitPanel
 
unitBright(UnitEvent) - Method in class x10.net.ServerDispatchProxy
unitBright recieves the UnitListener event to be dispatched to the SocketController
unitDim(UnitEvent) - Method in interface x10.UnitListener
unitDim is called when an x10 Dim event occurs.
unitDim(UnitEvent) - Method in class x10.awt.UnitPanel
 
unitDim(UnitEvent) - Method in class x10.net.ServerDispatchProxy
unitDim recieves the UnitListener event to be dispatched to the SocketController
unitOff(UnitEvent) - Method in interface x10.UnitListener
unitOff is called when an x10 Off event occurs.
unitOff(UnitEvent) - Method in class x10.awt.UnitPanel
 
unitOff(UnitEvent) - Method in class x10.net.ServerDispatchProxy
unitOff recieves the UnitListener event to be dispatched to the SocketController
unitOn(UnitEvent) - Method in interface x10.UnitListener
unitOn is called when an x10 On event occurs.
unitOn(UnitEvent) - Method in class x10.awt.UnitPanel
 
unitOn(UnitEvent) - Method in class x10.net.ServerDispatchProxy
unitOn recieves the UnitListener event to be dispatched to the SocketController

X

x10 - package x10
Core API's for building software-based X10 Modules, and communicating with hardware-based X10 Modules.
x10.awt - package x10.awt
API's for building awt-based X10 Modules and Virtual Controllers.
x10.net - package x10.net
Network Client and Server classes that use the core X10 API for providing X10 control over a network.
x10.util - package x10.util
Utilities used by the X10 packages.

A B C D E F G I K L M O P R S T U X

Copyright ©2000-2005 Wade Wassenberg.
On the web: http://x10.homelinux.org.
Send bug reports to x10@wass.homelinux.net.
Last Modified June 1, 2005