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

A

angleTurned() - Method in class com.maschel.roomba.RoombaJSSC

Get the angle turned in degrees since the last sensor data request.

B

batteryCapacity() - Method in class com.maschel.roomba.RoombaJSSC

Get the estimated charge capacity of roomba's battery in milliamp-hours (mAh)

batteryCharge() - Method in class com.maschel.roomba.RoombaJSSC

Get the estimated charge of the roomba's battery in milliamp-hours (mAh).

batteryCurrent() - Method in class com.maschel.roomba.RoombaJSSC

Get the current in milliamps (mA) flowing into or out of roomba's battery.

batteryTemperature() - Method in class com.maschel.roomba.RoombaJSSC

Get the temperature of Roomba's battery in degrees Celsius.

batteryVoltage() - Method in class com.maschel.roomba.RoombaJSSC

Get the voltage of the battery in millivolt (mV)

bumpLeft() - Method in class com.maschel.roomba.RoombaJSSC

Get value of left bumper sensor.

bumpRight() - Method in class com.maschel.roomba.RoombaJSSC

Get value of right bumper sensor.

buttonCleanPressed() - Method in class com.maschel.roomba.RoombaJSSC

Check if the clean button is pressed.

buttonClockPressed() - Method in class com.maschel.roomba.RoombaJSSC

Check if the clock button is pressed.

buttonDayPressed() - Method in class com.maschel.roomba.RoombaJSSC

Check if the day button is pressed.

buttonDockPressed() - Method in class com.maschel.roomba.RoombaJSSC

Check if the dock button is pressed.

buttonHourPressed() - Method in class com.maschel.roomba.RoombaJSSC

Check if the hour button is pressed.

buttonMinutePressed() - Method in class com.maschel.roomba.RoombaJSSC

Check if the minute button is pressed.

buttons(boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean) - Method in class com.maschel.roomba.RoombaJSSC

This command lets you push Roomba’s buttons.

buttonSchedulePressed() - Method in class com.maschel.roomba.RoombaJSSC

Check if the schedule button is pressed.

buttonSpotPressed() - Method in class com.maschel.roomba.RoombaJSSC

Check if the spot button is pressed.

C

chargingState() - Method in class com.maschel.roomba.RoombaJSSC

Get current charging state

clean() - Method in class com.maschel.roomba.RoombaJSSC

This command starts the default cleaning mode.

cleanMax() - Method in class com.maschel.roomba.RoombaJSSC

This command starts the Max cleaning mode, which will clean until the battery is dead.

cleanSpot() - Method in class com.maschel.roomba.RoombaJSSC

This command starts the Spot cleaning mode.

cliffFrontLeft() - Method in class com.maschel.roomba.RoombaJSSC

Get value of cliff front left sensor.

cliffFrontRight() - Method in class com.maschel.roomba.RoombaJSSC

Get value of cliff front right sensor.

cliffLeft() - Method in class com.maschel.roomba.RoombaJSSC

Get value of cliff left sensor.

cliffRight() - Method in class com.maschel.roomba.RoombaJSSC

Get value of cliff right sensor.

cliffSignalFrontLeft() - Method in class com.maschel.roomba.RoombaJSSC

Get the strength of the cliff front left signal.

cliffSignalFrontRight() - Method in class com.maschel.roomba.RoombaJSSC

Get the strength of the cliff front right signal.

cliffSignalLeft() - Method in class com.maschel.roomba.RoombaJSSC

Get the strength of the cliff left signal.

cliffSignalRight() - Method in class com.maschel.roomba.RoombaJSSC

Get the strength of the cliff right signal.

com.maschel.roomba - package com.maschel.roomba

com.maschel.roomba.song - package com.maschel.roomba.song

connect(String) - Method in class com.maschel.roomba.RoombaJSSC

connect(String) - Method in class com.maschel.roomba.RoombaJSSCSerial

Connect to serial port.

D

digitLedsAscii(char, char, char, char) - Method in class com.maschel.roomba.RoombaJSSC

