Package Roomba

The Roomba wrapper library. Includes the Robot class, SCI namespace with all commands as specified by the SCI specification and a set of helper classes for easy access to robot's resources. More...

Namespaces
package	SCI
	All commands as specified by the SCI document.

Classes
class	Robot
	The main class for communication with Roomba through a serial interface. More...
class	Component
	Interface for different convenience classes that require access to the Robot class. More...
class	Sensors
	A convenience class for accessing Roomba's sensors. More...
class	Leds
	A convenience class for accessing Roomba's LEDs. More...

Enumerations
enum	ChargingState {   NOT_CHARGING = 0, CHARGING_RECOVERY = 1, CHARGING = 2, TRCIKLE_CHARGING = 3,   WAITING = 4, CHARGING_ERROR = 5 }
	Charging state of the robot. More...
enum	BaudRate {   BAUDRATE_300 = 0, BAUDRATE_600 = 1, BAUDRATE_1200 = 2, BAUDRATE_2400 = 3,   BAUDRATE_4800 = 4, BAUDRATE_9600 = 5, BAUDRATE_14400 = 6, BAUDRATE_19200 = 7,   BAUDRATE_28800 = 8, BAUDRATE_38400 = 9, BAUDRATE_57600 = 10, BAUDRATE_115200 = 11 }
	Baud rate of the serial connection. More...
enum	StatusLED { STATUSLED_OFF = 0, STATUSLED_RED = 1, STATUSLED_GREEN = 2, STATUSLED_AMBER = 3 }
	Status LED colour. More...
enum	SensorPacket { ALL_SENSORS = 0, PACKET_1 = 1, PACKET_2 = 2, PACKET_3 = 3 }
	Sensor packet type. A packet code value of 0 sends all of the data bytes. A value of 1 through 3 sends a subset of the sensor data. More...

Detailed Description

The Roomba wrapper library. Includes the Robot class, SCI namespace with all commands as specified by the SCI specification and a set of helper classes for easy access to robot's resources.

The majority of comments are based directly on the official iRobot Roomba Serial Command Interface (SCI) Specification document. http://www.irobot.com/images/consumer/hacker/roomba_sci_spec_manual.pdf

Enumeration Type Documentation

enum Roomba.BaudRate

Baud rate of the serial connection.

enum Roomba.ChargingState

Charging state of the robot.

enum Roomba.SensorPacket

Sensor packet type. A packet code value of 0 sends all of the data bytes. A value of 1 through 3 sends a subset of the sensor data.

enum Roomba.StatusLED

Status LED colour.