A B C D E F G H I K L M N O P R S T U V W

A

actionPerformed(ActionEvent) - Method in class roombacomm.RoombaCommPanel
implement actionlistener
actionPerformed(ActionEvent) - Method in class roombacomm.RoombaCommTestOld
implement actionlistener
angle() - Method in class roombacomm.RoombaComm
Angle traveled since last requested units: mm, diff in distance traveled by two drive wheels range: -32768 - 32767
angleInDegrees() - Method in class roombacomm.RoombaComm
angle since last read, but in degrees
angleInRadians() - Method in class roombacomm.RoombaComm
angle since last read, but in radians

B

bark() - Static method in class roombacomm.Tribble
 
binary(int) - Method in class roombacomm.RoombaComm
 
bpmToMillis(int) - Static method in class roombacomm.RTTTLParser
 
bump() - Method in class roombacomm.RoombaComm
Did we bump into anything
bumpLeft() - Method in class roombacomm.RoombaComm
Left bump sensor
bumpRight() - Method in class roombacomm.RoombaComm
Right bump sensor
bumps_wheeldrops() - Method in class roombacomm.RoombaComm
lower-level func, returns raw byte
BumpTurn - Class in roombacomm
Read sensors to detect bumps and turn away from them while driving
BumpTurn() - Constructor for class roombacomm.BumpTurn
 
buttons() - Method in class roombacomm.RoombaComm
lower-level func, returns raw byte

C

capacity() - Method in class roombacomm.RoombaComm
Estimated charge capacity of battery units: mAh range: 0-65535
charge() - Method in class roombacomm.RoombaComm
Current charge of battery units: mAh range: 0-65535
charging_state() - Method in class roombacomm.RoombaComm
Charging state units: enumeration range:
clean() - Method in class roombacomm.RoombaComm
Send the CLEAN command
cleanButton() - Method in class roombacomm.RoombaComm
'Clean' button pressed state
cliff_frontleft() - Method in class roombacomm.RoombaComm
lower-level func, returns raw byte
cliff_frontright() - Method in class roombacomm.RoombaComm
lower-level func, returns raw byte
cliff_left() - Method in class roombacomm.RoombaComm
lower-level func, returns raw byte
cliff_right() - Method in class roombacomm.RoombaComm
lower-level func, returns raw byte
cliffFrontLeft() - Method in class roombacomm.RoombaComm
front left cliff sensor
cliffFrontRight() - Method in class roombacomm.RoombaComm
front right cliff sensor
cliffLeft() - Method in class roombacomm.RoombaComm
left cliff sensor
cliffRight() - Method in class roombacomm.RoombaComm
right cliff sensor
computeSafetyFault() - Method in class roombacomm.RoombaComm
Compute possible safety fault.
computeSensors() - Method in class roombacomm.RoombaCommSerial
called by serialEvent when we have enough bytes to make sensors valid
connect(String) - Method in class roombacomm.RoombaComm
Connect to a port (for serial, portid is serial port name, for net, portid is url?)
connect() - Method in class roombacomm.RoombaCommPanel
 
connect(String) - Method in class roombacomm.RoombaCommSerial
Connect to a serial port specified by portid doesn't guarantee connection to Roomba, just to serial port
connected() - Method in class roombacomm.RoombaComm
Returns current connected state.
control() - Method in class roombacomm.RoombaComm
Send CONTROL command
createImageIcon(String, String) - Static method in class roombacomm.RoombaCommPanel
Returns an ImageIcon, or null if the path was invalid.
createImageIcon(String, String) - Static method in class roombacomm.RoombaCommTestOld
Returns an ImageIcon, or null if the path was invalid.
createSong(int, int[]) - Method in class roombacomm.RoombaComm
Make a song
createSong(int, Note[]) - Method in class roombacomm.RoombaComm
Make a song
createTribblePurrSong() - Static method in class roombacomm.Tribble
 