This command controls the four 7 segment displays on the Roomba 560 and 570 using ASCII character codes.

dirtDetectLevel() - Method in class com.maschel.roomba.RoombaJSSC

Get the level of the dirt detect sensor.

disconnect() - Method in class com.maschel.roomba.RoombaJSSC

disconnect() - Method in class com.maschel.roomba.RoombaJSSCSerial

Disconnect serial port.

distanceTraveled() - Method in class com.maschel.roomba.RoombaJSSC

Get distance travelled in mm since the last sensor data request.

drive(int, int) - Method in class com.maschel.roomba.RoombaJSSC

This command controls Roomba’s drive wheels.

driveDirect(int, int) - Method in class com.maschel.roomba.RoombaJSSC

This command lets you control the forward and backward motion of Roomba’s drive wheels independently.

drivePWM(int, int) - Method in class com.maschel.roomba.RoombaJSSC

This command lets you control the raw forward and backward motion of Roomba’s drive wheels independently.

E

encoderCountsLeft() - Method in class com.maschel.roomba.RoombaJSSC

Get the (cumulative) number of raw left encoder counts.

encoderCountsRight() - Method in class com.maschel.roomba.RoombaJSSC

Get the (cumulative) number of raw right encoder counts.

F

fullMode() - Method in class com.maschel.roomba.RoombaJSSC

This command gives you complete control over Roomba by putting the OI into Full mode, and turning off the cliff, wheel-drop and internal charger safety features.

G

getDuration() - Method in class com.maschel.roomba.song.RoombaSongNote

getDurationByte(int) - Method in enum com.maschel.roomba.song.RoombaNoteDuration

Get the byte representation of the relative note duration

getNote() - Method in class com.maschel.roomba.song.RoombaSongNote

getNoteByte() - Method in enum com.maschel.roomba.song.RoombaNote

Get the byte representation of the note

H

hardReset() - Method in class com.maschel.roomba.RoombaJSSC

This command resets the Roomba, as if you had removed and reinserted the battery.

homebaseChargerAvailable() - Method in class com.maschel.roomba.RoombaJSSC

Check if the homebase charger is present and powered.

I

infraredCharacterLeft() - Method in class com.maschel.roomba.RoombaJSSC

Get the character currently received by the left receiver.

infraredCharacterOmni() - Method in class com.maschel.roomba.RoombaJSSC

Get the character currently received by the omnidirectional receiver.

infraredCharacterRight() - Method in class com.maschel.roomba.RoombaJSSC

Get the character currently received by the right receiver.

internalChargerAvailable() - Method in class com.maschel.roomba.RoombaJSSC

Check if the internal charger is present and powered.

L

leds(boolean, boolean, boolean, boolean, int, int) - Method in class com.maschel.roomba.RoombaJSSC

This command controls the LEDs common to all models of Roomba 600.

lightBumperCenterLeft() - Method in class com.maschel.roomba.RoombaJSSC

Check if the center left light bumper detects an obstacle.

lightBumperCenterRight() - Method in class com.maschel.roomba.RoombaJSSC

Check if the center right light bumper detects an obstacle.

lightBumperFrontLeft() - Method in class com.maschel.roomba.RoombaJSSC

Check if the front left light bumper detects an obstacle.

lightBumperFrontRight() - Method in class com.maschel.roomba.RoombaJSSC

Check if the front right light bumper detects an obstacle.

lightBumperLeft() - Method in class com.maschel.roomba.RoombaJSSC

Check if the left light bumper detects an obstacle.

lightBumperRight() - Method in class com.maschel.roomba.RoombaJSSC

Check if the right light bumper detects an obstacle.

lightBumperSignalCenterLeft() - Method in class com.maschel.roomba.RoombaJSSC

Get the strength of the light bumper center left signal.

lightBumperSignalCenterRight() - Method in class com.maschel.roomba.RoombaJSSC

Get the strength of the light bumper center right signal.

lightBumperSignalFrontLeft() - Method in class com.maschel.roomba.RoombaJSSC

Get the strength of the light bumper front left signal.

