Below are a description of each of the files of this project.
/
- COPYRIGHT
- GNU copyright notice for
the project
- index.html
- Redirects to
docs/index.html
- README.txt
- text file which tells the
user to open index.html in a browser
- build.xml
- ant build file for the project
/src/com/hackingroomba/roombacomm
- FrameProcessor.java
- An class to handle visual
processing from a camera mounted on
the roomba.
- Used by:
com.hackingroomba.roombacomm.Bsquare
- JImagePanel.java
- It looks like nothing
references this in the project. Maybe it
was an early version/contriubutor to FrameProcessor.java ?
- Note.java
- Simple wrapper for musical
notes
- Used by:
com.hackingroomba.roombacomm.
- RoombaComm
- RTTTLPlay
- RoombaCommFrame
- RoombaCommPanel
- RoombaCommSerial
- RTTTLParser.java
- A simple class to allow a
"rttlstring" into an ArrayList of
notes. The array can later be passed to a connected Roomba to make it
sing a song. How to use this is deminstrated in
com.hackingroomba.roombacomm.RoombaCommFrame.playSong(RoombaComm
roombacomm, String rtttl)
- Used by:
com.hackingroomba.roombacomm.
- RTTTLPlay
- RoombaCommFrame
- RoombaCommPanel
- RoombaCommSerial
- A few sample rttlstrings
you could use are included here ( you
can find more via google. :) )
- (close encounters of the
third kind)
closeencounter:d=16,o=5,b=125:d,p,e,p,c,p.,c4,p,g4,1p.,d6,p,e6,p,c6,p.,c,p,g,1p.,
- Thunderstruck, ACDC)
thunderstr:d=16,o=5,b=160:c6,c,a#,c,a,c,a#,c,a,c,g,c,a,c,f,c,g,c,e,c,f,c,e,c,f,c,e,c,f,c,e,c
- RoombaComm.java
- This is the primary
implementation for this project. It is an
abstract class that acts as an abstraction layer from the iRobot API's
for the models of Roomba's that this project is attempting to support.
The class is designed to simplify users use of the iRobot API and to
provide as consistent as possible abstraction layer between versions of
the iRobot API versions. This interface is currently implemented based
on how the Roombacomm will connect to the Roomba device. There are two
main implementations of this interface: RoombaCommSerial.java
and RoombaCommTCPClient.java
.
- RoombaCommFrame.java
- This is a Java Swing User
Interface(UI). It is intended to
allow a user to manually control their roomba from their PC. GUI size
options may be available to support desktop and/or Netbook screen
resolutions in the future.
- RoombaCommGUI.java
- This is a class designed
to start a graphical interface (mainly
RoombaCommFrame.java, but others may be possible in the future) that
can be used to manually control the features of the RoombaComm library.
The main function of this class is to handle command line interfaces
(CLI) inputs and to provide an example of how other applications could
reuse RoombaCommFrame.java for their own use.
- RoombaCommSerial.java
- The serial-port based
implementation of RoombaComm. Designed
for physical RS-232 ports, USB adapter ports like Keyspan USA-19HS, and
Bluetooth serial port profiles.
- RoombaCommTCPClient.java
- This class is an extension
of the RoombaComm interface. This
implementation is designed to communicate with the Roomba device across
a TCP/IP network.
- images/
- This is a directory of
image files used in the the GUI's.
Classes designed for specific test(s)
- Bsquare.java
- Drive the Roomba forward,
back, or CW or CCW square
- BumpTurn.java
- Read sensors to detect
bumps and turn away from them while
driving
- Drive.java
- command line controls to
move a Roomba (RoombaCommSerial only)
- DriveRealTime.java
- GUI to allow user to use
arrow keys to drive a Roomba in real
time (RoombaCommSerial only)
- ListSerialPorts.java
- A simple command line
program to enumerate the Serial ports
that the application sees in the environment.
- LogoA.java
- Make a square with a
Roomba.
Leaves Roomba in same place it began (theoretically)
Older classes (Legacy?/Depreciated?) that may not be maintained by this
project going forward:
- RoombaCommPanel.java
- This
is an older graphical interface that can be used to manually control
some of the features of the project. This UI is the orginal work of Tod
E. Kurt, and is not being maintained so that any external to the
project references can be perserved. (However, the location of the
class has been changed to match the project ongoing source tree
structure.)
- RoombaCommTest.java
- A small GUI to test out
RoombaComm.
- This class is simlar in
concept to the RoombaCommGUI class.
However it uses the RoombaCommPanel for the UI that it starts for the
user.
- RoombaCommTestOld.java
- A small GUI to test out
RoombaComm. (an Even earlier version of
RoombacommTest.java)
- This class is simlar in
concept to the RoombaCommGUI class.
However it uses the RoombaCommPanel for the UI that it starts for the
user.
- RTTTLPlay.java
- Play RTTL formatted
ringtones on the Roomba.
This class only supports a serial connection to a Roomba to play a RTTL
string from a command line parameter.
- RoombaRecorder.java
- A simple wrapper for
multiple MacroRecorderPanels
- This UI allows the user
to record and play back movements for
a roomba.
- RoombaRecorderPanel.java
- GUI (tab) for
RoombaRecorder
A Panel containing controls for testing RoombaComm.
- SimpleTest.java
- A simple test of
RoombaCommSerial functionality.
- Spiral.java
- Make the Roomba drive in a
spiral. (RoombaCommSerial only)
- Spiro1.java
- A Spirograph-like example
(RoombaCommSerial only)
- Spiro2.java
- A Spirograph-like example with additional parameters and
behaviors
(RoombaCommSerial only)
- Spy.java
- Connect to a roomba
(RoombaCommSerial only) and watch sensor
data comming back from the device.
NEED to find the differences between Spy.java, SpyAuto.java,
and SpySimple.java
- SpyAuto.java
- Connect to a roomba
(RoombaCommSerial only) and watch sensor
data comming back from the device.
NEED to find the differences between Spy.java, SpyAuto.java,
and SpySimple.java
- SpySimple.java
- Connect to a roomba
(RoombaCommSerial only) and watch sensor
data comming back from the device.
NEED to find the differences between Spy.java, SpyAuto.java,
and SpySimple.java
- Test.java
- Connect to a roomba
(RoombaCommSerial only) and run through a
static set of operations to exercise the older RoombaComm Library.
- Tribble.java
- Connect to a roomba
(RoombaCommSerial only) and make it make
Tribble noises
- Waggle.java
- Connect to a roomba
(RoombaCommSerial only) Drive the Roomba in
a Waggle, like when it's searching for something
- net/
- DumpMethods
- use Java reflection to
output methods of the RoombaCommSerial
class.
Looks to be heavily based on a Simple Example from
http://java.sun.com/developer/technicalArticles/ALT/Reflection/
- RoombaCommTCPServer
- an early ServerSocket
based attempt to communicate with a
Roomba
- SimpleTest
- Connect to a roomba
(RoombaCommSerial only) and run through a
static set of operations to exercise the older RoombaComm Library.
AR: Paul look at
whether
this is really a duplicate of the file in roombacomm - if so, delete it
- TextHttpServer
- Appears to be a
crude(maybe a sample from somewhere?) class
to
implement an Http Server. It appears to have no direct links/references
to RoombaComm.
/src/scripts
- runit.bat and runit.sh:
Windows and Unix
scripts that set CLASSPATH & run the programs from the proper
places
- RoombaCommTest.bat,
RoombaCommTest.sh,
RoombaCommGUI.bat and RoombaCommGUI.sh:
/src/processing-examples
Directories intended to be copied into the users Processing work
directory
- roombaring/roombaring.pde:
Play a tune on Roomba (possibly the tron theme).
- roombatune/roombatune.pde:
Allow the user to use their PC keyboard as a a musical keyboard to play
notes in real time on the Roomba
- roombaview/roombaview.pde:
Provide a GUI to drive roomba which runs inside the
Processing environment. The GUI uses direction buttons to control
Roomba and moves it across a grid in the GUI as Roomba drives.
- roombaview/data/: Directory containing
images displayed by the GUI.
- roombaview/libraries/MyGUI/library: Directory
contains
MyGUI.jar, which provides button handling etc for the application.
Check the processing documentation for where to copy the MyGUI library.
/docs
- Index.html: Project
overview and lead-in to documentation.
How to use the project (for non-developers.) Contains much of the
content from README in the original project structure
- DevelopersGuide.html:
Instructions on recommended configuration,
packages & tools that should be installed to enable
development.
Refers to the book where appropriate.
- DirectoryStructure.html: a
listing of directories in the project
- both source and those built automatically, and their purpose
- FileDescriptions.html: This
file. A description of each source
file in the project. Q: is there
a need to describe generated files?
- ToDo.html: list of things to
do to the project
- SVN_Info.html: Subversion
policies for the project
- eclipseHowTo.html:
Instructions for configuring eclipse for this
project. Contents from removed README.eclipse.txt file
- windowsHowTo.html:
Instructions specific to running roombacomm
under windows
- wifiRouterHowTo.html:
Instructions for connecting a wifi router
and installing & configuring the necessary daemons to provide
wifi
access to Roomba. (Content needs to come from Jonathan.)
/lib
- jargs.jar: library which supports posix-style command-line
arguments (hyphen-argument style
/lib/rxtxlib
- librxtxSerial.jnilib: Java extension which lets serial I/O escape
from the virtual machine
- rxtxSerial.dll: Windows dll which provides COM access to
librxtxSerial.jnilib
- librxtxSerial.so: Mac OS-X library which provices serial driver
access to librxtxSerial.jnilib
- RXTXcomm.jar: ???
- macosx_setup.command:a script to fix permissions for loc files on
Mac OS X
- README.rxtx: the name says it all