current() - Method in class roombacomm.RoombaComm
Current flowing in or out of battery units: mA range: -332768 - 32767

D

debug - Variable in class roombacomm.RoombaComm
turns on/off various debugging messages
defaultSensorsUpdateTime - Static variable in class roombacomm.RoombaComm
default update time in ms for auto sensors update
defaultSpeed - Static variable in class roombacomm.RoombaComm
default speed for movement operations if speed isn't specified
delay(int) - Method in class roombacomm.RoombaComm
Alias to pause
dirt() - Method in class roombacomm.RoombaComm
 
dirt_left() - Method in class roombacomm.RoombaComm
 
dirt_right() - Method in class roombacomm.RoombaComm
 
dirtLeft() - Method in class roombacomm.RoombaComm
amount of dirt seen by left dirt sensor
dirtRight() - Method in class roombacomm.RoombaComm
amount of dirt seen by right dirt sensor
disconnect() - Method in class roombacomm.RoombaComm
Disconnect from a port, clean up any memory in use
disconnect() - Method in class roombacomm.RoombaCommPanel
 
disconnect() - Method in class roombacomm.RoombaCommSerial
Disconnect from serial port
distance() - Method in class roombacomm.RoombaComm
Distance traveled since last requested units: mm range: -32768 - 32767
Drive - Class in roombacomm
Some example DRIVE things to do
Drive() - Constructor for class roombacomm.Drive
 
drive(int, int) - Method in class roombacomm.RoombaComm
Move the Roomba via the low-level velocity + radius method.
DriveRealTime - Class in roombacomm
Drive the Roomba with the arrow keys in real-time
DriveRealTime(String[]) - Constructor for class roombacomm.DriveRealTime
 
duration - Variable in class roombacomm.Note
 

E

errorMessage(String, Throwable) - Method in class roombacomm.RoombaComm
General error reporting, all corraled here just in case I think of something slightly more intelligent to do.

F

flushOutput - Variable in class roombacomm.RoombaCommSerial
RXTX bombs when flushing output sometimes, so by default do not flush the output stream.
full() - Method in class roombacomm.RoombaComm
Send FULL command

G

getSpeed() - Method in class roombacomm.RoombaComm
Get speed for movement commands
goBackward(int) - Method in class roombacomm.RoombaComm
 
goBackward() - Method in class roombacomm.RoombaComm
Go backward at the current (negative) speed
goBackwardAt(int) - Method in class roombacomm.RoombaComm
Go backward at a specified speed
goForward(int) - Method in class roombacomm.RoombaComm
 
goForward() - Method in class roombacomm.RoombaComm
Go forward the current (positive) speed
goForwardAt(int) - Method in class roombacomm.RoombaComm
Go forward at a specified speed
goStraight(int) - Method in class roombacomm.RoombaComm
Go straight at the current speed for a specified distance.
goStraightAt(int) - Method in class roombacomm.RoombaComm
Go straight at a specified speed.

H

hex(byte) - Method in class roombacomm.RoombaComm
 
hex(int) - Method in class roombacomm.RoombaComm
 

I

input - Variable in class roombacomm.RoombaCommSerial
the serial input stream, normally you don't need access to this
isPortInUse(String) - Static method in class roombacomm.RoombaCommSerial
Let you check to see if a port is in use by another Rooomba before trying to use it.

K

keyIsPressed() - Static method in class roombacomm.BumpTurn
check for keypress, return true if so
keyIsPressed() - Static method in class roombacomm.Spiral
check for keypress, return true if so
keyIsPressed() - Static method in class roombacomm.SpySimple
check for keypress, return true if so
keyIsPressed() - Static method in class roombacomm.Tribble
check for keypress, return true if so
keyPressed(KeyEvent) - Method in class roombacomm.DriveRealTime
Handle the key pressed event from the text field.
keyReleased(KeyEvent) - Method in class roombacomm.DriveRealTime
Handle the key released event from the text field.
keyTyped(KeyEvent) - Method in class roombacomm.DriveRealTime
Handle the key typed event from the text field.