lightBumperSignalFrontRight() - Method in class com.maschel.roomba.RoombaJSSC

Get the strength of the light bumper front right signal.

lightBumperSignalLeft() - Method in class com.maschel.roomba.RoombaJSSC

Get the strength of the light bumper left signal.

lightBumperSignalRight() - Method in class com.maschel.roomba.RoombaJSSC

Get the strength of the light bumper right signal.

M

mainBrushOvercurrent() - Method in class com.maschel.roomba.RoombaJSSC

Get value of main brush overcurrent sensor.

mode() - Method in class com.maschel.roomba.RoombaJSSC

Get the current OI mode.

motorCurrentLeft() - Method in class com.maschel.roomba.RoombaJSSC

Get the current being drawn by the left wheel motor in milli Ampere (mA).

motorCurrentMainBrush() - Method in class com.maschel.roomba.RoombaJSSC

Get the current being drawn by the main brush motor in milli Ampere (mA).

motorCurrentRight() - Method in class com.maschel.roomba.RoombaJSSC

Get the current being drawn by the right wheel motor in milli Ampere (mA).

motorCurrentSideBrush() - Method in class com.maschel.roomba.RoombaJSSC

Get the current being drawn by the side brush motor in milli Ampere (mA).

motors(boolean, boolean, boolean, boolean, boolean) - Method in class com.maschel.roomba.RoombaJSSC

This command lets you control the forward and backward motion of Roomba’s main brush, side brush, and vacuum independently.

motorsPWM(int, int, int) - Method in class com.maschel.roomba.RoombaJSSC

This command lets you control the speed of Roomba’s main brush, side brush, and vacuum independently.

P

play(int) - Method in class com.maschel.roomba.RoombaJSSC

This command lets you select a song to play from the songs added to Roomba using the Song command.

portList() - Method in class com.maschel.roomba.RoombaJSSC

portList() - Method in class com.maschel.roomba.RoombaJSSCSerial

Get the list of available serial ports.

powerOff() - Method in class com.maschel.roomba.RoombaJSSC

This command powers down Roomba.

R

relativeLeds(boolean, boolean, boolean, boolean, int, int) - Method in class com.maschel.roomba.RoombaJSSC

This command controls the LEDs common to all models of Roomba 600.

requestedRadius() - Method in class com.maschel.roomba.RoombaJSSC

Get the radius most recently requested with a Drive command.

requestedVelocity() - Method in class com.maschel.roomba.RoombaJSSC

Get the velocity most recently requested with a Drive command.

requestedVelocityLeft() - Method in class com.maschel.roomba.RoombaJSSC

Get the left wheel velocity most recently requested with a Drive Direct command.

requestedVelocityRight() - Method in class com.maschel.roomba.RoombaJSSC

Get the right wheel velocity most recently requested with a Drive Direct command.

reset() - Method in class com.maschel.roomba.RoombaJSSC

Reset the Roomba after error, this will also run the 'start' and 'safe' commands.

RoombaJSSC - Class in com.maschel.roomba

RoombaJSSC - Library for controlling a roomba using the JSSC serial library.

RoombaJSSC() - Constructor for class com.maschel.roomba.RoombaJSSC

RoombaJSSCSerial - Class in com.maschel.roomba

RoombaJSSC implementation, this class contains all the serial library dependent code.

RoombaJSSCSerial() - Constructor for class com.maschel.roomba.RoombaJSSCSerial

RoombaNote - Enum in com.maschel.roomba.song

Enum of all notes that can be played by the Roomba Usage: RoombaNote.C1 (for C note first octave).

RoombaNoteDuration - Enum in com.maschel.roomba.song

Enum of most common note durations Usage: RoombaNoteDuration.QuarterNote (for quarter note duration).

RoombaSongNote - Class in com.maschel.roomba.song

Class used for describing Roomba Songs A RoombaSongNote consists of a note (RoombaNote) and a duration (RoombaNoteDuration)

RoombaSongNote(RoombaNote, RoombaNoteDuration) - Constructor for class com.maschel.roomba.song.RoombaSongNote

