X 1 0 A P I 1.0.1 D o c u m e n t a t i o n |
J e s s e P e t e r s o n |
Contents
Release NotesREADME, ChangesAPI Documentation
README
ChangesBugs
Known and fixed bugs
Reference to packages, classes and members. Generated by javadoc.X10 API DocumentationSamples, Tutorials
Examples of how to use the X10 API.Introduction
The introduction provides some background information on how to use the X10 API.CM11AEvents
CM11AEvents is a test program to generate the CM11A eventsCM11AEvent
andCM11AStatus
.DownloadMacros
DownloadMacros is an example program that demonstrates how to configure and download both macro initiated and timer initiated macros to the CM11A device.EmbeddedGateway
EmbeddedGateway is an example program that demonstrates the use of the X10 API with the TINI processor. The TINI processor is an embedded processor capable of running Java programs. The demonstration program implements an X10 gateway by using the TINI's serial port to connect to a CM11A and the TINI's ethernet port to receive X10 events from IP based clients and send X10 event notification to IP based listeners. The program implements the same interface as that described for the X10Server program. Because it the same protocol as theX10Server
, the programsMulticastListener
andX10ServerClient
will also withEmbeddedGateway
.MonitorX10
MonitorX10 is a utility program that listens for X10 events received from the CM11A device and prints the events to the screen. This allows you to monitor the activity on the poweline X10 network.MulticastListener
MulticastListener is an example program that listens for X10Event UDP multicast messages sent from an X10Server. See the X10Server sample below for more information.SendX10
SendX10 is a command line interface to send basic X10 commands through either a CM11A or CM17A device.SetClock
SetClock is an example program that sets the CM11A device's internal clock.SpeakX10
SpeakX10 is a Java Speech API enabled program that monitors X10 commands. When a command is tranmitted through your power line network, this program will speak the command.X10Server
X10Server is a network accessible server that allows X10 commands to be sent via a TCP socket connection and transmitting simple ASCII command strings. X10 events from the X10 powerline network are also transmitted via UDP multicast message broadcasts which are available to any program listening on the correct UDP port and group. An example client can be found below under X10ServerClient. An example event listener can be found above under MulticastListener.X10ServerClient
X10ServerClient is a simple text based client that exercises an X10Server's ability to receive X10 commands via a network TCP connection. For more information about the X10Server program, see the description above.
Copyright © 2000 Jesse Peterson