L

listPorts() - Method in class roombacomm.RoombaComm
List available ports
listPorts() - Method in class roombacomm.RoombaCommSerial
If this just hangs and never completes on Windows, it may be because the DLL doesn't have its exec bit set.
ListSerialPorts - Class in roombacomm
A simple test of RoombaComm and RoombaCommSerial functionality.
ListSerialPorts() - Constructor for class roombacomm.ListSerialPorts
 
logmsg(String) - Method in class roombacomm.RoombaComm
just a little debug
LogoA - Class in roombacomm
Some example Logo-like things to do
LogoA() - Constructor for class roombacomm.LogoA
 

M

main(String[]) - Static method in class roombacomm.BumpTurn
 
main(String[]) - Static method in class roombacomm.Drive
 
main(String[]) - Static method in class roombacomm.DriveRealTime
 
main(String[]) - Static method in class roombacomm.ListSerialPorts
 
main(String[]) - Static method in class roombacomm.LogoA
 
main(String[]) - Static method in class roombacomm.RoombaCommTest
 
main(String[]) - Static method in class roombacomm.RoombaCommTestOld
 
main(String[]) - Static method in class roombacomm.RTTTLParser
 
main(String[]) - Static method in class roombacomm.RTTTLPlay
 
main(String[]) - Static method in class roombacomm.SimpleTest
 
main(String[]) - Static method in class roombacomm.Spiral
 
main(String[]) - Static method in class roombacomm.Spiro1
 
main(String[]) - Static method in class roombacomm.Spy
 
main(String[]) - Static method in class roombacomm.SpyAuto
 
main(String[]) - Static method in class roombacomm.SpySimple
 
main(String[]) - Static method in class roombacomm.Test
 
main(String[]) - Static method in class roombacomm.Tribble
 
main(String[]) - Static method in class roombacomm.Waggle
 
max() - Method in class roombacomm.RoombaComm
Send the max command
maxButton() - Method in class roombacomm.RoombaComm
'Max' button pressed state
millimetersPerDegree - Static variable in class roombacomm.RoombaComm
mm/deg is circumference distance divided by 360 degrees
millimetersPerRadian - Static variable in class roombacomm.RoombaComm
mm/rad is a circumference distance divied by two pi
mode() - Method in class roombacomm.RoombaComm
current SCI mode RoombaComm thinks the Roomba is in
modeAsString() - Method in class roombacomm.RoombaComm
mode as String
motor_overcurrents() - Method in class roombacomm.RoombaComm
lower-level func, returns raw byte
motorOvercurrentDriveLeft() - Method in class roombacomm.RoombaComm
overcurrent on left drive wheel
motorOvercurrentDriveRight() - Method in class roombacomm.RoombaComm
overcurrent on right drive wheel
motorOvercurrentMainBrush() - Method in class roombacomm.RoombaComm
overcurrent on main brush
motorOvercurrentSideBrush() - Method in class roombacomm.RoombaComm
overcurrent on side brush
motorOvercurrentVacuum() - Method in class roombacomm.RoombaComm
overcurrent on vacuum

N

Note - Class in roombacomm
Simple wrapper for musical notes
notenum - Variable in class roombacomm.Note
 
noteToNum - Static variable in class roombacomm.RTTTLParser
 

O

output - Variable in class roombacomm.RoombaCommSerial
the serial output stream, normally you don't need access to this

P

parse(String) - Static method in class roombacomm.RTTTLParser
 