S

safeMode() - Method in class com.maschel.roomba.RoombaJSSC

This command puts the OI into Safe mode, enabling user control of Roomba.

safetyFault() - Method in class com.maschel.roomba.RoombaJSSC

Check if a safety fault has occurred, this will put the roomba into passive mode.

schedule(boolean, boolean, boolean, boolean, boolean, boolean, boolean, int, int, int, int, int, int, int, int, int, int, int, int, int, int) - Method in class com.maschel.roomba.RoombaJSSC

This command sends Roomba a new schedule.

schedulingLeds(boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean) - Method in class com.maschel.roomba.RoombaJSSC

This command controls the state of the scheduling LEDs present on the Roomba 560 and 570.

seekDock() - Method in class com.maschel.roomba.RoombaJSSC

This command directs Roomba to drive onto the dock the next time it encounters the docking beams.

send(byte[]) - Method in class com.maschel.roomba.RoombaJSSC

send(int) - Method in class com.maschel.roomba.RoombaJSSC

send(byte[]) - Method in class com.maschel.roomba.RoombaJSSCSerial

Send byte[] to serial port.

send(int) - Method in class com.maschel.roomba.RoombaJSSCSerial

Send integer to serial port.

serialEvent(SerialPortEvent) - Method in class com.maschel.roomba.RoombaJSSCSerial

serialPort - Variable in class com.maschel.roomba.RoombaJSSCSerial

setDayTime(int, int, int) - Method in class com.maschel.roomba.RoombaJSSC

This command sets Roomba’s clock.

sideBrushOvercurrent() - Method in class com.maschel.roomba.RoombaJSSC

Get value of side brush overcurrent sensor.

sleep(int) - Method in class com.maschel.roomba.RoombaJSSC

General sleep function that gives commands that use this function some time to instantiate.

song(int, RoombaSongNote[], int) - Method in class com.maschel.roomba.RoombaJSSC

This command lets you specify up to four songs to the OI that you can play at a later time.

songNotesToBytes(RoombaSongNote[], int) - Static method in class com.maschel.roomba.song.RoombaSongNote

Get the byte array of give RoombaSongNote array.

songNumber() - Method in class com.maschel.roomba.RoombaJSSC

Get the currently selected song.

songPlaying() - Method in class com.maschel.roomba.RoombaJSSC

Check if a song is playing.

start() - Method in class com.maschel.roomba.RoombaJSSC

This command starts the OI.

startup() - Method in class com.maschel.roomba.RoombaJSSC

This command starts the OI of the roomba and puts it in Safe mode which enables user control.

stasis() - Method in class com.maschel.roomba.RoombaJSSC

Check if the roomba is making forward progress.

stop() - Method in class com.maschel.roomba.RoombaJSSC

This command stops the OI.

U

updateSensors() - Method in class com.maschel.roomba.RoombaJSSC

This command requests new sensor data from the roomba.

V

valueOf(String) - Static method in enum com.maschel.roomba.song.RoombaNote

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.maschel.roomba.song.RoombaNoteDuration

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.maschel.roomba.song.RoombaNote

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.maschel.roomba.song.RoombaNoteDuration

Returns an array containing the constants of this enum type, in the order they are declared.

virtualWall() - Method in class com.maschel.roomba.RoombaJSSC

Get value of virtual wall sensor.

W

wall() - Method in class com.maschel.roomba.RoombaJSSC

Get value of wall sensor.

wallSignal() - Method in class com.maschel.roomba.RoombaJSSC

Get the strength of the wall signal.

wheelDropLeft() - Method in class com.maschel.roomba.RoombaJSSC

Get value of left wheel drop sensor.

wheelDropRight() - Method in class com.maschel.roomba.RoombaJSSC

Get value of right wheel drop sensor.

wheelOvercurrentLeft() - Method in class com.maschel.roomba.RoombaJSSC

Get value of left wheel overcurrent sensor.

wheelOvercurrentRight() - Method in class com.maschel.roomba.RoombaJSSC

Get value of right wheel overcurrent sensor.

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