pause(int) - Method in class roombacomm.RoombaComm
Just a simple pause function.
playMidiNote(int, int) - Method in class roombacomm.RoombaCommPanel
Play a (MIDI) note, that is, make the Roomba a musical instrument notenums 32-127: notenum == corresponding note played thru beeper velocity == duration in number of 1/64s of a second (e.g.
playNote(int, int) - Method in class roombacomm.RoombaComm
Play a musical note Does it via the hacky method of defining a one-note song & playing it Uses up song slot 15.
playSong(int) - Method in class roombacomm.RoombaComm
 
port - Variable in class roombacomm.RoombaCommSerial
The RXTX port object, normally you don't need access to this
powerButton() - Method in class roombacomm.RoombaComm
'Power' button pressed state
powerOff() - Method in class roombacomm.RoombaComm
Power off the Roomba.
println(String) - Method in class roombacomm.RoombaComm
 
printSensors(RoombaCommSerial) - Static method in class roombacomm.SpySimple
 
purr() - Static method in class roombacomm.Tribble
 

R

remote_opcode() - Method in class roombacomm.RoombaComm
lower-level func, returns raw byte
reset() - Method in class roombacomm.RoombaComm
Reset Roomba after a fault.
roombacomm - package roombacomm
 
RoombaComm - Class in roombacomm
The abstract base for all Roomba communications.
RoombaComm() - Constructor for class roombacomm.RoombaComm
 
RoombaComm(boolean) - Constructor for class roombacomm.RoombaComm
 
RoombaComm(boolean, int) - Constructor for class roombacomm.RoombaComm
 
RoombaCommPanel - Class in roombacomm
A Panel containing controls for testing RoombaComm.
RoombaCommPanel() - Constructor for class roombacomm.RoombaCommPanel
 
RoombaCommSerial - Class in roombacomm
The serial-port based implementation of RoombaComm.
RoombaCommSerial() - Constructor for class roombacomm.RoombaCommSerial
 
RoombaCommSerial(boolean) - Constructor for class roombacomm.RoombaCommSerial
 
RoombaCommSerial(boolean, int) - Constructor for class roombacomm.RoombaCommSerial
 
RoombaCommTest - Class in roombacomm
A simple wrapper for RoombaCommPanel.
RoombaCommTest(String[]) - Constructor for class roombacomm.RoombaCommTest
 
RoombaCommTestOld - Class in roombacomm
 
RoombaCommTestOld() - Constructor for class roombacomm.RoombaCommTestOld
 
RTTTLParser - Class in roombacomm
 
RTTTLParser() - Constructor for class roombacomm.RTTTLParser
 
RTTTLPlay - Class in roombacomm
Play RTTL formatted ringtones on the Roomba.
RTTTLPlay() - Constructor for class roombacomm.RTTTLPlay
 

S

safe() - Method in class roombacomm.RoombaComm
Send SAFE command
safetyFault() - Method in class roombacomm.RoombaComm
 
send(byte[]) - Method in class roombacomm.RoombaComm
Send given byte array to Roomba.
send(int) - Method in class roombacomm.RoombaComm
Send a single byte to the Roomba (defined as int because of stupid java signed bytes)
send(byte[]) - Method in class roombacomm.RoombaCommSerial
subclassed.
send(int) - Method in class roombacomm.RoombaCommSerial
This will handle both ints, bytes and chars transparently.
sensors(int) - Method in class roombacomm.RoombaComm
Send the SENSORS command with one of the SENSORS_ arguments Typically, one does "sensors(SENSORS_ALL)" to get all sensor data
sensors() - Method in class roombacomm.RoombaComm
get all sensor data
sensorsAsString() - Method in class roombacomm.RoombaComm
 
sensorsAutoUpdate() - Method in class roombacomm.RoombaComm
 
sensorsUpdateTime() - Method in class roombacomm.RoombaComm
 
sensorsValid() - Method in class roombacomm.RoombaComm
 
serialEvent(SerialPortEvent) - Method in class roombacomm.RoombaCommSerial
callback for SerialPortEventListener (from processing.serial.Serial)
setLEDs(boolean, boolean, boolean, boolean, boolean, boolean, int, int) - Method in class roombacomm.RoombaComm
Turns on/off the various LEDs.
setMotors(boolean, boolean, boolean) - Method in class roombacomm.RoombaComm
Turns on/off the non-drive motors (main brush, vacuum, sidebrush).
setSensorsAutoUpdate(boolean) - Method in class roombacomm.RoombaComm
 
setSensorsUpdateTime(int) - Method in class roombacomm.RoombaComm
 
setShowHardwareHandhake(boolean) - Method in class roombacomm.RoombaCommPanel
Set to 'false' to hide the "h/w handshake" button, which seems to be only needed on Windows
setSpeed(int) - Method in class roombacomm.RoombaComm
Set speed for movement commands
setupWindow() - Method in class roombacomm.DriveRealTime
 
SimpleTest - Class in roombacomm
A simple test of RoombaComm and RoombaCommSerial functionality.
SimpleTest() - Constructor for class roombacomm.SimpleTest
 
speed - Variable in class roombacomm.RoombaComm
current speed for movement operations that don't take a speed
spin(int) - Method in class roombacomm.RoombaComm
Spin right or spin left a particular number of degrees
spinLeft(int) - Method in class roombacomm.RoombaComm
Spin left a specified angle at a specified speed
spinLeft() - Method in class roombacomm.RoombaComm
Spin in place anti-clockwise, at the current speed
spinLeftAt(int) - Method in class roombacomm.RoombaComm
Spin in place anti-clockwise, at the current speed.
spinRight(int) - Method in class roombacomm.RoombaComm
Spin right the current speed for a specified angle
spinRight() - Method in class roombacomm.RoombaComm
Spin in place clockwise, at the current speed
spinRightAt(int) - Method in class roombacomm.RoombaComm
Spin in place clockwise, at the current speed.
Spiral - Class in roombacomm
Make the Roomab drive in a spiral.
Spiral() - Constructor for class roombacomm.Spiral
 
Spiro1 - Class in roombacomm
A Spirograph-like example
Spiro1() - Constructor for class roombacomm.Spiro1
 
spot() - Method in class roombacomm.RoombaComm
Send the SPOT command
spotButton() - Method in class roombacomm.RoombaComm
'Spot' button pressed state
Spy - Class in roombacomm
Spy on the Roomba as it goes about its normal business
Spy() - Constructor for class roombacomm.Spy
 
SpyAuto - Class in roombacomm
Spy on the Roomba as it goes about its normal business
SpyAuto() - Constructor for class roombacomm.SpyAuto
 
SpySimple - Class in roombacomm
Spy on the Roomba as it goes about its normal business
SpySimple() - Constructor for class roombacomm.SpySimple
 
square(RoombaComm, int) - Static method in class roombacomm.LogoA
Make a square with a Roomba.
start() - Method in class roombacomm.RoombaComm
Send START command
startAutoUpdate() - Method in class roombacomm.RoombaComm
 
startup() - Method in class roombacomm.RoombaComm
Put Roomba in safe mode.
stateChanged(ChangeEvent) - Method in class roombacomm.RoombaCommPanel
implement ChangeListener, for the slider
stateChanged(ChangeEvent) - Method in class roombacomm.RoombaCommTestOld
implement ChangeListener, for the slider
stop() - Method in class roombacomm.RoombaComm
Stop Rooomba's motion.

T

temperature() - Method in class roombacomm.RoombaComm
temperature of battery units: degrees Celcius range: -128 - 127
Test - Class in roombacomm
A fairly thorough test of the RoombaComm API.
Test() - Constructor for class roombacomm.Test
 
toSec64ths() - Method in class roombacomm.Note
 
toShort(byte, byte) - Static method in class roombacomm.RoombaComm
 
toString() - Method in class roombacomm.Note
 
toUnsignedShort(byte, byte) - Static method in class roombacomm.RoombaComm
 
Tribble - Class in roombacomm
Make Tribble noises
Tribble() - Constructor for class roombacomm.Tribble
 
turn(int) - Method in class roombacomm.RoombaComm
 
turnLeft() - Method in class roombacomm.RoombaComm
 
turnRight() - Method in class roombacomm.RoombaComm
 

U

updateDisplay(String) - Method in class roombacomm.DriveRealTime
a sort of gui equivalent to system.out.println
updateDisplay(String) - Method in class roombacomm.RoombaCommPanel
 
updateSensors() - Method in class roombacomm.RoombaComm
Query Roomba for sensor status and sync its state with this object's Subclasses should query Roomba and fill up 'sensor_bytes' with the full sensor data set If a RooombaComm object is constructed with 'autoUpdate' true, calling this method is not required because a separate thread is created to do sensor updating.
updateSensors() - Method in class roombacomm.RoombaCommSerial
Update sensors.
updateSensorsPause - Static variable in class roombacomm.RoombaCommSerial
The time to wait in milliseconds after sending sensors command before attempting to read

V

vacuum(boolean) - Method in class roombacomm.RoombaComm
Turn all vacuum motors on or off according to state
VERSION - Static variable in class roombacomm.RoombaComm
version of the library
virtual_wall() - Method in class roombacomm.RoombaComm
lower-level func, returns raw byte
voltage() - Method in class roombacomm.RoombaComm
Voltage of battery units: mV range: 0 - 65535

W

Waggle - Class in roombacomm
Drive the Roomba in a Waggle, like when it's searching for something
Waggle() - Constructor for class roombacomm.Waggle
 
waitForDSR - Variable in class roombacomm.RoombaCommSerial
Some "virtual" serial ports like Bluetooth serial on Windows return weird errors deep inside RXTX if an opened port is used before the virtual COM port is ready.
wakeup() - Method in class roombacomm.RoombaComm
Wake's Roomba up, if possible, thus optional To wake up the Roomba requires twiddling its DD line, often hooked up to the RS-232 DTR line, which may not be available in some implementations
wakeup() - Method in class roombacomm.RoombaCommSerial
toggles DD line via serial port DTR (if available)
wall() - Method in class roombacomm.RoombaComm
Can we see a wall?
wheelbase - Static variable in class roombacomm.RoombaComm
distance between wheels on the roomba, in millimeters
wheelDropCenter() - Method in class roombacomm.RoombaComm
Center wheeldrop sensor
wheelDropLeft() - Method in class roombacomm.RoombaComm
Left wheeldrop sensor
wheelDropRight() - Method in class roombacomm.RoombaComm
Right wheeldrop sensor
windowActivated(WindowEvent) - Method in class roombacomm.RoombaCommTest
implement windowlistener
windowActivated(WindowEvent) - Method in class roombacomm.RoombaCommTestOld
implement windowlistener
windowClosed(WindowEvent) - Method in class roombacomm.RoombaCommTest
implement windowlistener
windowClosed(WindowEvent) - Method in class roombacomm.RoombaCommTestOld
implement windowlistener
windowClosing(WindowEvent) - Method in class roombacomm.RoombaCommTest
implement windowlistener
windowClosing(WindowEvent) - Method in class roombacomm.RoombaCommTestOld
implement windowlistener
windowDeactivated(WindowEvent) - Method in class roombacomm.RoombaCommTest
implement windowlistener
windowDeactivated(WindowEvent) - Method in class roombacomm.RoombaCommTestOld
implement windowlistener
windowDeiconified(WindowEvent) - Method in class roombacomm.RoombaCommTest
implement windowlistener
windowDeiconified(WindowEvent) - Method in class roombacomm.RoombaCommTestOld
implement windowlistener
windowIconified(WindowEvent) - Method in class roombacomm.RoombaCommTest
implement windowlistener
windowIconified(WindowEvent) - Method in class roombacomm.RoombaCommTestOld
implement windowlistener
windowOpened(WindowEvent) - Method in class roombacomm.RoombaCommTest
implement windowlistener
windowOpened(WindowEvent) - Method in class roombacomm.RoombaCommTestOld
implement windowlistener

A B C D E F G H I K L M N O P R S T U V W